feat: Events via webhook (#771)

Closes #215, closes #656
plankanban · Jun 6, 2024 · 3779bdb · 3779bdb
1 parent 4124ab1
commit 3779bdb
Show file tree

Hide file tree

Showing 38 changed files with 416 additions and 9 deletions.
diff --git a/server/.env.sample b/server/.env.sample
@@ -46,6 +46,9 @@ SECRET_KEY=notsecretkey
 # SLACK_BOT_TOKEN=
 # SLACK_CHANNEL_ID=
 
+# WEBHOOK_URL=
+# WEBHOOK_BEARER=
+
 ## Do not edit this
 
 TZ=UTC
diff --git a/server/api/controllers/attachments/create.js b/server/api/controllers/attachments/create.js
@@ -44,7 +44,7 @@ module.exports = {
   async fn(inputs, exits) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, board } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -88,6 +88,7 @@ module.exports = {
         card,
         creatorUser: currentUser,
       },
+      board,
       requestId: inputs.requestId,
       request: this.req,
     });

diff --git a/server/api/controllers/card-memberships/create.js b/server/api/controllers/card-memberships/create.js
@@ -45,7 +45,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, board } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -74,6 +74,7 @@ module.exports = {
           card,
           userId: inputs.userId,
         },
+        board,
         request: this.req,
       })
       .intercept('userAlreadyCardMember', () => Errors.USER_ALREADY_CARD_MEMBER);

diff --git a/server/api/controllers/card-memberships/delete.js b/server/api/controllers/card-memberships/delete.js
@@ -39,7 +39,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { board } = await sails.helpers.cards
+    const { board, card } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -67,6 +67,7 @@ module.exports = {
 
     cardMembership = await sails.helpers.cardMemberships.deleteOne.with({
       board,
+      card,
       record: cardMembership,
       request: this.req,
     });

diff --git a/server/api/controllers/comment-actions/delete.js b/server/api/controllers/comment-actions/delete.js
@@ -36,7 +36,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.COMMENT_ACTION_NOT_FOUND);
 
     let { action } = path;
-    const { board, project } = path;
+    const { board, project, card } = path;
 
     const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
@@ -61,6 +61,7 @@ module.exports = {
 
     action = await sails.helpers.actions.deleteOne.with({
       board,
+      card,
       record: action,
       request: this.req,
     });

diff --git a/server/api/controllers/comment-actions/update.js b/server/api/controllers/comment-actions/update.js
@@ -40,7 +40,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.COMMENT_ACTION_NOT_FOUND);
 
     let { action } = path;
-    const { board, project } = path;
+    const { board, project, card } = path;
 
     const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
@@ -69,6 +69,7 @@ module.exports = {
 
     action = await sails.helpers.actions.updateOne.with({
       values,
+      card,
       board,
       record: action,
       request: this.req,

diff --git a/server/api/controllers/lists/delete.js b/server/api/controllers/lists/delete.js
@@ -28,7 +28,8 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    let { list } = await sails.helpers.lists
+    // eslint-disable-next-line prefer-const
+    let { list, board } = await sails.helpers.lists
       .getProjectPath(inputs.id)
       .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
 
@@ -47,6 +48,7 @@ module.exports = {
 
     list = await sails.helpers.lists.deleteOne.with({
       record: list,
+      board,
       request: this.req,
     });
 

diff --git a/server/api/controllers/lists/update.js b/server/api/controllers/lists/update.js
@@ -35,7 +35,8 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    let { list } = await sails.helpers.lists
+    // eslint-disable-next-line prefer-const
+    let { list, board } = await sails.helpers.lists
       .getProjectPath(inputs.id)
       .intercept('pathNotFound', () => Errors.LIST_NOT_FOUND);
 
@@ -56,6 +57,7 @@ module.exports = {
 
     list = await sails.helpers.lists.updateOne.with({
       values,
+      board,
       record: list,
       request: this.req,
     });

diff --git a/server/api/controllers/tasks/create.js b/server/api/controllers/tasks/create.js
@@ -39,7 +39,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, board } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -63,6 +63,7 @@ module.exports = {
         ...values,
         card,
       },
+      board,
       request: this.req,
     });
 

diff --git a/server/api/helpers/actions/create-one.js b/server/api/helpers/actions/create-one.js
@@ -95,6 +95,15 @@ module.exports = {
       buildAndSendSlackMessage(values.user, values.card, action);
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'ACTION_CREATE',
+      data: action,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board: inputs.board,
+    });
+
     return action;
   },
 };
