@budibase/backend-core 3.2.5 → 3.2.7

package/src/context/mainContext.ts

@@ -1,422 +0,0 @@
-// some test cases call functions directly, need to
-// store an app ID to pretend there is a context
-import env from "../environment"
-import Context from "./Context"
-import * as conversions from "../docIds/conversions"
-import { getDB } from "../db/db"
-import {
-  DocumentType,
-  SEPARATOR,
-  StaticDatabases,
-  DEFAULT_TENANT_ID,
-} from "../constants"
-import { Database, IdentityContext, Snippet, App, Table } from "@budibase/types"
-import { ContextMap } from "./types"
-
-let TEST_APP_ID: string | null = null
-
-export function getGlobalDBName(tenantId?: string) {
-  // tenant ID can be set externally, for example user API where
-  // new tenants are being created, this may be the case
-  if (!tenantId) {
-    tenantId = getTenantId()
-  }
-  return baseGlobalDBName(tenantId)
-}
-
-export function getAuditLogDBName(tenantId?: string) {
-  if (!tenantId) {
-    tenantId = getTenantId()
-  }
-  if (tenantId === DEFAULT_TENANT_ID) {
-    return StaticDatabases.AUDIT_LOGS.name
-  } else {
-    return `${tenantId}${SEPARATOR}${StaticDatabases.AUDIT_LOGS.name}`
-  }
-}
-
-export function getScimDBName(tenantId?: string) {
-  if (!tenantId) {
-    tenantId = getTenantId()
-  }
-  if (tenantId === DEFAULT_TENANT_ID) {
-    return StaticDatabases.SCIM_LOGS.name
-  } else {
-    return `${tenantId}${SEPARATOR}${StaticDatabases.SCIM_LOGS.name}`
-  }
-}
-
-export function baseGlobalDBName(tenantId: string | undefined | null) {
-  if (!tenantId || tenantId === DEFAULT_TENANT_ID) {
-    return StaticDatabases.GLOBAL.name
-  } else {
-    return `${tenantId}${SEPARATOR}${StaticDatabases.GLOBAL.name}`
-  }
-}
-
-export function getPlatformURL() {
-  return env.PLATFORM_URL
-}
-
-export function isMultiTenant() {
-  return !!env.MULTI_TENANCY
-}
-
-export function isTenantIdSet() {
-  const context = Context.get()
-  return !!context?.tenantId
-}
-
-export function isTenancyEnabled() {
-  return env.MULTI_TENANCY
-}
-
-/**
- * Given an app ID this will attempt to retrieve the tenant ID from it.
- * @return The tenant ID found within the app ID.
- */
-export function getTenantIDFromAppID(appId: string) {
-  if (!appId) {
-    return undefined
-  }
-  if (!isMultiTenant()) {
-    return DEFAULT_TENANT_ID
-  }
-  const split = appId.split(SEPARATOR)
-  const hasDev = split[1] === DocumentType.DEV
-  if ((hasDev && split.length === 3) || (!hasDev && split.length === 2)) {
-    return undefined
-  }
-  if (hasDev) {
-    return split[2]
-  } else {
-    return split[1]
-  }
-}
-
-function updateContext(updates: ContextMap): ContextMap {
-  let context: ContextMap
-  try {
-    context = Context.get()
-  } catch (err) {
-    // no context, start empty
-    context = {}
-  }
-  context = {
-    ...context,
-    ...updates,
-  }
-  return context
-}
-
-async function newContext<T>(updates: ContextMap, task: () => T) {
-  guardMigration()
-
-  // see if there already is a context setup
-  let context: ContextMap = updateContext(updates)
-  return Context.run(context, task)
-}
-
-export async function doInAutomationContext<T>(params: {
-  appId: string
-  automationId: string
-  task: () => T
-}): Promise<T> {
-  await ensureSnippetContext()
-  return newContext(
-    {
-      tenantId: getTenantIDFromAppID(params.appId),
-      appId: params.appId,
-      automationId: params.automationId,
-    },
-    params.task
-  )
-}
-
-export async function doInContext(appId: string, task: any): Promise<any> {
-  const tenantId = getTenantIDFromAppID(appId)
-  return newContext(
-    {
-      tenantId,
-      appId,
-    },
-    task
-  )
-}
-
-export async function doInTenant<T>(
-  tenantId: string | undefined,
-  task: () => T
-): Promise<T> {
-  // make sure default always selected in single tenancy
-  if (!env.MULTI_TENANCY) {
-    tenantId = tenantId || DEFAULT_TENANT_ID
-  }
-
-  const updates = tenantId ? { tenantId } : {}
-  return newContext(updates, task)
-}
-
-export async function doInAppContext<T>(
-  appId: string,
-  task: () => T
-): Promise<T> {
-  return _doInAppContext(appId, task)
-}
-
-async function _doInAppContext<T>(
-  appId: string,
-  task: () => T,
-  extraContextSettings?: ContextMap
-): Promise<T> {
-  if (!appId) {
-    throw new Error("appId is required")
-  }
-
-  const tenantId = getTenantIDFromAppID(appId)
-  const updates: ContextMap = { appId, ...extraContextSettings }
-  if (tenantId) {
-    updates.tenantId = tenantId
-  }
-
-  return newContext(updates, task)
-}
-
-export async function doInIdentityContext<T>(
-  identity: IdentityContext,
-  task: () => T
-): Promise<T> {
-  if (!identity) {
-    throw new Error("identity is required")
-  }
-
-  const context: ContextMap = {
-    identity,
-  }
-  if (identity.tenantId) {
-    context.tenantId = identity.tenantId
-  }
-  return newContext(context, task)
-}
-
-function guardMigration() {
-  const context = Context.get()
-  if (context?.isMigrating) {
-    throw new Error(
-      "The context cannot be changed, a migration is currently running"
-    )
-  }
-}
-
-export async function doInAppMigrationContext<T>(
-  appId: string,
-  task: () => T
-): Promise<T> {
-  return _doInAppContext(appId, task, {
-    isMigrating: true,
-  })
-}
-
-export function getIdentity(): IdentityContext | undefined {
-  try {
-    const context = Context.get()
-    return context?.identity
-  } catch (e) {
-    // do nothing - identity is not in context
-  }
-}
-
-export function getTenantId(): string {
-  if (!isMultiTenant()) {
-    return DEFAULT_TENANT_ID
-  }
-  const context = Context.get()
-  const tenantId = context?.tenantId
-  if (!tenantId) {
-    throw new Error("Tenant id not found")
-  }
-  return tenantId
-}
-
-export function getAutomationId(): string | undefined {
-  const context = Context.get()
-  return context?.automationId
-}
-
-export function getAppId(): string | undefined {
-  const context = Context.get()
-  const foundId = context?.appId
-  if (!foundId && env.isTest() && TEST_APP_ID) {
-    return TEST_APP_ID
-  } else {
-    return foundId
-  }
-}
-
-export function getIP(): string | undefined {
-  const context = Context.get()
-  return context?.ip
-}
-
-export const getProdAppId = () => {
-  const appId = getAppId()
-  if (!appId) {
-    throw new Error("Could not get appId")
-  }
-  return conversions.getProdAppID(appId)
-}
-
-export function doInEnvironmentContext(
-  values: Record<string, string>,
-  task: any
-) {
-  if (!values) {
-    throw new Error("Must supply environment variables.")
-  }
-  const updates = {
-    environmentVariables: values,
-  }
-  return newContext(updates, task)
-}
-
-export function doInScimContext(task: any) {
-  const updates: ContextMap = {
-    isScim: true,
-  }
-  return newContext(updates, task)
-}
-
-export function doInIPContext(ip: string, task: any) {
-  return newContext({ ip }, task)
-}
-
-export async function ensureSnippetContext(enabled = !env.isTest()) {
-  const ctx = getCurrentContext()
-
-  // If we've already added snippets to context, continue
-  if (!ctx || ctx.snippets) {
-    return
-  }
-
-  // Otherwise get snippets for this app and update context
-  let snippets: Snippet[] | undefined
-  const db = getAppDB()
-  if (db && enabled) {
-    const app = await db.get<App>(DocumentType.APP_METADATA)
-    snippets = app.snippets
-  }
-
-  // Always set snippets to a non-null value so that we can tell we've attempted
-  // to load snippets
-  ctx.snippets = snippets || []
-}
-
-export function getEnvironmentVariables() {
-  const context = Context.get()
-  if (!context.environmentVariables) {
-    return null
-  } else {
-    return context.environmentVariables
-  }
-}
-
-export function getGlobalDB(): Database {
-  const context = Context.get()
-  if (!context || (env.MULTI_TENANCY && !context.tenantId)) {
-    throw new Error("Global DB not found")
-  }
-  return getDB(baseGlobalDBName(context?.tenantId))
-}
-
-export function getAuditLogsDB(): Database {
-  if (!getTenantId()) {
-    throw new Error("No tenant ID found - cannot open audit log DB")
-  }
-  return getDB(getAuditLogDBName())
-}
-
-/**
- * Gets the app database based on whatever the request
- * contained, dev or prod.
- */
-export function getAppDB(opts?: any): Database {
-  const appId = getAppId()
-  if (!appId) {
-    throw new Error("Unable to retrieve app DB - no app ID.")
-  }
-  return getDB(appId, opts)
-}
-
-/**
- * This specifically gets the prod app ID, if the request
- * contained a development app ID, this will get the prod one.
- */
-export function getProdAppDB(opts?: any): Database {
-  const appId = getAppId()
-  if (!appId) {
-    throw new Error("Unable to retrieve prod DB - no app ID.")
-  }
-  return getDB(conversions.getProdAppID(appId), opts)
-}
-
-/**
- * This specifically gets the dev app ID, if the request
- * contained a prod app ID, this will get the dev one.
- */
-export function getDevAppDB(opts?: any): Database {
-  const appId = getAppId()
-  if (!appId) {
-    throw new Error("Unable to retrieve dev DB - no app ID.")
-  }
-  return getDB(conversions.getDevelopmentAppID(appId), opts)
-}
-
-export function isScim(): boolean {
-  const context = Context.get()
-  const scimCall = context?.isScim
-  return !!scimCall
-}
-
-export function getCurrentContext(): ContextMap | undefined {
-  try {
-    return Context.get()
-  } catch (e) {
-    return undefined
-  }
-}
-
-export function getFeatureFlags<T extends Record<string, any>>(
-  key: string
-): T | undefined {
-  const context = getCurrentContext()
-  if (!context) {
-    return undefined
-  }
-  return context.featureFlagCache?.[key] as T
-}
-
-export function setFeatureFlags(key: string, value: Record<string, any>) {
-  const context = getCurrentContext()
-  if (!context) {
-    return
-  }
-  context.featureFlagCache ??= {}
-  context.featureFlagCache[key] = value
-}
-
-export function getTableForView(viewId: string): Table | undefined {
-  const context = getCurrentContext()
-  if (!context) {
-    return
-  }
-  return context.viewToTableCache?.[viewId]
-}
-
-export function setTableForView(viewId: string, table: Table) {
-  const context = getCurrentContext()
-  if (!context) {
-    return
-  }
-  context.viewToTableCache ??= {}
-  context.viewToTableCache[viewId] = table
-}

