@budibase/server 0.9.125-alpha.4 → 0.9.125-alpha.5

package/src/automations/triggerInfo/rowUpdated.js

@@ -0,0 +1,40 @@
+exports.definition = {
+  name: "Row Updated",
+  event: "row:update",
+  icon: "ri-refresh-line",
+  tagline: "Row is updated in {{inputs.enriched.table.name}}",
+  description: "Fired when a row is updated in your database",
+  stepId: "ROW_UPDATED",
+  inputs: {},
+  schema: {
+    inputs: {
+      properties: {
+        tableId: {
+          type: "string",
+          customType: "table",
+          title: "Table",
+        },
+      },
+      required: ["tableId"],
+    },
+    outputs: {
+      properties: {
+        row: {
+          type: "object",
+          customType: "row",
+          description: "The row that was updated",
+        },
+        id: {
+          type: "string",
+          description: "Row ID - can be used for updating",
+        },
+        revision: {
+          type: "string",
+          description: "Revision of row",
+        },
+      },
+      required: ["row", "id"],
+    },
+  },
+  type: "TRIGGER",
+}

package/src/automations/triggerInfo/webhook.js

@@ -0,0 +1,36 @@
+exports.definition = {
+  name: "Webhook",
+  event: "web:trigger",
+  icon: "ri-global-line",
+  tagline: "Webhook endpoint is hit",
+  description: "Trigger an automation when a HTTP POST webhook is hit",
+  stepId: "WEBHOOK",
+  inputs: {},
+  schema: {
+    inputs: {
+      properties: {
+        schemaUrl: {
+          type: "string",
+          customType: "webhookUrl",
+          title: "Schema URL",
+        },
+        triggerUrl: {
+          type: "string",
+          customType: "webhookUrl",
+          title: "Trigger URL",
+        },
+      },
+      required: ["schemaUrl", "triggerUrl"],
+    },
+    outputs: {
+      properties: {
+        body: {
+          type: "object",
+          description: "Body of the request which hit the webhook",
+        },
+      },
+      required: ["body"],
+    },
+  },
+  type: "TRIGGER",
+}

package/src/automations/triggers.js

@@ -1,244 +1,22 @@
 const CouchDB = require("../db")
 const emitter = require("../events/index")
-const env = require("../environment")
-const Queue = env.isTest()
-  ? require("../utilities/queue/inMemoryQueue")
-  : require("bull")
 const { getAutomationParams } = require("../db/utils")
 const { coerce } = require("../utilities/rowProcessor")
-const { utils } = require("@budibase/auth/redis")
-const { JobQueues } = require("../constants")
-const {
-  isExternalTable,
-  breakExternalTableId,
-} = require("../integrations/utils")
-const { getExternalTable } = require("../api/controllers/table/utils")
-
-const { opts } = utils.getRedisOptions()
-let automationQueue = new Queue(JobQueues.AUTOMATIONS, { redis: opts })
-
-const FAKE_STRING = "TEST"
-const FAKE_BOOL = false
-const FAKE_NUMBER = 1
-const FAKE_DATETIME = "1970-01-01T00:00:00.000Z"
+const { definitions } = require("./triggerInfo")
+const { isDevAppID } = require("../db/utils")
+// need this to call directly, so we can get a response
+const { queue } = require("./bullboard")
+const { checkTestFlag } = require("../utilities/redis")
+const utils = require("./utils")
+const env = require("../environment")
 
