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

package/src/constants/index.js

@@ -123,5 +123,10 @@ exports.BaseQueryVerbs = {
   DELETE: "delete",
 }
 
+exports.MetadataTypes = {
+  AUTOMATION_TEST_INPUT: "automationTestInput",
+  AUTOMATION_TEST_HISTORY: "automationTestHistory",
+}
+
 // pass through the list from the auth/core lib
 exports.ObjectStoreBuckets = ObjectStoreBuckets

package/src/db/linkedRows/index.js

@@ -36,6 +36,18 @@ exports.IncludeDocs = IncludeDocs
 exports.getLinkDocuments = getLinkDocuments
 exports.createLinkView = createLinkView
 
+function clearRelationshipFields(table, rows) {
+  for (let [key, field] of Object.entries(table.schema)) {
+    if (field.type === FieldTypes.LINK) {
+      rows = rows.map(row => {
+        delete row[key]
+        return row
+      })
+    }
+  }
+  return rows
+}
+
 async function getLinksForRows(appId, rows) {
   const tableIds = [...new Set(rows.map(el => el.tableId))]
   // start by getting all the link values for performance reasons
@@ -126,33 +138,6 @@ exports.updateLinks = async function (args) {
   }
 }
 
-/**
- * Update a row with information about the links that pertain to it.
- * @param {string} appId The instance in which this row has been created.
- * @param {object} rows The row(s) themselves which is to be updated with info (if applicable). This can be
- * a single row object or an array of rows - both will be handled.
- * @returns {Promise<object>} The updated row (this may be the same if no links were found). If an array was input
- * then an array will be output, object input -> object output.
- */
-exports.attachLinkIDs = async (appId, rows) => {
-  const links = await getLinksForRows(appId, rows)
-  // now iterate through the rows and all field information
-  for (let row of rows) {
-    // find anything that matches the row's ID we are searching for and join it
-    links
-      .filter(el => el.thisId === row._id)
-      .forEach(link => {
-        if (row[link.fieldName] == null) {
-          row[link.fieldName] = []
-        }
-        row[link.fieldName].push(link.id)
-      })
-  }
-  // if it was an array when it came in then handle it as an array in response
-  // otherwise return the first element as there was only one input
-  return rows
-}
-
 /**
  * Given a table and a list of rows this will retrieve all of the attached docs and enrich them into the row.
  * This is required for formula fields, this may only be utilised internally (for now).
@@ -173,6 +158,9 @@ exports.attachFullLinkedDocs = async (ctx, table, rows) => {
   const links = (await getLinksForRows(appId, rows)).filter(link =>
     rows.some(row => row._id === link.thisId)
   )
+  // clear any existing links that could be dupe'd
+  rows = clearRelationshipFields(table, rows)
+  // now get the docs and combine into the rows
   let linked = await getFullLinkedDocs(ctx, appId, links)
   const linkedTables = []
   for (let row of rows) {

package/src/db/tests/linkTests.spec.js

@@ -59,16 +59,4 @@ describe("test link functionality", () => {
       expect(Array.isArray(output)).toBe(true)
     })
   })
-
-  describe("attachLinkIDs", () => {
-    it("should be able to attach linkIDs", async () => {
-      await config.init()
-      await config.createTable()
-      const table = await config.createLinkedTable()
-      const row = await config.createRow()
-      const linkRow = await config.createRow(basicLinkedRow(table._id, row._id))
-      const attached = await links.attachLinkIDs(config.getAppId(), [linkRow])
-      expect(attached[0].link[0]).toBe(row._id)
-    })
-  })
 })

package/src/db/utils.js

@@ -7,6 +7,8 @@ const {
   APP_PREFIX,
   SEPARATOR,
   StaticDatabases,
+  isDevAppID,
+  isProdAppID,
 } = require("@budibase/auth/db")
 
 const UNICODE_MAX = "\ufff0"
@@ -36,6 +38,7 @@ const DocumentTypes = {
   DATASOURCE_PLUS: "datasource_plus",
   QUERY: "query",
   DEPLOYMENTS: "deployments",
+  METADATA: "metadata",
 }
 
 const ViewNames = {
@@ -63,6 +66,8 @@ const BudibaseInternalDB = {
 
 exports.APP_PREFIX = APP_PREFIX
 exports.APP_DEV_PREFIX = APP_DEV_PREFIX
+exports.isDevAppID = isDevAppID
+exports.isProdAppID = isProdAppID
 exports.USER_METDATA_PREFIX = `${DocumentTypes.ROW}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
 exports.LINK_USER_METADATA_PREFIX = `${DocumentTypes.LINK}${SEPARATOR}${InternalTables.USER_METADATA}${SEPARATOR}`
 exports.ViewNames = ViewNames
@@ -331,6 +336,18 @@ exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
   )
 }
 
+exports.generateMetadataID = (type, entityId) => {
+  return `${DocumentTypes.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`
+}
+
+exports.getMetadataParams = (type, entityId = null, otherProps = {}) => {
+  let docId = `${type}${SEPARATOR}`
+  if (entityId != null) {
+    docId += entityId
+  }
+  return getDocParams(DocumentTypes.METADATA, docId, otherProps)
+}
+
 /**
  * This can be used with the db.allDocs to get a list of IDs
  */

