@budibase/server 1.0.49-alpha.4 → 1.0.49-alpha.8

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)

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/usageQuotas/syncApps.ts

@@ -1,12 +1,12 @@
-const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
-const { getAllApps } = require("@budibase/backend-core/db")
-import CouchDB from "../../../db"
+import { getGlobalDB, getTenantId } from "@budibase/backend-core/tenancy"
+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 })
+  // @ts-ignore
+  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"
+import { getGlobalDB, getTenantId } from "@budibase/backend-core/tenancy"
+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 })
+  // @ts-ignore
+  const allApps = await getAllApps({ all: true })
+  // @ts-ignore
   const appIds = allApps ? allApps.map((app: { appId: any }) => app.appId) : []
   const rows = await getUniqueRows(appIds)
   const rowCount = rows ? rows.length : 0

package/src/module.d.ts

@@ -0,0 +1,3 @@
+declare module "@budibase/backend-core"
+declare module "@budibase/backend-core/tenancy"
+declare module "@budibase/backend-core/db"

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