@budibase/server 2.1.45 → 2.1.46-alpha.1

package/src/app.ts

@@ -10,21 +10,20 @@ if (process.env.ELASTIC_APM_ENABLED) {
 }
 
 import { ExtendableContext } from "koa"
-import db from "./db"
+import * as db from "./db"
 db.init()
-const Koa = require("koa")
-const destroyable = require("server-destroy")
-const koaBody = require("koa-body")
-const http = require("http")
-const api = require("./api")
-const automations = require("./automations/index")
-const Sentry = require("@sentry/node")
-const { logAlert } = require("@budibase/backend-core/logging")
-const { Thread } = require("./threads")
-import redis from "./utilities/redis"
-import { events } from "@budibase/backend-core"
+import Koa from "koa"
+import koaBody from "koa-body"
+import http from "http"
+import * as api from "./api"
+import * as automations from "./automations"
+import { Thread } from "./threads"
+import * as redis from "./utilities/redis"
+import { events, logging } from "@budibase/backend-core"
 import { initialise as initialiseWebsockets } from "./websocket"
 import { startup } from "./startup"
+const Sentry = require("@sentry/node")
+const destroyable = require("server-destroy")
 
 const app = new Koa()
 
@@ -35,6 +34,7 @@ app.use(
     formLimit: "10mb",
     jsonLimit: "10mb",
     textLimit: "10mb",
+    // @ts-ignore
     enableTypes: ["json", "form", "text"],
     parsedMethods: ["POST", "PUT", "PATCH", "DELETE"],
   })
@@ -77,12 +77,13 @@ server.on("close", async () => {
   }
 })
 
