@budibase/server 2.1.22-alpha.6 → 2.1.22-alpha.8

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

@@ -1,30 +1,34 @@
 const TestConfig = require("../../tests/utilities/TestConfiguration")
 const { basicTable } = require("../../tests/utilities/structures")
 const linkUtils = require("../linkedRows/linkUtils")
-const { getAppDB } = require("@budibase/backend-core/context")
-const { doWithDB } = require("@budibase/backend-core/db")
+const { context } = require("@budibase/backend-core")
 
 describe("test link functionality", () => {
   const config = new TestConfig(false)
+  let appId
 
   describe("getLinkedTable", () => {
-    let db, table
+    let table
     beforeEach(async () => {
-      await config.init()
-      db = getAppDB()
+      const app = await config.init()
+      appId = app.appId
       table = await config.createTable()
     })
 
     it("should be able to retrieve a linked table from a list", async () => {
-      const retrieved = await linkUtils.getLinkedTable(table._id, [table])
-      expect(retrieved._id).toBe(table._id)
+      await context.doInAppContext(appId, async () => {
+        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(table._id, tables)
-      expect(retrieved._id).toBe(table._id)
-      expect(tables[0]).toBeDefined()
+      await context.doInAppContext(appId, async () => {
+        const retrieved = await linkUtils.getLinkedTable(table._id, tables)
+        expect(retrieved._id).toBe(table._id)
+        expect(tables[0]).toBeDefined()
+      })
     })
   })
 
@@ -48,15 +52,14 @@ describe("test link functionality", () => {
   describe("getLinkDocuments", () => {
     it("should create the link view when it doesn't exist", async () => {
       // create the DB and a very basic app design DB
-      const output = await doWithDB("test", async db => {
-        await db.put({ _id: "_design/database", views: {} })
-        return await linkUtils.getLinkDocuments({
+      await context.doInAppContext(appId, async () => {
+        const output = await linkUtils.getLinkDocuments({
           tableId: "test",
           rowId: "test",
           includeDocs: false,
         })
+        expect(Array.isArray(output)).toBe(true)
       })
-      expect(Array.isArray(output)).toBe(true)
     })
   })
 })

package/src/db/{utils.js → utils.ts}

@@ -1,44 +1,19 @@
-const newid = require("./newid")
-const {
-  DocumentType: CoreDocType,
-  InternalTable,
-  getRoleParams,
-  generateRoleID,
-  APP_DEV_PREFIX,
-  APP_PREFIX,
-  SEPARATOR,
-  StaticDatabases,
-  isDevAppID,
-  isProdAppID,
-  getDevelopmentAppID,
-  generateAppID,
-  getQueryIndex,
-  ViewName,
-  getDocParams,
-  getRowParams,
-  generateRowID,
-  getUserMetadataParams,
-  generateUserMetadataID,
-  getGlobalIDFromUserMetadataID,
-} = require("@budibase/backend-core/db")
-
-const UNICODE_MAX = "\ufff0"
-
-const AppStatus = {
+import newid from "./newid"
+import { db as dbCore } from "@budibase/backend-core"
+
+type Optional = string | null
+
+export const AppStatus = {
   DEV: "development",
   ALL: "all",
   DEPLOYED: "published",
 }
 
-const DocumentType = CoreDocType
-
-const SearchIndexes = {
+export const SearchIndexes = {
   ROWS: "rows",
 }
 
-exports.StaticDatabases = StaticDatabases
-
-const BudibaseInternalDB = {
+export const BudibaseInternalDB = {
   _id: "bb_internal",
   type: "budibase",
   name: "Budibase DB",
@@ -46,37 +21,36 @@ const BudibaseInternalDB = {
   config: {},
 }
 
-exports.APP_PREFIX = APP_PREFIX
-exports.APP_DEV_PREFIX = APP_DEV_PREFIX
-exports.isDevAppID = isDevAppID
-exports.isProdAppID = isProdAppID
-exports.USER_METDATA_PREFIX = `${DocumentType.ROW}${SEPARATOR}${InternalTable.USER_METADATA}${SEPARATOR}`
-exports.LINK_USER_METADATA_PREFIX = `${DocumentType.LINK}${SEPARATOR}${InternalTable.USER_METADATA}${SEPARATOR}`
-exports.TABLE_ROW_PREFIX = `${DocumentType.ROW}${SEPARATOR}${DocumentType.TABLE}`
-exports.ViewName = ViewName
-exports.InternalTables = InternalTable
-exports.DocumentType = DocumentType
-exports.SEPARATOR = SEPARATOR
-exports.UNICODE_MAX = UNICODE_MAX
-exports.SearchIndexes = SearchIndexes
-exports.AppStatus = AppStatus
-exports.BudibaseInternalDB = BudibaseInternalDB
-exports.generateAppID = generateAppID
-exports.generateDevAppID = getDevelopmentAppID
-exports.generateRoleID = generateRoleID
-exports.getRoleParams = getRoleParams
-exports.getQueryIndex = getQueryIndex
-exports.getDocParams = getDocParams
-exports.getRowParams = getRowParams
-exports.generateRowID = generateRowID
-exports.getUserMetadataParams = getUserMetadataParams
-exports.generateUserMetadataID = generateUserMetadataID
-exports.getGlobalIDFromUserMetadataID = getGlobalIDFromUserMetadataID
+export const SEPARATOR = dbCore.SEPARATOR
+export const StaticDatabases = dbCore.StaticDatabases
+export const DocumentType = dbCore.DocumentType
+export const APP_PREFIX = dbCore.APP_PREFIX
+export const APP_DEV_PREFIX = dbCore.APP_DEV_PREFIX
+export const isDevAppID = dbCore.isDevAppID
+export const isProdAppID = dbCore.isProdAppID
+export const USER_METDATA_PREFIX = `${DocumentType.ROW}${SEPARATOR}${dbCore.InternalTable.USER_METADATA}${SEPARATOR}`
+export const LINK_USER_METADATA_PREFIX = `${DocumentType.LINK}${SEPARATOR}${dbCore.InternalTable.USER_METADATA}${SEPARATOR}`
+export const TABLE_ROW_PREFIX = `${DocumentType.ROW}${SEPARATOR}${DocumentType.TABLE}`
+export const ViewName = dbCore.ViewName
+export const InternalTables = dbCore.InternalTable
+export const UNICODE_MAX = dbCore.UNICODE_MAX
+export const generateAppID = dbCore.generateAppID
+export const generateDevAppID = dbCore.getDevelopmentAppID
+export const generateRoleID = dbCore.generateRoleID
+export const getRoleParams = dbCore.getRoleParams
+export const getQueryIndex = dbCore.getQueryIndex
+export const getDocParams = dbCore.getDocParams
+export const getRowParams = dbCore.getRowParams
+export const generateRowID = dbCore.generateRowID
+export const getUserMetadataParams = dbCore.getUserMetadataParams
+export const generateUserMetadataID = dbCore.generateUserMetadataID
+export const getGlobalIDFromUserMetadataID =
+  dbCore.getGlobalIDFromUserMetadataID
 
 /**
  * Gets parameters for retrieving tables, this is a utility function for the getDocParams function.
  */
-exports.getTableParams = (tableId = null, otherProps = {}) => {
+export function getTableParams(tableId?: Optional, otherProps = {}) {
   return getDocParams(DocumentType.TABLE, tableId, otherProps)
 }
 
@@ -84,7 +58,7 @@ exports.getTableParams = (tableId = null, otherProps = {}) => {
  * Generates a new table ID.
  * @returns {string} The new table ID which the table doc can be stored under.
  */
-exports.generateTableID = () => {
+export function generateTableID() {
   return `${DocumentType.TABLE}${SEPARATOR}${newid()}`
 }
 
@@ -93,7 +67,7 @@ exports.generateTableID = () => {
  * @param {string} rowId The ID of the row.
  * @returns {string} The table ID.
  */
-exports.getTableIDFromRowID = rowId => {
+export function getTableIDFromRowID(rowId: string) {
   const components = rowId
     .split(DocumentType.TABLE + SEPARATOR)[1]
     .split(SEPARATOR)
@@ -103,7 +77,10 @@ exports.getTableIDFromRowID = rowId => {
 /**
  * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
  */
-exports.getAutomationParams = (automationId = null, otherProps = {}) => {
+export function getAutomationParams(
+  automationId?: Optional,
+  otherProps: any = {}
+) {
   return getDocParams(DocumentType.AUTOMATION, automationId, otherProps)
 }
 
@@ -111,7 +88,7 @@ exports.getAutomationParams = (automationId = null, otherProps = {}) => {
  * Generates a new automation ID.
  * @returns {string} The new automation ID which the automation doc can be stored under.
  */
-exports.generateAutomationID = () => {
+export function generateAutomationID() {
   return `${DocumentType.AUTOMATION}${SEPARATOR}${newid()}`
 }
 
@@ -126,14 +103,14 @@ exports.generateAutomationID = () => {
  * @param {string} fieldName2 the name of the field in the linked row.
  * @returns {string} The new link doc ID which the automation doc can be stored under.
  */
-exports.generateLinkID = (
-  tableId1,
-  tableId2,
-  rowId1,
-  rowId2,
-  fieldName1,
-  fieldName2
-) => {
+export function generateLinkID(
+  tableId1: string,
+  tableId2: string,
+  rowId1: string,
+  rowId2: string,
+  fieldName1: string,
+  fieldName2: string
+) {
   const tables = `${SEPARATOR}${tableId1}${SEPARATOR}${tableId2}`
   const rows = `${SEPARATOR}${rowId1}${SEPARATOR}${rowId2}`
   const fields = `${SEPARATOR}${fieldName1}${SEPARATOR}${fieldName2}`
@@ -143,7 +120,7 @@ exports.generateLinkID = (
 /**
  * Gets parameters for retrieving link docs, this is a utility function for the getDocParams function.
  */
-exports.getLinkParams = (otherProps = {}) => {
+export function getLinkParams(otherProps: any = {}) {
   return getDocParams(DocumentType.LINK, null, otherProps)
 }
 
@@ -151,14 +128,14 @@ exports.getLinkParams = (otherProps = {}) => {
  * Generates a new layout ID.
  * @returns {string} The new layout ID which the layout doc can be stored under.
  */
-exports.generateLayoutID = id => {
+export function generateLayoutID(id: string) {
   return `${DocumentType.LAYOUT}${SEPARATOR}${id || newid()}`
 }
 
 /**
  * Gets parameters for retrieving layout, this is a utility function for the getDocParams function.
  */
-exports.getLayoutParams = (layoutId = null, otherProps = {}) => {
+export function getLayoutParams(layoutId?: Optional, otherProps: any = {}) {
   return getDocParams(DocumentType.LAYOUT, layoutId, otherProps)
 }
 
@@ -166,14 +143,14 @@ exports.getLayoutParams = (layoutId = null, otherProps = {}) => {
  * Generates a new screen ID.
  * @returns {string} The new screen ID which the screen doc can be stored under.
  */
-exports.generateScreenID = () => {
+export function generateScreenID() {
   return `${DocumentType.SCREEN}${SEPARATOR}${newid()}`
 }
 
 /**
  * Gets parameters for retrieving screens, this is a utility function for the getDocParams function.
  */
-exports.getScreenParams = (screenId = null, otherProps = {}) => {
+export function getScreenParams(screenId?: Optional, otherProps: any = {}) {
   return getDocParams(DocumentType.SCREEN, screenId, otherProps)
 }
 
@@ -181,14 +158,14 @@ exports.getScreenParams = (screenId = null, otherProps = {}) => {
  * Generates a new webhook ID.
  * @returns {string} The new webhook ID which the webhook doc can be stored under.
  */
-exports.generateWebhookID = () => {
+export function generateWebhookID() {
   return `${DocumentType.WEBHOOK}${SEPARATOR}${newid()}`
 }
 
 /**
  * Gets parameters for retrieving a webhook, this is a utility function for the getDocParams function.
  */
-exports.getWebhookParams = (webhookId = null, otherProps = {}) => {
+export function getWebhookParams(webhookId?: Optional, otherProps: any = {}) {
   return getDocParams(DocumentType.WEBHOOK, webhookId, otherProps)
 }
 
@@ -196,7 +173,7 @@ exports.getWebhookParams = (webhookId = null, otherProps = {}) => {
  * Generates a new datasource ID.
  * @returns {string} The new datasource ID which the webhook doc can be stored under.
  */
-exports.generateDatasourceID = ({ plus = false } = {}) => {
+export function generateDatasourceID({ plus = false } = {}) {
   return `${
     plus ? DocumentType.DATASOURCE_PLUS : DocumentType.DATASOURCE
   }${SEPARATOR}${newid()}`
@@ -205,7 +182,10 @@ exports.generateDatasourceID = ({ plus = false } = {}) => {
 /**
  * Gets parameters for retrieving a datasource, this is a utility function for the getDocParams function.
  */
-exports.getDatasourceParams = (datasourceId = null, otherProps = {}) => {
+export function getDatasourceParams(
+  datasourceId?: Optional,
+  otherProps: any = {}
+) {
   return getDocParams(DocumentType.DATASOURCE, datasourceId, otherProps)
 }
 
@@ -213,7 +193,7 @@ exports.getDatasourceParams = (datasourceId = null, otherProps = {}) => {
  * Generates a new query ID.
  * @returns {string} The new query ID which the query doc can be stored under.
  */
-exports.generateQueryID = datasourceId => {
+export function generateQueryID(datasourceId: string) {
   return `${
     DocumentType.QUERY
   }${SEPARATOR}${datasourceId}${SEPARATOR}${newid()}`
@@ -223,21 +203,21 @@ exports.generateQueryID = datasourceId => {
  * Generates a metadata ID for automations, used to track errors in recurring
  * automations etc.
  */
-exports.generateAutomationMetadataID = automationId => {
+export function generateAutomationMetadataID(automationId: string) {
   return `${DocumentType.AUTOMATION_METADATA}${SEPARATOR}${automationId}`
 }
 
 /**
  * Retrieve all automation metadata in an app database.
  */
-exports.getAutomationMetadataParams = (otherProps = {}) => {
+export function getAutomationMetadataParams(otherProps: any = {}) {
   return getDocParams(DocumentType.AUTOMATION_METADATA, null, otherProps)
 }
 
 /**
  * Gets parameters for retrieving a query, this is a utility function for the getDocParams function.
  */
-exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
+export function getQueryParams(datasourceId?: Optional, otherProps: any = {}) {
   if (datasourceId == null) {
     return getDocParams(DocumentType.QUERY, null, otherProps)
   }
@@ -253,15 +233,19 @@ exports.getQueryParams = (datasourceId = null, otherProps = {}) => {
  * Generates a new flag document ID.
  * @returns {string} The ID of the flag document that was generated.
  */
-exports.generateUserFlagID = userId => {
+export function generateUserFlagID(userId: string) {
   return `${DocumentType.USER_FLAG}${SEPARATOR}${userId}`
 }
 
-exports.generateMetadataID = (type, entityId) => {
+export function generateMetadataID(type: string, entityId: string) {
   return `${DocumentType.METADATA}${SEPARATOR}${type}${SEPARATOR}${entityId}`
 }
 
-exports.getMetadataParams = (type, entityId = null, otherProps = {}) => {
+export function getMetadataParams(
+  type: string,
+  entityId?: Optional,
+  otherProps: any = {}
+) {
   let docId = `${type}${SEPARATOR}`
   if (entityId != null) {
     docId += entityId
@@ -269,22 +253,22 @@ exports.getMetadataParams = (type, entityId = null, otherProps = {}) => {
   return getDocParams(DocumentType.METADATA, docId, otherProps)
 }
 
-exports.generateMemoryViewID = viewName => {
+export function generateMemoryViewID(viewName: string) {
   return `${DocumentType.MEM_VIEW}${SEPARATOR}${viewName}`
 }
 
-exports.getMemoryViewParams = (otherProps = {}) => {
+export function getMemoryViewParams(otherProps: any = {}) {
   return getDocParams(DocumentType.MEM_VIEW, null, otherProps)
 }
 
-exports.generatePluginID = name => {
+export function generatePluginID(name: string) {
   return `${DocumentType.PLUGIN}${SEPARATOR}${name}`
 }
 
 /**
  * This can be used with the db.allDocs to get a list of IDs
  */
-exports.getMultiIDParams = ids => {
+export function getMultiIDParams(ids: string[]) {
   return {
     keys: ids,
     include_docs: true,

package/src/integrations/googlesheets.ts

@@ -12,10 +12,7 @@ import { buildExternalTableId } from "./utils"
 import { DataSourceOperation, FieldTypes } from "../constants"
 import { GoogleSpreadsheet } from "google-spreadsheet"
 import env from "../environment"
-
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const { getScopedConfig } = require("@budibase/backend-core/db")
-const { Configs } = require("@budibase/backend-core/constants")
+import { tenancy, db as dbCore, constants } from "@budibase/backend-core"
 const fetch = require("node-fetch")
 
 interface GoogleSheetsConfig {
@@ -176,9 +173,9 @@ class GoogleSheetsIntegration implements DatasourcePlus {
   async connect() {
     try {
       // Initialise oAuth client
-      const db = getGlobalDB()
-      let googleConfig = await getScopedConfig(db, {
-        type: Configs.GOOGLE,
+      const db = tenancy.getGlobalDB()
+      let googleConfig = await dbCore.getScopedConfig(db, {
+        type: constants.Config.GOOGLE,
       })
 
       if (!googleConfig) {

package/src/middleware/appInfo.ts

@@ -0,0 +1,20 @@
+import { isDevAppID, isProdAppID } from "../db/utils"
+import { BBContext } from "@budibase/types"
+
+export enum AppType {
+  DEV = "dev",
+  PROD = "prod",
+}
+
+export function middleware({ appType }: { appType?: AppType } = {}) {
+  return (ctx: BBContext, next: any) => {
+    const appId = ctx.appId
+    if (appType === AppType.DEV && appId && !isDevAppID(appId)) {
+      ctx.throw(400, "Only apps in development support this endpoint")
+    }
+    if (appType === AppType.PROD && appId && !isProdAppID(appId)) {
+      ctx.throw(400, "Only apps in production support this endpoint")
+    }
+    return next()
+  }
+}

package/src/middleware/authorized.ts

@@ -4,8 +4,8 @@ import {
   BUILTIN_ROLE_IDS,
 } from "@budibase/backend-core/roles"
 const {
-  PermissionTypes,
-  PermissionLevels,
+  PermissionType,
+  PermissionLevel,
   doesHaveBasePermission,
 } = require("@budibase/backend-core/permissions")
 const builderMiddleware = require("./builder")
@@ -33,7 +33,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 === PermissionTypes.BUILDER
+  const isBuilderApi = permType === PermissionType.BUILDER
   if (isBuilderApi && !isBuilder) {
     return ctx.throw(403, "Not Authorized")
   }
@@ -91,9 +91,9 @@ export = (permType: any, permLevel: any = null, opts = { schema: false }) =>
     let resourceRoles: any = []
     let otherLevelRoles: any = []
     const otherLevel =
-      permLevel === PermissionLevels.READ
-        ? PermissionLevels.WRITE
-        : PermissionLevels.READ
+      permLevel === PermissionLevel.READ
+        ? PermissionLevel.WRITE
+        : PermissionLevel.READ
     const appId = getAppId()
     if (appId && hasResource(ctx)) {
       resourceRoles = await getRequiredResourceRole(permLevel, ctx)

package/src/middleware/{builder.js → builder.ts}

@@ -1,14 +1,16 @@
-const { APP_DEV_PREFIX } = require("../db/utils")
-const {
+import {
+  APP_DEV_PREFIX,
+  DocumentType,
+  getGlobalIDFromUserMetadataID,
+} from "../db/utils"
+import {
   doesUserHaveLock,
   updateLock,
   checkDebounce,
   setDebounce,
-} = require("../utilities/redis")
-const { doWithDB } = require("@budibase/backend-core/db")
-const { DocumentType, getGlobalIDFromUserMetadataID } = require("../db/utils")
-const { PermissionTypes } = require("@budibase/backend-core/permissions")
-const { app: appCache } = require("@budibase/backend-core/cache")
+} from "../utilities/redis"
+import { db as dbCore, cache, permissions } from "@budibase/backend-core"
+import { BBContext, Database } from "@budibase/types"
 
 const DEBOUNCE_TIME_SEC = 30
 
@@ -21,11 +23,11 @@ const DEBOUNCE_TIME_SEC = 30
  * through the authorized middleware                *
  ****************************************************/
 
-async function checkDevAppLocks(ctx) {
+async function checkDevAppLocks(ctx: BBContext) {
   const appId = ctx.appId
 
   // if any public usage, don't proceed
-  if (!ctx.user._id && !ctx.user.userId) {
+  if (!ctx.user?._id && !ctx.user?.userId) {
     return
   }
 
@@ -41,34 +43,34 @@ async function checkDevAppLocks(ctx) {
   await updateLock(appId, ctx.user)
 }
 
-async function updateAppUpdatedAt(ctx) {
+async function updateAppUpdatedAt(ctx: BBContext) {
   const appId = ctx.appId
   // if debouncing skip this update
   // get methods also aren't updating
   if (ctx.method === "GET" || (await checkDebounce(appId))) {
     return
   }
-  await doWithDB(appId, async db => {
+  await dbCore.doWithDB(appId, async (db: Database) => {
     const metadata = await db.get(DocumentType.APP_METADATA)
     metadata.updatedAt = new Date().toISOString()
 
-    metadata.updatedBy = getGlobalIDFromUserMetadataID(ctx.user.userId)
+    metadata.updatedBy = getGlobalIDFromUserMetadataID(ctx.user?.userId!)
 
     const response = await db.put(metadata)
     metadata._rev = response.rev
-    await appCache.invalidateAppMetadata(appId, metadata)
+    await cache.app.invalidateAppMetadata(appId, metadata)
     // set a new debounce record with a short TTL
     await setDebounce(appId, DEBOUNCE_TIME_SEC)
   })
 }
 
-module.exports = async (ctx, permType) => {
+export = async function builder(ctx: BBContext, permType: string) {
   const appId = ctx.appId
   // this only functions within an app context
   if (!appId) {
     return
   }
-  const isBuilderApi = permType === PermissionTypes.BUILDER
+  const isBuilderApi = permType === permissions.PermissionType.BUILDER
   const referer = ctx.headers["referer"]
 
   const overviewPath = "/builder/portal/overview/"