@budibase/server 1.0.49-alpha.5 → 1.0.49-alpha.9

package/src/threads/automation.js

@@ -5,11 +5,11 @@ const automationUtils = require("../automations/automationUtils")
 const AutomationEmitter = require("../events/AutomationEmitter")
 const { processObject } = require("@budibase/string-templates")
 const { DEFAULT_TENANT_ID } = require("@budibase/backend-core/constants")
-const CouchDB = require("../db")
 const { DocumentTypes, isDevAppID } = require("../db/utils")
 const { doInTenant } = require("@budibase/backend-core/tenancy")
 const usage = require("../utilities/usageQuota")
 const { definitions: triggerDefs } = require("../automations/triggerInfo")
+const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
 
 const FILTER_STEP_ID = actions.ACTION_DEFINITIONS.FILTER.stepId
 const CRON_STEP_ID = triggerDefs.CRON.stepId
@@ -59,11 +59,10 @@ class Orchestrator {
   }
 
   async getApp() {
-    const appId = this._appId
     if (this._app) {
       return this._app
     }
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     this._app = await db.get(DocumentTypes.APP_METADATA)
     return this._app
   }
@@ -131,16 +130,19 @@ class Orchestrator {
 }
 
 module.exports = (input, callback) => {
-  const automationOrchestrator = new Orchestrator(
-    input.data.automation,
-    input.data.event
-  )
-  automationOrchestrator
-    .execute()
-    .then(response => {
-      callback(null, response)
-    })
-    .catch(err => {
-      callback(err)
-    })
+  const appId = input.data.event.appId
+  doInAppContext(appId, () => {
+    const automationOrchestrator = new Orchestrator(
+      input.data.automation,
+      input.data.event
+    )
+    automationOrchestrator
+      .execute()
+      .then(response => {
+        callback(null, response)
+      })
+      .catch(err => {
+        callback(err)
+      })
+  })
 }

package/src/threads/query.js

@@ -3,14 +3,10 @@ threadUtils.threadSetup()
 const ScriptRunner = require("../utilities/scriptRunner")
 const { integrations } = require("../integrations")
 const { processStringSync } = require("@budibase/string-templates")
