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

package/src/middleware/currentapp.js

@@ -11,9 +11,9 @@ const { generateUserMetadataID, isDevAppID } = require("../db/utils")
 const { dbExists } = require("@budibase/backend-core/db")
 const { isUserInAppTenant } = require("@budibase/backend-core/tenancy")
 const { getCachedSelf } = require("../utilities/global")
-const CouchDB = require("../db")
 const env = require("../environment")
 const { isWebhookEndpoint } = require("./utils")
+const { doInAppContext } = require("@budibase/backend-core/context")
 
 module.exports = async (ctx, next) => {
   // try to get the appID from the request
@@ -31,7 +31,7 @@ module.exports = async (ctx, next) => {
   // check the app exists referenced in cookie
   if (appCookie) {
     const appId = appCookie.appId
-    const exists = await dbExists(CouchDB, appId)
+    const exists = await dbExists(appId)
     if (!exists) {
       clearCookie(ctx, Cookies.CurrentApp)
       return next()
@@ -41,13 +41,15 @@ module.exports = async (ctx, next) => {
   }
 
   // deny access to application preview
-  if (
-    isDevAppID(requestAppId) &&
-    !isWebhookEndpoint(ctx) &&
-    (!ctx.user || !ctx.user.builder || !ctx.user.builder.global)
-  ) {
-    clearCookie(ctx, Cookies.CurrentApp)
-    return ctx.redirect("/")
+  if (!env.isTest()) {
+    if (
+      isDevAppID(requestAppId) &&
+      !isWebhookEndpoint(ctx) &&
+      (!ctx.user || !ctx.user.builder || !ctx.user.builder.global)
+    ) {
+      clearCookie(ctx, Cookies.CurrentApp)
+      return ctx.redirect("/")
+    }
   }
 
   let appId,
@@ -68,44 +70,46 @@ module.exports = async (ctx, next) => {
     return next()
   }
 
-  let noCookieSet = false
-  // if the user not in the right tenant then make sure they have no permissions
-  // need to judge this only based on the request app ID,
-  if (
-    env.MULTI_TENANCY &&
-    ctx.user &&
-    requestAppId &&
-    !isUserInAppTenant(requestAppId)
-  ) {
-    // don't error, simply remove the users rights (they are a public user)
-    delete ctx.user.builder
-    delete ctx.user.admin
-    delete ctx.user.roles
-    roleId = BUILTIN_ROLE_IDS.PUBLIC
-    noCookieSet = true
-  }
+  return doInAppContext(appId, async () => {
+    let noCookieSet = false
+    // if the user not in the right tenant then make sure they have no permissions
+    // need to judge this only based on the request app ID,
+    if (
+      env.MULTI_TENANCY &&
+      ctx.user &&
+      requestAppId &&
+      !isUserInAppTenant(requestAppId)
+    ) {
+      // don't error, simply remove the users rights (they are a public user)
+      delete ctx.user.builder
+      delete ctx.user.admin
+      delete ctx.user.roles
+      roleId = BUILTIN_ROLE_IDS.PUBLIC
+      noCookieSet = true
+    }
 
-  ctx.appId = appId
-  if (roleId) {
-    ctx.roleId = roleId
-    const userId = ctx.user ? generateUserMetadataID(ctx.user._id) : null
-    ctx.user = {
-      ...ctx.user,
-      // override userID with metadata one
-      _id: userId,
-      userId,
-      roleId,
-      role: await getRole(appId, roleId),
+    ctx.appId = appId
+    if (roleId) {
+      ctx.roleId = roleId
+      const userId = ctx.user ? generateUserMetadataID(ctx.user._id) : null
+      ctx.user = {
+        ...ctx.user,
+        // override userID with metadata one
+        _id: userId,
+        userId,
+        roleId,
+        role: await getRole(roleId),
+      }
+    }
+    if (
+      (requestAppId !== appId ||
+        appCookie == null ||
+        appCookie.appId !== requestAppId) &&
+      !noCookieSet
+    ) {
+      setCookie(ctx, { appId }, Cookies.CurrentApp)
     }
-  }
-  if (
-    (requestAppId !== appId ||
-      appCookie == null ||
-      appCookie.appId !== requestAppId) &&
-    !noCookieSet
-  ) {
-    setCookie(ctx, { appId }, Cookies.CurrentApp)
-  }
 
-  return next()
+    return next()
+  })
 }

package/src/middleware/tests/authorized.spec.js

@@ -11,6 +11,9 @@ const authorizedMiddleware = require("../authorized")
 const env = require("../../environment")
 const { PermissionTypes, PermissionLevels } = require("@budibase/backend-core/permissions")
 require("@budibase/backend-core").init(require("../../db"))
+const { doInAppContext } = require("@budibase/backend-core/context")
+
+const APP_ID = ""
 
 class TestConfiguration {
   constructor(role) {
@@ -23,7 +26,7 @@ class TestConfiguration {
       request: {
         url: ""
       },
-      appId: "",
+      appId: APP_ID,
       auth: {},
       next: this.next,
       throw: this.throw,
@@ -32,7 +35,9 @@ class TestConfiguration {
   }
 
   executeMiddleware() {
-    return this.middleware(this.ctx, this.next)
+    return doInAppContext(APP_ID, () => {
+      return this.middleware(this.ctx, this.next)
+    })
   }
 
   setUser(user) {

package/src/middleware/tests/currentapp.spec.js

@@ -1,6 +1,11 @@
 mockAuthWithNoCookie()
 mockWorker()
 
+jest.mock("@budibase/backend-core/db", () => ({
+  ...jest.requireActual("@budibase/backend-core/db"),
+  dbExists: () => true,
+}))
+
 function mockWorker() {
   jest.mock("../../utilities/workerRequests", () => ({
     getGlobalSelf: () => {
@@ -50,6 +55,7 @@ function mockAuthWithCookie() {
       return "app_test"
     },
     setCookie: jest.fn(),
+    clearCookie: jest.fn(),
     getCookie: () => ({appId: "app_different", roleId: "PUBLIC"}),
   }))
   jest.mock("@budibase/backend-core/constants", () => ({

package/src/middleware/usageQuota.js

@@ -1,10 +1,10 @@
-const CouchDB = require("../db")
 const usageQuota = require("../utilities/usageQuota")
 const { getUniqueRows } = require("../utilities/usageQuota/rows")
 const {
   isExternalTable,
   isRowId: isExternalRowId,
 } = require("../integrations/utils")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 // currently only counting new writes and deletes
 const METHOD_MAP = {
@@ -46,7 +46,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()

package/src/migrations/functions/appUrls.ts

@@ -9,7 +9,16 @@ import { getAppUrl } from "../../api/controllers/application"
  * Add the url to the app metadata if it doesn't exist
  */
 export const run = async (appDb: any) => {
-  const metadata = await appDb.get(DocumentTypes.APP_METADATA)
+  let metadata
+  try {
+    metadata = await appDb.get(DocumentTypes.APP_METADATA)
+  } catch (e) {
+    // sometimes the metadata document doesn't exist
+    // exit early instead of failing the migration
+    console.error("Error retrieving app metadata. Skipping", e)
+    return
+  }
+
   if (!metadata.url) {
     const context = {
       request: {
@@ -20,6 +29,6 @@ export const run = async (appDb: any) => {
     }
     metadata.url = getAppUrl(context)
     console.log(`Adding url to app: ${metadata.url}`)
+    await appDb.put(metadata)
   }
-  await appDb.put(metadata)
 }

package/src/migrations/functions/usageQuotas/syncApps.ts

@@ -1,12 +1,13 @@
-const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
-const { getAllApps } = require("@budibase/backend-core/db")
-import CouchDB from "../../../db"
+// @ts-ignore
+import { getGlobalDB, getTenantId } from "@budibase/backend-core/tenancy"
+// @ts-ignore
+import { getAllApps } from "@budibase/backend-core/db"
 import { getUsageQuotaDoc } from "../../../utilities/usageQuota"
 
 export const run = async () => {
   const db = getGlobalDB()
   // get app count
-  const devApps = await getAllApps(CouchDB, { dev: true })
+  const devApps = await getAllApps({ dev: true })
   const appCount = devApps ? devApps.length : 0
 
   // sync app count

package/src/migrations/functions/usageQuotas/syncRows.ts

@@ -1,13 +1,14 @@
-const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
-const { getAllApps } = require("@budibase/backend-core/db")
-import CouchDB from "../../../db"
+// @ts-ignore
+import { getGlobalDB, getTenantId } from "@budibase/backend-core/tenancy"
+// @ts-ignore
+import { getAllApps } from "@budibase/backend-core/db"
 import { getUsageQuotaDoc } from "../../../utilities/usageQuota"
 import { getUniqueRows } from "../../../utilities/usageQuota/rows"
 
 export const run = async () => {
   const db = getGlobalDB()
   // get all rows in all apps
-  const allApps = await getAllApps(CouchDB, { all: true })
+  const allApps = await getAllApps({ all: true })
   const appIds = allApps ? allApps.map((app: { appId: any }) => app.appId) : []
   const rows = await getUniqueRows(appIds)
   const rowCount = rows ? rows.length : 0

package/src/tests/utilities/TestConfiguration.js

@@ -1,3 +1,6 @@
+const core = require("@budibase/backend-core")
+const CouchDB = require("../../db")
+core.init(CouchDB)
 const { BUILTIN_ROLE_IDS } = require("@budibase/backend-core/roles")
 const env = require("../../environment")
 const {
@@ -17,13 +20,11 @@ const supertest = require("supertest")
 const { cleanup } = require("../../utilities/fileSystem")
 const { Cookies, Headers } = require("@budibase/backend-core/constants")
 const { jwt } = require("@budibase/backend-core/auth")
-const core = require("@budibase/backend-core")
 const { getGlobalDB } = require("@budibase/backend-core/tenancy")
 const { createASession } = require("@budibase/backend-core/sessions")
 const { user: userCache } = require("@budibase/backend-core/cache")
-const CouchDB = require("../../db")
 const newid = require("../../db/newid")
-core.init(CouchDB)
+const context = require("@budibase/backend-core/context")
 
 const GLOBAL_USER_ID = "us_uuid1"
 const EMAIL = "babs@babs.com"
@@ -65,11 +66,21 @@ class TestConfiguration {
     request.request = {
       body: config,
     }
-    if (params) {
-      request.params = params
+    async function run() {
+      if (params) {
+        request.params = params
+      }
+      await controlFunc(request)
+      return request.body
+    }
+    // check if already in a context
+    if (context.getAppId() == null) {
+      return context.doInAppContext(this.appId, async () => {
+        return run()
+      })
+    } else {
+      return run()
     }
-    await controlFunc(request)
-    return request.body
   }
 
   async globalUser({
@@ -175,6 +186,7 @@ class TestConfiguration {
     // create dev app
     this.app = await this._req({ name: appName }, null, controllers.app.create)
     this.appId = this.app.appId
+    context.updateAppId(this.appId)
 
     // create production app
     this.prodApp = await this.deploy()
@@ -187,14 +199,16 @@ class TestConfiguration {
   }
 
   async deploy() {
-    const deployment = await this._req(null, null, controllers.deploy.deployApp)
-    const prodAppId = deployment.appId.replace("_dev", "")
-    const appPackage = await this._req(
-      null,
-      { appId: prodAppId },
-      controllers.app.fetchAppPackage
-    )
-    return appPackage.application
+    await this._req(null, null, controllers.deploy.deployApp)
+    const prodAppId = this.getAppId().replace("_dev", "")
+    return context.doInAppContext(prodAppId, async () => {
+      const appPackage = await this._req(
+        null,
+        { appId: prodAppId },
+        controllers.app.fetchAppPackage
+      )
+      return appPackage.application
+    })
   }
 
   async updateTable(config = null) {
@@ -423,42 +437,47 @@ class TestConfiguration {
 
   async login({ roleId, userId, builder, prodApp = false } = {}) {
     const appId = prodApp ? this.prodAppId : this.appId
-
-    userId = !userId ? `us_uuid1` : userId
-    if (!this.request) {
-      throw "Server has not been opened, cannot login."
-    }
-    // make sure the user exists in the global DB
-    if (roleId !== BUILTIN_ROLE_IDS.PUBLIC) {
-      await this.globalUser({
-        userId,
-        builder,
-        roles: { [this.prodAppId]: roleId },
+    return context.doInAppContext(appId, async () => {
+      userId = !userId ? `us_uuid1` : userId
+      if (!this.request) {
+        throw "Server has not been opened, cannot login."
+      }
+      // make sure the user exists in the global DB
+      if (roleId !== BUILTIN_ROLE_IDS.PUBLIC) {
+        await this.globalUser({
+          id: userId,
+          builder,
+          roles: { [this.prodAppId]: roleId },
+        })
+      }
+      await createASession(userId, {
+        sessionId: "sessionid",
+        tenantId: TENANT_ID,
       })
-    }
-    // have to fake this
-    const auth = {
-      userId,
-      sessionId: "sessionid",
-      tenantId: TENANT_ID,
-    }
-    const app = {
-      roleId: roleId,
-      appId,
-    }
-    const authToken = jwt.sign(auth, env.JWT_SECRET)
-    const appToken = jwt.sign(app, env.JWT_SECRET)
-
-    // returning necessary request headers
-    await userCache.invalidateUser(userId)
-    return {
-      Accept: "application/json",
-      Cookie: [
-        `${Cookies.Auth}=${authToken}`,
-        `${Cookies.CurrentApp}=${appToken}`,
-      ],
-      [Headers.APP_ID]: appId,
-    }
+      // have to fake this
+      const auth = {
+        userId,
+        sessionId: "sessionid",
+        tenantId: TENANT_ID,
+      }
+      const app = {
+        roleId: roleId,
+        appId,
+      }
+      const authToken = jwt.sign(auth, env.JWT_SECRET)
+      const appToken = jwt.sign(app, env.JWT_SECRET)
+
+      // returning necessary request headers
+      await userCache.invalidateUser(userId)
+      return {
+        Accept: "application/json",
+        Cookie: [
+          `${Cookies.Auth}=${authToken}`,
+          `${Cookies.CurrentApp}=${appToken}`,
+        ],
+        [Headers.APP_ID]: appId,
+      }
+    })
   }
 }
 

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,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)
+      })
+  })
 }

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)