@budibase/backend-core 2.9.40-alpha.6 → 2.10.1

package/src/context/mainContext.ts

@@ -0,0 +1,310 @@
+// 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 } 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 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 {null|string} 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(updates: ContextMap, task: any) {
+  // see if there already is a context setup
+  let context: ContextMap = updateContext(updates)
+  return Context.run(context, task)
+}
+
+export async function doInAutomationContext(params: {
+  appId: string
+  automationId: string
+  task: any
+}): Promise<any> {
+  const tenantId = getTenantIDFromAppID(params.appId)
+  return newContext(
+    {
+      tenantId,
+      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 | null,
+  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(
+  appId: string | null,
+  task: any
+): Promise<any> {
+  if (!appId && !env.isTest()) {
+    throw new Error("appId is required")
+  }
+
+  let updates: ContextMap
+  if (!appId) {
+    updates = { appId: "" }
+  } else {
+    const tenantId = getTenantIDFromAppID(appId)
+    updates = { appId }
+    if (tenantId) {
+      updates.tenantId = tenantId
+    }
+  }
+  return newContext(updates, task)
+}
+
+export async function doInIdentityContext(
+  identity: IdentityContext,
+  task: any
+): Promise<any> {
+  if (!identity) {
+    throw new Error("identity is required")
+  }
+
+  const context: ContextMap = {
+    identity,
+  }
+  if (identity.tenantId) {
+    context.tenantId = identity.tenantId
+  }
+  return newContext(context, task)
+}
+
+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 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 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()
+  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
+}

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

@@ -0,0 +1,147 @@
+import { testEnv } from "../../../tests/extra"
+import * as context from "../"
+import { DEFAULT_TENANT_ID } from "../../constants"
+
+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)
+    })
+  })
+})

package/src/context/types.ts

@@ -0,0 +1,11 @@
+import { IdentityContext } from "@budibase/types"
+
+// 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
+  automationId?: string
+}

package/src/db/Replication.ts

@@ -0,0 +1,84 @@
+import { getPouchDB, closePouchDB } from "./couch"
+import { DocumentType } from "../constants"
+
+class Replication {
+  source: any
+  target: any
+  replication: any
+
+  /**
+   *
+   * @param {String} source - the DB you want to replicate or rollback to
+   * @param {String} target - the DB you want to replicate to, or rollback from
+   */
+  constructor({ source, target }: any) {
+    this.source = getPouchDB(source)
+    this.target = getPouchDB(target)
+  }
+
+  close() {
+    return Promise.all([closePouchDB(this.source), closePouchDB(this.target)])
+  }
+
+  promisify(operation: any, opts = {}) {
+    return new Promise(resolve => {
+      operation(this.target, opts)
+        .on("denied", function (err: any) {
+          // a document failed to replicate (e.g. due to permissions)
+          throw new Error(`Denied: Document failed to replicate ${err}`)
+        })
+        .on("complete", function (info: any) {
+          return resolve(info)
+        })
+        .on("error", function (err: any) {
+          throw new Error(`Replication Error: ${err}`)
+        })
+    })
+  }
+
+  /**
+   * Two way replication operation, intended to be promise based.
+   * @param {Object} opts - PouchDB replication options
+   */
+  sync(opts = {}) {
+    this.replication = this.promisify(this.source.sync, opts)
+    return this.replication
+  }
+
+  /**
+   * One way replication operation, intended to be promise based.
+   * @param {Object} opts - PouchDB replication options
+   */
+  replicate(opts = {}) {
+    this.replication = this.promisify(this.source.replicate.to, opts)
+    return this.replication
+  }
+
+  appReplicateOpts() {
+    return {
+      filter: (doc: any) => {
+        if (doc._id && doc._id.startsWith(DocumentType.AUTOMATION_LOG)) {
+          return false
+        }
+        return doc._id !== DocumentType.APP_METADATA
+      },
+    }
+  }
+
+  /**
+   * Rollback the target DB back to the state of the source DB
+   */
+  async rollback() {
+    await this.target.destroy()
+    // Recreate the DB again
+    this.target = getPouchDB(this.target.name)
+    // take the opportunity to remove deleted tombstones
+    await this.replicate()
+  }
+
+  cancel() {
+    this.replication.cancel()
+  }
+}
+
+export default Replication

package/src/db/constants.ts

@@ -0,0 +1,10 @@
+export const CONSTANT_INTERNAL_ROW_COLS = [
+  "_id",
+  "_rev",
+  "type",
+  "createdAt",
+  "updatedAt",
+  "tableId",
+] as const
+
+export const CONSTANT_EXTERNAL_ROW_COLS = ["_id", "_rev", "tableId"] as const