-const CouchDB = require("../db")
-
-const IS_TRIPLE_BRACE = new RegExp(/^{{3}.*}{3}$/)
-const IS_HANDLEBARS = new RegExp(/^{{2}.*}{2}$/)
+const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
 
 class QueryRunner {
   constructor(input, flags = { noRecursiveQuery: false }) {
-    this.appId = input.appId
     this.datasource = input.datasource
     this.queryVerb = input.queryVerb
     this.fields = input.fields
@@ -104,12 +100,11 @@ class QueryRunner {
   }
 
   async runAnotherQuery(queryId, parameters) {
-    const db = new CouchDB(this.appId)
+    const db = getAppDB()
     const query = await db.get(queryId)
     const datasource = await db.get(query.datasourceId)
     return new QueryRunner(
       {
-        appId: this.appId,
         datasource,
         queryVerb: query.queryVerb,
         fields: query.fields,
@@ -190,12 +185,8 @@ class QueryRunner {
         enrichedQuery[key] = this.enrichQueryFields(fields[key], parameters)
       } else if (typeof fields[key] === "string") {
         // enrich string value as normal
-        let value = fields[key]
-        // add triple brace to avoid escaping e.g. '=' in cookie header
-        if (IS_HANDLEBARS.test(value) && !IS_TRIPLE_BRACE.test(value)) {
-          value = `{${value}}`
-        }
-        enrichedQuery[key] = processStringSync(value, parameters, {
+        enrichedQuery[key] = processStringSync(fields[key], parameters, {
+          noEscaping: true,
           noHelpers: true,
         })
       } else {
@@ -223,12 +214,14 @@ class QueryRunner {
 }
 
 module.exports = (input, callback) => {
-  const Runner = new QueryRunner(input)
-  Runner.execute()
-    .then(response => {
-      callback(null, response)
-    })
-    .catch(err => {
-      callback(err)
-    })
+  doInAppContext(input.appId, () => {
+    const Runner = new QueryRunner(input)
+    Runner.execute()
+      .then(response => {
+        callback(null, response)
+      })
+      .catch(err => {
+        callback(err)
+      })
+  })
 }

package/src/utilities/fileSystem/index.js

@@ -1,5 +1,4 @@
 const { budibaseTempDir } = require("../budibaseDir")
-const { isDev } = require("../index")
 const fs = require("fs")
 const { join } = require("path")
 const uuid = require("uuid/v4")
@@ -20,6 +19,7 @@ const {
   LINK_USER_METADATA_PREFIX,
 } = require("../../db/utils")
 const MemoryStream = require("memorystream")
+const { getAppId } = require("@budibase/backend-core/context")
 
 const TOP_LEVEL_PATH = join(__dirname, "..", "..", "..")
 const NODE_MODULES_PATH = join(TOP_LEVEL_PATH, "node_modules")
@@ -51,7 +51,7 @@ exports.init = () => {
  * everything required to function is ready.
  */
 exports.checkDevelopmentEnvironment = () => {
-  if (!isDev()) {
+  if (!env.isDev() || env.isTest()) {
     return
   }
   if (!fs.existsSync(budibaseTempDir())) {
@@ -251,7 +251,8 @@ exports.downloadTemplate = async (type, name) => {
 /**
  * Retrieves component libraries from object store (or tmp symlink if in local)
  */
-exports.getComponentLibraryManifest = async (appId, library) => {
+exports.getComponentLibraryManifest = async library => {
+  const appId = getAppId()
   const filename = "manifest.json"
   /* istanbul ignore next */
   // when testing in cypress and so on we need to get the package

package/src/utilities/global.js

@@ -3,7 +3,7 @@ const {
   getGlobalIDFromUserMetadataID,
 } = require("../db/utils")
 const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
-const { getDeployedAppID } = require("@budibase/backend-core/db")
+const { getProdAppID } = require("@budibase/backend-core/db")
 const { getGlobalUserParams } = require("@budibase/backend-core/db")
 const { user: userCache } = require("@budibase/backend-core/cache")
 const {
@@ -11,8 +11,10 @@ const {
   isUserInAppTenant,
 } = require("@budibase/backend-core/tenancy")
 const env = require("../environment")
+const { getAppId } = require("@budibase/backend-core/context")
 
-exports.updateAppRole = (appId, user) => {
+exports.updateAppRole = (user, { appId } = {}) => {
+  appId = appId || getAppId()
   if (!user || !user.roles) {
     return user
   }
@@ -24,7 +26,7 @@ exports.updateAppRole = (appId, user) => {
     return user
   }
   // always use the deployed app
-  user.roleId = user.roles[getDeployedAppID(appId)]
+  user.roleId = user.roles[getProdAppID(appId)]
   // if a role wasn't found then either set as admin (builder) or public (everyone else)
   if (!user.roleId && user.builder && user.builder.global) {
     user.roleId = BUILTIN_ROLE_IDS.ADMIN
@@ -35,18 +37,18 @@ exports.updateAppRole = (appId, user) => {
   return user
 }
 
-function processUser(appId, user) {
+function processUser(user, { appId } = {}) {
   if (user) {
     delete user.password
   }
-  return exports.updateAppRole(appId, user)
+  return exports.updateAppRole(user, { appId })
 }
 
 exports.getCachedSelf = async (ctx, appId) => {
   // this has to be tenant aware, can't depend on the context to find it out
   // running some middlewares before the tenancy causes context to break
   const user = await userCache.getUser(ctx.user._id)
-  return processUser(appId, user)
+  return processUser(user, { appId })
 }
 
 exports.getRawGlobalUser = async userId => {
@@ -54,12 +56,13 @@ exports.getRawGlobalUser = async userId => {
   return db.get(getGlobalIDFromUserMetadataID(userId))
 }
 
-exports.getGlobalUser = async (appId, userId) => {
+exports.getGlobalUser = async userId => {
   let user = await exports.getRawGlobalUser(userId)
-  return processUser(appId, user)
+  return processUser(user)
 }
 
-exports.getGlobalUsers = async (appId = null, users = null) => {
+exports.getGlobalUsers = async (users = null) => {
+  const appId = getAppId()
   const db = getGlobalDB()
   let globalUsers
   if (users) {
@@ -86,11 +89,11 @@ exports.getGlobalUsers = async (appId = null, users = null) => {
   if (!appId) {
     return globalUsers
   }
-  return globalUsers.map(user => exports.updateAppRole(appId, user))
+  return globalUsers.map(user => exports.updateAppRole(user))
 }
 
-exports.getGlobalUsersFromMetadata = async (appId, users) => {
-  const globalUsers = await exports.getGlobalUsers(appId, users)
+exports.getGlobalUsersFromMetadata = async users => {
+  const globalUsers = await exports.getGlobalUsers(users)
   return users.map(user => {
     const globalUser = globalUsers.find(
       globalUser => globalUser && user._id.includes(globalUser._id)

package/src/utilities/index.js

@@ -1,9 +1,9 @@
 const env = require("../environment")
 const { OBJ_STORE_DIRECTORY } = require("../constants")
 const { sanitizeKey } = require("@budibase/backend-core/objectStore")
-const CouchDB = require("../db")
 const { generateMetadataID } = require("../db/utils")
 const Readable = require("stream").Readable
+const { getAppDB } = require("@budibase/backend-core/context")
 
 const BB_CDN = "https://cdn.budi.live"
 
@@ -73,8 +73,8 @@ exports.attachmentsRelativeURL = attachmentKey => {
   )
 }
 
-exports.updateEntityMetadata = async (appId, type, entityId, updateFn) => {
-  const db = new CouchDB(appId)
+exports.updateEntityMetadata = async (type, entityId, updateFn) => {
+  const db = getAppDB()
   const id = generateMetadataID(type, entityId)
   // read it to see if it exists, we'll overwrite it no matter what
   let rev,
@@ -99,14 +99,14 @@ exports.updateEntityMetadata = async (appId, type, entityId, updateFn) => {
   }
 }
 
-exports.saveEntityMetadata = async (appId, type, entityId, metadata) => {
-  return exports.updateEntityMetadata(appId, type, entityId, () => {
+exports.saveEntityMetadata = async (type, entityId, metadata) => {
+  return exports.updateEntityMetadata(type, entityId, () => {
     return metadata
   })
 }
 
-exports.deleteEntityMetadata = async (appId, type, entityId) => {
-  const db = new CouchDB(appId)
+exports.deleteEntityMetadata = async (type, entityId) => {
+  const db = getAppDB()
   const id = generateMetadataID(type, entityId)
   let rev
   try {
@@ -141,16 +141,6 @@ exports.stringToReadStream = string => {
   })
 }
 
-exports.doesDatabaseExist = async dbName => {
-  try {
-    const db = new CouchDB(dbName, { skip_setup: true })
-    const info = await db.info()
-    return info && !info.error
-  } catch (err) {
-    return false
-  }
-}
-
 exports.formatBytes = bytes => {
   const units = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
   const byteIncrements = 1024

package/src/utilities/routing/index.js

@@ -1,9 +1,9 @@
-const CouchDB = require("../../db")
 const { createRoutingView } = require("../../db/views/staticViews")
 const { ViewNames, getQueryIndex, UNICODE_MAX } = require("../../db/utils")
+const { getAppDB } = require("@budibase/backend-core/context")
 
-exports.getRoutingInfo = async appId => {
-  const db = new CouchDB(appId)
+exports.getRoutingInfo = async () => {
+  const db = getAppDB()
   try {
     const allRouting = await db.query(getQueryIndex(ViewNames.ROUTING), {
       startKey: "",
@@ -14,8 +14,8 @@ exports.getRoutingInfo = async appId => {
     // check if the view doesn't exist, it should for all new instances
     /* istanbul ignore next */
     if (err != null && err.name === "not_found") {
-      await createRoutingView(appId)
-      return exports.getRoutingInfo(appId)
+      await createRoutingView()
+      return exports.getRoutingInfo()
     } else {
       throw err
     }

package/src/utilities/rowProcessor/index.js

@@ -7,10 +7,10 @@ const { deleteFiles } = require("../../utilities/fileSystem/utilities")
 const { ObjectStoreBuckets } = require("../../constants")
 const {
   isProdAppID,
-  getDeployedAppID,
+  getProdAppID,
   dbExists,
 } = require("@budibase/backend-core/db")
-const CouchDB = require("../../db")
+const { getAppId } = require("@budibase/backend-core/context")
 
 const BASE_AUTO_ID = 1
 
@@ -253,26 +253,20 @@ exports.inputProcessing = (
 /**
  * This function enriches the input rows with anything they are supposed to contain, for example
  * link records or attachment links.
- * @param {string} appId the app in which the request 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[]|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 (
-  { appId },
-  table,
-  rows,
-  opts = { squash: true }
-) => {
+exports.outputProcessing = async (table, rows, opts = { squash: true }) => {
   let wasArray = true
   if (!(rows instanceof Array)) {
     rows = [rows]
     wasArray = false
   }
   // attach any linked row information
-  let enriched = await linkRows.attachFullLinkedDocs(appId, table, rows)
+  let enriched = await linkRows.attachFullLinkedDocs(table, rows)
 
   // process formulas
   enriched = processFormulas(table, enriched, { dynamic: true })
@@ -291,18 +285,13 @@ exports.outputProcessing = async (
     }
   }
   if (opts.squash) {
-    enriched = await linkRows.squashLinksToPrimaryDisplay(
-      appId,
-      table,
-      enriched
-    )
+    enriched = await linkRows.squashLinksToPrimaryDisplay(table, enriched)
   }
   return wasArray ? enriched : enriched[0]
 }
 
 /**
  * Clean up any attachments that were attached to a row.
- * @param {string} appId The ID of the app from which a row is being deleted.
  * @param {object} table The table from which a row is being removed.
  * @param {any} row optional - the row being removed.
  * @param {any} rows optional - if multiple rows being deleted can do this in bulk.
@@ -311,15 +300,12 @@ exports.outputProcessing = async (
  * deleted attachment columns.
  * @return {Promise<void>} When all attachments have been removed this will return.
  */
-exports.cleanupAttachments = async (
-  appId,
-  table,
-  { row, rows, oldRow, oldTable }
-) => {
+exports.cleanupAttachments = async (table, { row, rows, oldRow, oldTable }) => {
+  const appId = getAppId()
   if (!isProdAppID(appId)) {
-    const prodAppId = getDeployedAppID(appId)
+    const prodAppId = getProdAppID(appId)
     // if prod exists, then don't allow deleting
-    const exists = await dbExists(CouchDB, prodAppId)
+    const exists = await dbExists(prodAppId)
     if (exists) {
       return
     }

package/src/utilities/usageQuota/index.js

@@ -52,6 +52,7 @@ exports.getUsageQuotaDoc = async db => {
  * Given a specified tenantId this will add to the usage object for the specified property.
  * @param {string} property The property which is to be added to (within the nested usageQuota object).
  * @param {number} usage The amount (this can be negative) to adjust the number by.
+ * @param {object} opts optional - options such as dryRun, to check what update will do.
  * @returns {Promise<void>} When this completes the API key will now be up to date - the quota period may have
  * also been reset after this call.
  */

package/src/utilities/usageQuota/rows.js

@@ -23,6 +23,7 @@ const getAppPairs = appIds => {
 }
 
 const getAppRows = async appId => {
+  // need to specify the app ID, as this is used for different apps in one call
   const appDb = new CouchDB(appId)
   const response = await appDb.allDocs(
     getRowParams(null, null, {

package/src/utilities/users.js

@@ -1,13 +1,13 @@
-const CouchDB = require("../db")
 const { InternalTables } = require("../db/utils")
 const { getGlobalUser } = require("../utilities/global")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 exports.getFullUser = async (ctx, userId) => {
-  const global = await getGlobalUser(ctx.appId, userId)
+  const global = await getGlobalUser(userId)
   let metadata
   try {
     // this will throw an error if the db doesn't exist, or there is no appId
-    const db = new CouchDB(ctx.appId)
+    const db = getAppDB()
     metadata = await db.get(userId)
   } catch (err) {
     // it is fine if there is no user metadata, just remove global db info

package/src/utilities/workerRequests.js

@@ -1,7 +1,7 @@
 const fetch = require("node-fetch")
 const env = require("../environment")
 const { checkSlashesInUrl } = require("./index")
-const { getDeployedAppID } = require("@budibase/backend-core/db")
+const { getProdAppID } = require("@budibase/backend-core/db")
 const { updateAppRole } = require("./global")
 const { Headers } = require("@budibase/backend-core/constants")
 const { getTenantId, isTenantIdSet } = require("@budibase/backend-core/tenancy")
@@ -70,15 +70,15 @@ exports.getGlobalSelf = async (ctx, appId = null) => {
   }
   let json = await response.json()
   if (appId) {
-    json = updateAppRole(appId, json)
+    json = updateAppRole(json)
   }
   return json
 }
 
 exports.removeAppFromUserRoles = async (ctx, appId) => {
-  const deployedAppId = getDeployedAppID(appId)
+  const prodAppId = getProdAppID(appId)
   const response = await fetch(
-    checkSlashesInUrl(env.WORKER_URL + `/api/global/roles/${deployedAppId}`),
+    checkSlashesInUrl(env.WORKER_URL + `/api/global/roles/${prodAppId}`),
     request(ctx, {
       method: "DELETE",
     })

package/tsconfig.json

@@ -12,7 +12,8 @@
     "incremental": true
   },
   "include": [
-    "./src/**/*"
+    "./src/**/*",
+    "./src/module.d.ts"
   ],
   "exclude": [
     "node_modules",