Automations feature backend (#43)

Co-authored-by: Mário Balça <mario.balca@gmail.com>

Author: themarolt

backend/package-lock.json

@@ -20,6 +20,8 @@
     "db:publish": "bash ./util/publish-db.sh",
     "docs": "bash ./util/publish-docs.sh",
     "sequelize-cli:source": "npm run build:setenv:dev && npm run build && ./node_modules/.bin/sequelize --config src/database/sequelize-cli-config.ts --migrations-source-path src/database/migrations",
+    "sequelize:migrate:staging": "npm run build:setenv:staging && npm run build && ./node_modules/.bin/sequelize --config src/database/sequelize-cli-config.ts --migrations-source-path src/database/migrations db:migrate",
+    "sequelize:migrate:prod": "npm run build:setenv:prod && npm run build && ./node_modules/.bin/sequelize --config src/database/sequelize-cli-config.ts --migrations-source-path src/database/migrations db:migrate",
     "sequelize-cli:build": "./node_modules/.bin/sequelize --config database/sequelize-cli-config.js --migrations-compiled-path database/migrations",
     "stripe:login": "stripe login",
     "stripe:start": "stripe listen --forward-to localhost:8080/api/plan/stripe/webhook",
@@ -69,6 +71,7 @@
     "sequelize": "6.21.2",
     "sequelize-cli-typescript": "^3.2.0-c",
     "stripe": "10.0.0",
+    "superagent": "^8.0.0",
     "swagger-ui-dist": "4.1.3",
     "uuid": "^8.3.2",
     "validator": "^13.7.0"
@@ -81,6 +84,7 @@
     "@types/jest": "^27.4.0",
     "@types/node": "^17.0.21",
     "@types/sanitize-html": "^2.6.2",
+    "@types/superagent": "^4.1.15",
     "@typescript-eslint/eslint-plugin": "^5.17.0",
     "@typescript-eslint/parser": "^5.17.0",
     "copyfiles": "2.4.1",
@@ -97,7 +101,6 @@
     "nodemon": "2.0.4",
     "prettier": "^2.5.1",
     "rdme": "^7.2.0",
-    "superagent": "^7.1.2",
     "supertest": "^6.2.2",
     "ts-jest": "^27.1.3",
     "ts-node": "10.6.0",

backend/package.json

@@ -0,0 +1,32 @@
+import PermissionChecker from '../../services/user/permissionChecker'
+import Permissions from '../../security/permissions'
+import AutomationService from '../../services/automationService'
+import track from '../../segment/track'
+import ApiResponseHandler from '../apiResponseHandler'
+
+/**
+ * POST /tenant/{tenantId}/automation
+ * @summary Create an automation
+ * @tag Automations
+ * @security Bearer
+ * @description Create a new automation for the tenant.
+ * @pathParam {string} tenantId - Your workspace/tenant ID
+ * @bodyContent {AutomationCreateInput} application/json
+ * @response 200 - Ok
+ * @responseContent {Automation} 200.application/json
+ * @responseExample {Automation} 200.application/json.Automation
+ * @response 401 - Unauthorized
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  try {
+    new PermissionChecker(req).validateHas(Permissions.values.automationCreate)
+    const payload = await new AutomationService(req).create(req.body.data)
+
+    track('Automation Created', { ...payload }, { ...req })
+
+    await ApiResponseHandler.success(req, res, payload)
+  } catch (error) {
+    await ApiResponseHandler.error(req, res, error)
+  }
+}

backend/src/api/automation/automationCreate.ts

@@ -0,0 +1,30 @@
+import PermissionChecker from '../../services/user/permissionChecker'
+import Permissions from '../../security/permissions'
+import AutomationService from '../../services/automationService'
+import track from '../../segment/track'
+import ApiResponseHandler from '../apiResponseHandler'
+
+/**
+ * DELETE /tenant/{tenantId}/automation/{automationId}
+ * @summary Destroys an existing automation
+ * @tag Automations
+ * @security Bearer
+ * @description Destroys an existing automation in the tenant.
+ * @pathParam {string} tenantId - Your workspace/tenant ID
+ * @pathParam {string} automationId - Automation ID that you want to update
+ * @response 204 - Ok - No content
+ * @response 401 - Unauthorized
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  try {
+    new PermissionChecker(req).validateHas(Permissions.values.automationDestroy)
+    await new AutomationService(req).destroy(req.params.automationId)
+
+    track('Automation Destroyed', { id: req.params.automationId }, { ...req })
+
+    await ApiResponseHandler.success(req, res, true, 204)
+  } catch (error) {
+    await ApiResponseHandler.error(req, res, error)
+  }
+}

backend/src/api/automation/automationDestroy.ts

@@ -0,0 +1,45 @@
+import PermissionChecker from '../../services/user/permissionChecker'
+import Permissions from '../../security/permissions'
+import ApiResponseHandler from '../apiResponseHandler'
+import AutomationExecutionService from '../../services/automationExecutionService'
+
+/**
+ * GET /tenant/{tenantId}/automation/{automationId}/executions
+ * @summary Get all automation execution history for tenant and automation
+ * @tag Automations
+ * @security Bearer
+ * @description Get all automation execution history for tenant and automation
+ * @pathParam {string} tenantId - Your workspace/tenant ID
+ * @pathParam {string} automationId - Your workspace/tenant ID
+ * @queryParam {integer} [offset=0] - How many elements from the beginning would you like to skip
+ * @queryParam {integer} [limit=10] - How many elements would you like to fetch
+ * @response 200 - Ok
+ * @responseContent {AutomationExecutionPage} 200.application/json
+ * @responseExample {AutomationExecutionPage} 200.application/json.AutomationExecutionPage
+ * @response 401 - Unauthorized
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  try {
+    new PermissionChecker(req).validateHas(Permissions.values.automationRead)
+
+    let offset = 0
+    if (req.query.offset) {
+      offset = parseInt(req.query.offset, 10)
+    }
+    let limit = 10
+    if (req.query.limit) {
+      limit = parseInt(req.query.limit, 10)
+    }
+
+    const payload = await new AutomationExecutionService(req).findAndCountAll({
+      automationId: req.params.automationId,
+      offset,
+      limit,
+    })
+
+    await ApiResponseHandler.success(req, res, payload)
+  } catch (error) {
+    await ApiResponseHandler.error(req, res, error)
+  }
+}

backend/src/api/automation/automationExecutionFind.ts

@@ -0,0 +1,29 @@
+import PermissionChecker from '../../services/user/permissionChecker'
+import Permissions from '../../security/permissions'
+import AutomationService from '../../services/automationService'
+import ApiResponseHandler from '../apiResponseHandler'
+
+/**
+ * GET /tenant/{tenantId}/automation/{automationId}
+ * @summary Get an existing automation data
+ * @tag Automations
+ * @security Bearer
+ * @description Get an existing automation data in the tenant.
+ * @pathParam {string} tenantId - Your workspace/tenant ID
+ * @pathParam {string} automationId - Automation ID that you want to find
+ * @response 200 - Ok
+ * @responseContent {Automation} 200.application/json
+ * @responseExample {Automation} 200.application/json.Automation
+ * @response 401 - Unauthorized
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  try {
+    new PermissionChecker(req).validateHas(Permissions.values.automationRead)
+    const payload = await new AutomationService(req).findById(req.params.automationId)
+
+    await ApiResponseHandler.success(req, res, payload)
+  } catch (error) {
+    await ApiResponseHandler.error(req, res, error)
+  }
+}

backend/src/api/automation/automationFind.ts

@@ -0,0 +1,59 @@
+import PermissionChecker from '../../services/user/permissionChecker'
+import Permissions from '../../security/permissions'
+import AutomationService from '../../services/automationService'
+import ApiResponseHandler from '../apiResponseHandler'
+import {
+  AutomationCriteria,
+  AutomationState,
+  AutomationTrigger,
+  AutomationType,
+} from '../../types/automationTypes'
+
+/**
+ * GET /tenant/{tenantId}/automation
+ * @summary Get all automation data for tenant
+ * @tag Automations
+ * @security Bearer
+ * @description Get all existing automation data for tenant.
+ * @pathParam {string} tenantId - Your workspace/tenant ID
+ * @queryParam {string} [filter[type]] - Filter by type of automation
+ * @queryParam {string} [filter[trigger]] - Filter by trigger type of automation
+ * @queryParam {string} [filter[state]] - Filter by state of automation
+ * @queryParam {number} [offset] - Skip the first n results. Default 0.
+ * @queryParam {number} [limit] - Limit the number of results. Default 50.
+ * @response 200 - Ok
+ * @responseContent {AutomationPage} 200.application/json
+ * @responseExample {AutomationPage} 200.application/json.AutomationPage
+ * @response 401 - Unauthorized
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  try {
+    new PermissionChecker(req).validateHas(Permissions.values.automationRead)
+
+    let offset = 0
+    if (req.query.offset) {
+      offset = parseInt(req.query.offset, 10)
+    }
+    let limit = 50
+    if (req.query.limit) {
+      limit = parseInt(req.query.limit, 10)
+    }
+
+    const criteria: AutomationCriteria = {
+      type: req.query.filter?.type ? (req.query.filter.type as AutomationType) : undefined,
+      trigger: req.query.filter?.trigger
+        ? (req.query.filter?.trigger as AutomationTrigger)
+        : undefined,
+      state: req.query.filter?.state ? (req.query.filter.state as AutomationState) : undefined,
+      limit,
+      offset,
+    }
+
+    const payload = await new AutomationService(req).findAndCountAll(criteria)
+
+    await ApiResponseHandler.success(req, res, payload)
+  } catch (error) {
+    await ApiResponseHandler.error(req, res, error)
+  }
+}

backend/src/api/automation/automationList.ts

@@ -0,0 +1,33 @@
+import PermissionChecker from '../../services/user/permissionChecker'
+import Permissions from '../../security/permissions'
+import AutomationService from '../../services/automationService'
+import track from '../../segment/track'
+import ApiResponseHandler from '../apiResponseHandler'
+
+/**
+ * PUT /tenant/{tenantId}/automation/{automationId}
+ * @summary Update an existing automation
+ * @tag Automations
+ * @security Bearer
+ * @description Updates an existing automation in the tenant.
+ * @pathParam {string} tenantId - Your workspace/tenant ID
+ * @pathParam {string} automationId - Automation ID that you want to update
+ * @bodyContent {AutomationUpdateInput} application/json
+ * @response 200 - Ok
+ * @responseContent {Automation} 200.application/json
+ * @responseExample {Automation} 200.application/json.Automation
+ * @response 401 - Unauthorized
+ * @response 429 - Too many requests
+ */
+export default async (req, res) => {
+  try {
+    new PermissionChecker(req).validateHas(Permissions.values.automationUpdate)
+    const payload = await new AutomationService(req).update(req.params.automationId, req.body.data)
+
+    track('Automation Updated', { ...payload }, { ...req })
+
+    await ApiResponseHandler.success(req, res, payload)
+  } catch (error) {
+    await ApiResponseHandler.error(req, res, error)
+  }
+}

backend/src/api/automation/automationUpdate.ts

@@ -0,0 +1,11 @@
+export default (app) => {
+  app.post('/tenant/:tenantId/automation', require('./automationCreate').default)
+  app.put('/tenant/:tenantId/automation/:automationId', require('./automationUpdate').default)
+  app.delete('/tenant/:tenantId/automation/:automationId', require('./automationDestroy').default)
+  app.get(
+    '/tenant/:tenantId/automation/:automationId/executions',
+    require('./automationExecutionFind').default,
+  )
+  app.get('/tenant/:tenantId/automation/:automationId', require('./automationFind').default)
+  app.get('/tenant/:tenantId/automation', require('./automationList').default)
+}

backend/src/api/automation/index.ts

@@ -225,3 +225,76 @@ components:
 
       xml:
         name: Conversation
+
+    # defines automation type enum
+    AutomationType:
+      description: Automation type
+      type: string
+      enum: ['webhook']
+
+    # defines automation state enum
+    AutomationState:
+      description: Automation state
+      type: string
+      enum: ['active', 'disabled']
+
+    # defines automation triggers
+    AutomationTrigger:
+      description: What will trigger an automation
+      type: string
+      enum: ['new_activity', 'new_member']
+
+    # defines automation execution state
+    AutomationExecutionState:
+      description: What was the state of the automation execution
+      type: string
+      enum: ['success', 'error']
+
+    # defines webhook automation settings
+    WebhookAutomationSettings:
+      description: Settings used by automation with type webhook
+      type: object
+      required:
+        - url
+      properties:
+        url:
+          description: URL to POST webhook data to
+          type: string
+          format: uri
+
+    # defines new activity triggered automation settings
+    NewActivityAutomationSettings:
+      description: Settings used by automation that is triggered by new activities
+      type: object
+      required:
+        - types
+        - platforms
+        - keywords
+        - teamMemberActivities
+      properties:
+        types:
+          description: 'If activity type matches any of these we should trigger this automation'
+          type: array
+          items:
+            type: string
+        platforms:
+          description: 'If activity came from any of these platforms we should trigger this automation'
+          type: array
+          items:
+            type: string
+        keywords:
+          description: 'If activity content contains any of these keywords we should trigger this automation'
+          type: array
+          items:
+            type: string
+        teamMemberActivities:
+          description: 'If activity came from any of our team members - should we trigger automation or not?'
+          type: boolean
+
+    # defines automation settings object
+    AutomationSettings:
+      description: Settings based on automation type and trigger - you need to provide union object of both automation type based settings and trigger based settings
+      type: object
+      anyOf:
+        - $ref: '#/components/schemas/WebhookAutomationSettings'
+        - $ref: '#/components/schemas/NewActivityAutomationSettings'