@budibase/server 0.9.138 → 0.9.140-alpha.2

package/src/automations/actions.js

@@ -1,4 +1,3 @@
-const sendgridEmail = require("./steps/sendgridEmail")
 const sendSmtpEmail = require("./steps/sendSmtpEmail")
 const createRow = require("./steps/createRow")
 const updateRow = require("./steps/updateRow")
@@ -8,15 +7,15 @@ const bash = require("./steps/bash")
 const executeQuery = require("./steps/executeQuery")
 const outgoingWebhook = require("./steps/outgoingWebhook")
 const serverLog = require("./steps/serverLog")
-const env = require("../environment")
-const Sentry = require("@sentry/node")
-const {
-  automationInit,
-  getExternalAutomationStep,
-} = require("../utilities/fileSystem")
+const discord = require("./steps/discord")
+const slack = require("./steps/slack")
+const zapier = require("./steps/zapier")
+const integromat = require("./steps/integromat")
+let filter = require("./steps/filter")
+let delay = require("./steps/delay")
+let queryRow = require("./steps/queryRows")
 
-const BUILTIN_ACTIONS = {
-  SEND_EMAIL: sendgridEmail.run,
+const ACTION_IMPLS = {
   SEND_EMAIL_SMTP: sendSmtpEmail.run,
   CREATE_ROW: createRow.run,
   UPDATE_ROW: updateRow.run,
@@ -26,9 +25,16 @@ const BUILTIN_ACTIONS = {
   EXECUTE_BASH: bash.run,
   EXECUTE_QUERY: executeQuery.run,
   SERVER_LOG: serverLog.run,
+  DELAY: delay.run,
+  FILTER: filter.run,
+  QUERY_ROWS: queryRow.run,
+  // these used to be lowercase step IDs, maintain for backwards compat
+  discord: discord.run,
+  slack: slack.run,
+  zapier: zapier.run,
+  integromat: integromat.run,
 }
-const BUILTIN_DEFINITIONS = {
-  SEND_EMAIL: sendgridEmail.definition,
+const ACTION_DEFINITIONS = {
   SEND_EMAIL_SMTP: sendSmtpEmail.definition,
   CREATE_ROW: createRow.definition,
   UPDATE_ROW: updateRow.definition,
@@ -38,47 +44,21 @@ const BUILTIN_DEFINITIONS = {
   EXECUTE_QUERY: executeQuery.definition,
   EXECUTE_BASH: bash.definition,
   SERVER_LOG: serverLog.definition,
+  DELAY: delay.definition,
+  FILTER: filter.definition,
+  QUERY_ROWS: queryRow.definition,
+  // these used to be lowercase step IDs, maintain for backwards compat
+  discord: discord.definition,
+  slack: slack.definition,
+  zapier: zapier.definition,
+  integromat: integromat.definition,
 }
 
-let MANIFEST = null
-
 /* istanbul ignore next */
-function buildBundleName(pkgName, version) {
-  return `${pkgName}@${version}.min.js`
-}
-
-/* istanbul ignore next */
-module.exports.getAction = async function (actionName) {
-  if (BUILTIN_ACTIONS[actionName] != null) {
-    return BUILTIN_ACTIONS[actionName]
-  }
-  // worker pools means that a worker may not have manifest
-  if (env.isProd() && MANIFEST == null) {
-    MANIFEST = await module.exports.init()
-  }
-  // env setup to get async packages
-  if (!MANIFEST || !MANIFEST.packages || !MANIFEST.packages[actionName]) {
-    return null
-  }
-  const pkg = MANIFEST.packages[actionName]
-  const bundleName = buildBundleName(pkg.stepId, pkg.version)
-  return getExternalAutomationStep(pkg.stepId, pkg.version, bundleName)
-}
-
-module.exports.init = async function () {
-  try {
-    MANIFEST = await automationInit()
-    module.exports.DEFINITIONS =
-      MANIFEST && MANIFEST.packages
-        ? Object.assign(MANIFEST.packages, BUILTIN_DEFINITIONS)
-        : BUILTIN_DEFINITIONS
-  } catch (err) {
-    console.error(err)
-    Sentry.captureException(err)
+exports.getAction = async function (actionName) {
+  if (ACTION_IMPLS[actionName] != null) {
+    return ACTION_IMPLS[actionName]
   }
-  return MANIFEST
 }
 
-// definitions will have downloaded ones added to it, while builtin won't
-module.exports.DEFINITIONS = BUILTIN_DEFINITIONS
-module.exports.BUILTIN_DEFINITIONS = BUILTIN_DEFINITIONS
+exports.ACTION_DEFINITIONS = ACTION_DEFINITIONS

package/src/automations/bullboard.js

@@ -1,14 +1,23 @@
 const { createBullBoard } = require("bull-board")
 const { BullAdapter } = require("bull-board/bullAdapter")
-const { getQueues } = require("./triggers")
 const express = require("express")
+const env = require("../environment")
+const Queue = env.isTest()
+  ? require("../utilities/queue/inMemoryQueue")
+  : require("bull")
+const { JobQueues } = require("../constants")
+const { utils } = require("@budibase/auth/redis")
+const { opts, redisProtocolUrl } = utils.getRedisOptions()
+
+const redisConfig = redisProtocolUrl || { redis: opts }
+let automationQueue = new Queue(JobQueues.AUTOMATIONS, redisConfig)
 
 exports.pathPrefix = "/bulladmin"
 
 exports.init = () => {
   const expressApp = express()
   // Set up queues for bull board admin
-  const queues = getQueues()
+  const queues = [automationQueue]
   const adapters = []
   for (let queue of queues) {
     adapters.push(new BullAdapter(queue))
@@ -18,3 +27,5 @@ exports.init = () => {
   expressApp.use(exports.pathPrefix, router)
   return expressApp
 }
+
+exports.queue = automationQueue

package/src/automations/index.js

@@ -1,51 +1,17 @@
-const triggers = require("./triggers")
-const actions = require("./actions")
-const env = require("../environment")
-const workerFarm = require("worker-farm")
-const singleThread = require("./thread")
-const { getAPIKey, update, Properties } = require("../utilities/usageQuota")
-
-let workers = workerFarm(require.resolve("./thread"))
-
-function runWorker(job) {
-  return new Promise((resolve, reject) => {
-    workers(job, err => {
-      if (err) {
-        reject(err)
-      } else {
-        resolve()
-      }
-    })
-  })
-}
-
-async function updateQuota(automation) {
-  const appId = automation.appId
-  const apiObj = await getAPIKey(appId)
-  // this will fail, causing automation to escape if limits reached
-  await update(apiObj.apiKey, Properties.AUTOMATION, 1)
-  return apiObj.apiKey
-}
+const { processEvent } = require("./utils")
+const { queue } = require("./bullboard")
 
 /**
  * This module is built purely to kick off the worker farm and manage the inputs/outputs
  */
-module.exports.init = async function () {
-  await actions.init()
-  triggers.automationQueue.process(async job => {
-    try {
-      if (env.USE_QUOTAS) {
-        job.data.automation.apiKey = await updateQuota(job.data.automation)
-      }
-      if (env.isProd()) {
-        await runWorker(job)
-      } else {
-        await singleThread(job)
-      }
-    } catch (err) {
-      console.error(
-        `${job.data.automation.appId} automation ${job.data.automation._id} was unable to run - ${err}`
-      )
-    }
+exports.init = function () {
+  // this promise will not complete
+  return queue.process(async job => {
+    await processEvent(job)
   })
 }
+
+exports.getQueues = () => {
+  return [queue]
+}
+exports.queue = queue

package/src/automations/steps/bash.js

@@ -1,12 +1,13 @@
 const { execSync } = require("child_process")
 const { processStringSync } = require("@budibase/string-templates")
 
-module.exports.definition = {
+exports.definition = {
   name: "Bash Scripting",
   tagline: "Execute a bash command",
-  icon: "ri-terminal-box-line",
+  icon: "JourneyEvent",
   description: "Run a bash script",
   type: "ACTION",
+  internal: true,
   stepId: "EXECUTE_BASH",
   inputs: {},
   schema: {
@@ -24,7 +25,11 @@ module.exports.definition = {
       properties: {
         stdout: {
           type: "string",
-          description: "Standard output of your bash command or script.",
+          description: "Standard output of your bash command or script",
+        },
+        success: {
+          type: "boolean",
+          description: "Whether the command was successful",
         },
       },
     },
@@ -32,7 +37,7 @@ module.exports.definition = {
   },
 }
 
-module.exports.run = async function ({ inputs, context }) {
+exports.run = async function ({ inputs, context }) {
   if (inputs.code == null) {
     return {
       stdout: "Budibase bash automation failed: Invalid inputs",
@@ -42,18 +47,20 @@ module.exports.run = async function ({ inputs, context }) {
   try {
     const command = processStringSync(inputs.code, context)
 
-    let stdout
+    let stdout,
+      success = true
     try {
       stdout = execSync(command, { timeout: 500 }).toString()
     } catch (err) {
       stdout = err.message
+      success = false
     }
 
     return {
       stdout,
+      success,
     }
   } catch (err) {
-    console.error(err)
     return {
       success: false,
       response: err,

package/src/automations/steps/createRow.js

@@ -3,12 +3,13 @@ const automationUtils = require("../automationUtils")
 const env = require("../../environment")
 const usage = require("../../utilities/usageQuota")
 
-module.exports.definition = {
+exports.definition = {
   name: "Create Row",
   tagline: "Create a {{inputs.enriched.table.name}} row",
-  icon: "ri-save-3-line",
+  icon: "TableRowAddBottom",
   description: "Add a row to your database",
   type: "ACTION",
+  internal: true,
   stepId: "CREATE_ROW",
   inputs: {},
   schema: {
@@ -42,7 +43,7 @@ module.exports.definition = {
         },
         success: {
           type: "boolean",
-          description: "Whether the action was successful",
+          description: "Whether the row creation was successful",
         },
         id: {
           type: "string",
@@ -58,7 +59,7 @@ module.exports.definition = {
   },
 }
 
-module.exports.run = async function ({ inputs, appId, apiKey, emitter }) {
+exports.run = async function ({ inputs, appId, apiKey, emitter }) {
   if (inputs.row == null || inputs.row.tableId == null) {
     return {
       success: false,
@@ -97,7 +98,6 @@ module.exports.run = async function ({ inputs, appId, apiKey, emitter }) {
       success: ctx.status === 200,
     }
   } catch (err) {
-    console.error(err)
     return {
       success: false,
       response: err,

package/src/automations/steps/delay.js

@@ -1,11 +1,12 @@
 let { wait } = require("../../utilities")
 
-module.exports.definition = {
+exports.definition = {
   name: "Delay",
-  icon: "ri-time-line",
+  icon: "Clock",
   tagline: "Delay for {{inputs.time}} milliseconds",
   description: "Delay the automation until an amount of time has passed",
   stepId: "DELAY",
+  internal: true,
   inputs: {},
   schema: {
     inputs: {
@@ -17,10 +18,22 @@ module.exports.definition = {
       },
       required: ["time"],
     },
+    outputs: {
+      properties: {
+        success: {
+          type: "boolean",
+          description: "Whether the delay was successful",
+        },
+      },
+      required: ["success"],
+    },
   },
   type: "LOGIC",
 }
 
-module.exports.run = async function delay({ inputs }) {
+exports.run = async function delay({ inputs }) {
   await wait(inputs.time)
+  return {
+    success: true,
+  }
 }

package/src/automations/steps/deleteRow.js

@@ -2,13 +2,14 @@ const rowController = require("../../api/controllers/row")
 const env = require("../../environment")
 const usage = require("../../utilities/usageQuota")
 
-module.exports.definition = {
+exports.definition = {
   description: "Delete a row from your database",
-  icon: "ri-delete-bin-line",
+  icon: "TableRowRemoveCenter",
   name: "Delete Row",
   tagline: "Delete a {{inputs.enriched.table.name}} row",
   type: "ACTION",
   stepId: "DELETE_ROW",
+  internal: true,
   inputs: {},
   schema: {
     inputs: {
@@ -42,7 +43,7 @@ module.exports.definition = {
         },
         success: {
           type: "boolean",
-          description: "Whether the action was successful",
+          description: "Whether the deletion was successful",
         },
       },
       required: ["row", "success"],
@@ -50,7 +51,7 @@ module.exports.definition = {
   },
 }
 
-module.exports.run = async function ({ inputs, appId, apiKey, emitter }) {
+exports.run = async function ({ inputs, appId, apiKey, emitter }) {
   if (inputs.id == null || inputs.revision == null) {
     return {
       success: false,
@@ -84,7 +85,6 @@ module.exports.run = async function ({ inputs, appId, apiKey, emitter }) {
       success: ctx.status === 200,
     }
   } catch (err) {
-    console.error(err)
     return {
       success: false,
       response: err,

package/src/automations/steps/discord.js

@@ -0,0 +1,83 @@
+const fetch = require("node-fetch")
+const { getFetchResponse } = require("./utils")
+
+const DEFAULT_USERNAME = "Budibase Automate"
+const DEFAULT_AVATAR_URL = "https://i.imgur.com/a1cmTKM.png"
+
+exports.definition = {
+  name: "Discord Message",
+  tagline: "Send a message to a Discord server",
+  description: "Send a message to a Discord server",
+  icon: "ri-discord-line",
+  stepId: "discord",
+  type: "ACTION",
+  internal: false,
+  inputs: {},
+  schema: {
+    inputs: {
+      properties: {
+        url: {
+          type: "string",
+          title: "Discord Webhook URL",
+        },
+        username: {
+          type: "string",
+          title: "Bot Name",
+        },
+        avatar_url: {
+          type: "string",
+          title: "Bot Avatar URL",
+        },
+        content: {
+          type: "string",
+          title: "Message",
+        },
+      },
+      required: ["url", "content"],
+    },
+    outputs: {
+      properties: {
+        httpStatus: {
+          type: "number",
+          description: "The HTTP status code of the request",
+        },
+        response: {
+          type: "string",
+          description: "The response from the Discord Webhook",
+        },
+        success: {
+          type: "boolean",
+          description: "Whether the message sent successfully",
+        },
+      },
+    },
+  },
+}
+
+exports.run = async function ({ inputs }) {
+  let { url, username, avatar_url, content } = inputs
+  if (!username) {
+    username = DEFAULT_USERNAME
+  }
+  if (!avatar_url) {
+    avatar_url = DEFAULT_AVATAR_URL
+  }
+  const response = await fetch(url, {
+    method: "post",
+    body: JSON.stringify({
+      username,
+      avatar_url,
+      content,
+    }),
+    headers: {
+      "Content-Type": "application/json",
+    },
+  })
+
+  const { status, message } = await getFetchResponse(response)
+  return {
+    httpStatus: status,
+    success: status === 200,
+    response: message,
+  }
+}

package/src/automations/steps/executeQuery.js

@@ -1,12 +1,14 @@
 const queryController = require("../../api/controllers/query")
+const { buildCtx } = require("./utils")
 
-module.exports.definition = {
+exports.definition = {
   name: "External Data Connector",
   tagline: "Execute Data Connector",
-  icon: "ri-database-2-line",
+  icon: "Data",
   description: "Execute a query in an external data connector",
   type: "ACTION",
   stepId: "EXECUTE_QUERY",
+  internal: true,
   inputs: {},
   schema: {
     inputs: {
@@ -42,7 +44,7 @@ module.exports.definition = {
   },
 }
 
-module.exports.run = async function ({ inputs, appId, emitter }) {
+exports.run = async function ({ inputs, appId, emitter }) {
   if (inputs.query == null) {
     return {
       success: false,
@@ -54,28 +56,22 @@ module.exports.run = async function ({ inputs, appId, emitter }) {
 
   const { queryId, ...rest } = inputs.query
 
-  const ctx = {
+  const ctx = buildCtx(appId, emitter, {
+    body: {
+      parameters: rest,
+    },
     params: {
       queryId,
     },
-    request: {
-      body: {
-        parameters: rest,
-      },
-    },
-    appId,
-    eventEmitter: emitter,
-  }
-
-  await queryController.execute(ctx)
+  })
 
   try {
+    await queryController.execute(ctx)
     return {
       response: ctx.body,
-      success: ctx.status === 200,
+      success: true,
     }
   } catch (err) {
-    console.error(err)
     return {
       success: false,
       response: err,

package/src/automations/steps/executeScript.js

@@ -1,11 +1,13 @@
 const scriptController = require("../../api/controllers/script")
+const { buildCtx } = require("./utils")
 
-module.exports.definition = {
+exports.definition = {
   name: "JS Scripting",
   tagline: "Execute JavaScript Code",
-  icon: "ri-terminal-box-line",
+  icon: "Code",
   description: "Run a piece of JavaScript code in your automation",
   type: "ACTION",
+  internal: true,
   stepId: "EXECUTE_SCRIPT",
   inputs: {},
   schema: {
@@ -23,8 +25,7 @@ module.exports.definition = {
       properties: {
         value: {
           type: "string",
-          description:
-            "The result of the last statement of the executed script.",
+          description: "The result of the return statement",
         },
         success: {
           type: "boolean",
@@ -36,7 +37,7 @@ module.exports.definition = {
   },
 }
 
-module.exports.run = async function ({ inputs, appId, context, emitter }) {
+exports.run = async function ({ inputs, appId, context, emitter }) {
   if (inputs.code == null) {
     return {
       success: false,
@@ -46,25 +47,20 @@ module.exports.run = async function ({ inputs, appId, context, emitter }) {
     }
   }
 
-  const ctx = {
-    request: {
-      body: {
-        script: inputs.code,
-        context,
-      },
+  const ctx = buildCtx(appId, emitter, {
+    body: {
+      script: inputs.code,
+      context,
     },
-    user: { appId },
-    eventEmitter: emitter,
-  }
+  })
 
   try {
     await scriptController.execute(ctx)
     return {
-      success: ctx.status === 200,
+      success: true,
       value: ctx.body,
     }
   } catch (err) {
-    console.error(err)
     return {
       success: false,
       response: err,

package/src/automations/steps/filter.js

@@ -1,29 +1,30 @@
-const LogicConditions = {
+const FilterConditions = {
   EQUAL: "EQUAL",
   NOT_EQUAL: "NOT_EQUAL",
   GREATER_THAN: "GREATER_THAN",
   LESS_THAN: "LESS_THAN",
 }
 
-const PrettyLogicConditions = {
-  [LogicConditions.EQUAL]: "Equals",
-  [LogicConditions.NOT_EQUAL]: "Not equals",
-  [LogicConditions.GREATER_THAN]: "Greater than",
-  [LogicConditions.LESS_THAN]: "Less than",
+const PrettyFilterConditions = {
+  [FilterConditions.EQUAL]: "Equals",
+  [FilterConditions.NOT_EQUAL]: "Not equals",
+  [FilterConditions.GREATER_THAN]: "Greater than",
+  [FilterConditions.LESS_THAN]: "Less than",
 }
 
-module.exports.LogicConditions = LogicConditions
-module.exports.PrettyLogicConditions = PrettyLogicConditions
+exports.FilterConditions = FilterConditions
+exports.PrettyFilterConditions = PrettyFilterConditions
 
-module.exports.definition = {
+exports.definition = {
   name: "Filter",
   tagline: "{{inputs.field}} {{inputs.condition}} {{inputs.value}}",
-  icon: "ri-git-branch-line",
+  icon: "Branch2",
   description: "Filter any automations which do not meet certain conditions",
   type: "LOGIC",
+  internal: true,
   stepId: "FILTER",
   inputs: {
-    condition: LogicConditions.EQUALS,
+    condition: FilterConditions.EQUALS,
   },
   schema: {
     inputs: {
@@ -35,8 +36,8 @@ module.exports.definition = {
         condition: {
           type: "string",
           title: "Condition",
-          enum: Object.values(LogicConditions),
-          pretty: Object.values(PrettyLogicConditions),
+          enum: Object.values(FilterConditions),
+          pretty: Object.values(PrettyFilterConditions),
         },
         value: {
           type: "string",
@@ -57,7 +58,7 @@ module.exports.definition = {
   },
 }
 
-module.exports.run = async function filter({ inputs }) {
+exports.run = async function filter({ inputs }) {
   let { field, condition, value } = inputs
   // coerce types so that we can use them
   if (!isNaN(value) && !isNaN(field)) {
@@ -70,16 +71,16 @@ module.exports.run = async function filter({ inputs }) {
   let success = false
   if (typeof field !== "object" && typeof value !== "object") {
     switch (condition) {
-      case LogicConditions.EQUAL:
+      case FilterConditions.EQUAL:
         success = field === value
         break
-      case LogicConditions.NOT_EQUAL:
+      case FilterConditions.NOT_EQUAL:
         success = field !== value
         break
-      case LogicConditions.GREATER_THAN:
+      case FilterConditions.GREATER_THAN:
         success = field > value
         break
-      case LogicConditions.LESS_THAN:
+      case FilterConditions.LESS_THAN:
         success = field < value
         break
     }