Merge pull request #2665 from whowillcare/master

Add Feature: complete the original author's webhook functions and add two-way webhook type

client/components/settings/settingBody.jade

@@ -18,6 +18,8 @@ template(name="setting")
               a.js-setting-menu(data-id="announcement-setting") {{_ 'admin-announcement'}}
             li
               a.js-setting-menu(data-id="layout-setting") {{_ 'layout'}}
+            li
+              a.js-setting-menu(data-id="webhook-setting") {{_ 'global-webhook'}}
         .main-body
           if loading.get
             +spinner
@@ -31,6 +33,12 @@ template(name="setting")
             +announcementSettings
           else if layoutSetting.get
             +layoutSettings
+          else if webhookSetting.get
+            +webhookSettings
+
+template(name="webhookSettings")
+  span
+     +outgoingWebhooksPopup
 
 template(name="general")
   ul#registration-setting.setting-detail

client/components/settings/settingBody.js

@@ -7,11 +7,13 @@ BlazeComponent.extendComponent({
     this.accountSetting = new ReactiveVar(false);
     this.announcementSetting = new ReactiveVar(false);
     this.layoutSetting = new ReactiveVar(false);
+    this.webhookSetting = new ReactiveVar(false);
 
     Meteor.subscribe('setting');
     Meteor.subscribe('mailServer');
     Meteor.subscribe('accountSettings');
     Meteor.subscribe('announcements');
+    Meteor.subscribe('globalwebhooks');
   },
 
   setError(error) {
@@ -83,6 +85,7 @@ BlazeComponent.extendComponent({
       this.accountSetting.set('account-setting' === targetID);
       this.announcementSetting.set('announcement-setting' === targetID);
       this.layoutSetting.set('layout-setting' === targetID);
+      this.webhookSetting.set('webhook-setting' === targetID);
     }
   },
 

client/components/sidebar/sidebar.jade

@@ -135,22 +135,30 @@ template(name="archiveBoardPopup")
 template(name="outgoingWebhooksPopup")
   each integrations
     form.integration-form
-      if title
-        h4 {{title}}
-      else
-        h4 {{_ 'no-name'}}
-      label
-        | URL
-        input.js-outgoing-webhooks-url(type="text" name="url" value=url)
-        input(type="hidden" value=_id name="id")
+      a.flex
+        span {{_ 'disable-webhook'}}
+        b  
+        .materialCheckBox(class="{{#unless enabled}}is-checked{{/unless}}")
+      input.js-outgoing-webhooks-title(placeholder="{{_ 'webhook-title'}}" type="text" name="title" value=title)
+      input.js-outgoing-webhooks-url(type="text" name="url" value=url autofocus)
+      input.js-outgoing-webhooks-token(placeholder="{{_ 'webhook-token' }}" type="text" value=token name="token")
+      select.js-outgoing-webhooks-type(name="type")
+          each _type in types
+              if($eq _type this.type)
+                  option(value=_type selected="selected") {{_ _type}}
+              else
+                  option(value=_type) {{_ _type}}
+      input(type="hidden" value=this.type name="_type")
+      input(type="hidden" value=_id name="id")
       input.primary.wide(type="submit" value="{{_ 'save'}}")
   form.integration-form
-    h4
-      | {{_ 'new-outgoing-webhook'}}
-    label
-      | URL
-      input.js-outgoing-webhooks-url(type="text" name="url" autofocus)
-    input.primary.wide(type="submit" value="{{_ 'save'}}")
+    input.js-outgoing-webhooks-title(placeholder="{{_ 'webhook-title'}}" type="text" name="title" autofocus)
+    input.js-outgoing-webhooks-url(placeholder="{{_ 'URL' }}" type="text" name="url")
+    input.js-outgoing-webhooks-token(placeholder="{{_ 'webhook-token' }}" type="text" name="token")
+    select.js-outgoing-webhooks-type(name="type")
+        each _type in types
+            option(value=_type) {{_ _type}}
+    input.primary.wide(type="submit" value="{{_ 'create'}}")
 
 template(name="boardMenuPopup")
   ul.pop-over-list

client/components/sidebar/sidebar.js

@@ -1,6 +1,8 @@
 Sidebar = null;
 
 const defaultView = 'home';
+const MCB = '.materialCheckBox';
+const CKCLS = 'is-checked';
 
 const viewTitles = {
   filter: 'filter-cards',
@@ -280,44 +282,71 @@ Template.membersWidget.events({
 });
 
 BlazeComponent.extendComponent({
+  boardId() {
+    return Session.get('currentBoard') || Integrations.Const.GLOBAL_WEBHOOK_ID;
+  },
   integrations() {
-    const boardId = Session.get('currentBoard');
+    const boardId = this.boardId();
     return Integrations.find({ boardId: `${boardId}` }).fetch();
   },
-
-  integration(id) {
-    const boardId = Session.get('currentBoard');
-    return Integrations.findOne({ _id: id, boardId: `${boardId}` });
+  types() {
+    return Integrations.Const.WEBHOOK_TYPES;
+  },
+  integration(cond) {
+    const boardId = this.boardId();
+    const condition = { boardId, ...cond };
+    for (const k in condition) {
+      if (!condition[k]) delete condition[k];
+    }
+    return Integrations.findOne(condition);
+  },
+  onCreated() {
+    this.disabled = new ReactiveVar(false);
   },
-
   events() {
     return [
       {
+        'click a.flex'(evt) {
+          this.disabled.set(!this.disabled.get());
+          $(evt.target).toggleClass(CKCLS, this.disabled.get());
+        },
         submit(evt) {
           evt.preventDefault();
           const url = evt.target.url.value;
-          const boardId = Session.get('currentBoard');
+          const boardId = this.boardId();
           let id = null;
           let integration = null;
+          const title = evt.target.title.value;
+          const token = evt.target.token.value;
+          const type = evt.target.type.value;
+          const enabled = !this.disabled.get();
+          let remove = false;
+          const values = {
+            url,
+            type,
+            token,
+            title,
+            enabled,
+          };
           if (evt.target.id) {
             id = evt.target.id.value;
-            integration = this.integration(id);
-            if (url) {
-              Integrations.update(integration._id, {
-                $set: {
-                  url: `${url}`,
-                },
-              });
-            } else {
-              Integrations.remove(integration._id);
-            }
+            integration = this.integration({ _id: id });
+            remove = !url;
+          } else if (url) {
+            integration = this.integration({ url, token });
+          }
+          if (remove) {
+            Integrations.remove(integration._id);
+          } else if (integration && integration._id) {
+            Integrations.update(integration._id, {
+              $set: values,
+            });
           } else if (url) {
             Integrations.insert({
+              ...values,
               userId: Meteor.userId(),
               enabled: true,
-              type: 'outgoing-webhooks',
-              url: `${url}`,
-              boardId: `${boardId}`,
+              boardId,
               activities: ['all'],
             });
           }
@@ -474,12 +503,12 @@ BlazeComponent.extendComponent({
           evt.preventDefault();
           this.currentBoard.allowsSubtasks = !this.currentBoard.allowsSubtasks;
           this.currentBoard.setAllowsSubtasks(this.currentBoard.allowsSubtasks);
-          $('.js-field-has-subtasks .materialCheckBox').toggleClass(
-            'is-checked',
+          $(`.js-field-has-subtasks ${MCB}`).toggleClass(
+            CKCLS,
             this.currentBoard.allowsSubtasks,
           );
           $('.js-field-has-subtasks').toggleClass(
-            'is-checked',
+            CKCLS,
             this.currentBoard.allowsSubtasks,
           );
           $('.js-field-deposit-board').prop(
@@ -515,15 +544,12 @@ BlazeComponent.extendComponent({
           ];
           options.forEach(function(element) {
             if (element !== value) {
-              $(`#${element} .materialCheckBox`).toggleClass(
-                'is-checked',
-                false,
-              );
-              $(`#${element}`).toggleClass('is-checked', false);
+              $(`#${element} ${MCB}`).toggleClass(CKCLS, false);
+              $(`#${element}`).toggleClass(CKCLS, false);
             }
           });
-          $(`#${value} .materialCheckBox`).toggleClass('is-checked', true);
-          $(`#${value}`).toggleClass('is-checked', true);
+          $(`#${value} ${MCB}`).toggleClass(CKCLS, true);
+          $(`#${value}`).toggleClass(CKCLS, true);
           this.currentBoard.setPresentParentTask(value);
           evt.preventDefault();
         },

client/lib/utils.js

@@ -23,7 +23,6 @@ Utils = {
       })
     );
   },
-
   MAX_IMAGE_PIXEL: Meteor.settings.public.MAX_IMAGE_PIXEL,
   COMPRESS_RATIO: Meteor.settings.public.IMAGE_COMPRESS_RATIO,
   processUploadedAttachment(card, fileObj, callback) {

i18n/en.i18n.json

@@ -510,9 +510,14 @@
   "email-smtp-test-text": "You have successfully sent an email",
   "error-invitation-code-not-exist": "Invitation code doesn't exist",
   "error-notAuthorized": "You are not authorized to view this page.",
+  "webhook-title": "Webhook Name",
+  "webhook-token": "Token (Optional for Authentication)",
   "outgoing-webhooks": "Outgoing Webhooks",
+  "bidirectional-webhooks": "Two-Way Webhooks",
   "outgoingWebhooksPopup-title": "Outgoing Webhooks",
   "boardCardTitlePopup-title": "Card Title Filter",
+  "disable-webhook": "Disable This Webhook",
+  "global-webhook": "Global Webhooks",
   "new-outgoing-webhook": "New Outgoing Webhook",
   "no-name": "(Unknown)",
   "Node_version": "Node version",

models/activities.js

@@ -184,10 +184,11 @@ if (Meteor.isServer) {
               // it's person at himself, ignore it?
               continue;
             }
-            const user = Users.findOne(username) || Users.findOne({ username });
-            const uid = user && user._id;
+            const atUser =
+              Users.findOne(username) || Users.findOne({ username });
+            const uid = atUser && atUser._id;
             params.atUsername = username;
-            params.atEmails = user.emails;
+            params.atEmails = atUser.emails;
             if (board.hasMember(uid)) {
               title = 'act-atUserComment';
               watchers = _.union(watchers, [uid]);
@@ -268,13 +269,23 @@ if (Meteor.isServer) {
     });
 
     const integrations = Integrations.find({
-      boardId: board._id,
-      type: 'outgoing-webhooks',
+      boardId: { $in: [board._id, Integrations.Const.GLOBAL_WEBHOOK_ID] },
+      // type: 'outgoing-webhooks', // all types
       enabled: true,
       activities: { $in: [description, 'all'] },
     }).fetch();
     if (integrations.length > 0) {
-      Meteor.call('outgoingWebhooks', integrations, description, params);
+      integrations.forEach(integration => {
+        Meteor.call(
+          'outgoingWebhooks',
+          integration,
+          description,
+          params,
+          () => {
+            return;
+          },
+        );
+      });
     }
   });
 }

models/integrations.js

@@ -88,16 +88,30 @@ Integrations.attachSchema(
     },
   }),
 );
-
+Integrations.Const = {
+  GLOBAL_WEBHOOK_ID: '_global',
+  ONEWAY: 'outgoing-webhooks',
+  TWOWAY: 'bidirectional-webhooks',
+  get WEBHOOK_TYPES() {
+    return [this.ONEWAY, this.TWOWAY];
+  },
+};
+const permissionHelper = {
+  allow(userId, doc) {
+    const user = Users.findOne(userId);
+    const isAdmin = user && Meteor.user().isAdmin;
+    return isAdmin || allowIsBoardAdmin(userId, Boards.findOne(doc.boardId));
+  },
+};
 Integrations.allow({
   insert(userId, doc) {
-    return allowIsBoardAdmin(userId, Boards.findOne(doc.boardId));
+    return permissionHelper.allow(userId, doc);
   },
   update(userId, doc) {
-    return allowIsBoardAdmin(userId, Boards.findOne(doc.boardId));
+    return permissionHelper.allow(userId, doc);
   },
   remove(userId, doc) {
-    return allowIsBoardAdmin(userId, Boards.findOne(doc.boardId));
+    return permissionHelper.allow(userId, doc);
   },
   fetch: ['boardId'],
 });

server/notifications/outgoing.js

@@ -8,6 +8,19 @@ const postCatchError = Meteor.wrapAsync((url, options, resolve) => {
   });
 });
 
+const Lock = {
+  _lock: {},
+  has(id) {
+    return !!this._lock[id];
+  },
+  set(id) {
+    this._lock[id] = 1;
+  },
+  unset(id) {
+    delete this._lock[id];
+  },
+};
+
 const webhooksAtbts = (process.env.WEBHOOKS_ATTRIBUTES &&
   process.env.WEBHOOKS_ATTRIBUTES.split(',')) || [
   'cardId',
@@ -20,15 +33,49 @@ const webhooksAtbts = (process.env.WEBHOOKS_ATTRIBUTES &&
   'commentId',
   'swimlaneId',
 ];
-
+const responseFunc = 'reactOnHookResponse';
 Meteor.methods({
-  outgoingWebhooks(integrations, description, params) {
-    check(integrations, Array);
+  [responseFunc](data) {
+    check(data, Object);
+    const paramCommentId = data.commentId;
+    const paramCardId = data.cardId;
+    const paramBoardId = data.boardId;
+    const newComment = data.comment;
+    if (paramCardId && paramBoardId && newComment) {
+      // only process data with the cardid, boardid and comment text, TODO can expand other functions here to react on returned data
+      const comment = CardComments.findOne({
+        _id: paramCommentId,
+        cardId: paramCardId,
+        boardId: paramBoardId,
+      });
+      if (comment) {
+        CardComments.update(comment._id, {
+          $set: {
+            text: newComment,
+          },
+        });
+      } else {
+        const userId = data.userId;
+        if (userId) {
+          CardComments.insert({
+            text: newComment,
+            userId,
+            cardId,
+            boardId,
+          });
+        }
+      }
+    }
+  },
+  outgoingWebhooks(integration, description, params) {
+    check(integration, Object);
     check(description, String);
     check(params, Object);
+    this.unblock();
 
     // label activity did not work yet, see wekan/models/activities.js
     const quoteParams = _.clone(params);
+    const clonedParams = _.clone(params);
     [
       'card',
       'list',
@@ -63,23 +110,44 @@ Meteor.methods({
       if (params[key]) value[key] = params[key];
     });
     value.description = description;
-
-    const options = {
-      headers: {
-        // 'Content-Type': 'application/json',
-        // 'X-Wekan-Activities-Token': 'Random.Id()',
-      },
-      data: value,
+    //integrations.forEach(integration => {
+    const is2way = integration.type === Integrations.Const.TWOWAY;
+    const token = integration.token || '';
+    const headers = {
+      'Content-Type': 'application/json',
     };
+    if (token) headers['X-Wekan-Token'] = token;
+    const options = {
+      headers,
+      data: is2way ? clonedParams : value,
+    };
+    const url = integration.url;
+    const response = postCatchError(url, options);
 
-    integrations.forEach(integration => {
-      const response = postCatchError(integration.url, options);
-
-      if (response && response.statusCode && response.statusCode === 200) {
-        return true; // eslint-disable-line consistent-return
-      } else {
-        throw new Meteor.Error('error-invalid-webhook-response');
+    if (response && response.statusCode && response.statusCode === 200) {
+      if (is2way) {
+        const cid = params.commentId;
+        const tooSoon = Lock.has(cid); // if an activity happens to fast, notification shouldn't fire with the same id
+        if (!tooSoon) {
+          let clearNotification = () => {};
+          if (cid) {
+            Lock.set(cid);
+            const clearNotificationFlagTimeout = 1000;
+            clearNotification = () => Lock.unset(cid);
+            Meteor.setTimeout(clearNotification, clearNotificationFlagTimeout);
+          }
+          const data = response.data; // only an JSON encoded response will be actioned
+          if (data) {
+            Meteor.call(responseFunc, data, () => {
+              clearNotification();
+            });
+          }
+        }
       }
-    });
+      return response; // eslint-disable-line consistent-return
+    } else {
+      throw new Meteor.Error('error-invalid-webhook-response');
+    }
+    //});
   },
 });

server/publications/settings.js

@@ -1,3 +1,9 @@
+Meteor.publish('globalwebhooks', () => {
+  const boardId = Integrations.Const.GLOBAL_WEBHOOK_ID;
+  return Integrations.find({
+    boardId,
+  });
+});
 Meteor.publish('setting', () => {
   return Settings.find(
     {},