@budibase/worker 2.1.42 → 2.1.43-alpha.1

package/src/api/routes/system/tests/accounts.spec.ts

@@ -1,10 +1,9 @@
 import sdk from "../../../../sdk"
-import { TestConfiguration, structures, API } from "../../../../tests"
+import { TestConfiguration, structures } from "../../../../tests"
 import { v4 as uuid } from "uuid"
 
 describe("accounts", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -23,7 +22,7 @@ describe("accounts", () => {
       it("saves account metadata", async () => {
         let account = structures.accounts.account()
 
-        const response = await api.accounts.saveMetadata(account)
+        const response = await config.api.accounts.saveMetadata(account)
 
         const id = sdk.accounts.formatAccountMetadataId(account.accountId)
         const metadata = await sdk.accounts.getMetadata(id)
@@ -34,9 +33,9 @@ describe("accounts", () => {
     describe("destroyMetadata", () => {
       it("destroys account metadata", async () => {
         const account = structures.accounts.account()
-        await api.accounts.saveMetadata(account)
+        await config.api.accounts.saveMetadata(account)
 
-        await api.accounts.destroyMetadata(account.accountId)
+        await config.api.accounts.destroyMetadata(account.accountId)
 
         const deleted = await sdk.accounts.getMetadata(account.accountId)
         expect(deleted).toBe(undefined)
@@ -45,7 +44,7 @@ describe("accounts", () => {
       it("destroys account metadata that does not exist", async () => {
         const id = uuid()
 
-        const response = await api.accounts.destroyMetadata(id)
+        const response = await config.api.accounts.destroyMetadata(id)
 
         expect(response.status).toBe(204)
       })

package/src/api/routes/system/tests/environment.spec.ts

@@ -0,0 +1,29 @@
+import { TestConfiguration } from "../../../../tests"
+
+describe("/api/system/environment", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("GET /api/system/environment", () => {
+    it("returns the expected environment", async () => {
+      const env = await config.api.environment.getEnvironment()
+      expect(env.body).toEqual({
+        cloud: true,
+        disableAccountPortal: false,
+        isDev: false,
+        multiTenancy: true,
+      })
+    })
+  })
+})

package/src/api/routes/system/tests/migrations.spec.ts

@@ -0,0 +1,63 @@
+const migrateFn = jest.fn()
+
+import { TestConfiguration } from "../../../../tests"
+
+jest.mock("../../../../migrations", () => {
+  return {
+    ...jest.requireActual("../../../../migrations"),
+    migrate: migrateFn,
+  }
+})
+
+describe("/api/system/migrations", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("POST /api/system/migrations/run", () => {
+    it("fails with no internal api key", async () => {
+      const res = await config.api.migrations.runMigrations({
+        headers: {},
+        status: 403,
+      })
+      expect(res.text).toBe("Unauthorized - no public worker access")
+      expect(migrateFn).toBeCalledTimes(0)
+    })
+
+    it("runs migrations", async () => {
+      const res = await config.api.migrations.runMigrations()
+      expect(res.text).toBe("OK")
+      expect(migrateFn).toBeCalledTimes(1)
+    })
+  })
+
+  describe("DELETE /api/system/migrations/definitions", () => {
+    it("fails with no internal api key", async () => {
+      const res = await config.api.migrations.getMigrationDefinitions({
+        headers: {},
+        status: 403,
+      })
+      expect(res.text).toBe("Unauthorized - no public worker access")
+    })
+
+    it("returns definitions", async () => {
+      const res = await config.api.migrations.getMigrationDefinitions()
+      expect(res.body).toEqual([
+        {
+          name: "global_info_sync_users",
+          type: "global",
+        },
+      ])
+    })
+  })
+})

package/src/api/routes/system/tests/restore.spec.ts

@@ -0,0 +1,36 @@
+import { TestConfiguration } from "../../../../tests"
+
+describe("/api/system/restore", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("POST /api/global/restore", () => {
+    it("doesn't allow restore in cloud", async () => {
+      const res = await config.api.restore.restored({ status: 405 })
+      expect(res.body).toEqual({
+        message: "This operation is not allowed in cloud.",
+        status: 405,
+      })
+    })
+
+    it("restores in self host", async () => {
+      config.modeSelf()
+      const res = await config.api.restore.restored()
+      expect(res.body).toEqual({
+        message: "System prepared after restore.",
+      })
+      config.modeCloud()
+    })
+  })
+})

package/src/api/routes/system/tests/status.spec.ts

@@ -0,0 +1,48 @@
+import { TestConfiguration } from "../../../../tests"
+import { accounts } from "@budibase/backend-core"
+import { mocks } from "@budibase/backend-core/tests"
+
+describe("/api/system/status", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("GET /api/system/status", () => {
+    it("returns status in self host", async () => {
+      config.modeSelf()
+      const res = await config.api.status.getStatus()
+      expect(res.body).toEqual({
+        health: {
+          passing: true,
+        },
+      })
+      expect(accounts.getStatus).toBeCalledTimes(0)
+      config.modeCloud()
+    })
+
+    it("returns status in cloud", async () => {
+      const value = {
+        health: {
+          passing: false,
+        },
+      }
+
+      mocks.accounts.getStatus.mockReturnValueOnce(value)
+
+      const res = await config.api.status.getStatus()
+
+      expect(accounts.getStatus).toBeCalledTimes(1)
+      expect(res.body).toEqual(value)
+    })
+  })
+})

package/src/api/routes/system/tests/tenants.spec.ts

@@ -0,0 +1,61 @@
+import { TestConfiguration } from "../../../../tests"
+import { tenancy } from "@budibase/backend-core"
+
+describe("/api/global/tenants", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("DELETE /api/system/tenants/:tenantId", () => {
+    it("allows deleting the current tenant", async () => {
+      const user = await config.createTenant()
+
+      await config.api.tenants.delete(user.tenantId, {
+        headers: config.authHeaders(user),
+      })
+    })
+
+    it("rejects deleting another tenant", async () => {
+      const user1 = await config.createTenant()
+      // create a second user in another tenant
+      const user2 = await config.createTenant()
+
+      const status = 403
+      const res = await config.api.tenants.delete(user1.tenantId, {
+        status,
+        headers: config.authHeaders(user2),
+      })
+
+      expect(res.body).toEqual({
+        message: "Tenant ID does not match current user",
+        status,
+      })
+    })
+
+    it("rejects non-admin", async () => {
+      const user1 = await config.createTenant()
+      // create an internal non-admin user
+      const user2 = await tenancy.doInTenant(user1.tenantId, () => {
+        return config.createUser()
+      })
+      await config.createSession(user2)
+
+      const res = await config.api.tenants.delete(user1.tenantId, {
+        status: 403,
+        headers: config.authHeaders(user2),
+      })
+
+      expect(res.body).toEqual(config.adminOnlyResponse())
+    })
+  })
+})

package/src/api/routes/validation/users.ts

@@ -1,4 +1,4 @@
-const { joiValidator } = require("@budibase/backend-core/auth")
+import { auth } from "@budibase/backend-core"
 import Joi from "joi"
 
 let schema: any = {
@@ -25,7 +25,7 @@ export const buildUserSaveValidation = (isSelf = false) => {
       _rev: Joi.string(),
     }
   }
-  return joiValidator.body(Joi.object(schema).required().unknown(true))
+  return auth.joiValidator.body(Joi.object(schema).required().unknown(true))
 }
 
 export const buildUserBulkUserValidation = (isSelf = false) => {
@@ -46,5 +46,5 @@ export const buildUserBulkUserValidation = (isSelf = false) => {
     }),
   }
 
-  return joiValidator.body(Joi.object(bulkSchema).required().unknown(true))
+  return auth.joiValidator.body(Joi.object(bulkSchema).required().unknown(true))
 }

package/src/constants/{index.js → index.ts}

@@ -1,97 +1,97 @@
-const { Configs } = require("@budibase/backend-core/constants")
+import { constants } from "@budibase/backend-core"
 
-exports.LOGO_URL =
+export const LOGO_URL =
   "https://d33wubrfki0l68.cloudfront.net/aac32159d7207b5085e74a7ef67afbb7027786c5/2b1fd/img/logo/bb-emblem.svg"
 
-exports.UserStatus = {
-  ACTIVE: "active",
-  INACTIVE: "inactive",
+export enum UserStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
 }
 
-exports.Configs = Configs
+export const Config = constants.Config
 
-exports.ConfigUploads = {
-  LOGO: "logo",
-  OIDC_LOGO: "oidc_logo",
+export enum ConfigUpload {
+  LOGO = "logo",
+  OIDC_LOGO = "oidc_logo",
 }
 
-const TemplateTypes = {
-  EMAIL: "email",
+export enum TemplateType {
+  EMAIL = "email",
 }
 
-const EmailTemplatePurpose = {
-  BASE: "base",
-  PASSWORD_RECOVERY: "password_recovery",
-  INVITATION: "invitation",
-  WELCOME: "welcome",
-  CUSTOM: "custom",
+export enum EmailTemplatePurpose {
+  BASE = "base",
+  PASSWORD_RECOVERY = "password_recovery",
+  INVITATION = "invitation",
+  WELCOME = "welcome",
+  CUSTOM = "custom",
 }
 
-const InternalTemplateBindings = {
-  PLATFORM_URL: "platformUrl",
-  COMPANY: "company",
-  LOGO_URL: "logoUrl",
-  EMAIL: "email",
-  USER: "user",
-  REQUEST: "request",
-  DOCS_URL: "docsUrl",
-  LOGIN_URL: "loginUrl",
-  CURRENT_YEAR: "currentYear",
-  CURRENT_DATE: "currentDate",
-  BODY: "body",
-  STYLES: "styles",
-  RESET_URL: "resetUrl",
-  RESET_CODE: "resetCode",
-  INVITE_URL: "inviteUrl",
-  INVITE_CODE: "inviteUrl",
-  CONTENTS: "contents",
+export enum InternalTemplateBinding {
+  PLATFORM_URL = "platformUrl",
+  COMPANY = "company",
+  LOGO_URL = "logoUrl",
+  EMAIL = "email",
+  USER = "user",
+  REQUEST = "request",
+  DOCS_URL = "docsUrl",
+  LOGIN_URL = "loginUrl",
+  CURRENT_YEAR = "currentYear",
+  CURRENT_DATE = "currentDate",
+  BODY = "body",
+  STYLES = "styles",
+  RESET_URL = "resetUrl",
+  RESET_CODE = "resetCode",
+  INVITE_URL = "inviteUrl",
+  INVITE_CODE = "inviteUrl",
+  CONTENTS = "contents",
 }
 
-const TemplateBindings = {
+export const TemplateBindings = {
   PLATFORM_URL: {
-    name: InternalTemplateBindings.PLATFORM_URL,
+    name: InternalTemplateBinding.PLATFORM_URL,
     description: "The URL used to access the budibase platform",
   },
   COMPANY: {
-    name: InternalTemplateBindings.COMPANY,
+    name: InternalTemplateBinding.COMPANY,
     description: "The name of your organization",
   },
   LOGO_URL: {
-    name: InternalTemplateBindings.LOGO_URL,
+    name: InternalTemplateBinding.LOGO_URL,
     description: "The URL of your organizations logo.",
   },
   EMAIL: {
-    name: InternalTemplateBindings.EMAIL,
+    name: InternalTemplateBinding.EMAIL,
     description: "The recipients email address.",
   },
   USER: {
-    name: InternalTemplateBindings.USER,
+    name: InternalTemplateBinding.USER,
     description: "The recipients user object.",
   },
   REQUEST: {
-    name: InternalTemplateBindings.REQUEST,
+    name: InternalTemplateBinding.REQUEST,
     description: "Additional request metadata.",
   },
   DOCS_URL: {
-    name: InternalTemplateBindings.DOCS_URL,
+    name: InternalTemplateBinding.DOCS_URL,
     description: "Organization documentation URL.",
   },
   LOGIN_URL: {
-    name: InternalTemplateBindings.LOGIN_URL,
+    name: InternalTemplateBinding.LOGIN_URL,
     description: "The URL used to log into the organization budibase instance.",
   },
   CURRENT_YEAR: {
-    name: InternalTemplateBindings.CURRENT_YEAR,
+    name: InternalTemplateBinding.CURRENT_YEAR,
     description: "The current year.",
   },
   CURRENT_DATE: {
-    name: InternalTemplateBindings.CURRENT_DATE,
+    name: InternalTemplateBinding.CURRENT_DATE,
     description: "The current date.",
   },
 }
 
-const TemplateMetadata = {
-  [TemplateTypes.EMAIL]: [
+export const TemplateMetadata = {
+  [TemplateType.EMAIL]: [
     {
       name: "Base format",
       description:
@@ -100,11 +100,11 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.BASE,
       bindings: [
         {
-          name: InternalTemplateBindings.BODY,
+          name: InternalTemplateBinding.BODY,
           description: "The main body of another email template.",
         },
         {
-          name: InternalTemplateBindings.STYLES,
+          name: InternalTemplateBinding.STYLES,
           description: "The contents of the Styling email template.",
         },
       ],
@@ -117,12 +117,12 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.PASSWORD_RECOVERY,
       bindings: [
         {
-          name: InternalTemplateBindings.RESET_URL,
+          name: InternalTemplateBinding.RESET_URL,
           description:
             "The URL the recipient must click to reset their password.",
         },
         {
-          name: InternalTemplateBindings.RESET_CODE,
+          name: InternalTemplateBinding.RESET_CODE,
           description:
             "The temporary password reset code used in the recipients password reset URL.",
         },
@@ -144,12 +144,12 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.INVITATION,
       bindings: [
         {
-          name: InternalTemplateBindings.INVITE_URL,
+          name: InternalTemplateBinding.INVITE_URL,
           description:
             "The URL the recipient must click to accept the invitation and activate their account.",
         },
         {
-          name: InternalTemplateBindings.INVITE_CODE,
+          name: InternalTemplateBinding.INVITE_CODE,
           description:
             "The temporary invite code used in the recipients invitation URL.",
         },
@@ -163,7 +163,7 @@ const TemplateMetadata = {
       purpose: EmailTemplatePurpose.CUSTOM,
       bindings: [
         {
-          name: InternalTemplateBindings.CONTENTS,
+          name: InternalTemplateBinding.CONTENTS,
           description: "Custom content body.",
         },
       ],
@@ -172,12 +172,5 @@ const TemplateMetadata = {
 }
 
 // all purpose combined
-exports.TemplatePurpose = {
-  ...EmailTemplatePurpose,
-}
-exports.TemplateTypes = TemplateTypes
-exports.EmailTemplatePurpose = EmailTemplatePurpose
-exports.TemplateMetadata = TemplateMetadata
-exports.TemplateBindings = TemplateBindings
-exports.InternalTemplateBindings = InternalTemplateBindings
-exports.GLOBAL_OWNER = "global"
+export { EmailTemplatePurpose as TemplatePurpose }
+export const GLOBAL_OWNER = "global"

package/src/constants/templates/{index.js → index.ts}

@@ -1,15 +1,15 @@
-const { readStaticFile } = require("../../utilities/fileSystem")
-const {
+import { readStaticFile } from "../../utilities/fileSystem"
+import {
   EmailTemplatePurpose,
-  TemplateTypes,
+  TemplateType,
   TemplatePurpose,
   GLOBAL_OWNER,
-} = require("../index")
-const { join } = require("path")
-const { getTemplateParams } = require("@budibase/backend-core/db")
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
+} from "../index"
+import { join } from "path"
+import { db as dbCore, tenancy } from "@budibase/backend-core"
+import { Template } from "@budibase/types"
 
-exports.EmailTemplates = {
+export const EmailTemplates = {
   [EmailTemplatePurpose.PASSWORD_RECOVERY]: readStaticFile(
     join(__dirname, "passwordRecovery.hbs")
   ),
@@ -23,10 +23,10 @@ exports.EmailTemplates = {
   [EmailTemplatePurpose.CUSTOM]: readStaticFile(join(__dirname, "custom.hbs")),
 }
 
-exports.addBaseTemplates = (templates, type = null) => {
+export function addBaseTemplates(templates: Template[], type?: string) {
   let purposeList
   switch (type) {
-    case TemplateTypes.EMAIL:
+    case TemplateType.EMAIL:
       purposeList = Object.values(EmailTemplatePurpose)
       break
     default:
@@ -38,9 +38,9 @@ exports.addBaseTemplates = (templates, type = null) => {
     if (templates.find(template => template.purpose === purpose)) {
       continue
     }
-    if (exports.EmailTemplates[purpose]) {
+    if (EmailTemplates[purpose]) {
       templates.push({
-        contents: exports.EmailTemplates[purpose],
+        contents: EmailTemplates[purpose],
         purpose,
         type,
       })
@@ -49,10 +49,14 @@ exports.addBaseTemplates = (templates, type = null) => {
   return templates
 }
 
-exports.getTemplates = async ({ ownerId, type, id } = {}) => {
-  const db = getGlobalDB()
+export async function getTemplates({
+  ownerId,
+  type,
+  id,
+}: { ownerId?: string; type?: string; id?: string } = {}) {
+  const db = tenancy.getGlobalDB()
   const response = await db.allDocs(
-    getTemplateParams(ownerId || GLOBAL_OWNER, id, {
+    dbCore.getTemplateParams(ownerId || GLOBAL_OWNER, id, {
       include_docs: true,
     })
   )
@@ -64,10 +68,10 @@ exports.getTemplates = async ({ ownerId, type, id } = {}) => {
   if (type) {
     templates = templates.filter(template => template.type === type)
   }
-  return exports.addBaseTemplates(templates, type)
+  return addBaseTemplates(templates, type)
 }
 
-exports.getTemplateByPurpose = async (type, purpose) => {
-  const templates = await exports.getTemplates({ type })
-  return templates.find(template => template.purpose === purpose)
+export async function getTemplateByPurpose(type: string, purpose: string) {
+  const templates = await getTemplates({ type })
+  return templates.find((template: Template) => template.purpose === purpose)
 }

package/src/db/index.ts

@@ -0,0 +1,10 @@
+import core from "@budibase/backend-core"
+import env from "../environment"
+
+export const init = () => {
+  const dbConfig: any = {}
+  if (env.isTest() && !env.COUCH_DB_URL) {
+    dbConfig.inMemory = true
+  }
+  core.init({ db: dbConfig })
+}

package/src/environment.ts

@@ -26,7 +26,7 @@ function parseIntSafe(number: any) {
   }
 }
 
-const env = {
+const environment = {
   // auth
   MINIO_ACCESS_KEY: process.env.MINIO_ACCESS_KEY,
   MINIO_SECRET_KEY: process.env.MINIO_SECRET_KEY,
@@ -68,7 +68,7 @@ const env = {
   _set(key: any, value: any) {
     process.env[key] = value
     // @ts-ignore
-    env[key] = value
+    environment[key] = value
   },
   isDev,
   isTest,
@@ -78,17 +78,19 @@ const env = {
 }
 
 // if some var haven't been set, define them
-if (!env.APPS_URL) {
-  env.APPS_URL = isDev() ? "http://localhost:4001" : "http://app-service:4002"
+if (!environment.APPS_URL) {
+  environment.APPS_URL = isDev()
+    ? "http://localhost:4001"
+    : "http://app-service:4002"
 }
 
 // clean up any environment variable edge cases
-for (let [key, value] of Object.entries(env)) {
+for (let [key, value] of Object.entries(environment)) {
   // handle the edge case of "0" to disable an environment variable
   if (value === "0") {
     // @ts-ignore
-    env[key] = 0
+    environment[key] = 0
   }
 }
 
-export = env
+export = environment