feat: Webhooks configuration, all events support, refactoring

plankanban · Jun 11, 2024 · c065566 · c065566
1 parent 3779bdb
commit c065566
Show file tree

Hide file tree

Showing 96 changed files with 1,274 additions and 503 deletions.
diff --git a/docker-compose-dev.yml b/docker-compose-dev.yml
@@ -45,6 +45,15 @@ services:
       # - SMTP_PASSWORD=
       # - SMTP_FROM="Demo Demo" <demo@demo.demo>
 
+      # Optional fields: accessToken, events, excludedEvents
+      # - |
+      #   WEBHOOKS=[{
+      #     "url": "http://localhost:3001",
+      #     "accessToken": "notaccesstoken",
+      #     "events": ["cardCreate", "cardUpdate", "cardDelete"],
+      #     "excludedEvents": ["notificationCreate", "notificationUpdate"]
+      #   }]
+
       # - SLACK_BOT_TOKEN=
       # - SLACK_CHANNEL_ID=
 

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -53,6 +53,15 @@ services:
       # - SMTP_PASSWORD=
       # - SMTP_FROM="Demo Demo" <demo@demo.demo>
 
+      # Optional fields: accessToken, events, excludedEvents
+      # - |
+      #   WEBHOOKS=[{
+      #     "url": "http://localhost:3001",
+      #     "accessToken": "notaccesstoken",
+      #     "events": ["cardCreate", "cardUpdate", "cardDelete"],
+      #     "excludedEvents": ["notificationCreate", "notificationUpdate"]
+      #   }]
+
       # - SLACK_BOT_TOKEN=
       # - SLACK_CHANNEL_ID=
     depends_on:

diff --git a/server/.env.sample b/server/.env.sample
@@ -43,12 +43,17 @@ SECRET_KEY=notsecretkey
 # SMTP_PASSWORD=
 # SMTP_FROM="Demo Demo" <demo@demo.demo>
 
