@budibase/server 1.0.49-alpha.2 → 1.0.49-alpha.6

package/src/automations/triggers.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../db")
 const emitter = require("../events/index")
 const { getAutomationParams } = require("../db/utils")
 const { coerce } = require("../utilities/rowProcessor")
@@ -9,6 +8,7 @@ const { queue } = require("./bullboard")
 const { checkTestFlag } = require("../utilities/redis")
 const utils = require("./utils")
 const env = require("../environment")
+const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
 
 const TRIGGER_DEFINITIONS = definitions
 const JOB_OPTS = {
@@ -21,39 +21,41 @@ async function queueRelevantRowAutomations(event, eventType) {
     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 })
-  )
+  doInAppContext(event.appId, async () => {
+    const db = getAppDB()
+    let automations = await db.allDocs(
+      getAutomationParams(null, { include_docs: true })
+    )
 
-  // filter down to the correct event type
-  automations = automations.rows
-    .map(automation => automation.doc)
-    .filter(automation => {
-      const trigger = automation.definition.trigger
-      return trigger && trigger.event === eventType
-    })
+    // filter down to the correct event type
+    automations = automations.rows
+      .map(automation => automation.doc)
+      .filter(automation => {
+        const trigger = automation.definition.trigger
+        return trigger && trigger.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 (
-      !env.ALLOW_DEV_AUTOMATIONS &&
-      isDevAppID(event.appId) &&
-      !(await checkTestFlag(automation._id))
-    ) {
-      continue
+    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 (
+        !env.ALLOW_DEV_AUTOMATIONS &&
+        isDevAppID(event.appId) &&
+        !(await checkTestFlag(automation._id))
+      ) {
+        continue
+      }
+      if (
+        automationTrigger.inputs &&
+        automationTrigger.inputs.tableId === event.row.tableId
+      ) {
+        await queue.add({ automation, event }, JOB_OPTS)
+      }
     }
-    if (
-      automationTrigger.inputs &&
-      automationTrigger.inputs.tableId === event.row.tableId
-    ) {
-      await queue.add({ automation, event }, JOB_OPTS)
-    }
-  }
+  })
 }
 
 emitter.on("row:save", async function (event) {

package/src/automations/utils.js

@@ -6,8 +6,9 @@ const { queue } = require("./bullboard")
 const newid = require("../db/newid")
 const { updateEntityMetadata } = require("../utilities")
 const { MetadataTypes } = require("../constants")
-const { getDeployedAppID } = require("@budibase/backend-core/db")
+const { getProdAppID } = require("@budibase/backend-core/db")
 const { cloneDeep } = require("lodash/fp")
+const { getAppDB, getAppId } = require("@budibase/backend-core/context")
 
 const WH_STEP_ID = definitions.WEBHOOK.stepId
 const CRON_STEP_ID = definitions.CRON.stepId
@@ -27,7 +28,6 @@ exports.processEvent = async job => {
 
 exports.updateTestHistory = async (appId, automation, history) => {
   return updateEntityMetadata(
-    appId,
     MetadataTypes.AUTOMATION_TEST_HISTORY,
     automation._id,
     metadata => {
@@ -93,6 +93,9 @@ exports.enableCronTrigger = async (appId, automation) => {
     )
     // Assign cron job ID from bull so we can remove it later if the cron trigger is removed
     trigger.cronJobId = job.id
+    // can't use getAppDB here as this is likely to be called from dev app,
+    // but this call could be for dev app or prod app, need to just use what
+    // was passed in
     const db = new CouchDB(appId)
     const response = await db.put(automation)
     automation._id = response.id
@@ -109,7 +112,8 @@ exports.enableCronTrigger = async (appId, automation) => {
  * @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 }) => {
+exports.checkForWebhooks = async ({ oldAuto, newAuto }) => {
+  const appId = getAppId()
   const oldTrigger = oldAuto ? oldAuto.definition.trigger : null
   const newTrigger = newAuto ? newAuto.definition.trigger : null
   const triggerChanged =
@@ -128,7 +132,7 @@ exports.checkForWebhooks = async ({ appId, oldAuto, newAuto }) => {
     oldTrigger.webhookId
   ) {
     try {
-      let db = new CouchDB(appId)
+      let db = getAppDB()
       // need to get the webhook to get the rev
       const webhook = await db.get(oldTrigger.webhookId)
       const ctx = {
@@ -166,7 +170,7 @@ exports.checkForWebhooks = async ({ appId, oldAuto, newAuto }) => {
     // the app ID has to be development for this endpoint
     // it can only be used when building the app
     // but the trigger endpoint will always be used in production
-    const prodAppId = getDeployedAppID(appId)
+    const prodAppId = getProdAppID(appId)
     newTrigger.inputs = {
       schemaUrl: `api/webhooks/schema/${appId}/${id}`,
       triggerUrl: `api/webhooks/trigger/${prodAppId}/${id}`,

package/src/db/linkedRows/LinkController.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../index")
 const { IncludeDocs, getLinkDocuments } = require("./linkUtils")
 const {
   generateLinkID,
@@ -7,6 +6,7 @@ const {
 } = require("../utils")
 const Sentry = require("@sentry/node")
 const { FieldTypes, RelationshipTypes } = require("../../constants")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 /**
  * Creates a new link document structure which can be put to the database. It is important to
@@ -52,9 +52,8 @@ function LinkDocument(
 }
 
 class LinkController {
-  constructor({ appId, tableId, row, table, oldTable }) {
-    this._appId = appId
-    this._db = new CouchDB(appId)
+  constructor({ tableId, row, table, oldTable }) {
+    this._db = getAppDB()
     this._tableId = tableId
     this._row = row
     this._table = table
@@ -99,7 +98,6 @@ class LinkController {
    */
   getRowLinkDocs(rowId) {
     return getLinkDocuments({
-      appId: this._appId,
       tableId: this._tableId,
       rowId,
       includeDocs: IncludeDocs.INCLUDE,
@@ -111,7 +109,6 @@ class LinkController {
    */
   getTableLinkDocs() {
     return getLinkDocuments({
-      appId: this._appId,
       tableId: this._tableId,
       includeDocs: IncludeDocs.INCLUDE,
     })
@@ -230,7 +227,6 @@ class LinkController {
           if (linkedSchema.relationshipType === RelationshipTypes.ONE_TO_MANY) {
             let links = (
               await getLinkDocuments({
-                appId: this._appId,
                 tableId: field.tableId,
                 rowId: linkId,
                 includeDocs: IncludeDocs.EXCLUDE,

package/src/db/linkedRows/index.js

@@ -9,12 +9,12 @@ const {
   getLinkedTable,
 } = require("./linkUtils")
 const { flatten } = require("lodash")
-const CouchDB = require("../../db")
 const { FieldTypes } = require("../../constants")
 const { getMultiIDParams, USER_METDATA_PREFIX } = require("../../db/utils")
 const { partition } = require("lodash")
 const { getGlobalUsersFromMetadata } = require("../../utilities/global")
 const { processFormulas } = require("../../utilities/rowProcessor/utils")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 /**
  * This functionality makes sure that when rows with links are created, updated or deleted they are processed
@@ -48,14 +48,13 @@ function clearRelationshipFields(table, rows) {
   return rows
 }
 
-async function getLinksForRows(appId, rows) {
+async function getLinksForRows(rows) {
   const tableIds = [...new Set(rows.map(el => el.tableId))]
   // start by getting all the link values for performance reasons
   const responses = flatten(
     await Promise.all(
       tableIds.map(tableId =>
         getLinkDocuments({
-          appId,
           tableId: tableId,
           includeDocs: IncludeDocs.EXCLUDE,
         })
@@ -72,9 +71,9 @@ async function getLinksForRows(appId, rows) {
   )
 }
 
-async function getFullLinkedDocs(appId, links) {
+async function getFullLinkedDocs(links) {
   // create DBs
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   const linkedRowIds = links.map(link => link.id)
   const uniqueRowIds = [...new Set(linkedRowIds)]
   let dbRows = (await db.allDocs(getMultiIDParams(uniqueRowIds))).rows.map(
@@ -88,7 +87,7 @@ async function getFullLinkedDocs(appId, links) {
   let [users, other] = partition(linked, linkRow =>
     linkRow._id.startsWith(USER_METDATA_PREFIX)
   )
-  users = await getGlobalUsersFromMetadata(appId, users)
+  users = await getGlobalUsersFromMetadata(users)
   return [...other, ...users]
 }
 
@@ -96,20 +95,16 @@ async function getFullLinkedDocs(appId, links) {
  * Update link documents for a row or table - this is to be called by the API controller when a change is occurring.
  * @param {string} args.eventType states what type of change which is occurring, means this can be expanded upon in the
  * future quite easily (all updates go through one function).
- * @param {string} args.appId The ID of the instance in which the change is occurring.
  * @param {string} args.tableId The ID of the of the table which is being changed.
- * @param {object|null} args.row The row which is changing, e.g. created, updated or deleted.
- * @param {object|null} args.table If the table has already been retrieved this can be used to reduce database gets.
- * @param {object|null} args.oldTable If the table is being updated then the old table can be provided for differencing.
+ * @param {object|undefined} args.row The row which is changing, e.g. created, updated or deleted.
+ * @param {object|undefined} args.table If the table has already been retrieved this can be used to reduce database gets.
+ * @param {object|undefined} args.oldTable If the table is being updated then the old table can be provided for differencing.
  * @returns {Promise<object>} When the update is complete this will respond successfully. Returns the row for
  * row operations and the table for table operations.
  */
 exports.updateLinks = async function (args) {
-  const { eventType, appId, row, tableId, table, oldTable } = args
+  const { eventType, row, tableId, table, oldTable } = args
   const baseReturnObj = row == null ? table : row
-  if (appId == null) {
-    throw "Cannot operate without an instance ID."
-  }
   // make sure table ID is set
   if (tableId == null && table != null) {
     args.tableId = table._id
@@ -146,26 +141,23 @@ exports.updateLinks = async function (args) {
 /**
  * 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).
- * @param {string} appId The ID of the app which this request is in the context of.
  * @param {object} table The table from which the rows originated.
  * @param {array<object>} rows The rows which are to be enriched.
  * @return {Promise<*>} returns the rows with all of the enriched relationships on it.
  */
-exports.attachFullLinkedDocs = async (appId, table, rows) => {
+exports.attachFullLinkedDocs = async (table, rows) => {
   const linkedTableIds = getLinkedTableIDs(table)
   if (linkedTableIds.length === 0) {
     return rows
   }
-  // create DBs
-  const db = new CouchDB(appId)
   // get all the links
-  const links = (await getLinksForRows(appId, rows)).filter(link =>
+  const links = (await getLinksForRows(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(appId, links)
+  let linked = await getFullLinkedDocs(links)
   const linkedTables = []
   for (let row of rows) {
     for (let link of links.filter(link => link.thisId === row._id)) {
@@ -176,11 +168,7 @@ exports.attachFullLinkedDocs = async (appId, table, rows) => {
       if (linkedRow) {
         const linkedTableId =
           linkedRow.tableId || getRelatedTableForField(table, link.fieldName)
-        const linkedTable = await getLinkedTable(
-          db,
-          linkedTableId,
-          linkedTables
-        )
+        const linkedTable = await getLinkedTable(linkedTableId, linkedTables)
         if (linkedTable) {
           row[link.fieldName].push(processFormulas(linkedTable, linkedRow))
         }
@@ -192,18 +180,16 @@ exports.attachFullLinkedDocs = async (appId, table, rows) => {
 
 /**
  * This function will take the given enriched rows and squash the links to only contain the primary display field.
- * @param {string} appId The app in which the tables/rows/links exist.
  * @param {object} table The table from which the rows originated.
  * @param {array<object>} enriched The pre-enriched rows (full docs) which are to be squashed.
  * @returns {Promise<Array>} The rows after having their links squashed to only contain the ID and primary display.
  */
-exports.squashLinksToPrimaryDisplay = async (appId, table, enriched) => {
-  const db = new CouchDB(appId)
+exports.squashLinksToPrimaryDisplay = async (table, enriched) => {
   // will populate this as we find them
   const linkedTables = [table]
   for (let row of enriched) {
     // this only fetches the table if its not already in array
-    const rowTable = await getLinkedTable(db, row.tableId, linkedTables)
+    const rowTable = await getLinkedTable(row.tableId, linkedTables)
     for (let [column, schema] of Object.entries(rowTable.schema)) {
       if (schema.type !== FieldTypes.LINK || !Array.isArray(row[column])) {
         continue
@@ -211,7 +197,7 @@ exports.squashLinksToPrimaryDisplay = async (appId, table, enriched) => {
       const newLinks = []
       for (let link of row[column]) {
         const linkTblId = link.tableId || getRelatedTableForField(table, column)
-        const linkedTable = await getLinkedTable(db, linkTblId, linkedTables)
+        const linkedTable = await getLinkedTable(linkTblId, linkedTables)
         const obj = { _id: link._id }
         if (link[linkedTable.primaryDisplay]) {
           obj.primaryDisplay = link[linkedTable.primaryDisplay]

package/src/db/linkedRows/linkUtils.js

@@ -1,8 +1,8 @@
-const CouchDB = require("../index")
 const Sentry = require("@sentry/node")
 const { ViewNames, getQueryIndex } = require("../utils")
 const { FieldTypes } = require("../../constants")
 const { createLinkView } = require("../views/staticViews")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 /**
  * Only needed so that boolean parameters are being used for includeDocs
@@ -17,7 +17,6 @@ exports.createLinkView = createLinkView
 
 /**
  * Gets the linking documents, not the linked documents themselves.
- * @param {string} args.appId The instance in which we are searching for linked rows.
  * @param {string} args.tableId The table which we are searching for linked rows against.
  * @param {string|null} args.fieldName The name of column/field which is being altered, only looking for
  * linking documents that are related to it. If this is not specified then the table level will be assumed.
@@ -30,8 +29,8 @@ exports.createLinkView = createLinkView
  * (if any).
  */
 exports.getLinkDocuments = async function (args) {
-  const { appId, tableId, rowId, includeDocs } = args
-  const db = new CouchDB(appId)
+  const { tableId, rowId, includeDocs } = args
+  const db = getAppDB()
   let params
   if (rowId != null) {
     params = { key: [tableId, rowId] }
@@ -68,7 +67,7 @@ exports.getLinkDocuments = async function (args) {
   } catch (err) {
     // check if the view doesn't exist, it should for all new instances
     if (err != null && err.name === "not_found") {
-      await exports.createLinkView(appId)
+      await exports.createLinkView()
       return exports.getLinkDocuments(arguments[0])
     } else {
       /* istanbul ignore next */
@@ -89,7 +88,8 @@ exports.getLinkedTableIDs = table => {
     .map(column => column.tableId)
 }
 
-exports.getLinkedTable = async (db, id, tables) => {
+exports.getLinkedTable = async (id, tables) => {
+  const db = getAppDB()
   let linkedTable = tables.find(table => table._id === id)
   if (linkedTable) {
     return linkedTable

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

@@ -20,7 +20,6 @@ describe("test the link controller", () => {
 
   function createLinkController(table, row = null, oldTable = null) {
     const linkConfig = {
-      appId: config.getAppId(),
       tableId: table._id,
       table,
     }

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

@@ -1,8 +1,8 @@
 const TestConfig = require("../../tests/utilities/TestConfiguration")
-const { basicTable, basicLinkedRow } = require("../../tests/utilities/structures")
+const { basicTable } = require("../../tests/utilities/structures")
 const linkUtils = require("../linkedRows/linkUtils")
-const links = require("../linkedRows")
 const CouchDB = require("../index")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 describe("test link functionality", () => {
   const config = new TestConfig(false)
@@ -11,18 +11,18 @@ describe("test link functionality", () => {
     let db, table
     beforeEach(async () => {
       await config.init()
-      db = new CouchDB(config.getAppId())
+      db = getAppDB()
       table = await config.createTable()
     })
 
     it("should be able to retrieve a linked table from a list", async () => {
-      const retrieved = await linkUtils.getLinkedTable(db, table._id, [table])
+      const retrieved = await linkUtils.getLinkedTable(table._id, [table])
       expect(retrieved._id).toBe(table._id)
     })
 
     it("should be able to retrieve a table from DB and update list", async () => {
       const tables = []
-      const retrieved = await linkUtils.getLinkedTable(db, table._id, tables)
+      const retrieved = await linkUtils.getLinkedTable(table._id, tables)
       expect(retrieved._id).toBe(table._id)
       expect(tables[0]).toBeDefined()
     })
@@ -51,7 +51,6 @@ describe("test link functionality", () => {
       const db = new CouchDB("test")
       await db.put({ _id: "_design/database", views: {} })
       const output = await linkUtils.getLinkDocuments({
-        appId: "test",
         tableId: "test",
         rowId: "test",
         includeDocs: false,

package/src/db/views/staticViews.js

@@ -1,4 +1,4 @@
-const CouchDB = require("../index")
+const { getAppDB } = require("@budibase/backend-core/context")
 const {
   DocumentTypes,
   SEPARATOR,
@@ -21,12 +21,11 @@ const SCREEN_PREFIX = DocumentTypes.SCREEN + SEPARATOR
 /**
  * Creates the link view for the instance, this will overwrite the existing one, but this should only
  * be called if it is found that the view does not exist.
- * @param {string} appId The instance to which the view should be added.
  * @returns {Promise<void>} The view now exists, please note that the next view of this query will actually build it,
  * so it may be slow.
  */
-exports.createLinkView = async appId => {
-  const db = new CouchDB(appId)
+exports.createLinkView = async () => {
+  const db = getAppDB()
   const designDoc = await db.get("_design/database")
   const view = {
     map: function (doc) {
@@ -57,8 +56,8 @@ exports.createLinkView = async appId => {
   await db.put(designDoc)
 }
 
-exports.createRoutingView = async appId => {
-  const db = new CouchDB(appId)
+exports.createRoutingView = async () => {
+  const db = getAppDB()
   const designDoc = await db.get("_design/database")
   const view = {
     // if using variables in a map function need to inject them before use
@@ -78,8 +77,8 @@ exports.createRoutingView = async appId => {
   await db.put(designDoc)
 }
 
-async function searchIndex(appId, indexName, fnString) {
-  const db = new CouchDB(appId)
+async function searchIndex(indexName, fnString) {
+  const db = getAppDB()
   const designDoc = await db.get("_design/database")
   designDoc.indexes = {
     [indexName]: {
@@ -90,9 +89,8 @@ async function searchIndex(appId, indexName, fnString) {
   await db.put(designDoc)
 }
 
-exports.createAllSearchIndex = async appId => {
+exports.createAllSearchIndex = async () => {
   await searchIndex(
-    appId,
     SearchIndexes.ROWS,
     function (doc) {
       function idx(input, prev) {

package/src/environment.js

@@ -2,7 +2,8 @@ function isTest() {
   return (
     process.env.NODE_ENV === "jest" ||
     process.env.NODE_ENV === "cypress" ||
-    process.env.JEST_WORKER_ID != null
+    (process.env.JEST_WORKER_ID != null &&
+      process.env.JEST_WORKER_ID !== "null")
   )
 }
 

package/src/integrations/utils.ts

@@ -52,7 +52,10 @@ export function buildExternalTableId(datasourceId: string, tableName: string) {
   return `${datasourceId}${DOUBLE_SEPARATOR}${tableName}`
 }
 
-export function breakExternalTableId(tableId: string) {
+export function breakExternalTableId(tableId: string | undefined) {
+  if (!tableId) {
+    return {}
+  }
   const parts = tableId.split(DOUBLE_SEPARATOR)
   let tableName = parts.pop()
   // if they need joined

package/src/middleware/authorized.js

@@ -10,6 +10,7 @@ const {
 const builderMiddleware = require("./builder")
 const { isWebhookEndpoint } = require("./utils")
 const { buildCsrfMiddleware } = require("@budibase/backend-core/auth")
+const { getAppId } = require("@budibase/backend-core/context")
 
 function hasResource(ctx) {
   return ctx.resourceId != null
@@ -45,7 +46,7 @@ const checkAuthorizedResource = async (
 ) => {
   // get the user's roles
   const roleId = ctx.roleId || BUILTIN_ROLE_IDS.PUBLIC
-  const userRoles = await getUserRoleHierarchy(ctx.appId, roleId, {
+  const userRoles = await getUserRoleHierarchy(roleId, {
     idOnly: false,
   })
   const permError = "User does not have permission"
@@ -81,8 +82,9 @@ module.exports =
 
     // get the resource roles
     let resourceRoles = []
-    if (ctx.appId && hasResource(ctx)) {
-      resourceRoles = await getRequiredResourceRole(ctx.appId, permLevel, ctx)
+    const appId = getAppId()
+    if (appId && hasResource(ctx)) {
+      resourceRoles = await getRequiredResourceRole(permLevel, ctx)
     }
 
     // if the resource is public, proceed

package/src/middleware/builder.js

@@ -5,7 +5,7 @@ const {
   checkDebounce,
   setDebounce,
 } = require("../utilities/redis")
-const CouchDB = require("../db")
+const { getDB } = require("@budibase/backend-core/db")
 const { DocumentTypes } = require("../db/utils")
 const { PermissionTypes } = require("@budibase/backend-core/permissions")
 const { app: appCache } = require("@budibase/backend-core/cache")
@@ -48,7 +48,7 @@ async function updateAppUpdatedAt(ctx) {
   if (ctx.method === "GET" || (await checkDebounce(appId))) {
     return
   }
-  const db = new CouchDB(appId)
+  const db = getDB(appId)
   const metadata = await db.get(DocumentTypes.APP_METADATA)
   metadata.updatedAt = new Date().toISOString()
   const response = await db.put(metadata)