@budibase/server 2.1.32-alpha.5 → 2.1.32-alpha.6

package/src/db/utils.ts

@@ -128,7 +128,7 @@ export function getLinkParams(otherProps: any = {}) {
  * Generates a new layout ID.
  * @returns {string} The new layout ID which the layout doc can be stored under.
  */
-export function generateLayoutID(id: string) {
+export function generateLayoutID(id?: string) {
   return `${DocumentType.LAYOUT}${SEPARATOR}${id || newid()}`
 }
 

package/src/db/views/staticViews.js

@@ -1,4 +1,4 @@
-const { getAppDB } = require("@budibase/backend-core/context")
+const { context } = require("@budibase/backend-core")
 const { DocumentType, SEPARATOR, ViewName, SearchIndexes } = require("../utils")
 const SCREEN_PREFIX = DocumentType.SCREEN + SEPARATOR
 
@@ -20,7 +20,7 @@ const SCREEN_PREFIX = DocumentType.SCREEN + SEPARATOR
  * so it may be slow.
  */
 exports.createLinkView = async () => {
-  const db = getAppDB()
+  const db = context.getAppDB()
   const designDoc = await db.get("_design/database")
   const view = {
     map: function (doc) {
@@ -54,7 +54,7 @@ exports.createLinkView = async () => {
 }
 
 exports.createRoutingView = async () => {
-  const db = getAppDB()
+  const db = context.getAppDB()
   const designDoc = await db.get("_design/database")
   const view = {
     // if using variables in a map function need to inject them before use
@@ -75,7 +75,7 @@ exports.createRoutingView = async () => {
 }
 
 async function searchIndex(indexName, fnString) {
-  const db = getAppDB()
+  const db = context.getAppDB()
   const designDoc = await db.get("_design/database")
   designDoc.indexes = {
     [indexName]: {

package/src/integrations/base/sql.ts

@@ -96,7 +96,7 @@ function generateSelectStatement(
 ): (string | Knex.Raw)[] {
   const { resource, meta } = json
   const schema = meta?.table?.schema
-  return resource.fields.map(field => {
+  return resource!.fields.map(field => {
     const fieldNames = field.split(/\./g)
     const tableName = fieldNames[0]
     const columnName = fieldNames[1]

package/src/integrations/base/sqlTable.ts

@@ -185,7 +185,7 @@ class SqlTableQueryBuilder {
           json.table,
           json.meta.tables,
           json.meta.table,
-          json.meta.renamed
+          json.meta.renamed!
         )
         break
       case Operation.DELETE_TABLE:

package/src/integrations/index.ts

@@ -67,50 +67,54 @@ if (
   INTEGRATIONS[SourceName.ORACLE] = oracle.integration
 }
 
-module.exports = {
-  getDefinitions: async () => {
-    const pluginSchemas: { [key: string]: Integration } = {}
-    if (environment.SELF_HOSTED) {
-      const plugins = await getPlugins(PluginType.DATASOURCE)
-      // extract the actual schema from each custom
-      for (let plugin of plugins) {
-        const sourceId = plugin.name
-        pluginSchemas[sourceId] = {
-          ...plugin.schema["schema"],
-          custom: true,
-        }
-        if (plugin.iconUrl) {
-          pluginSchemas[sourceId].iconUrl = plugin.iconUrl
-        }
+export async function getDefinitions() {
+  const pluginSchemas: { [key: string]: Integration } = {}
+  if (environment.SELF_HOSTED) {
+    const plugins = await getPlugins(PluginType.DATASOURCE)
+    // extract the actual schema from each custom
+    for (let plugin of plugins) {
+      const sourceId = plugin.name
+      pluginSchemas[sourceId] = {
+        ...plugin.schema["schema"],
+        custom: true,
+      }
+      if (plugin.iconUrl) {
+        pluginSchemas[sourceId].iconUrl = plugin.iconUrl
       }
     }
-    return {
-      ...cloneDeep(DEFINITIONS),
-      ...pluginSchemas,
-    }
-  },
-  getIntegration: async (integration: string) => {
-    if (INTEGRATIONS[integration]) {
-      return INTEGRATIONS[integration]
-    }
-    if (environment.SELF_HOSTED) {
-      const plugins = await getPlugins(PluginType.DATASOURCE)
-      for (let plugin of plugins) {
-        if (plugin.name === integration) {
-          // need to use commonJS require due to its dynamic runtime nature
-          const retrieved: any = await getDatasourcePlugin(
-            plugin.name,
-            plugin.jsUrl,
-            plugin.schema?.hash
-          )
-          if (retrieved.integration) {
-            return retrieved.integration
-          } else {
-            return retrieved
-          }
+  }
+  return {
+    ...cloneDeep(DEFINITIONS),
+    ...pluginSchemas,
+  }
+}
+
+export async function getIntegration(integration: string) {
+  if (INTEGRATIONS[integration]) {
+    return INTEGRATIONS[integration]
+  }
+  if (environment.SELF_HOSTED) {
+    const plugins = await getPlugins(PluginType.DATASOURCE)
+    for (let plugin of plugins) {
+      if (plugin.name === integration) {
+        // need to use commonJS require due to its dynamic runtime nature
+        const retrieved: any = await getDatasourcePlugin(
+          plugin.name,
+          plugin.jsUrl,
+          plugin.schema?.hash
+        )
+        if (retrieved.integration) {
+          return retrieved.integration
+        } else {
+          return retrieved
         }
       }
     }
-    throw new Error("No datasource implementation found.")
-  },
+  }
+  throw new Error("No datasource implementation found.")
+}
+
+export default {
+  getDefinitions,
+  getIntegration,
 }

package/src/middleware/authorized.ts

@@ -1,23 +1,13 @@
-import {
-  getUserRoleHierarchy,
-  getRequiredResourceRole,
-  BUILTIN_ROLE_IDS,
-} from "@budibase/backend-core/roles"
-const {
-  PermissionType,
-  PermissionLevel,
-  doesHaveBasePermission,
-} = require("@budibase/backend-core/permissions")
-const builderMiddleware = require("./builder")
-const { isWebhookEndpoint } = require("./utils")
-const { buildCsrfMiddleware } = require("@budibase/backend-core/auth")
-const { getAppId } = require("@budibase/backend-core/context")
+import { roles, permissions, auth, context } from "@budibase/backend-core"
+import { Role } from "@budibase/types"
+import builderMiddleware from "./builder"
+import { isWebhookEndpoint } from "./utils"
 
 function hasResource(ctx: any) {
   return ctx.resourceId != null
 }
 
-const csrf = buildCsrfMiddleware()
+const csrf = auth.buildCsrfMiddleware()
 
 /**
  * Apply authorization to the requested resource:
@@ -33,7 +23,7 @@ const checkAuthorized = async (
 ) => {
   // check if this is a builder api and the user is not a builder
   const isBuilder = ctx.user && ctx.user.builder && ctx.user.builder.global
-  const isBuilderApi = permType === PermissionType.BUILDER
+  const isBuilderApi = permType === permissions.PermissionType.BUILDER
   if (isBuilderApi && !isBuilder) {
     return ctx.throw(403, "Not Authorized")
   }
@@ -51,10 +41,10 @@ const checkAuthorizedResource = async (
   permLevel: any
 ) => {
   // get the user's roles
-  const roleId = ctx.roleId || BUILTIN_ROLE_IDS.PUBLIC
-  const userRoles = (await getUserRoleHierarchy(roleId, {
+  const roleId = ctx.roleId || roles.BUILTIN_ROLE_IDS.PUBLIC
+  const userRoles = (await roles.getUserRoleHierarchy(roleId, {
     idOnly: false,
-  })) as { _id: string }[]
+  })) as Role[]
   const permError = "User does not have permission"
   // check if the user has the required role
   if (resourceRoles.length > 0) {
@@ -66,7 +56,9 @@ const checkAuthorizedResource = async (
       ctx.throw(403, permError)
     }
     // fallback to the base permissions when no resource roles are found
-  } else if (!doesHaveBasePermission(permType, permLevel, userRoles)) {
+  } else if (
+    !permissions.doesHaveBasePermission(permType, permLevel, userRoles)
+  ) {
     ctx.throw(403, permError)
   }
 }
@@ -91,21 +83,22 @@ export = (permType: any, permLevel: any = null, opts = { schema: false }) =>
     let resourceRoles: any = []
     let otherLevelRoles: any = []
     const otherLevel =
-      permLevel === PermissionLevel.READ
-        ? PermissionLevel.WRITE
-        : PermissionLevel.READ
-    const appId = getAppId()
+      permLevel === permissions.PermissionLevel.READ
+        ? permissions.PermissionLevel.WRITE
+        : permissions.PermissionLevel.READ
+    const appId = context.getAppId()
     if (appId && hasResource(ctx)) {
-      resourceRoles = await getRequiredResourceRole(permLevel, ctx)
+      resourceRoles = await roles.getRequiredResourceRole(permLevel, ctx)
       if (opts && opts.schema) {
-        otherLevelRoles = await getRequiredResourceRole(otherLevel, ctx)
+        otherLevelRoles = await roles.getRequiredResourceRole(otherLevel, ctx)
       }
     }
 
     // if the resource is public, proceed
     if (
-      resourceRoles.includes(BUILTIN_ROLE_IDS.PUBLIC) ||
-      (otherLevelRoles && otherLevelRoles.includes(BUILTIN_ROLE_IDS.PUBLIC))
+      resourceRoles.includes(roles.BUILTIN_ROLE_IDS.PUBLIC) ||
+      (otherLevelRoles &&
+        otherLevelRoles.includes(roles.BUILTIN_ROLE_IDS.PUBLIC))
     ) {
       return next()
     }

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

@@ -9,8 +9,7 @@ jest.mock("../../environment", () => ({
 )
 const authorizedMiddleware = require("../authorized")
 const env = require("../../environment")
-const { PermissionType, PermissionLevel } = require("@budibase/backend-core/permissions")
-const { doInAppContext } = require("@budibase/backend-core/context")
+const { permissions } = require("@budibase/backend-core")
 
 const APP_ID = ""
 
@@ -113,7 +112,7 @@ describe("Authorization middleware", () => {
     
     it("throws if the user does not have builder permissions", async () => {
       config.setEnvironment(false)
-      config.setMiddlewareRequiredPermission(PermissionType.BUILDER)
+      config.setMiddlewareRequiredPermission(permissions.PermissionType.BUILDER)
       config.setUser({
         role: {
           _id: ""
@@ -125,13 +124,13 @@ describe("Authorization middleware", () => {
     })
 
     it("passes on to next() middleware if the user has resource permission", async () => {
-      config.setResourceId(PermissionType.QUERY)
+      config.setResourceId(permissions.PermissionType.QUERY)
       config.setUser({
         role: {
           _id: ""
         }
       })
-      config.setMiddlewareRequiredPermission(PermissionType.QUERY)
+      config.setMiddlewareRequiredPermission(permissions.PermissionType.QUERY)
 
       await config.executeMiddleware()
       expect(config.next).toHaveBeenCalled()
@@ -155,7 +154,7 @@ describe("Authorization middleware", () => {
           _id: ""
         },
       })
-      config.setMiddlewareRequiredPermission(PermissionType.ADMIN, PermissionLevel.BASIC)
+      config.setMiddlewareRequiredPermission(permissions.PermissionType.ADMIN, permissions.PermissionLevel.BASIC)
       
       await config.executeMiddleware()
       expect(config.throw).toHaveBeenCalledWith(403, "User does not have permission")

package/src/migrations/functions/appUrls.ts

@@ -1,4 +1,4 @@
-const { DocumentType } = require("@budibase/backend-core/db")
+import { db as dbCore } from "@budibase/backend-core"
 import { getAppUrl } from "../../api/controllers/application"
 
 /**
@@ -11,7 +11,7 @@ import { getAppUrl } from "../../api/controllers/application"
 export const run = async (appDb: any) => {
   let metadata
   try {
-    metadata = await appDb.get(DocumentType.APP_METADATA)
+    metadata = await appDb.get(dbCore.DocumentType.APP_METADATA)
   } catch (e) {
     // sometimes the metadata document doesn't exist
     // exit early instead of failing the migration

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

@@ -1,4 +1,4 @@
-const {  DocumentType, doWithDB } = require("@budibase/backend-core/db")
+const { db: dbCore } = require("@budibase/backend-core")
 const TestConfig = require("../../../tests/utilities/TestConfiguration")
 
 const migration = require("../appUrls")
@@ -14,12 +14,12 @@ describe("run", () => {
 
   it("runs successfully", async () => {
     const app = await config.createApp("testApp")
-    const metadata = await doWithDB(app.appId, async db => {
-      const metadataDoc = await db.get( DocumentType.APP_METADATA)
+    const metadata = await dbCore.doWithDB(app.appId, async db => {
+      const metadataDoc = await db.get(dbCore.DocumentType.APP_METADATA)
       delete metadataDoc.url
       await db.put(metadataDoc)
       await migration.run(db)
-      return await db.get( DocumentType.APP_METADATA)
+      return await db.get(dbCore.DocumentType.APP_METADATA)
     })
     expect(metadata.url).toEqual("/testapp")
   })

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

@@ -1,11 +1,16 @@
-jest.mock("@budibase/backend-core/db", () => ({
-  ...jest.requireActual("@budibase/backend-core/db"),
-  createNewUserEmailView: jest.fn(),
-}))
-const coreDb = require("@budibase/backend-core/db")
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    db: {
+      ...core.db,
+      createNewUserEmailView: jest.fn()
+    }
+  }
+})
+const { tenancy, db: dbCore } = require("@budibase/backend-core")
 const TestConfig = require("../../../tests/utilities/TestConfiguration")
 const { TENANT_ID } = require("../../../tests/utilities/structures")
-const { getGlobalDB, doInTenant } = require("@budibase/backend-core/tenancy")
 
 // mock email view creation
 
@@ -21,10 +26,10 @@ describe("run", () => {
     afterAll(config.end)
 
     it("runs successfully", async () => {
-      await doInTenant(TENANT_ID, async () => {
-        const globalDb = getGlobalDB()
+      await tenancy.doInTenant(TENANT_ID, async () => {
+        const globalDb = tenancy.getGlobalDB()
         await migration.run(globalDb)
-        expect(coreDb.createNewUserEmailView).toHaveBeenCalledTimes(1)
+        expect(dbCore.createNewUserEmailView).toHaveBeenCalledTimes(1)
       })
     })
 })

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

@@ -1,15 +1,14 @@
-import { getTenantId } from "@budibase/backend-core/tenancy"
-import { getAllApps } from "@budibase/backend-core/db"
+import { tenancy, db as dbCore } from "@budibase/backend-core"
 import { quotas } from "@budibase/pro"
 import { QuotaUsageType, StaticQuotaName } from "@budibase/types"
 
 export const run = async () => {
   // get app count
-  const devApps = await getAllApps({ dev: true })
+  const devApps = await dbCore.getAllApps({ dev: true })
   const appCount = devApps ? devApps.length : 0
 
   // sync app count
-  const tenantId = getTenantId()
+  const tenantId = tenancy.getTenantId()
   console.log(`[Tenant: ${tenantId}] Syncing app count: ${appCount}`)
   await quotas.setUsage(appCount, StaticQuotaName.APPS, QuotaUsageType.STATIC)
 }

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

@@ -1,12 +1,11 @@
-import { getTenantId } from "@budibase/backend-core/tenancy"
-import { getAllApps } from "@budibase/backend-core/db"
+import { tenancy, db as dbCore } from "@budibase/backend-core"
 import { getUniqueRows } from "../../../utilities/usageQuota/rows"
 import { quotas } from "@budibase/pro"
 import { StaticQuotaName, QuotaUsageType, App } from "@budibase/types"
 
 export const run = async () => {
   // get all rows in all apps
-  const allApps = (await getAllApps({ all: true })) as App[]
+  const allApps = (await dbCore.getAllApps({ all: true })) as App[]
   const appIds = allApps ? allApps.map((app: { appId: any }) => app.appId) : []
   const { appRows } = await getUniqueRows(appIds)
 
@@ -19,7 +18,7 @@ export const run = async () => {
   })
 
   // sync row count
-  const tenantId = getTenantId()
+  const tenantId = tenancy.getTenantId()
   console.log(`[Tenant: ${tenantId}] Syncing row count: ${rowCount}`)
   await quotas.setUsagePerApp(
     counts,

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

@@ -2,7 +2,7 @@ import TestConfig from "../../../../tests/utilities/TestConfiguration"
 import * as syncRows from "../syncRows"
 import { quotas } from "@budibase/pro"
 import { QuotaUsageType, StaticQuotaName } from "@budibase/types"
-const { getProdAppID } = require("@budibase/backend-core/db")
+const { db: dbCore } = require("@budibase/backend-core")
 
 describe("syncRows", () => {
   let config = new TestConfig(false)
@@ -38,12 +38,12 @@ describe("syncRows", () => {
       // assert the migration worked
       usageDoc = await quotas.getQuotaUsage()
       expect(usageDoc.usageQuota.rows).toEqual(3)
-      expect(usageDoc.apps?.[getProdAppID(app1.appId)].usageQuota.rows).toEqual(
-        1
-      )
-      expect(usageDoc.apps?.[getProdAppID(app2.appId)].usageQuota.rows).toEqual(
-        2
-      )
+      expect(
+        usageDoc.apps?.[dbCore.getProdAppID(app1.appId)].usageQuota.rows
+      ).toEqual(1)
+      expect(
+        usageDoc.apps?.[dbCore.getProdAppID(app2.appId)].usageQuota.rows
+      ).toEqual(2)
     })
   })
 })

package/src/migrations/functions/userEmailViewCasing.ts

@@ -1,4 +1,4 @@
-const { createNewUserEmailView } = require("@budibase/backend-core/db")
+import { db as dbCore } from "@budibase/backend-core"
 
 /**
  * Date:
@@ -8,6 +8,6 @@ const { createNewUserEmailView } = require("@budibase/backend-core/db")
  * Recreate the user email view to include latest changes i.e. lower casing the email address
  */
 
-export const run = async (db: any) => {
-  await createNewUserEmailView(db)
+export const run = async () => {
+  await dbCore.createNewUserEmailView()
 }

package/src/sdk/app/backups/exports.ts

@@ -1,6 +1,5 @@
-import { db as dbCore } from "@budibase/backend-core"
+import { db as dbCore, objectStore } from "@budibase/backend-core"
 import { budibaseTempDir } from "../../../utilities/budibaseDir"
-import { retrieveDirectory } from "../../../utilities/fileSystem/utilities"
 import { streamFile, createTempFolder } from "../../../utilities/fileSystem"
 import { ObjectStoreBuckets } from "../../../constants"
 import {
@@ -88,7 +87,10 @@ export async function exportApp(appId: string, config?: ExportOpts) {
   // export bucket contents
   let tmpPath
   if (!env.isTest()) {
-    tmpPath = await retrieveDirectory(ObjectStoreBuckets.APPS, appPath)
+    tmpPath = await objectStore.retrieveDirectory(
+      ObjectStoreBuckets.APPS,
+      appPath
+    )
   } else {
     tmpPath = createTempFolder(uuid())
   }

package/src/sdk/app/backups/imports.ts

@@ -1,12 +1,8 @@
-import { db as dbCore } from "@budibase/backend-core"
+import { db as dbCore, objectStore } from "@budibase/backend-core"
 import { Database } from "@budibase/types"
 import { getAutomationParams, TABLE_ROW_PREFIX } from "../../../db/utils"
 import { budibaseTempDir } from "../../../utilities/budibaseDir"
 import { DB_EXPORT_FILE, GLOBAL_DB_EXPORT_FILE } from "./constants"
-import {
-  upload,
-  uploadDirectory,
-} from "../../../utilities/fileSystem/utilities"
 import { downloadTemplate } from "../../../utilities/fileSystem"
 import { FieldTypes, ObjectStoreBuckets } from "../../../constants"
 import { join } from "path"
@@ -174,11 +170,11 @@ export async function importApp(
         filename = join(prodAppId, filename)
         if (fs.lstatSync(path).isDirectory()) {
           promises.push(
-            uploadDirectory(ObjectStoreBuckets.APPS, path, filename)
+            objectStore.uploadDirectory(ObjectStoreBuckets.APPS, path, filename)
           )
         } else {
           promises.push(
-            upload({
+            objectStore.upload({
               bucket: ObjectStoreBuckets.APPS,
               path,
               filename,

package/src/startup.ts

@@ -1,5 +1,5 @@
 import * as env from "./environment"
-import redis from "./utilities/redis"
+import * as redis from "./utilities/redis"
 import {
   createAdminUser,
   generateApiKey,
@@ -19,7 +19,7 @@ import eventEmitter from "./events"
 import * as migrations from "./migrations"
 import bullboard from "./automations/bullboard"
 import * as pro from "@budibase/pro"
-import api from "./api"
+import * as api from "./api"
 import sdk from "./sdk"
 const pino = require("koa-pino-logger")