diff --git a/server/api/helpers/actions/delete-one.js b/server/api/helpers/actions/delete-one.js
@@ -4,6 +4,10 @@ module.exports = {
       type: 'ref',
       required: true,
     },
+    card: {
+      type: 'ref',
+      required: true,
+    },
     board: {
       type: 'ref',
       required: true,
@@ -25,6 +29,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ACTION_DELETE',
+        data: action,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return action;

diff --git a/server/api/helpers/actions/update-one.js b/server/api/helpers/actions/update-one.js
@@ -8,6 +8,10 @@ module.exports = {
       type: 'json',
       required: true,
     },
+    card: {
+      type: 'ref',
+      required: true,
+    },
     board: {
       type: 'ref',
       required: true,
@@ -31,6 +35,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ACTION_UPDATE',
+        data: action,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return action;

diff --git a/server/api/helpers/attachments/create-one.js b/server/api/helpers/attachments/create-one.js
@@ -21,6 +21,10 @@ module.exports = {
       custom: valuesValidator,
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     requestId: {
       type: 'string',
       isNotEmptyString: true,
@@ -31,7 +35,7 @@ module.exports = {
   },
 
   async fn(inputs) {
-    const { values } = inputs;
+    const { values, board } = inputs;
 
     const attachment = await Attachment.create({
       ...values,
@@ -55,9 +59,20 @@ module.exports = {
         values: {
           coverAttachmentId: attachment.id,
         },
+        board,
+        request: inputs.request,
       });
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'ATTACHMENT_CREATE',
+      data: attachment,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board,
+    });
+
     return attachment;
   },
 };
diff --git a/server/api/helpers/attachments/delete-one.js b/server/api/helpers/attachments/delete-one.js
@@ -48,6 +48,15 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ATTACHMENT_DELETE',
+        data: attachment,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return attachment;

diff --git a/server/api/helpers/attachments/update-one.js b/server/api/helpers/attachments/update-one.js
@@ -31,6 +31,14 @@ module.exports = {
         },
         inputs.request,
       );
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'ATTACHMENT_UPDATE',
+        data: attachment,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        board: inputs.board,
+      });
     }
 
     return attachment;

diff --git a/server/api/helpers/boards/create-one.js b/server/api/helpers/boards/create-one.js
@@ -111,6 +111,14 @@ module.exports = {
       );
     });
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'BOARD_CREATE',
+      data: board,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      board,
+    });
+
     return {
       board,
       boardMembership,

diff --git a/server/api/helpers/boards/delete-one.js b/server/api/helpers/boards/delete-one.js
@@ -35,6 +35,14 @@ module.exports = {
       });
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'BOARD_DELETE',
+      data: board,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      board,
+    });
+
     return board;
   },
 };
diff --git a/server/api/helpers/boards/update-one.js b/server/api/helpers/boards/update-one.js
@@ -83,6 +83,14 @@ module.exports = {
       });
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'BOARD_UPDATE',
+      data: board,
+      projectId: board.projectId,
+      user: inputs.request.currentUser,
+      board,
+    });
+
     return board;
   },
 };
diff --git a/server/api/helpers/card-memberships/create-one.js b/server/api/helpers/card-memberships/create-one.js
@@ -21,6 +21,10 @@ module.exports = {
       custom: valuesValidator,
       required: true,
     },
+    board: {
+      type: 'ref',
+      required: true,
+    },
     request: {
       type: 'ref',
     },
@@ -75,6 +79,15 @@ module.exports = {
       );
     }
 
+    await sails.helpers.utils.sendWebhook.with({
+      event: 'CARD_MEMBERSHIP_CREATE',
+      data: cardMembership,
+      projectId: inputs.board.projectId,
+      user: inputs.request.currentUser,
+      card: values.card,
+      board: inputs.board,
+    });
+
     return cardMembership;
   },
 };
diff --git a/server/api/helpers/card-memberships/delete-one.js b/server/api/helpers/card-memberships/delete-one.js
@@ -4,6 +4,10 @@ module.exports = {
       type: 'ref',
       required: true,
     },
+    card: {
+      type: 'ref',
+      required: true,
+    },
     board: {
       type: 'ref',
       required: true,
@@ -40,6 +44,15 @@ module.exports = {
           },
         });
       }
+
+      await sails.helpers.utils.sendWebhook.with({
+        event: 'CARD_MEMBERSHIP_DELETE',
+        data: cardMembership,
+        projectId: inputs.board.projectId,
+        user: inputs.request.currentUser,
+        card: inputs.card,
+        board: inputs.board,
+      });
     }
 
     return cardMembership;