package/src/context/tests/index.spec.ts

@@ -1,255 +0,0 @@
-import { testEnv } from "../../../tests/extra"
-import * as context from "../"
-import { DEFAULT_TENANT_ID } from "../../constants"
-import { structures } from "../../../tests"
-import * as db from "../../db"
-import Context from "../Context"
-import { ContextMap } from "../types"
-import { IdentityType } from "@budibase/types"
-
-describe("context", () => {
-  describe("doInTenant", () => {
-    describe("single-tenancy", () => {
-      beforeAll(() => {
-        testEnv.singleTenant()
-      })
-
-      it("defaults to the default tenant", () => {
-        const tenantId = context.getTenantId()
-        expect(tenantId).toBe(DEFAULT_TENANT_ID)
-      })
-
-      it("defaults to the default tenant db", async () => {
-        await context.doInTenant(DEFAULT_TENANT_ID, () => {
-          const db = context.getGlobalDB()
-          expect(db.name).toBe("global-db")
-        })
-      })
-    })
-
-    describe("multi-tenancy", () => {
-      beforeAll(() => {
-        testEnv.multiTenant()
-      })
-
-      it("fails when no tenant id is set", () => {
-        const test = () => {
-          let error: any
-          try {
-            context.getTenantId()
-          } catch (e) {
-            error = e
-          }
-          expect(error.message).toBe("Tenant id not found")
-        }
-
-        // test under no tenancy
-        test()
-
-        // test after tenancy has been accessed to ensure cleanup
-        context.doInTenant("test", () => {})
-        test()
-      })
-
-      it("fails when no tenant db is set", () => {
-        const test = () => {
-          let error: any
-          try {
-            context.getGlobalDB()
-          } catch (e) {
-            error = e
-          }
-          expect(error.message).toBe("Global DB not found")
-        }
-
-        // test under no tenancy
-        test()
-
-        // test after tenancy has been accessed to ensure cleanup
-        context.doInTenant("test", () => {})
-        test()
-      })
-
-      it("sets tenant id", () => {
-        context.doInTenant("test", () => {
-          const tenantId = context.getTenantId()
-          expect(tenantId).toBe("test")
-        })
-      })
-
-      it("initialises the tenant db", async () => {
-        await context.doInTenant("test", () => {
-          const db = context.getGlobalDB()
-          expect(db.name).toBe("test_global-db")
-        })
-      })
-
-      it("sets the tenant id when nested with same tenant id", async () => {
-        await context.doInTenant("test", async () => {
-          const tenantId = context.getTenantId()
-          expect(tenantId).toBe("test")
-
-          await context.doInTenant("test", async () => {
-            const tenantId = context.getTenantId()
-            expect(tenantId).toBe("test")
-
-            await context.doInTenant("test", () => {
-              const tenantId = context.getTenantId()
-              expect(tenantId).toBe("test")
-            })
-          })
-        })
-      })
-
-      it("initialises the tenant db when nested with same tenant id", async () => {
-        await context.doInTenant("test", async () => {
-          const db = context.getGlobalDB()
-          expect(db.name).toBe("test_global-db")
-
-          await context.doInTenant("test", async () => {
-            const db = context.getGlobalDB()
-            expect(db.name).toBe("test_global-db")
-
-            await context.doInTenant("test", () => {
-              const db = context.getGlobalDB()
-              expect(db.name).toBe("test_global-db")
-            })
-          })
-        })
-      })
-
-      it("sets different tenant id inside another context", () => {
-        context.doInTenant("test", () => {
-          const tenantId = context.getTenantId()
-          expect(tenantId).toBe("test")
-
-          context.doInTenant("nested", () => {
-            const tenantId = context.getTenantId()
-            expect(tenantId).toBe("nested")
-
-            context.doInTenant("double-nested", () => {
-              const tenantId = context.getTenantId()
-              expect(tenantId).toBe("double-nested")
-            })
-          })
-        })
-      })
-    })
-  })
-
-  describe("doInScimContext", () => {
-    it("returns true when set", () => {
-      context.doInScimContext(() => {
-        const isScim = context.isScim()
-        expect(isScim).toBe(true)
-      })
-    })
-    it("returns false when not set", () => {
-      const isScim = context.isScim()
-      expect(isScim).toBe(false)
-    })
-  })
-
-  describe("doInAppMigrationContext", () => {
-    it("the context is set correctly", async () => {
-      const appId = db.generateAppID()
-
-      await context.doInAppMigrationContext(appId, () => {
-        const context = Context.get()
-
-        const expected: ContextMap = {
-          appId,
-          isMigrating: true,
-        }
-        expect(context).toEqual(expected)
-      })
-    })
-
-    it("the context is set correctly when running in a tenant id", async () => {
-      const tenantId = structures.tenant.id()
-      const appId = db.generateAppID(tenantId)
-
-      await context.doInAppMigrationContext(appId, () => {
-        const context = Context.get()
-
-        const expected: ContextMap = {
-          appId,
-          isMigrating: true,
-          tenantId,
-        }
-        expect(context).toEqual(expected)
-      })
-    })
-
-    it("the context is not modified outside the delegate", async () => {
-      const appId = db.generateAppID()
-
-      expect(Context.get()).toBeUndefined()
-
-      await context.doInAppMigrationContext(appId, () => {
-        const context = Context.get()
-
-        const expected: ContextMap = {
-          appId,
-          isMigrating: true,
-        }
-        expect(context).toEqual(expected)
-      })
-
-      expect(Context.get()).toBeUndefined()
-    })
-
-    it.each([
-      [
-        "doInAppMigrationContext",
-        () => context.doInAppMigrationContext(db.generateAppID(), () => {}),
-      ],
-      [
-        "doInAppContext",
-        () => context.doInAppContext(db.generateAppID(), () => {}),
-      ],
-      [
-        "doInAutomationContext",
-        () =>
-          context.doInAutomationContext({
-            appId: db.generateAppID(),
-            automationId: structures.generator.guid(),
-            task: () => {},
-          }),
-      ],
-      ["doInContext", () => context.doInContext(db.generateAppID(), () => {})],
-      [
-        "doInEnvironmentContext",
-        () => context.doInEnvironmentContext({}, () => {}),
-      ],
-      [
-        "doInIdentityContext",
-        () =>
-          context.doInIdentityContext(
-            {
-              account: undefined,
-              type: IdentityType.USER,
-              _id: structures.users.user()._id!,
-            },
-            () => {}
-          ),
-      ],
-      ["doInScimContext", () => context.doInScimContext(() => {})],
-      [
-        "doInTenant",
-        () => context.doInTenant(structures.tenant.id(), () => {}),
-      ],
-    ])(
-      "a nested context.%s function cannot run",
-      async (_, otherContextCall: () => Promise<void>) => {
-        await expect(
-          context.doInAppMigrationContext(db.generateAppID(), async () => {
-            await otherContextCall()
-          })
-        ).rejects.toThrow(
-          "The context cannot be changed, a migration is currently running"
-        )
-      }
-    )
-  })
-})

package/src/context/types.ts

@@ -1,26 +0,0 @@
-import { IdentityContext, Snippet, Table, VM } from "@budibase/types"
-import { OAuth2Client } from "google-auth-library"
-import { GoogleSpreadsheet } from "google-spreadsheet"
-
-// keep this out of Budibase types, don't want to expose context info
-export type ContextMap = {
-  tenantId?: string
-  appId?: string
-  identity?: IdentityContext
-  environmentVariables?: Record<string, string>
-  isScim?: boolean
-  ip?: string
-  automationId?: string
-  isMigrating?: boolean
-  vm?: VM
-  cleanup?: (() => void | Promise<void>)[]
-  snippets?: Snippet[]
-  googleSheets?: {
-    oauthClient: OAuth2Client
-    clients: Record<string, GoogleSpreadsheet>
-  }
-  featureFlagCache?: {
-    [key: string]: Record<string, any>
-  }
-  viewToTableCache?: Record<string, Table>
-}