@budibase/server 1.0.49-alpha.1 → 1.0.49-alpha.13

package/src/db/linkedRows/linkUtils.js

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

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

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

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

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

package/src/db/views/staticViews.js

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

package/src/environment.js

@@ -2,7 +2,8 @@ function isTest() {
   return (
     process.env.NODE_ENV === "jest" ||
     process.env.NODE_ENV === "cypress" ||
-    process.env.JEST_WORKER_ID != null
+    (process.env.JEST_WORKER_ID != null &&
+      process.env.JEST_WORKER_ID !== "null")
   )
 }
 
@@ -43,6 +44,7 @@ module.exports = {
   REDIS_PASSWORD: process.env.REDIS_PASSWORD,
   INTERNAL_API_KEY: process.env.INTERNAL_API_KEY,
   MULTI_TENANCY: process.env.MULTI_TENANCY,
+  HTTP_MIGRATIONS: process.env.HTTP_MIGRATIONS,
   // environment
   NODE_ENV: process.env.NODE_ENV,
   JEST_WORKER_ID: process.env.JEST_WORKER_ID,

package/src/integrations/base/sql.ts

@@ -166,15 +166,13 @@ class InternalBuilder {
 
   addSorting(query: KnexQuery, json: QueryJson): KnexQuery {
     let { sort, paginate } = json
-    if (!sort) {
-      return query
-    }
     const table = json.meta?.table
-    for (let [key, value] of Object.entries(sort)) {
-      const direction = value === SortDirection.ASCENDING ? "asc" : "desc"
-      query = query.orderBy(`${table?.name}.${key}`, direction)
-    }
-    if (this.client === SqlClients.MS_SQL && !sort && paginate?.limit) {
+    if (sort) {
+      for (let [key, value] of Object.entries(sort)) {
+        const direction = value === SortDirection.ASCENDING ? "asc" : "desc"
+        query = query.orderBy(`${table?.name}.${key}`, direction)
+      }
+    } else if (this.client === SqlClients.MS_SQL && paginate?.limit) {
       // @ts-ignore
       query = query.orderBy(`${table?.name}.${table?.primary[0]}`)
     }
@@ -191,29 +189,70 @@ class InternalBuilder {
     if (!relationships) {
       return query
     }
+    const tableSets: Record<string, [any]> = {}
+    // aggregate into table sets (all the same to tables)
     for (let relationship of relationships) {
-      const from = relationship.from,
-        to = relationship.to,
-        toTable = relationship.tableName
-      if (!relationship.through) {
+      const keyObj: { toTable: string; throughTable: string | undefined } = {
+        toTable: relationship.tableName,
+        throughTable: undefined,
+      }
+      if (relationship.through) {
+        keyObj.throughTable = relationship.through
+      }
+      const key = JSON.stringify(keyObj)
+      if (tableSets[key]) {
+        tableSets[key].push(relationship)
+      } else {
+        tableSets[key] = [relationship]
+      }
+    }
+    for (let [key, relationships] of Object.entries(tableSets)) {
+      const { toTable, throughTable } = JSON.parse(key)
+      if (!throughTable) {
         // @ts-ignore
-        query = query.leftJoin(
+        query = query.join(
           toTable,
-          `${fromTable}.${from}`,
-          `${toTable}.${to}`
+          function () {
+            for (let relationship of relationships) {
+              const from = relationship.from,
+                to = relationship.to
+              // @ts-ignore
+              this.orOn(`${fromTable}.${from}`, "=", `${toTable}.${to}`)
+            }
+          },
+          "left"
         )
       } else {
-        const throughTable = relationship.through
-        const fromPrimary = relationship.fromPrimary
-        const toPrimary = relationship.toPrimary
         query = query
           // @ts-ignore
-          .leftJoin(
+          .join(
             throughTable,
-            `${fromTable}.${fromPrimary}`,
-            `${throughTable}.${from}`
+            function () {
+              for (let relationship of relationships) {
+                const fromPrimary = relationship.fromPrimary
+                const from = relationship.from
+                // @ts-ignore
+                this.orOn(
+                  `${fromTable}.${fromPrimary}`,
+                  "=",
+                  `${throughTable}.${from}`
+                )
+              }
+            },
+            "left"
+          )
+          .join(
+            toTable,
+            function () {
+              for (let relationship of relationships) {
+                const toPrimary = relationship.toPrimary
+                const to = relationship.to
+                // @ts-ignore
+                this.orOn(`${toTable}.${toPrimary}`, `${throughTable}.${to}`)
+              }
+            },
+            "left"
           )
-          .leftJoin(toTable, `${toTable}.${toPrimary}`, `${throughTable}.${to}`)
       }
     }
     return query.limit(BASE_LIMIT)

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,11 +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 migration = require("../migrations/usageQuotas")
+const { getAppDB } = require("@budibase/backend-core/context")
 
 // currently only counting new writes and deletes
 const METHOD_MAP = {
@@ -47,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()
@@ -74,7 +73,6 @@ module.exports = async (ctx, next) => {
     usage = files.map(file => file.size).reduce((total, size) => total + size)
   }
   try {
-    await migration.run()
     await performRequest(ctx, next, property, usage)
   } catch (err) {
     ctx.throw(400, err)

package/src/migrations/functions/appUrls.ts

@@ -0,0 +1,34 @@
+const { DocumentTypes } = require("@budibase/backend-core/db")
+import { getAppUrl } from "../../api/controllers/application"
+
+/**
+ * Date:
+ * January 2022
+ *
+ * Description:
+ * Add the url to the app metadata if it doesn't exist
+ */
+export const run = async (appDb: any) => {
+  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: {
+        body: {
+          name: metadata.name,
+        },
+      },
+    }
+    metadata.url = getAppUrl(context)
+    console.log(`Adding url to app: ${metadata.url}`)
+    await appDb.put(metadata)
+  }
+}

package/src/migrations/functions/quotas1.ts

@@ -0,0 +1,20 @@
+import { runQuotaMigration } from "./usageQuotas"
+import * as syncApps from "./usageQuotas/syncApps"
+import * as syncRows from "./usageQuotas/syncRows"
+
+/**
+ * Date:
+ * January 2022
+ *
+ * Description:
+ * Synchronise the app and row quotas to the state of the db after it was
+ * discovered that the quota resets were still in place and the row quotas
+ * weren't being decremented correctly.
+ */
+
+export const run = async () => {
+  await runQuotaMigration(async () => {
+    await syncApps.run()
+    await syncRows.run()
+  })
+}

package/src/migrations/functions/tests/appUrls.spec.js

@@ -0,0 +1,29 @@
+const { DocumentTypes } = require("@budibase/backend-core/db")
+const env = require("../../../environment")
+const TestConfig = require("../../../tests/utilities/TestConfiguration")
+
+const migration = require("../appUrls")
+
+describe("run", () => {
+  let config = new TestConfig(false)
+  const CouchDB = config.getCouch()
+
+  beforeEach(async () => {
+    await config.init()
+  })
+
+  afterAll(config.end)  
+
+  it("runs successfully", async () => {
+    const app = await config.createApp("testApp")
+    const appDb = new CouchDB(app.appId)
+    let metadata = await appDb.get(DocumentTypes.APP_METADATA)
+    delete metadata.url
+    await appDb.put(metadata)
+    
+    await migration.run(appDb)
+
+    metadata = await appDb.get(DocumentTypes.APP_METADATA)
+    expect(metadata.url).toEqual("/testapp")
+  })
+})

package/src/migrations/{tests/usageQuotas/index.spec.js → functions/tests/quotas1.spec.js}

@@ -4,10 +4,10 @@ const TestConfig = require("../../../tests/utilities/TestConfiguration")
 const syncApps = jest.fn()
 const syncRows = jest.fn()
 
-jest.mock("../../usageQuotas/syncApps", () => ({ run: syncApps }) )
-jest.mock("../../usageQuotas/syncRows", () => ({ run: syncRows }) )
+jest.mock("../usageQuotas/syncApps", () => ({ run: syncApps }) )
+jest.mock("../usageQuotas/syncRows", () => ({ run: syncRows }) )
 
-const migrations = require("../../usageQuotas")
+const migration = require("../quotas1")
 
 describe("run", () => {
   let config = new TestConfig(false)
@@ -19,8 +19,8 @@ describe("run", () => {
 
   afterAll(config.end)  
 
-  it("runs the required migrations", async () => {
-    await migrations.run()
+  it("runs ", async () => {
+    await migration.run()
     expect(syncApps).toHaveBeenCalledTimes(1)
     expect(syncRows).toHaveBeenCalledTimes(1)
   })