-module.exports = server.listen(env.PORT || 0, async () => {
+export = server.listen(env.PORT || 0, async () => {
   await startup(app, server)
 })
 
 const shutdown = () => {
   server.close()
+  // @ts-ignore
   server.destroy()
 }
 
@@ -93,7 +94,7 @@ process.on("uncaughtException", err => {
     return
   }
   errCode = -1
-  logAlert("Uncaught exception.", err)
+  logging.logAlert("Uncaught exception.", err)
   shutdown()
 })
 

package/src/automations/{actions.js → actions.ts}

@@ -1,22 +1,26 @@
-const sendSmtpEmail = require("./steps/sendSmtpEmail")
-const createRow = require("./steps/createRow")
-const updateRow = require("./steps/updateRow")
-const deleteRow = require("./steps/deleteRow")
-const executeScript = require("./steps/executeScript")
-const executeQuery = require("./steps/executeQuery")
-const outgoingWebhook = require("./steps/outgoingWebhook")
-const serverLog = require("./steps/serverLog")
-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")
-let loop = require("./steps/loop")
-const env = require("../environment")
+import * as sendSmtpEmail from "./steps/sendSmtpEmail"
+import * as createRow from "./steps/createRow"
+import * as updateRow from "./steps/updateRow"
+import * as deleteRow from "./steps/deleteRow"
+import * as executeScript from "./steps/executeScript"
+import * as executeQuery from "./steps/executeQuery"
+import * as outgoingWebhook from "./steps/outgoingWebhook"
+import * as serverLog from "./steps/serverLog"
+import * as discord from "./steps/discord"
+import * as slack from "./steps/slack"
+import * as zapier from "./steps/zapier"
+import * as integromat from "./steps/integromat"
+import * as filter from "./steps/filter"
+import * as delay from "./steps/delay"
+import * as queryRow from "./steps/queryRows"
+import * as loop from "./steps/loop"
+import env from "../environment"
+import { AutomationStepSchema, AutomationStepInput } from "@budibase/types"
 
-const ACTION_IMPLS = {
+const ACTION_IMPLS: Record<
+  string,
+  (opts: AutomationStepInput) => Promise<any>
+> = {
   SEND_EMAIL_SMTP: sendSmtpEmail.run,
   CREATE_ROW: createRow.run,
   UPDATE_ROW: updateRow.run,
@@ -28,14 +32,13 @@ const ACTION_IMPLS = {
   DELAY: delay.run,
   FILTER: filter.run,
   QUERY_ROWS: queryRow.run,
-  LOOP: loop.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 ACTION_DEFINITIONS = {
+export const ACTION_DEFINITIONS: Record<string, AutomationStepSchema> = {
   SEND_EMAIL_SMTP: sendSmtpEmail.definition,
   CREATE_ROW: createRow.definition,
   UPDATE_ROW: updateRow.definition,
@@ -60,15 +63,15 @@ const ACTION_DEFINITIONS = {
 // ran at all
 if (env.SELF_HOSTED) {
   const bash = require("./steps/bash")
+  // @ts-ignore
   ACTION_IMPLS["EXECUTE_BASH"] = bash.run
+  // @ts-ignore
   ACTION_DEFINITIONS["EXECUTE_BASH"] = bash.definition
 }
 
 /* istanbul ignore next */
-exports.getAction = async function (actionName) {
+export async function getAction(actionName: string) {
   if (ACTION_IMPLS[actionName] != null) {
     return ACTION_IMPLS[actionName]
   }
 }
-
-exports.ACTION_DEFINITIONS = ACTION_DEFINITIONS

package/src/automations/{automationUtils.js → automationUtils.ts}

@@ -1,9 +1,10 @@
-const {
+import {
   decodeJSBinding,
   isJSBinding,
   encodeJSBinding,
-} = require("@budibase/string-templates")
-const sdk = require("../sdk")
+} from "@budibase/string-templates"
+import sdk from "../sdk"
+import { Row } from "@budibase/types"
 
 /**
  * When values are input to the system generally they will be of type string as this is required for template strings.
@@ -21,7 +22,7 @@ const sdk = require("../sdk")
  * @returns {object} The inputs object which has had all the various types supported by this function converted to their
  * primitive types.
  */
-exports.cleanInputValues = (inputs, schema) => {
+export function cleanInputValues(inputs: Record<string, any>, schema: any) {
   if (schema == null) {
     return inputs
   }
@@ -62,12 +63,12 @@ exports.cleanInputValues = (inputs, schema) => {
  * @param {object} row The input row structure which requires clean-up after having been through template statements.
  * @returns {Promise<Object>} The cleaned up rows object, will should now have all the required primitive types.
  */
-exports.cleanUpRow = async (tableId, row) => {
+export async function cleanUpRow(tableId: string, row: Row) {
   let table = await sdk.tables.getTable(tableId)
-  return exports.cleanInputValues(row, { properties: table.schema })
+  return cleanInputValues(row, { properties: table.schema })
 }
 
-exports.getError = err => {
+export function getError(err: any) {
   if (err == null) {
     return "No error provided."
   }
@@ -80,13 +81,13 @@ exports.getError = err => {
   return typeof err !== "string" ? err.toString() : err
 }
 
-exports.substituteLoopStep = (hbsString, substitute) => {
+export function substituteLoopStep(hbsString: string, substitute: string) {
   let checkForJS = isJSBinding(hbsString)
   let substitutedHbsString = ""
   let open = checkForJS ? `$("` : "{{"
   let closed = checkForJS ? `")` : "}}"
   if (checkForJS) {
-    hbsString = decodeJSBinding(hbsString)
+    hbsString = decodeJSBinding(hbsString) as string
   }
   let pointer = 0,
     openPointer = 0,
@@ -111,9 +112,9 @@ exports.substituteLoopStep = (hbsString, substitute) => {
   return substitutedHbsString
 }
 
-exports.stringSplit = value => {
-  if (value == null) {
-    return []
+export function stringSplit(value: string | string[]) {
+  if (value == null || Array.isArray(value)) {
+    return value || []
   }
   if (value.split("\n").length > 1) {
     value = value.split("\n")

package/src/automations/bullboard.ts

@@ -0,0 +1,38 @@
+import { BullAdapter } from "@bull-board/api/bullAdapter"
+import { KoaAdapter } from "@bull-board/koa"
+import { queue } from "@budibase/backend-core"
+import * as automation from "../threads/automation"
+import { backups } from "@budibase/pro"
+import { createBullBoard } from "@bull-board/api"
+import BullQueue from "bull"
+
+export const automationQueue: BullQueue.Queue = queue.createQueue(
+  queue.JobQueue.AUTOMATION,
+  { removeStalledCb: automation.removeStalled }
+)
+
+const PATH_PREFIX = "/bulladmin"
+
+export async function init() {
+  // Set up queues for bull board admin
+  const backupQueue = await backups.getBackupQueue()
+  const queues = [automationQueue]
+  if (backupQueue) {
+    queues.push(backupQueue)
+  }
+  const adapters = []
+  const serverAdapter: any = new KoaAdapter()
+  for (let queue of queues) {
+    adapters.push(new BullAdapter(queue))
+  }
+  createBullBoard({
+    queues: adapters,
+    serverAdapter,
+  })
+  serverAdapter.setBasePath(PATH_PREFIX)
+  return serverAdapter.registerPlugin()
+}
+
+export async function shutdown() {
+  await queue.shutdown()
+}

package/src/automations/index.ts

@@ -0,0 +1,26 @@
+import { processEvent } from "./utils"
+import { automationQueue } from "./bullboard"
+import { rebootTrigger } from "./triggers"
+import BullQueue from "bull"
+
+export { automationQueue } from "./bullboard"
+export { shutdown } from "./bullboard"
+export { TRIGGER_DEFINITIONS } from "./triggers"
+export { ACTION_DEFINITIONS } from "./actions"
+
+/**
+ * This module is built purely to kick off the worker farm and manage the inputs/outputs
+ */
+export async function init() {
+  // this promise will not complete
+  const promise = automationQueue.process(async job => {
+    await processEvent(job)
+  })
+  // on init we need to trigger any reboot automations
+  await rebootTrigger()
+  return promise
+}
+
+export function getQueues(): BullQueue.Queue[] {
+  return [automationQueue]
+}

package/src/automations/steps/{bash.js → bash.ts}

@@ -1,16 +1,21 @@
-const { execSync } = require("child_process")
-const { processStringSync } = require("@budibase/string-templates")
-const automationUtils = require("../automationUtils")
-const environment = require("../../environment")
+import { execSync } from "child_process"
+import { processStringSync } from "@budibase/string-templates"
+import * as automationUtils from "../automationUtils"
+import environment from "../../environment"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Bash Scripting",
   tagline: "Execute a bash command",
   icon: "JourneyEvent",
   description: "Run a bash script",
   type: "ACTION",
   internal: true,
-  stepId: "EXECUTE_BASH",
+  stepId: AutomationActionStepId.EXECUTE_BASH,
   inputs: {},
   schema: {
     inputs: {
@@ -39,7 +44,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs, context }) {
+export async function run({ inputs, context }: AutomationStepInput) {
   if (inputs.code == null) {
     return {
       stdout: "Budibase bash automation failed: Invalid inputs",
@@ -55,7 +60,7 @@ exports.run = async function ({ inputs, context }) {
       stdout = execSync(command, {
         timeout: environment.QUERY_THREAD_TIMEOUT || 500,
       }).toString()
-    } catch (err) {
+    } catch (err: any) {
       stdout = err.message
       success = false
     }

package/src/automations/steps/createRow.ts

@@ -1,15 +1,20 @@
 import { save } from "../../api/controllers/row"
 import { cleanUpRow, getError } from "../automationUtils"
 import { buildCtx } from "./utils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-export const definition = {
+export const definition: AutomationStepSchema = {
   name: "Create Row",
   tagline: "Create a {{inputs.enriched.table.name}} row",
   icon: "TableRowAddBottom",
   description: "Add a row to your database",
   type: "ACTION",
   internal: true,
-  stepId: "CREATE_ROW",
+  stepId: AutomationActionStepId.CREATE_ROW,
   inputs: {},
   schema: {
     inputs: {
@@ -58,7 +63,7 @@ export const definition = {
   },
 }
 
-export async function run({ inputs, appId, emitter }: any) {
+export async function run({ inputs, appId, emitter }: AutomationStepInput) {
   if (inputs.row == null || inputs.row.tableId == null) {
     return {
       success: false,

package/src/automations/steps/{delay.js → delay.ts}

@@ -1,11 +1,16 @@
-let { wait } = require("../../utilities")
+import { wait } from "../../utilities"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Delay",
   icon: "Clock",
   tagline: "Delay for {{inputs.time}} milliseconds",
   description: "Delay the automation until an amount of time has passed",
-  stepId: "DELAY",
+  stepId: AutomationActionStepId.DELAY,
   internal: true,
   inputs: {},
   schema: {
@@ -31,7 +36,7 @@ exports.definition = {
   type: "LOGIC",
 }
 
-exports.run = async function delay({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   await wait(inputs.time)
   return {
     success: true,

package/src/automations/steps/deleteRow.ts

@@ -1,14 +1,19 @@
 import { destroy } from "../../api/controllers/row"
 import { buildCtx } from "./utils"
 import { getError } from "../automationUtils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-export const definition = {
+export const definition: AutomationStepSchema = {
   description: "Delete a row from your database",
   icon: "TableRowRemoveCenter",
   name: "Delete Row",
   tagline: "Delete a {{inputs.enriched.table.name}} row",
   type: "ACTION",
-  stepId: "DELETE_ROW",
+  stepId: AutomationActionStepId.DELETE_ROW,
   internal: true,
   inputs: {},
   schema: {
@@ -47,7 +52,7 @@ export const definition = {
   },
 }
 
-export async function run({ inputs, appId, emitter }: any) {
+export async function run({ inputs, appId, emitter }: AutomationStepInput) {
   if (inputs.id == null) {
     return {
       success: false,

package/src/automations/steps/{discord.js → discord.ts}

@@ -1,15 +1,20 @@
-const fetch = require("node-fetch")
-const { getFetchResponse } = require("./utils")
+import fetch from "node-fetch"
+import { getFetchResponse } from "./utils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
 const DEFAULT_USERNAME = "Budibase Automate"
 const DEFAULT_AVATAR_URL = "https://i.imgur.com/a1cmTKM.png"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   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",
+  stepId: AutomationActionStepId.discord,
   type: "ACTION",
   internal: false,
   inputs: {},
@@ -54,7 +59,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   let { url, username, avatar_url, content } = inputs
   if (!username) {
     username = DEFAULT_USERNAME

package/src/automations/steps/{executeQuery.js → executeQuery.ts}

@@ -1,14 +1,19 @@
-const queryController = require("../../api/controllers/query")
-const { buildCtx } = require("./utils")
-const automationUtils = require("../automationUtils")
+import * as queryController from "../../api/controllers/query"
+import { buildCtx } from "./utils"
+import * as automationUtils from "../automationUtils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "External Data Connector",
   tagline: "Execute Data Connector",
   icon: "Data",
   description: "Execute a query in an external data connector",
   type: "ACTION",
-  stepId: "EXECUTE_QUERY",
+  stepId: AutomationActionStepId.EXECUTE_QUERY,
   internal: true,
   inputs: {},
   schema: {
@@ -50,7 +55,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs, appId, emitter }) {
+export async function run({ inputs, appId, emitter }: AutomationStepInput) {
   if (inputs.query == null) {
     return {
       success: false,
@@ -62,7 +67,7 @@ exports.run = async function ({ inputs, appId, emitter }) {
 
   const { queryId, ...rest } = inputs.query
 
-  const ctx = buildCtx(appId, emitter, {
+  const ctx: any = buildCtx(appId, emitter, {
     body: {
       parameters: rest,
     },

package/src/automations/steps/{executeScript.js → executeScript.ts}

@@ -1,15 +1,20 @@
-const scriptController = require("../../api/controllers/script")
-const { buildCtx } = require("./utils")
-const automationUtils = require("../automationUtils")
+import * as scriptController from "../../api/controllers/script"
+import { buildCtx } from "./utils"
+import * as automationUtils from "../automationUtils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "JS Scripting",
   tagline: "Execute JavaScript Code",
   icon: "Code",
   description: "Run a piece of JavaScript code in your automation",
   type: "ACTION",
   internal: true,
-  stepId: "EXECUTE_SCRIPT",
+  stepId: AutomationActionStepId.EXECUTE_SCRIPT,
   inputs: {},
   schema: {
     inputs: {
@@ -38,7 +43,12 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs, appId, context, emitter }) {
+export async function run({
+  inputs,
+  appId,
+  context,
+  emitter,
+}: AutomationStepInput) {
   if (inputs.code == null) {
     return {
       success: false,
@@ -48,7 +58,7 @@ exports.run = async function ({ inputs, appId, context, emitter }) {
     }
   }
 
-  const ctx = buildCtx(appId, emitter, {
+  const ctx: any = buildCtx(appId, emitter, {
     body: {
       script: inputs.code,
       context,

package/src/automations/steps/{filter.js → filter.ts}

@@ -1,21 +1,24 @@
-const FilterConditions = {
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
+
+export const FilterConditions = {
   EQUAL: "EQUAL",
   NOT_EQUAL: "NOT_EQUAL",
   GREATER_THAN: "GREATER_THAN",
   LESS_THAN: "LESS_THAN",
 }
 
-const PrettyFilterConditions = {
+export const PrettyFilterConditions = {
   [FilterConditions.EQUAL]: "Equals",
   [FilterConditions.NOT_EQUAL]: "Not equals",
   [FilterConditions.GREATER_THAN]: "Greater than",
   [FilterConditions.LESS_THAN]: "Less than",
 }
 
-exports.FilterConditions = FilterConditions
-exports.PrettyFilterConditions = PrettyFilterConditions
-
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Condition",
   tagline: "{{inputs.field}} {{inputs.condition}} {{inputs.value}}",
   icon: "Branch2",
@@ -23,9 +26,9 @@ exports.definition = {
     "Conditionally halt automations which do not meet certain conditions",
   type: "LOGIC",
   internal: true,
-  stepId: "FILTER",
+  stepId: AutomationActionStepId.FILTER,
   inputs: {
-    condition: FilterConditions.EQUALS,
+    condition: FilterConditions.EQUAL,
   },
   schema: {
     inputs: {
@@ -63,7 +66,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function filter({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   try {
     let { field, condition, value } = inputs
     // coerce types so that we can use them

package/src/automations/steps/{integromat.js → integromat.ts}

@@ -1,13 +1,18 @@
-const fetch = require("node-fetch")
-const { getFetchResponse } = require("./utils")
+import fetch from "node-fetch"
+import { getFetchResponse } from "./utils"
+import {
+  AutomationActionStepId,
+  AutomationStepSchema,
+  AutomationStepInput,
+} from "@budibase/types"
 
-exports.definition = {
+export const definition: AutomationStepSchema = {
   name: "Integromat Integration",
   tagline: "Trigger an Integromat scenario",
   description:
     "Performs a webhook call to Integromat and gets the response (if configured)",
   icon: "ri-shut-down-line",
-  stepId: "integromat",
+  stepId: AutomationActionStepId.integromat,
   type: "ACTION",
   internal: false,
   inputs: {},
@@ -61,7 +66,7 @@ exports.definition = {
   },
 }
 
-exports.run = async function ({ inputs }) {
+export async function run({ inputs }: AutomationStepInput) {
   const { url, value1, value2, value3, value4, value5 } = inputs
 
   const response = await fetch(url, {

package/src/automations/steps/{loop.js → loop.ts}

@@ -1,9 +1,11 @@
-exports.definition = {
+import { AutomationActionStepId, AutomationStepSchema } from "@budibase/types"
+
+export const definition: AutomationStepSchema = {
   name: "Looping",
   icon: "Reuse",
   tagline: "Loop the block",
   description: "Loop",
-  stepId: "LOOP",
+  stepId: AutomationActionStepId.LOOP,
   internal: true,
   inputs: {},
   schema: {