Final pass refactoring - need to test but all code in server converted.

packages/backend-core/context.js

@@ -4,6 +4,7 @@ const {
   getProdAppDB,
   getAppId,
   updateAppId,
+  doInAppContext,
 } = require("./src/tenancy/context")
 
 module.exports = {
@@ -12,4 +13,5 @@ module.exports = {
   getProdAppDB,
   getAppId,
   updateAppId,
+  doInAppContext,
 }

packages/backend-core/src/db/constants.js

@@ -32,3 +32,7 @@ exports.StaticDatabases = {
     },
   },
 }
+
+exports.APP_PREFIX = exports.DocumentTypes.APP + exports.SEPARATOR
+exports.APP_DEV = exports.APP_DEV_PREFIX =
+  exports.DocumentTypes.APP_DEV + exports.SEPARATOR

packages/backend-core/src/db/conversions.js

@@ -0,0 +1,46 @@
+const NO_APP_ERROR = "No app provided"
+const { APP_DEV_PREFIX, APP_PREFIX } = require("./constants")
+
+exports.isDevAppID = appId => {
+  if (!appId) {
+    throw NO_APP_ERROR
+  }
+  return appId.startsWith(APP_DEV_PREFIX)
+}
+
+exports.isProdAppID = appId => {
+  if (!appId) {
+    throw NO_APP_ERROR
+  }
+  return appId.startsWith(APP_PREFIX) && !exports.isDevAppID(appId)
+}
+
+exports.isDevApp = app => {
+  if (!app) {
+    throw NO_APP_ERROR
+  }
+  return exports.isDevAppID(app.appId)
+}
+
+/**
+ * Convert a development app ID to a deployed app ID.
+ */
+exports.getDeployedAppID = appId => {
+  // if dev, convert it
+  if (appId.startsWith(APP_DEV_PREFIX)) {
+    const id = appId.split(APP_DEV_PREFIX)[1]
+    return `${APP_PREFIX}${id}`
+  }
+  return appId
+}
+
+/**
+ * Convert a deployed app ID to a development app ID.
+ */
+exports.getDevelopmentAppID = appId => {
+  if (!appId.startsWith(APP_DEV_PREFIX)) {
+    const id = appId.split(APP_PREFIX)[1]
+    return `${APP_DEV_PREFIX}${id}`
+  }
+  return appId
+}

packages/backend-core/src/db/utils.js

@@ -2,7 +2,13 @@ const { newid } = require("../hashing")
 const Replication = require("./Replication")
 const { DEFAULT_TENANT_ID, Configs } = require("../constants")
 const env = require("../environment")