+# Optional fields: accessToken, events, excludedEvents
+# WEBHOOKS='[{
+#   "url": "http://localhost:3001",
+#   "accessToken": "notaccesstoken",
+#   "events": ["cardCreate", "cardUpdate", "cardDelete"],
+#   "excludedEvents": ["notificationCreate", "notificationUpdate"]
+# }]'
+
 # 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,12 +44,12 @@ module.exports = {
   async fn(inputs, exits) {
     const { currentUser } = this.req;
 
-    const { card, board } = await sails.helpers.cards
+    const { card, list, board, project } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
     const boardMembership = await BoardMembership.findOne({
-      boardId: card.boardId,
+      boardId: board.id,
       userId: currentUser.id,
     });
 
@@ -83,12 +83,14 @@ module.exports = {
     const fileData = await sails.helpers.attachments.processUploadedFile(file);
 
     const attachment = await sails.helpers.attachments.createOne.with({
+      project,
+      board,
+      list,
       values: {
         ...fileData,
         card,
         creatorUser: currentUser,
       },
-      board,
       requestId: inputs.requestId,
       request: this.req,
     });

diff --git a/server/api/controllers/attachments/delete.js b/server/api/controllers/attachments/delete.js
@@ -33,7 +33,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.ATTACHMENT_NOT_FOUND);
 
     let { attachment } = path;
-    const { card, board } = path;
+    const { card, list, board, project } = path;
 
     const boardMembership = await BoardMembership.findOne({
       boardId: board.id,
@@ -49,9 +49,12 @@ module.exports = {
     }
 
     attachment = await sails.helpers.attachments.deleteOne.with({
+      project,
       board,
+      list,
       card,
       record: attachment,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/attachments/update.js b/server/api/controllers/attachments/update.js
@@ -37,7 +37,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.ATTACHMENT_NOT_FOUND);
 
     let { attachment } = path;
-    const { board } = path;
+    const { card, list, board, project } = path;
 
     const boardMembership = await BoardMembership.findOne({
       boardId: board.id,
@@ -56,8 +56,12 @@ module.exports = {
 
     attachment = await sails.helpers.attachments.updateOne.with({
       values,
+      project,
       board,
+      list,
+      card,
       record: attachment,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/board-memberships/create.js b/server/api/controllers/board-memberships/create.js
@@ -48,14 +48,11 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { board } = await sails.helpers.boards
+    const { board, project } = await sails.helpers.boards
       .getProjectPath(inputs.boardId)
       .intercept('pathNotFound', () => Errors.BOARD_NOT_FOUND);
 
-    const isProjectManager = await sails.helpers.users.isProjectManager(
-      currentUser.id,
-      board.projectId,
-    );
+    const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
     if (!isProjectManager) {
       throw Errors.BOARD_NOT_FOUND; // Forbidden
@@ -71,11 +68,13 @@ module.exports = {
 
     const boardMembership = await sails.helpers.boardMemberships.createOne
       .with({
+        project,
         values: {
           ...values,
           board,
           user,
         },
+        actorUser: currentUser,
         request: this.req,
       })
       .intercept('userAlreadyBoardMember', () => Errors.USER_ALREADY_BOARD_MEMBER);

diff --git a/server/api/controllers/board-memberships/delete.js b/server/api/controllers/board-memberships/delete.js
@@ -27,7 +27,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.BOARD_MEMBERSHIP_NOT_FOUND);
 
     let { boardMembership } = path;
-    const { project } = path;
+    const { board, project } = path;
 
     if (boardMembership.userId !== currentUser.id) {
       const isProjectManager = await sails.helpers.users.isProjectManager(
@@ -42,7 +42,9 @@ module.exports = {
 
     boardMembership = await sails.helpers.boardMemberships.deleteOne.with({
       project,
+      board,
       record: boardMembership,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/board-memberships/update.js b/server/api/controllers/board-memberships/update.js
@@ -35,7 +35,7 @@ module.exports = {
       .intercept('pathNotFound', () => Errors.BOARD_MEMBERSHIP_NOT_FOUND);
 
     let { boardMembership } = path;
-    const { project } = path;
+    const { board, project } = path;
 
     const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
@@ -47,7 +47,10 @@ module.exports = {
 
     boardMembership = await sails.helpers.boardMemberships.updateOne.with({
       values,
+      project,
+      board,
       record: boardMembership,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/boards/create.js b/server/api/controllers/boards/create.js
@@ -103,7 +103,7 @@ module.exports = {
         project,
       },
       import: boardImport,
-      user: currentUser,
+      actorUser: currentUser,
       requestId: inputs.requestId,
       request: this.req,
     });

diff --git a/server/api/controllers/boards/delete.js b/server/api/controllers/boards/delete.js
@@ -22,25 +22,27 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    let { board } = await sails.helpers.boards
+    const path = await sails.helpers.boards
       .getProjectPath(inputs.id)
       .intercept('pathNotFound', () => Errors.BOARD_NOT_FOUND);
 
+    let { board } = path;
+    const { project } = path;
+
     if (!board) {
       throw Errors.BOARD_NOT_FOUND;
     }
 
-    const isProjectManager = await sails.helpers.users.isProjectManager(
-      currentUser.id,
-      board.projectId,
-    );
+    const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
     if (!isProjectManager) {
       throw Errors.BOARD_NOT_FOUND; // Forbidden
     }
 
     board = await sails.helpers.boards.deleteOne.with({
+      project,
       record: board,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/boards/update.js b/server/api/controllers/boards/update.js
@@ -29,18 +29,18 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    let { board } = await sails.helpers.boards
+    const path = await sails.helpers.boards
       .getProjectPath(inputs.id)
       .intercept('pathNotFound', () => Errors.BOARD_NOT_FOUND);
 
+    let { board } = path;
+    const { project } = path;
+
     if (!board) {
       throw Errors.BOARD_NOT_FOUND;
     }
 
-    const isProjectManager = await sails.helpers.users.isProjectManager(
-      currentUser.id,
-      board.projectId,
-    );
+    const isProjectManager = await sails.helpers.users.isProjectManager(currentUser.id, project.id);
 
     if (!isProjectManager) {
       throw Errors.BOARD_NOT_FOUND; // Forbidden
@@ -50,7 +50,9 @@ module.exports = {
 
     board = await sails.helpers.boards.updateOne.with({
       values,
+      project,
       record: board,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/card-labels/create.js b/server/api/controllers/card-labels/create.js
@@ -45,12 +45,12 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { card } = await sails.helpers.cards
+    const { card, list, board, project } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
     const boardMembership = await BoardMembership.findOne({
-      boardId: card.boardId,
+      boardId: board.id,
       userId: currentUser.id,
     });
 
@@ -64,7 +64,7 @@ module.exports = {
 
     const label = await Label.findOne({
       id: inputs.labelId,
-      boardId: card.boardId,
+      boardId: board.id,
     });
 
     if (!label) {
@@ -73,10 +73,14 @@ module.exports = {
 
     const cardLabel = await sails.helpers.cardLabels.createOne
       .with({
+        project,
+        board,
+        list,
         values: {
           card,
           label,
         },
+        actorUser: currentUser,
         request: this.req,
       })
       .intercept('labelAlreadyInCard', () => Errors.LABEL_ALREADY_IN_CARD);

diff --git a/server/api/controllers/card-labels/delete.js b/server/api/controllers/card-labels/delete.js
@@ -39,7 +39,7 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { board } = await sails.helpers.cards
+    const { card, list, board, project } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -66,8 +66,12 @@ module.exports = {
     }
 
     cardLabel = await sails.helpers.cardLabels.deleteOne.with({
+      project,
       board,
+      list,
+      card,
       record: cardLabel,
+      actorUser: currentUser,
       request: this.req,
     });
 

diff --git a/server/api/controllers/card-memberships/create.js b/server/api/controllers/card-memberships/create.js
@@ -45,12 +45,12 @@ module.exports = {
   async fn(inputs) {
     const { currentUser } = this.req;
 
-    const { card, board } = await sails.helpers.cards
+    const { card, list, board, project } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
     const boardMembership = await BoardMembership.findOne({
-      boardId: card.boardId,
+      boardId: board.id,
       userId: currentUser.id,
     });
 
@@ -62,19 +62,22 @@ module.exports = {
       throw Errors.NOT_ENOUGH_RIGHTS;
     }
 
-    const isBoardMember = await sails.helpers.users.isBoardMember(inputs.userId, card.boardId);
+    const isBoardMember = await sails.helpers.users.isBoardMember(inputs.userId, board.id);
 
     if (!isBoardMember) {
       throw Errors.USER_NOT_FOUND;
     }
 
     const cardMembership = await sails.helpers.cardMemberships.createOne
       .with({
+        project,
+        board,
+        list,
         values: {
           card,
           userId: inputs.userId,
         },
-        board,
+        actorUser: currentUser,
         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, card } = await sails.helpers.cards
+    const { card, list, board, project } = await sails.helpers.cards
       .getProjectPath(inputs.cardId)
       .intercept('pathNotFound', () => Errors.CARD_NOT_FOUND);
 
@@ -66,9 +66,12 @@ module.exports = {
     }
 
     cardMembership = await sails.helpers.cardMemberships.deleteOne.with({
+      project,
       board,
+      list,
       card,
       record: cardMembership,
+      actorUser: currentUser,
       request: this.req,
     });