feat: Move webhooks configuration from environment variable to UI

server/api/controllers/webhooks/create.js

@@ -0,0 +1,76 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+const { isUrl } = require('../../../utils/validators');
+
+const Errors = {
+  LIMIT_REACHED: {
+    limitReached: 'Limit reached',
+  },
+};
+
+module.exports = {
+  inputs: {
+    name: {
+      type: 'string',
+      maxLength: 128,
+      required: true,
+    },
+    url: {
+      type: 'string',
+      maxLength: 2048,
+      custom: isUrl,
+      required: true,
+    },
+    accessToken: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 512,
+      allowNull: true,
+    },
+    events: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 2048,
+      allowNull: true,
+    },
+    excludedEvents: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 2048,
+      allowNull: true,
+    },
+  },
+
+  exits: {
+    limitReached: {
+      responseType: 'conflict',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const values = _.pick(inputs, ['name', 'url', 'accessToken']);
+    const events = inputs.events && inputs.events.split(',');
+    const excludedEvents = inputs.excludedEvents && inputs.excludedEvents.split(',');
+
+    const webhook = await sails.helpers.webhooks.createOne
+      .with({
+        values: {
+          ...values,
+          events,
+          excludedEvents,
+        },
+        actorUser: currentUser,
+        request: this.req,
+      })
+      .intercept('limitReached', () => Errors.LIMIT_REACHED);
+
+    return {
+      item: webhook,
+    };
+  },
+};

server/api/controllers/webhooks/delete.js

@@ -0,0 +1,51 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+const { idInput } = require('../../../utils/inputs');
+
+const Errors = {
+  WEBHOOK_NOT_FOUND: {
+    webhookNotFound: 'Webhook not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    id: {
+      ...idInput,
+      required: true,
+    },
+  },
+
+  exits: {
+    webhookNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    let webhook = await Webhook.qm.getOneById(inputs.id);
+
+    if (!webhook) {
+      throw Errors.WEBHOOK_NOT_FOUND;
+    }
+
+    webhook = await sails.helpers.webhooks.deleteOne.with({
+      record: webhook,
+      actorUser: currentUser,
+      request: this.req,
+    });
+
+    if (!webhook) {
+      throw Errors.WEBHOOK_NOT_FOUND;
+    }
+
+    return {
+      item: webhook,
+    };
+  },
+};

server/api/controllers/webhooks/index.js

@@ -0,0 +1,14 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+module.exports = {
+  async fn() {
+    const webhooks = await Webhook.qm.getAll();
+
+    return {
+      items: webhooks,
+    };
+  },
+};

server/api/controllers/webhooks/update.js

@@ -0,0 +1,89 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+const { isUrl } = require('../../../utils/validators');
+const { idInput } = require('../../../utils/inputs');
+
+const Errors = {
+  WEBHOOK_NOT_FOUND: {
+    webhookNotFound: 'Webhook not found',
+  },
+};
+
+module.exports = {
+  inputs: {
+    id: {
+      ...idInput,
+      required: true,
+    },
+    name: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 128,
+    },
+    url: {
+      type: 'string',
+      maxLength: 2048,
+      custom: isUrl,
+    },
+    accessToken: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 512,
+      allowNull: true,
+    },
+    events: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 2048,
+      allowNull: true,
+    },
+    excludedEvents: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 2048,
+      allowNull: true,
+    },
+  },
+
+  exits: {
+    webhookNotFound: {
+      responseType: 'notFound',
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    let webhook = await Webhook.qm.getOneById(inputs.id);
+
+    if (!webhook) {
+      throw Errors.WEBHOOK_NOT_FOUND;
+    }
+
+    const values = _.pick(inputs, ['name', 'url', 'accessToken']);
+    const events = inputs.events && inputs.events.split(',');
+    const excludedEvents = inputs.excludedEvents && inputs.excludedEvents.split(',');
+
+    webhook = await sails.helpers.webhooks.updateOne.with({
+      record: webhook,
+      values: {
+        ...values,
+        events,
+        excludedEvents,
+      },
+      actorUser: currentUser,
+      request: this.req,
+    });
+
+    if (!webhook) {
+      throw Errors.WEBHOOK_NOT_FOUND;
+    }
+
+    return {
+      item: webhook,
+    };
+  },
+};