-const { StaticDatabases, SEPARATOR, DocumentTypes } = require("./constants")
+const {
+  StaticDatabases,
+  SEPARATOR,
+  DocumentTypes,
+  APP_PREFIX,
+  APP_DEV,
+} = require("./constants")
 const {
   getTenantId,
   getTenantIDFromAppID,
@@ -12,8 +18,13 @@ const fetch = require("node-fetch")
 const { getCouch } = require("./index")
 const { getAppMetadata } = require("../cache/appMetadata")
 const { checkSlashesInUrl } = require("../helpers")
-
-const NO_APP_ERROR = "No app provided"
+const {
+  isDevApp,
+  isProdAppID,
+  isDevAppID,
+  getDevelopmentAppID,
+  getDeployedAppID,
+} = require("./conversions")
 
 const UNICODE_MAX = "\ufff0"
 
@@ -24,10 +35,15 @@ exports.ViewNames = {
 exports.StaticDatabases = StaticDatabases
 
 exports.DocumentTypes = DocumentTypes
-exports.APP_PREFIX = DocumentTypes.APP + SEPARATOR
-exports.APP_DEV = exports.APP_DEV_PREFIX = DocumentTypes.APP_DEV + SEPARATOR
+exports.APP_PREFIX = APP_PREFIX
+exports.APP_DEV = exports.APP_DEV_PREFIX = APP_DEV
 exports.SEPARATOR = SEPARATOR
 exports.getTenantIDFromAppID = getTenantIDFromAppID
+exports.isDevApp = isDevApp
+exports.isProdAppID = isProdAppID
+exports.isDevAppID = isDevAppID
+exports.getDevelopmentAppID = getDevelopmentAppID
+exports.getDeployedAppID = getDeployedAppID
 
 /**
  * If creating DB allDocs/query params with only a single top level ID this can be used, this
@@ -52,27 +68,6 @@ function getDocParams(docType, docId = null, otherProps = {}) {
   }
 }
 
-exports.isDevAppID = appId => {
-  if (!appId) {
-    throw NO_APP_ERROR
-  }
-  return appId.startsWith(exports.APP_DEV_PREFIX)
-}
-
-exports.isProdAppID = appId => {
-  if (!appId) {
-    throw NO_APP_ERROR
-  }
-  return appId.startsWith(exports.APP_PREFIX) && !exports.isDevAppID(appId)
-}
-
-function isDevApp(app) {
-  if (!app) {
-    throw NO_APP_ERROR
-  }
-  return exports.isDevAppID(app.appId)
-}
-
 /**
  * Generates a new workspace ID.
  * @returns {string} The new workspace ID which the workspace doc can be stored under.
@@ -157,29 +152,6 @@ exports.getRoleParams = (roleId = null, otherProps = {}) => {
   return getDocParams(DocumentTypes.ROLE, roleId, otherProps)
 }
 
-/**
- * Convert a development app ID to a deployed app ID.
- */
-exports.getDeployedAppID = appId => {
-  // if dev, convert it
-  if (appId.startsWith(exports.APP_DEV_PREFIX)) {
-    const id = appId.split(exports.APP_DEV_PREFIX)[1]
-    return `${exports.APP_PREFIX}${id}`
-  }
-  return appId
-}
-
-/**
- * Convert a deployed app ID to a development app ID.
- */
-exports.getDevelopmentAppID = appId => {
-  if (!appId.startsWith(exports.APP_DEV_PREFIX)) {
-    const id = appId.split(exports.APP_PREFIX)[1]
-    return `${exports.APP_DEV_PREFIX}${id}`
-  }
-  return appId
-}
-
 exports.getCouchUrl = () => {
   if (!env.COUCH_DB_URL) return
 

packages/backend-core/src/tenancy/context.js

@@ -2,7 +2,7 @@ const env = require("../environment")
 const { Headers } = require("../../constants")
 const cls = require("./FunctionContext")
 const { getCouch } = require("../db")
-const { getDeployedAppID, getDevelopmentAppID } = require("../db/utils")
+const { getDeployedAppID, getDevelopmentAppID } = require("../db/conversions")
 const { isEqual } = require("lodash")
 
 // some test cases call functions directly, need to
@@ -42,6 +42,16 @@ exports.doInTenant = (tenantId, task) => {
   })
 }
 
+exports.doInAppContext = (appId, task) => {
+  return cls.run(() => {
+    // set the app ID
+    cls.setOnContext(ContextKeys.APP_ID, appId)
+
+    // invoke the task
+    return task()
+  })
+}
+
 exports.updateTenantId = tenantId => {
   cls.setOnContext(ContextKeys.TENANT_ID, tenantId)
 }

packages/server/src/api/controllers/auth.js

@@ -1,11 +1,10 @@
-const CouchDB = require("../../db")
 const { outputProcessing } = require("../../utilities/rowProcessor")
 const { InternalTables } = require("../../db/utils")
 const { getFullUser } = require("../../utilities/users")
 const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
+const { getAppDB, getAppId } = require("@budibase/backend-core/context")
 
 exports.fetchSelf = async ctx => {
-  const appId = ctx.appId
   let userId = ctx.user.userId || ctx.user._id
   /* istanbul ignore next */
   if (!userId) {
@@ -17,8 +16,8 @@ exports.fetchSelf = async ctx => {
   // this shouldn't be returned by the app self
   delete user.roles
 
-  if (appId) {
-    const db = new CouchDB(appId)
+  if (getAppId()) {
+    const db = getAppDB()
     // remove the full roles structure
     delete user.roles
     try {

packages/server/src/api/controllers/automation.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../../db")
 const actions = require("../../automations/actions")
 const triggers = require("../../automations/triggers")
 const { getAutomationParams, generateAutomationID } = require("../../db/utils")
@@ -10,6 +9,7 @@ const {
 const { deleteEntityMetadata } = require("../../utilities")
 const { MetadataTypes } = require("../../constants")
 const { setTestFlag, clearTestFlag } = require("../../utilities/redis")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 const ACTION_DEFS = removeDeprecated(actions.ACTION_DEFINITIONS)
 const TRIGGER_DEFS = removeDeprecated(triggers.TRIGGER_DEFINITIONS)
@@ -20,14 +20,9 @@ const TRIGGER_DEFS = removeDeprecated(triggers.TRIGGER_DEFINITIONS)
  *                       *
  *************************/
 
-async function cleanupAutomationMetadata(appId, automationId) {
+async function cleanupAutomationMetadata(automationId) {
+  await deleteEntityMetadata(MetadataTypes.AUTOMATION_TEST_INPUT, automationId)
   await deleteEntityMetadata(
-    appId,
-    MetadataTypes.AUTOMATION_TEST_INPUT,
-    automationId
-  )
-  await deleteEntityMetadata(
-    appId,
     MetadataTypes.AUTOMATION_TEST_HISTORY,
     automationId
   )
@@ -58,7 +53,7 @@ function cleanAutomationInputs(automation) {
 }
 
 exports.create = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   let automation = ctx.request.body
   automation.appId = ctx.appId
 
@@ -72,7 +67,6 @@ exports.create = async function (ctx) {
   automation.type = "automation"
   automation = cleanAutomationInputs(automation)
   automation = await checkForWebhooks({
-    appId: ctx.appId,
     newAuto: automation,
   })
   const response = await db.put(automation)
@@ -89,13 +83,12 @@ exports.create = async function (ctx) {
 }
 
 exports.update = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   let automation = ctx.request.body
   automation.appId = ctx.appId
   const oldAutomation = await db.get(automation._id)
   automation = cleanAutomationInputs(automation)
   automation = await checkForWebhooks({
-    appId: ctx.appId,
     oldAuto: oldAutomation,
     newAuto: automation,
   })
@@ -131,7 +124,7 @@ exports.update = async function (ctx) {
 }
 
 exports.fetch = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const response = await db.allDocs(
     getAutomationParams(null, {
       include_docs: true,
@@ -141,20 +134,19 @@ exports.fetch = async function (ctx) {
 }
 
 exports.find = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   ctx.body = await db.get(ctx.params.id)
 }
 
 exports.destroy = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const automationId = ctx.params.id
   const oldAutomation = await db.get(automationId)
   await checkForWebhooks({
-    appId: ctx.appId,
     oldAuto: oldAutomation,
   })
   // delete metadata first
-  await cleanupAutomationMetadata(ctx.appId, automationId)
+  await cleanupAutomationMetadata(automationId)
   ctx.body = await db.remove(automationId, ctx.params.rev)
 }
 
@@ -180,12 +172,11 @@ module.exports.getDefinitionList = async function (ctx) {
  *********************/
 
 exports.trigger = async function (ctx) {
-  const appId = ctx.appId
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   let automation = await db.get(ctx.params.id)
   await triggers.externalTrigger(automation, {
     ...ctx.request.body,
-    appId,
+    appId: ctx.appId,
   })
   ctx.body = {
     message: `Automation ${automation._id} has been triggered.`,
@@ -205,8 +196,7 @@ function prepareTestInput(input) {
 }
 
 exports.test = async function (ctx) {
-  const appId = ctx.appId
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   let automation = await db.get(ctx.params.id)
   await setTestFlag(automation._id)
   const testInput = prepareTestInput(ctx.request.body)
@@ -214,7 +204,7 @@ exports.test = async function (ctx) {
     automation,
     {
       ...testInput,
-      appId,
+      appId: ctx.appId,
     },
     { getResponses: true }
   )

packages/server/src/api/controllers/deploy/Deployment.js

@@ -1,18 +1,14 @@
 const newid = require("../../../db/newid")
+const { getAppId } = require("@budibase/backend-core/context")
 
 /**
  * This is used to pass around information about the deployment that is occurring
  */
 class Deployment {
-  constructor(appId, id = null) {
-    this.appId = appId
+  constructor(id = null) {
     this._id = id || newid()
   }
 
-  getAppId() {
-    return this.appId
-  }
-
   setVerification(verification) {
     if (!verification) {
       return
@@ -43,7 +39,7 @@ class Deployment {
   getJSON() {
     const obj = {
       _id: this._id,
-      appId: this.appId,
+      appId: getAppId(),
       status: this.status,
     }
     if (this.err) {

packages/server/src/api/controllers/deploy/index.js

@@ -1,12 +1,20 @@
-const CouchDB = require("../../../db")
 const Deployment = require("./Deployment")
-const { Replication, getDeployedAppID } = require("@budibase/backend-core/db")
+const {
+  Replication,
+  getDeployedAppID,
+  getDevelopmentAppID,
+} = require("@budibase/backend-core/db")
 const { DocumentTypes, getAutomationParams } = require("../../../db/utils")
 const {
   disableAllCrons,
   enableCronTrigger,
 } = require("../../../automations/utils")
 const { app: appCache } = require("@budibase/backend-core/cache")
+const {
+  getAppId,
+  getAppDB,
+  getProdAppDB,
+} = require("@budibase/backend-core/context")
 
 // the max time we can wait for an invalidation to complete before considering it failed
 const MAX_PENDING_TIME_MS = 30 * 60000
@@ -34,9 +42,8 @@ async function checkAllDeployments(deployments) {
 }
 
 async function storeDeploymentHistory(deployment) {
-  const appId = deployment.getAppId()
   const deploymentJSON = deployment.getJSON()
-  const db = new CouchDB(appId)
+  const db = getAppDB()
 
   let deploymentDoc
   try {
@@ -64,7 +71,7 @@ async function storeDeploymentHistory(deployment) {
 }
 
 async function initDeployedApp(prodAppId) {
-  const db = new CouchDB(prodAppId)
+  const db = getProdAppDB()
   console.log("Reading automation docs")
   const automations = (
     await db.allDocs(
@@ -88,10 +95,12 @@ async function initDeployedApp(prodAppId) {
 
 async function deployApp(deployment) {
   try {
-    const productionAppId = getDeployedAppID(deployment.appId)
+    const appId = getAppId()
+    const devAppId = getDevelopmentAppID(appId)
+    const productionAppId = getDeployedAppID(appId)
 
     const replication = new Replication({
-      source: deployment.appId,
+      source: devAppId,
       target: productionAppId,
     })
 
@@ -99,7 +108,7 @@ async function deployApp(deployment) {
 
     await replication.replicate()
     console.log("replication complete.. replacing app meta doc")
-    const db = new CouchDB(productionAppId)
+    const db = getProdAppDB()
     const appDoc = await db.get(DocumentTypes.APP_METADATA)
     appDoc.appId = productionAppId
     appDoc.instance._id = productionAppId
@@ -122,8 +131,7 @@ async function deployApp(deployment) {
 
 exports.fetchDeployments = async function (ctx) {
   try {
-    const appId = ctx.appId
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
     const { updated, deployments } = await checkAllDeployments(
       deploymentDoc,
@@ -140,8 +148,7 @@ exports.fetchDeployments = async function (ctx) {
 
 exports.deploymentProgress = async function (ctx) {
   try {
-    const appId = ctx.appId
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
     ctx.body = deploymentDoc[ctx.params.deploymentId]
   } catch (err) {
@@ -153,7 +160,7 @@ exports.deploymentProgress = async function (ctx) {
 }
 
 exports.deployApp = async function (ctx) {
-  let deployment = new Deployment(ctx.appId)
+  let deployment = new Deployment()
   console.log("Deployment object created")
   deployment.setStatus(DeploymentStatus.PENDING)
   console.log("Deployment object set to pending")

packages/server/src/api/controllers/dev.js

@@ -1,12 +1,12 @@
 const fetch = require("node-fetch")
-const CouchDB = require("../../db")
 const env = require("../../environment")
 const { checkSlashesInUrl } = require("../../utilities")
 const { request } = require("../../utilities/workerRequests")
 const { clearLock } = require("../../utilities/redis")
-const { Replication } = require("@budibase/backend-core/db")
+const { Replication, getDeployedAppID } = require("@budibase/backend-core/db")
 const { DocumentTypes } = require("../../db/utils")
 const { app: appCache } = require("@budibase/backend-core/cache")
+const { getProdAppDB, getAppDB } = require("@budibase/backend-core/context")
 
 async function redirect(ctx, method, path = "global") {
   const { devPath } = ctx.params
@@ -77,11 +77,11 @@ exports.clearLock = async ctx => {
 
 exports.revert = async ctx => {
   const { appId } = ctx.params
-  const productionAppId = appId.replace("_dev", "")
+  const productionAppId = getDeployedAppID(appId)
 
   // App must have been deployed first
   try {
-    const db = new CouchDB(productionAppId, { skip_setup: true })
+    const db = getProdAppDB({ skip_setup: true })
     const info = await db.info()
     if (info.error) throw info.error
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
@@ -103,7 +103,7 @@ exports.revert = async ctx => {
 
     await replication.rollback()
     // update appID in reverted app to be dev version again
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const appDoc = await db.get(DocumentTypes.APP_METADATA)
     appDoc.appId = appId
     appDoc.instance._id = appId

packages/server/src/api/controllers/metadata.js

@@ -1,7 +1,7 @@
 const { MetadataTypes } = require("../../constants")
-const CouchDB = require("../../db")
 const { generateMetadataID } = require("../../db/utils")
 const { saveEntityMetadata, deleteEntityMetadata } = require("../../utilities")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 exports.getTypes = async ctx => {
   ctx.body = {
@@ -14,17 +14,12 @@ exports.saveMetadata = async ctx => {
   if (type === MetadataTypes.AUTOMATION_TEST_HISTORY) {
     ctx.throw(400, "Cannot save automation history type")
   }
-  ctx.body = await saveEntityMetadata(
-    ctx.appId,
-    type,
-    entityId,
-    ctx.request.body
-  )
+  ctx.body = await saveEntityMetadata(type, entityId, ctx.request.body)
 }
 
 exports.deleteMetadata = async ctx => {
   const { type, entityId } = ctx.params
-  await deleteEntityMetadata(ctx.appId, type, entityId)
+  await deleteEntityMetadata(type, entityId)
   ctx.body = {
     message: "Metadata deleted successfully",
   }
@@ -32,7 +27,7 @@ exports.deleteMetadata = async ctx => {
 
 exports.getMetadata = async ctx => {
   const { type, entityId } = ctx.params
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const id = generateMetadataID(type, entityId)
   try {
     ctx.body = await db.get(id)

packages/server/src/api/controllers/query/import/index.ts

@@ -1,10 +1,11 @@
-import CouchDB from "../../../../db"
 import { queryValidation } from "../validation"
 import { generateQueryID } from "../../../../db/utils"
 import { ImportInfo, ImportSource } from "./sources/base"
 import { OpenAPI2 } from "./sources/openapi2"
 import { Query } from "./../../../../definitions/common"
 import { Curl } from "./sources/curl"
+// @ts-ignore
+import { getAppDB } from "@budibase/backend-core/context"
 interface ImportResult {
   errorQueries: Query[]
   queries: Query[]
@@ -34,7 +35,6 @@ export class RestImporter {
   }
 
   importQueries = async (
-    appId: string,
     datasourceId: string
   ): Promise<ImportResult> => {
     // constuct the queries
@@ -58,7 +58,7 @@ export class RestImporter {
       })
 
     // persist queries
-    const db = new CouchDB(appId)
+    const db = getAppDB()
     const response = await db.bulkDocs(queries)
 
     // create index to seperate queries and errors

packages/server/src/api/controllers/query/import/tests/index.spec.js

@@ -77,7 +77,7 @@ describe("Rest Importer", () => {
   const testImportQueries = async (key, data, assertions) => {
     await init(data)
     bulkDocs.mockReturnValue([])
-    const importResult = await restImporter.importQueries("appId", "datasourceId")
+    const importResult = await restImporter.importQueries("datasourceId")
     expect(importResult.errorQueries.length).toBe(0)
     expect(importResult.queries.length).toBe(assertions[key].count)
     expect(bulkDocs).toHaveBeenCalledTimes(1)

packages/server/src/api/controllers/query/index.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../../../db")
 const {
   generateQueryID,
   getQueryParams,
@@ -10,6 +9,7 @@ const { save: saveDatasource } = require("../datasource")
 const { RestImporter } = require("./import")
 const { invalidateDynamicVariables } = require("../../../threads/utils")
 const environment = require("../../../environment")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 const Runner = new Thread(ThreadType.QUERY, {
   timeoutMs: environment.QUERY_THREAD_TIMEOUT || 10000,
@@ -28,7 +28,7 @@ function enrichQueries(input) {
 }
 
 exports.fetch = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   const body = await db.allDocs(
     getQueryParams(null, {
@@ -69,7 +69,7 @@ exports.import = async ctx => {
     datasourceId = body.datasourceId
   }
 
-  const importResult = await importer.importQueries(ctx.appId, datasourceId)
+  const importResult = await importer.importQueries(datasourceId)
 
   ctx.body = {
     ...importResult,
@@ -79,7 +79,7 @@ exports.import = async ctx => {
 }
 
 exports.save = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const query = ctx.request.body
 
   if (!query._id) {
@@ -94,7 +94,7 @@ exports.save = async function (ctx) {
 }
 
 exports.find = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const query = enrichQueries(await db.get(ctx.params.queryId))
   // remove properties that could be dangerous in real app
   if (isProdAppID(ctx.appId)) {
@@ -105,7 +105,7 @@ exports.find = async function (ctx) {
 }
 
 exports.preview = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   const datasource = await db.get(ctx.request.body.datasourceId)
   // preview may not have a queryId as it hasn't been saved, but if it does
@@ -136,7 +136,7 @@ exports.preview = async function (ctx) {
 }
 
 async function execute(ctx, opts = { rowsOnly: false }) {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
 
   const query = await db.get(ctx.params.queryId)
   const datasource = await db.get(query.datasourceId)
@@ -181,7 +181,8 @@ exports.executeV2 = async function (ctx) {
   return execute(ctx, { rowsOnly: false })
 }
 
-const removeDynamicVariables = async (db, queryId) => {
+const removeDynamicVariables = async queryId => {
+  const db = getAppDB()
   const query = await db.get(queryId)
   const datasource = await db.get(query.datasourceId)
   const dynamicVariables = datasource.config.dynamicVariables
@@ -202,8 +203,8 @@ const removeDynamicVariables = async (db, queryId) => {
 }
 
 exports.destroy = async function (ctx) {
-  const db = new CouchDB(ctx.appId)
-  await removeDynamicVariables(db, ctx.params.queryId)
+  const db = getAppDB()
+  await removeDynamicVariables(ctx.params.queryId)
   await db.remove(ctx.params.queryId, ctx.params.revId)
   ctx.message = `Query deleted.`
   ctx.status = 200

packages/server/src/api/controllers/routing.js

@@ -39,12 +39,11 @@ Routing.prototype.addScreenId = function (fullpath, roleId, screenId) {
 
 /**
  * Gets the full routing structure by querying the routing view and processing the result into the tree.
- * @param {string} appId The application to produce the routing structure for.
  * @returns {Promise<object>} The routing structure, this is the full structure designed for use in the builder,
  * if the client routing is required then the updateRoutingStructureForUserRole should be used.
  */
-async function getRoutingStructure(appId) {
-  const screenRoutes = await getRoutingInfo(appId)
+async function getRoutingStructure() {
+  const screenRoutes = await getRoutingInfo()
   const routing = new Routing()
 
   for (let screenRoute of screenRoutes) {
@@ -57,7 +56,7 @@ async function getRoutingStructure(appId) {
 }
 
 exports.fetch = async ctx => {
-  ctx.body = await getRoutingStructure(ctx.appId)
+  ctx.body = await getRoutingStructure()
 }
 
 exports.clientFetch = async ctx => {

packages/server/src/api/controllers/row/external.js

@@ -9,7 +9,7 @@ const {
   breakRowIdField,
 } = require("../../../integrations/utils")
 const ExternalRequest = require("./ExternalRequest")
-const CouchDB = require("../../../db")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 async function handleRequest(operation, tableId, opts = {}) {
   // make sure the filters are cleaned up, no empty strings for equals, fuzzy or string
@@ -179,7 +179,7 @@ exports.fetchEnrichedRow = async ctx => {
   const id = ctx.params.rowId
   const tableId = ctx.params.tableId
   const { datasourceId, tableName } = breakExternalTableId(tableId)
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   const datasource = await db.get(datasourceId)
   if (!datasource || !datasource.entities) {
     ctx.throw(400, "Datasource has not been configured for plus API.")

packages/server/src/api/controllers/table/internal.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../../../db")
 const linkRows = require("../../../db/linkedRows")
 const { getRowParams, generateTableID } = require("../../../db/utils")
 const { FieldTypes } = require("../../../constants")
@@ -9,10 +8,10 @@ const {
   handleDataImport,
 } = require("./utils")
 const usageQuota = require("../../../utilities/usageQuota")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 exports.save = async function (ctx) {
-  const appId = ctx.appId
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   const { dataImport, ...rest } = ctx.request.body
   let tableToSave = {
     type: "table",
@@ -79,7 +78,6 @@ exports.save = async function (ctx) {
   // update linked rows
   try {
     const linkResp = await linkRows.updateLinks({
-      appId,
       eventType: oldTable
         ? linkRows.EventType.TABLE_UPDATED
         : linkRows.EventType.TABLE_SAVE,
@@ -108,8 +106,7 @@ exports.save = async function (ctx) {
 }
 
 exports.destroy = async function (ctx) {
-  const appId = ctx.appId
-  const db = new CouchDB(appId)
+  const db = getAppDB()
   const tableToDelete = await db.get(ctx.params.tableId)
 
   // Delete all rows for that table
@@ -123,7 +120,6 @@ exports.destroy = async function (ctx) {
 
   // update linked rows
   await linkRows.updateLinks({
-    appId,
     eventType: linkRows.EventType.TABLE_DELETE,
     table: tableToDelete,
   })

packages/server/src/api/controllers/user.js

@@ -11,8 +11,8 @@ const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
 const {
   getDevelopmentAppID,
   getDeployedAppIDs,
+  dbExists,
 } = require("@budibase/backend-core/db")
-const { doesDatabaseExist } = require("../../utilities")
 const { UserStatus } = require("@budibase/backend-core/constants")
 const { getAppDB } = require("@budibase/backend-core/context")
 
@@ -102,7 +102,7 @@ exports.syncUser = async function (ctx) {
     const roleId = roles[prodAppId]
     const devAppId = getDevelopmentAppID(prodAppId)
     for (let appId of [prodAppId, devAppId]) {
-      if (!(await doesDatabaseExist(appId))) {
+      if (!(await dbExists(appId))) {
         continue
       }
       const db = getAppDB()

packages/server/src/api/controllers/webhook.js

@@ -1,9 +1,9 @@
-const CouchDB = require("../../db")
 const { generateWebhookID, getWebhookParams } = require("../../db/utils")
 const toJsonSchema = require("to-json-schema")
 const validate = require("jsonschema").validate
 const triggers = require("../../automations/triggers")
 const { getDeployedAppID } = require("@budibase/backend-core/db")
+const { getAppDB, updateAppId } = require("@budibase/backend-core/context")
 
 const AUTOMATION_DESCRIPTION = "Generated from Webhook Schema"
 
@@ -23,7 +23,7 @@ exports.WebhookType = {
 }
 
 exports.fetch = async ctx => {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const response = await db.allDocs(
     getWebhookParams(null, {
       include_docs: true,
@@ -33,7 +33,7 @@ exports.fetch = async ctx => {
 }
 
 exports.save = async ctx => {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   const webhook = ctx.request.body
   webhook.appId = ctx.appId
 
@@ -52,12 +52,13 @@ exports.save = async ctx => {
 }
 
 exports.destroy = async ctx => {
-  const db = new CouchDB(ctx.appId)
+  const db = getAppDB()
   ctx.body = await db.remove(ctx.params.id, ctx.params.rev)
 }
 
 exports.buildSchema = async ctx => {
-  const db = new CouchDB(ctx.params.instance)
+  updateAppId(ctx.params.instance)
+  const db = getAppDB()
   const webhook = await db.get(ctx.params.id)
   webhook.bodySchema = toJsonSchema(ctx.request.body)
   // update the automation outputs
@@ -81,9 +82,10 @@ exports.buildSchema = async ctx => {
 }
 
 exports.trigger = async ctx => {
-  const prodAppId = getDeployedAppID(ctx.params.instance)
+  const deployedAppId = getDeployedAppID(ctx.params.instance)
+  updateAppId(deployedAppId)
   try {
-    const db = new CouchDB(prodAppId)
+    const db = getAppDB()
     const webhook = await db.get(ctx.params.id)
     // validate against the schema
     if (webhook.bodySchema) {
@@ -96,7 +98,7 @@ exports.trigger = async ctx => {
       await triggers.externalTrigger(target, {
         body: ctx.request.body,
         ...ctx.request.body,
-        appId: prodAppId,
+        appId: deployedAppId,
       })
     }
     ctx.status = 200

packages/server/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) {

packages/server/src/automations/utils.js

@@ -8,6 +8,7 @@ const { updateEntityMetadata } = require("../utilities")
 const { MetadataTypes } = require("../constants")
 const { getDeployedAppID } = 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 => {
@@ -109,7 +109,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 +129,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 = {

packages/server/src/db/linkedRows/index.js

@@ -96,9 +96,9 @@ async function getFullLinkedDocs(links) {
  * @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.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.
  */

packages/server/src/middleware/usageQuota.js

@@ -1,4 +1,3 @@
-const CouchDB = require("../db")
 const usageQuota = require("../utilities/usageQuota")
 const { getUniqueRows } = require("../utilities/usageQuota/rows")
 const {
@@ -6,6 +5,7 @@ const {
   isRowId: isExternalRowId,
 } = require("../integrations/utils")
 const migration = require("../migrations/usageQuotas")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 // currently only counting new writes and deletes
 const METHOD_MAP = {
@@ -47,7 +47,7 @@ module.exports = async (ctx, next) => {
     const usageId = ctx.request.body._id
     try {
       if (ctx.appId) {
-        const db = new CouchDB(ctx.appId)
+        const db = getAppDB()
         await db.get(usageId)
       }
       return next()

packages/server/src/tests/utilities/TestConfiguration.js

@@ -180,8 +180,8 @@ class TestConfiguration {
   }
 
   async deploy() {
-    const deployment = await this._req(null, null, controllers.deploy.deployApp)
-    const prodAppId = deployment.appId.replace("_dev", "")
+    await this._req(null, null, controllers.deploy.deployApp)
+    const prodAppId = this.getAppId().replace("_dev", "")
     const appPackage = await this._req(
       null,
       { appId: prodAppId },

packages/server/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)
+      })
+  })
 }

packages/server/src/threads/query.js

@@ -3,14 +3,13 @@ threadUtils.threadSetup()
 const ScriptRunner = require("../utilities/scriptRunner")
 const { integrations } = require("../integrations")
 const { processStringSync } = require("@budibase/string-templates")
-const CouchDB = require("../db")
+const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
 
 const IS_TRIPLE_BRACE = new RegExp(/^{{3}.*}{3}$/)
 const IS_HANDLEBARS = new RegExp(/^{{2}.*}{2}$/)
 
 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 +103,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,
@@ -223,12 +221,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)
+      })
+  })
 }

packages/server/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

packages/server/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
     }