-const BUILTIN_DEFINITIONS = {
-  ROW_SAVED: {
-    name: "Row Created",
-    event: "row:save",
-    icon: "ri-save-line",
-    tagline: "Row is added to {{inputs.enriched.table.name}}",
-    description: "Fired when a row is added to your database",
-    stepId: "ROW_SAVED",
-    inputs: {},
-    schema: {
-      inputs: {
-        properties: {
-          tableId: {
-            type: "string",
-            customType: "table",
-            title: "Table",
-          },
-        },
-        required: ["tableId"],
-      },
-      outputs: {
-        properties: {
-          row: {
-            type: "object",
-            customType: "row",
-            description: "The new row that was created",
-          },
-          id: {
-            type: "string",
-            description: "Row ID - can be used for updating",
-          },
-          revision: {
-            type: "string",
-            description: "Revision of row",
-          },
-        },
-        required: ["row", "id"],
-      },
-    },
-    type: "TRIGGER",
-  },
-  ROW_UPDATED: {
-    name: "Row Updated",
-    event: "row:update",
-    icon: "ri-refresh-line",
-    tagline: "Row is updated in {{inputs.enriched.table.name}}",
-    description: "Fired when a row is updated in your database",
-    stepId: "ROW_UPDATED",
-    inputs: {},
-    schema: {
-      inputs: {
-        properties: {
-          tableId: {
-            type: "string",
-            customType: "table",
-            title: "Table",
-          },
-        },
-        required: ["tableId"],
-      },
-      outputs: {
-        properties: {
-          row: {
-            type: "object",
-            customType: "row",
-            description: "The row that was updated",
-          },
-          id: {
-            type: "string",
-            description: "Row ID - can be used for updating",
-          },
-          revision: {
-            type: "string",
-            description: "Revision of row",
-          },
-        },
-        required: ["row", "id"],
-      },
-    },
-    type: "TRIGGER",
-  },
-  ROW_DELETED: {
-    name: "Row Deleted",
-    event: "row:delete",
-    icon: "ri-delete-bin-line",
-    tagline: "Row is deleted from {{inputs.enriched.table.name}}",
-    description: "Fired when a row is deleted from your database",
-    stepId: "ROW_DELETED",
-    inputs: {},
-    schema: {
-      inputs: {
-        properties: {
-          tableId: {
-            type: "string",
-            customType: "table",
-            title: "Table",
-          },
-        },
-        required: ["tableId"],
-      },
-      outputs: {
-        properties: {
-          row: {
-            type: "object",
-            customType: "row",
-            description: "The row that was deleted",
-          },
-        },
-        required: ["row"],
-      },
-    },
-    type: "TRIGGER",
-  },
-  WEBHOOK: {
-    name: "Webhook",
-    event: "web:trigger",
-    icon: "ri-global-line",
-    tagline: "Webhook endpoint is hit",
-    description: "Trigger an automation when a HTTP POST webhook is hit",
-    stepId: "WEBHOOK",
-    inputs: {},
-    schema: {
-      inputs: {
-        properties: {
-          schemaUrl: {
-            type: "string",
-            customType: "webhookUrl",
-            title: "Schema URL",
-          },
-          triggerUrl: {
-            type: "string",
-            customType: "webhookUrl",
-            title: "Trigger URL",
-          },
-        },
-        required: ["schemaUrl", "triggerUrl"],
-      },
-      outputs: {
-        properties: {
-          body: {
-            type: "object",
-            description: "Body of the request which hit the webhook",
-          },
-        },
-        required: ["body"],
-      },
-    },
-    type: "TRIGGER",
-  },
-  APP: {
-    name: "App Action",
-    event: "app:trigger",
-    icon: "ri-window-fill",
-    tagline: "Automation fired from the frontend",
-    description: "Trigger an automation from an action inside your app",
-    stepId: "APP",
-    inputs: {},
-    schema: {
-      inputs: {
-        properties: {
-          fields: {
-            type: "object",
-            customType: "triggerSchema",
-            title: "Fields",
-          },
-        },
-        required: [],
-      },
-      outputs: {
-        properties: {
-          fields: {
-            type: "object",
-            description: "Fields submitted from the app frontend",
-          },
-        },
-        required: ["fields"],
-      },
-    },
-    type: "TRIGGER",
-  },
-  CRON: {
-    name: "Cron Trigger",
-    event: "cron:trigger",
-    icon: "ri-timer-line",
-    tagline: "Cron Trigger (<b>{{inputs.cron}}</b>)",
-    description: "Triggers automation on a cron schedule.",
-    stepId: "CRON",
-    inputs: {},
-    schema: {
-      inputs: {
-        properties: {
-          cron: {
-            type: "string",
-            customType: "cron",
-            title: "Expression",
-          },
-        },
-        required: ["cron"],
-      },
-      outputs: {
-        properties: {
-          timestamp: {
-            type: "number",
-            description: "Timestamp the cron was executed",
-          },
-        },
-        required: ["timestamp"],
-      },
-    },
-    type: "TRIGGER",
-  },
-}
+const TRIGGER_DEFINITIONS = definitions
 
 async function queueRelevantRowAutomations(event, eventType) {
   if (event.appId == null) {
     throw `No appId specified for ${eventType} - check event emitters.`
   }
+
   const db = new CouchDB(event.appId)
   let automations = await db.allDocs(
     getAutomationParams(null, { include_docs: true })
@@ -255,14 +33,22 @@ async function queueRelevantRowAutomations(event, eventType) {
   for (let automation of automations) {
     let automationDef = automation.definition
     let automationTrigger = automationDef ? automationDef.trigger : {}
+    // don't queue events which are for dev apps, only way to test automations is
+    // running tests on them, in production the test flag will never
+    // be checked due to lazy evaluation (first always false)
     if (
-      !automation.live ||
-      !automationTrigger.inputs ||
-      automationTrigger.inputs.tableId !== event.row.tableId
+      !env.ALLOW_DEV_AUTOMATIONS &&
+      isDevAppID(event.appId) &&
+      !(await checkTestFlag(automation._id))
     ) {
       continue
     }
-    automationQueue.add({ automation, event })
+    if (
+      automationTrigger.inputs &&
+      automationTrigger.inputs.tableId === event.row.tableId
+    ) {
+      await queue.add({ automation, event })
+    }
   }
 }
 
@@ -290,51 +76,12 @@ emitter.on("row:delete", async function (event) {
   await queueRelevantRowAutomations(event, "row:delete")
 })
 
-async function fillRowOutput(automation, params) {
-  let triggerSchema = automation.definition.trigger
-  let tableId = triggerSchema.inputs.tableId
-  try {
-    let table
-    if (!isExternalTable(tableId)) {
-      const db = new CouchDB(params.appId)
-      table = await db.get(tableId)
-    } else {
-      const { datasourceId, tableName } = breakExternalTableId(tableId)
-      table = await getExternalTable(params.appId, datasourceId, tableName)
-    }
-    let row = {}
-    for (let schemaKey of Object.keys(table.schema)) {
-      const paramValue = params[schemaKey]
-      let propSchema = table.schema[schemaKey]
-      switch (propSchema.constraints.type) {
-        case "string":
-          row[schemaKey] = paramValue || FAKE_STRING
-          break
-        case "boolean":
-          row[schemaKey] = paramValue || FAKE_BOOL
-          break
-        case "number":
-          row[schemaKey] = paramValue || FAKE_NUMBER
-          break
-        case "datetime":
-          row[schemaKey] = paramValue || FAKE_DATETIME
-          break
-      }
-    }
-    params.row = row
-  } catch (err) {
-    /* istanbul ignore next */
-    throw "Failed to find table for trigger"
-  }
-  return params
-}
-
-module.exports.externalTrigger = async function (automation, params) {
-  // TODO: replace this with allowing user in builder to input values in future
+exports.externalTrigger = async function (
+  automation,
+  params,
+  { getResponses } = {}
+) {
   if (automation.definition != null && automation.definition.trigger != null) {
-    if (automation.definition.trigger.inputs.tableId != null) {
-      params = await fillRowOutput(automation, params)
-    }
     if (automation.definition.trigger.stepId === "APP") {
       // values are likely to be submitted as strings, so we shall convert to correct type
       const coercedFields = {}
@@ -345,14 +92,12 @@ module.exports.externalTrigger = async function (automation, params) {
       params.fields = coercedFields
     }
   }
-
-  automationQueue.add({ automation, event: params })
-}
-
-module.exports.getQueues = () => {
-  return [automationQueue]
+  const data = { automation, event: params }
+  if (getResponses) {
+    return utils.processEvent({ data })
+  } else {
+    return queue.add(data)
+  }
 }
-module.exports.fillRowOutput = fillRowOutput
-module.exports.automationQueue = automationQueue
 
-module.exports.BUILTIN_DEFINITIONS = BUILTIN_DEFINITIONS
+exports.TRIGGER_DEFINITIONS = TRIGGER_DEFINITIONS

package/src/automations/utils.js

@@ -0,0 +1,159 @@
+const runner = require("./thread")
+const { definitions } = require("./triggerInfo")
+const webhooks = require("../api/controllers/webhook")
+const CouchDB = require("../db")
+const { queue } = require("./bullboard")
+const newid = require("../db/newid")
+const { updateEntityMetadata } = require("../utilities")
+const { MetadataTypes } = require("../constants")
+
+const WH_STEP_ID = definitions.WEBHOOK.stepId
+const CRON_STEP_ID = definitions.CRON.stepId
+
+exports.processEvent = async job => {
+  try {
+    // need to actually await these so that an error can be captured properly
+    return await runner(job)
+  } catch (err) {
+    console.error(
+      `${job.data.automation.appId} automation ${job.data.automation._id} was unable to run - ${err}`
+    )
+    return { err }
+  }
+}
+
+exports.updateTestHistory = async (appId, automation, history) => {
+  return updateEntityMetadata(
+    appId,
+    MetadataTypes.AUTOMATION_TEST_HISTORY,
+    automation._id,
+    metadata => {
+      if (metadata && Array.isArray(metadata.history)) {
+        metadata.history.push(history)
+      } else {
+        metadata = {
+          history: [history],
+        }
+      }
+      return metadata
+    }
+  )
+}
+
+// end the repetition and the job itself
+exports.disableAllCrons = async appId => {
+  const promises = []
+  const jobs = await queue.getRepeatableJobs()
+  for (let job of jobs) {
+    if (job.key.includes(`${appId}_cron`)) {
+      promises.push(queue.removeRepeatableByKey(job.key))
+      promises.push(queue.removeJobs(job.id))
+    }
+  }
+  return Promise.all(promises)
+}
+
+/**
+ * This function handles checking of any cron jobs that need to be enabled/updated.
+ * @param {string} appId The ID of the app in which we are checking for webhooks
+ * @param {object|undefined} automation The automation object to be updated.
+ */
+exports.enableCronTrigger = async (appId, automation) => {
+  const trigger = automation ? automation.definition.trigger : null
+  function isCronTrigger(auto) {
+    return (
+      auto &&
+      auto.definition.trigger &&
+      auto.definition.trigger.stepId === CRON_STEP_ID
+    )
+  }
+  // need to create cron job
+  if (isCronTrigger(automation)) {
+    // make a job id rather than letting Bull decide, makes it easier to handle on way out
+    const jobId = `${appId}_cron_${newid()}`
+    const job = await queue.add(
+      {
+        automation,
+        event: { appId, timestamp: Date.now() },
+      },
+      { repeat: { cron: trigger.inputs.cron }, jobId }
+    )
+    // Assign cron job ID from bull so we can remove it later if the cron trigger is removed
+    trigger.cronJobId = job.id
+    const db = new CouchDB(appId)
+    const response = await db.put(automation)
+    automation._id = response.id
+    automation._rev = response.rev
+  }
+  return automation
+}
+
+/**
+ * This function handles checking if any webhooks need to be created or deleted for automations.
+ * @param {string} appId The ID of the app in which we are checking for webhooks
+ * @param {object|undefined} oldAuto The old automation object if updating/deleting
+ * @param {object|undefined} newAuto The new automation object if creating/updating
+ * @returns {Promise<object|undefined>} After this is complete the new automation object may have been updated and should be
+ * written to DB (this does not write to DB as it would be wasteful to repeat).
+ */
+exports.checkForWebhooks = async ({ appId, oldAuto, newAuto }) => {
+  const oldTrigger = oldAuto ? oldAuto.definition.trigger : null
+  const newTrigger = newAuto ? newAuto.definition.trigger : null
+  const triggerChanged =
+    oldTrigger && newTrigger && oldTrigger.id !== newTrigger.id
+  function isWebhookTrigger(auto) {
+    return (
+      auto &&
+      auto.definition.trigger &&
+      auto.definition.trigger.stepId === WH_STEP_ID
+    )
+  }
+  // need to delete webhook
+  if (
+    isWebhookTrigger(oldAuto) &&
+    (!isWebhookTrigger(newAuto) || triggerChanged) &&
+    oldTrigger.webhookId
+  ) {
+    try {
+      let db = new CouchDB(appId)
+      // need to get the webhook to get the rev
+      const webhook = await db.get(oldTrigger.webhookId)
+      const ctx = {
+        appId,
+        params: { id: webhook._id, rev: webhook._rev },
+      }
+      // might be updating - reset the inputs to remove the URLs
+      if (newTrigger) {
+        delete newTrigger.webhookId
+        newTrigger.inputs = {}
+      }
+      await webhooks.destroy(ctx)
+    } catch (err) {
+      // don't worry about not being able to delete, if it doesn't exist all good
+    }
+  }
+  // need to create webhook
+  if (
+    (!isWebhookTrigger(oldAuto) || triggerChanged) &&
+    isWebhookTrigger(newAuto)
+  ) {
+    const ctx = {
+      appId,
+      request: {
+        body: new webhooks.Webhook(
+          "Automation webhook",
+          webhooks.WebhookType.AUTOMATION,
+          newAuto._id
+        ),
+      },
+    }
+    await webhooks.save(ctx)
+    const id = ctx.body.webhook._id
+    newTrigger.webhookId = id
+    newTrigger.inputs = {
+      schemaUrl: `api/webhooks/schema/${appId}/${id}`,
+      triggerUrl: `api/webhooks/trigger/${appId}/${id}`,
+    }
+  }
+  return newAuto
+}