package/src/environment.js

@@ -55,6 +55,7 @@ module.exports = {
   BUDIBASE_API_KEY: process.env.BUDIBASE_API_KEY,
   USERID_API_KEY: process.env.USERID_API_KEY,
   DEPLOYMENT_CREDENTIALS_URL: process.env.DEPLOYMENT_CREDENTIALS_URL,
+  ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
   _set(key, value) {
     process.env[key] = value
     module.exports[key] = value

package/src/middleware/appInfo.js

@@ -0,0 +1,19 @@
+const { isDevAppID, isProdAppID } = require("../db/utils")
+
+exports.AppType = {
+  DEV: "dev",
+  PROD: "prod",
+}
+
+exports.middleware =
+  ({ appType } = {}) =>
+  (ctx, next) => {
+    const appId = ctx.appId
+    if (appType === exports.AppType.DEV && appId && !isDevAppID(appId)) {
+      ctx.throw(400, "Only apps in development support this endpoint")
+    }
+    if (appType === exports.AppType.PROD && appId && !isProdAppID(appId)) {
+      ctx.throw(400, "Only apps in production support this endpoint")
+    }
+    return next()
+  }

package/src/middleware/usageQuota.js

@@ -14,7 +14,7 @@ const DOMAIN_MAP = {
   views: usageQuota.Properties.VIEW,
   users: usageQuota.Properties.USER,
   // this will not be updated by endpoint calls
-  // instead it will be updated by triggers
+  // instead it will be updated by triggerInfo
   automationRuns: usageQuota.Properties.AUTOMATION,
 }
 

package/src/utilities/fileSystem/index.js

@@ -14,18 +14,12 @@ const {
   downloadTarball,
 } = require("./utilities")
 const { updateClientLibrary } = require("./clientLibrary")
-const download = require("download")
 const env = require("../../environment")
-const { homedir } = require("os")
-const fetch = require("node-fetch")
 const {
   USER_METDATA_PREFIX,
   LINK_USER_METADATA_PREFIX,
 } = require("../../db/utils")
 
-const DEFAULT_AUTOMATION_BUCKET =
-  "https://prod-budi-automations.s3-eu-west-1.amazonaws.com"
-const DEFAULT_AUTOMATION_DIRECTORY = ".budibase-automations"
 const TOP_LEVEL_PATH = join(__dirname, "..", "..", "..")
 const NODE_MODULES_PATH = join(TOP_LEVEL_PATH, "node_modules")
 
@@ -205,30 +199,6 @@ exports.getComponentLibraryManifest = async (appId, library) => {
   return JSON.parse(resp)
 }
 
-exports.automationInit = async () => {
-  const directory =
-    env.AUTOMATION_DIRECTORY || join(homedir(), DEFAULT_AUTOMATION_DIRECTORY)
-  const bucket = env.AUTOMATION_BUCKET || DEFAULT_AUTOMATION_BUCKET
-  if (!fs.existsSync(directory)) {
-    fs.mkdirSync(directory, { recursive: true })
-  }
-  // env setup to get async packages
-  let response = await fetch(`${bucket}/manifest.json`)
-  return response.json()
-}
-
-exports.getExternalAutomationStep = async (name, version, bundleName) => {
-  const directory =
-    env.AUTOMATION_DIRECTORY || join(homedir(), DEFAULT_AUTOMATION_DIRECTORY)
-  const bucket = env.AUTOMATION_BUCKET || DEFAULT_AUTOMATION_BUCKET
-  try {
-    return require(join(directory, bundleName))
-  } catch (err) {
-    await download(`${bucket}/${name}/${version}/${bundleName}`, directory)
-    return require(join(directory, bundleName))
-  }
-}
-
 /**
  * All file reads come through here just to make sure all of them make sense
  * allows a centralised location to check logic is all good.

package/src/utilities/index.js

@@ -1,6 +1,8 @@
 const env = require("../environment")
 const { OBJ_STORE_DIRECTORY } = require("../constants")
 const { sanitizeKey } = require("@budibase/auth/src/objectStore")
+const CouchDB = require("../db")
+const { generateMetadataID } = require("../db/utils")
 
 const BB_CDN = "https://cdn.budi.live"
 
@@ -55,3 +57,52 @@ exports.attachmentsRelativeURL = attachmentKey => {
     `${exports.objectStoreUrl()}/${attachmentKey}`
   )
 }
+
+exports.updateEntityMetadata = async (appId, type, entityId, updateFn) => {
+  const db = new CouchDB(appId)
+  const id = generateMetadataID(type, entityId)
+  // read it to see if it exists, we'll overwrite it no matter what
+  let rev,
+    metadata = {}
+  try {
+    const oldMetadata = await db.get(id)
+    rev = oldMetadata._rev
+    metadata = updateFn(oldMetadata)
+  } catch (err) {
+    rev = null
+    metadata = updateFn({})
+  }
+  metadata._id = id
+  if (rev) {
+    metadata._rev = rev
+  }
+  const response = await db.put(metadata)
+  return {
+    ...metadata,
+    _id: id,
+    _rev: response.rev,
+  }
+}
+
+exports.saveEntityMetadata = async (appId, type, entityId, metadata) => {
+  return exports.updateEntityMetadata(appId, type, entityId, () => {
+    return metadata
+  })
+}
+
+exports.deleteEntityMetadata = async (appId, type, entityId) => {
+  const db = new CouchDB(appId)
+  const id = generateMetadataID(type, entityId)
+  let rev
+  try {
+    const metadata = await db.get(id)
+    if (metadata) {
+      rev = metadata._rev
+    }
+  } catch (err) {
+    // don't need to error if it doesn't exist
+  }
+  if (id && rev) {
+    await db.remove(id, rev)
+  }
+}

package/src/utilities/redis.js

@@ -2,20 +2,24 @@ const { Client, utils } = require("@budibase/auth/redis")
 const { getGlobalIDFromUserMetadataID } = require("../db/utils")
 
 const APP_DEV_LOCK_SECONDS = 600
-let devAppClient, debounceClient
+const AUTOMATION_TEST_FLAG_SECONDS = 60
+let devAppClient, debounceClient, flagClient
 
 // we init this as we want to keep the connection open all the time
 // reduces the performance hit
 exports.init = async () => {
   devAppClient = new Client(utils.Databases.DEV_LOCKS)
   debounceClient = new Client(utils.Databases.DEBOUNCE)
+  flagClient = new Client(utils.Databases.FLAGS)
   await devAppClient.init()
   await debounceClient.init()
+  await flagClient.init()
 }
 
 exports.shutdown = async () => {
   if (devAppClient) await devAppClient.finish()
   if (debounceClient) await debounceClient.finish()
+  if (flagClient) await flagClient.finish()
 }
 
 exports.doesUserHaveLock = async (devAppId, user) => {
@@ -67,3 +71,16 @@ exports.checkDebounce = async id => {
 exports.setDebounce = async (id, seconds) => {
   await debounceClient.store(id, "debouncing", seconds)
 }
+
+exports.setTestFlag = async id => {
+  await flagClient.store(id, { testing: true }, AUTOMATION_TEST_FLAG_SECONDS)
+}
+
+exports.checkTestFlag = async id => {
+  const flag = await flagClient.get(id)
+  return !!(flag && flag.testing)
+}
+
+exports.clearTestFlag = async id => {
+  await devAppClient.delete(id)
+}

package/src/utilities/rowProcessor/index.js

@@ -185,10 +185,16 @@ exports.inputProcessing = (user = {}, table, row) => {
  * @param {object} ctx the request which is looking for enriched rows.
  * @param {object} table the table from which these rows came from originally, this is used to determine
  * the schema of the rows and then enrich.
- * @param {object[]} rows the rows which are to be enriched.
- * @returns {object[]} the enriched rows will be returned.
+ * @param {object[]|object} rows the rows which are to be enriched.
+ * @param {object} opts used to set some options for the output, such as disabling relationship squashing.
+ * @returns {object[]|object} the enriched rows will be returned.
  */
-exports.outputProcessing = async (ctx, table, rows) => {
+exports.outputProcessing = async (
+  ctx,
+  table,
+  rows,
+  opts = { squash: true }
+) => {
   const appId = ctx.appId
   let wasArray = true
   if (!(rows instanceof Array)) {
@@ -214,6 +220,12 @@ exports.outputProcessing = async (ctx, table, rows) => {
       }
     }
   }
-  enriched = await linkRows.squashLinksToPrimaryDisplay(appId, table, enriched)
+  if (opts.squash) {
+    enriched = await linkRows.squashLinksToPrimaryDisplay(
+      appId,
+      table,
+      enriched
+    )
+  }
   return wasArray ? enriched : enriched[0]
 }

package/dist/automations/logic.js

@@ -1,17 +0,0 @@
-"use strict";
-let filter = require("./steps/filter");
-let delay = require("./steps/delay");
-let BUILTIN_LOGIC = {
-    DELAY: delay.run,
-    FILTER: filter.run,
-};
-let BUILTIN_DEFINITIONS = {
-    DELAY: delay.definition,
-    FILTER: filter.definition,
-};
-module.exports.getLogic = function (logicName) {
-    if (BUILTIN_LOGIC[logicName] != null) {
-        return BUILTIN_LOGIC[logicName];
-    }
-};
-module.exports.BUILTIN_DEFINITIONS = BUILTIN_DEFINITIONS;

package/dist/automations/steps/sendgridEmail.js

@@ -1,85 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-module.exports.definition = {
-    description: "Send an email using SendGrid",
-    tagline: "Send email to {{inputs.to}}",
-    icon: "ri-mail-open-line",
-    name: "Send Email (SendGrid)",
-    type: "ACTION",
-    stepId: "SEND_EMAIL",
-    inputs: {},
-    schema: {
-        inputs: {
-            properties: {
-                apiKey: {
-                    type: "string",
-                    title: "SendGrid API key",
-                },
-                to: {
-                    type: "string",
-                    title: "Send To",
-                },
-                from: {
-                    type: "string",
-                    title: "Send From",
-                },
-                subject: {
-                    type: "string",
-                    title: "Email Subject",
-                },
-                contents: {
-                    type: "string",
-                    title: "Email Contents",
-                },
-            },
-            required: ["to", "from", "subject", "contents"],
-        },
-        outputs: {
-            properties: {
-                success: {
-                    type: "boolean",
-                    description: "Whether the email was sent",
-                },
-                response: {
-                    type: "object",
-                    description: "A response from the email client, this may be an error",
-                },
-            },
-            required: ["success"],
-        },
-    },
-};
-module.exports.run = function ({ inputs }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const sgMail = require("@sendgrid/mail");
-        sgMail.setApiKey(inputs.apiKey);
-        const msg = {
-            to: inputs.to,
-            from: inputs.from,
-            subject: inputs.subject,
-            text: inputs.contents ? inputs.contents : "Empty",
-        };
-        try {
-            let response = yield sgMail.send(msg);
-            return {
-                success: true,
-                response,
-            };
-        }
-        catch (err) {
-            console.error(err);
-            return {
-                success: false,
-                response: err,
-            };
-        }
-    });
-};