@budibase/worker 2.2.9 → 2.2.10-alpha.0

package/src/api/routes/global/tests/templates.spec.ts

@@ -1,4 +1,17 @@
+import {
+  addBaseTemplates,
+  EmailTemplates,
+  getTemplates,
+} from "../../../../constants/templates"
+import {
+  EmailTemplatePurpose,
+  TemplateMetadata,
+  TemplateMetadataNames,
+  TemplateType,
+} from "../../../../constants"
 import { TestConfiguration } from "../../../../tests"
+import { join } from "path"
+import { readStaticFile } from "../../../../../src/utilities/fileSystem"
 
 // TODO
 
@@ -18,18 +31,85 @@ describe("/api/global/template", () => {
   })
 
   describe("GET /api/global/template/definitions", () => {
-    it("retrieves definitions", () => {})
-  })
-
-  describe("POST /api/global/template", () => {})
+    describe("retrieves definitions", () => {
+      it("checks description definitions", async () => {
+        let result = await config.api.templates.definitions()
 
-  describe("GET /api/global/template", () => {})
+        expect(result.body.info[EmailTemplatePurpose.BASE].description).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][0].description
+        )
+        expect(
+          result.body.info[EmailTemplatePurpose.PASSWORD_RECOVERY].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][1].description)
+        expect(
+          result.body.info[EmailTemplatePurpose.WELCOME].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][2].description)
+        expect(
+          result.body.info[EmailTemplatePurpose.INVITATION].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][3].description)
+        expect(
+          result.body.info[EmailTemplatePurpose.CUSTOM].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][4].description)
+      })
 
-  describe("GET /api/global/template/:type", () => {})
+      it("checks description bindings", async () => {
+        let result = await config.api.templates.definitions()
 
-  describe("GET /api/global/template/:ownerId", () => {})
+        expect(result.body.bindings[EmailTemplatePurpose.BASE]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][0].bindings
+        )
+        expect(
+          result.body.bindings[EmailTemplatePurpose.PASSWORD_RECOVERY]
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][1].bindings)
+        expect(result.body.bindings[EmailTemplatePurpose.WELCOME]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][2].bindings
+        )
+        expect(result.body.bindings[EmailTemplatePurpose.INVITATION]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][3].bindings
+        )
+        expect(result.body.bindings[EmailTemplatePurpose.CUSTOM]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][4].bindings
+        )
+      })
+    })
+  })
 
-  describe("GET /api/global/template/:id", () => {})
+  describe("POST /api/global/template", () => {
+    it("adds a new template", async () => {
+      let purpose = "base"
+      let contents = "Test contents"
+      let updatedTemplate = {
+        contents: contents,
+        purpose: purpose,
+        type: "email",
+      }
+      await config.api.templates.saveTemplate(updatedTemplate)
+      let res = await config.api.templates.getTemplate()
+      let newTemplate = res.body.find((t: any) => (t.purpose = purpose))
+      expect(newTemplate.contents).toEqual(contents)
+    })
+  })
 
-  describe("DELETE /api/global/template/:id/:rev", () => {})
+  describe("GET /api/global/template", () => {
+    it("fetches templates", async () => {
+      let res = await config.api.templates.getTemplate()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.BASE)
+      ).toBeDefined()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.CUSTOM)
+      ).toBeDefined()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.INVITATION)
+      ).toBeDefined()
+      expect(
+        res.body.find(
+          (t: any) => t.purpose === EmailTemplatePurpose.PASSWORD_RECOVERY
+        )
+      ).toBeDefined()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.WELCOME)
+      ).toBeDefined()
+    })
+  })
 })

package/src/api/routes/global/tests/users.spec.ts

@@ -116,7 +116,7 @@ describe("/api/global/users", () => {
 
     it("should ignore users existing in other tenants", async () => {
       const user = await config.createUser()
-      jest.resetAllMocks()
+      jest.clearAllMocks()
 
       await tenancy.doInTenant(TENANT_1, async () => {
         const response = await config.api.users.bulkCreateUsers([user])
@@ -229,7 +229,7 @@ describe("/api/global/users", () => {
 
     it("should not be able to create user that exists in other tenant", async () => {
       const user = await config.createUser()
-      jest.resetAllMocks()
+      jest.clearAllMocks()
 
       await tenancy.doInTenant(TENANT_1, async () => {
         delete user._id

package/src/constants/index.ts

@@ -27,6 +27,14 @@ export enum EmailTemplatePurpose {
   CUSTOM = "custom",
 }
 
+export enum TemplateMetadataNames {
+  BASE = "Base format",
+  PASSWORD_RECOVERY = "Password recovery",
+  WELCOME = "User welcome",
+  INVITATION = "User invitation",
+  CUSTOM = "Custom",
+}
+
 export enum InternalTemplateBinding {
   PLATFORM_URL = "platformUrl",
   COMPANY = "company",
@@ -93,7 +101,7 @@ export const TemplateBindings = {
 export const TemplateMetadata = {
   [TemplateType.EMAIL]: [
     {
-      name: "Base format",
+      name: TemplateMetadataNames.BASE,
       description:
         "This is the base template, all others are based on it. The {{ body }} will be replaced with another email template.",
       category: "miscellaneous",
@@ -110,7 +118,7 @@ export const TemplateMetadata = {
       ],
     },
     {
-      name: "Password recovery",
+      name: TemplateMetadataNames.PASSWORD_RECOVERY,
       description:
         "When a user requests a password reset they will receive an email built with this template.",
       category: "user management",
@@ -129,7 +137,7 @@ export const TemplateMetadata = {
       ],
     },
     {
-      name: "User welcome",
+      name: TemplateMetadataNames.WELCOME,
       description:
         "When a new user is added they will be sent a welcome email using this template.",
       category: "user management",
@@ -137,7 +145,7 @@ export const TemplateMetadata = {
       bindings: [],
     },
     {
-      name: "User invitation",
+      name: TemplateMetadataNames.INVITATION,
       description:
         "When inviting a user via the email on-boarding this template will be used.",
       category: "user management",
@@ -156,7 +164,7 @@ export const TemplateMetadata = {
       ],
     },
     {
-      name: "Custom",
+      name: TemplateMetadataNames.CUSTOM,
       description:
         "A custom template, this is currently used for SMTP email actions in automations.",
       category: "automations",

package/src/environment.ts

@@ -91,6 +91,11 @@ for (let [key, value] of Object.entries(environment)) {
     // @ts-ignore
     environment[key] = 0
   }
+  // handle the edge case of "false" to disable an environment variable
+  if (value === "false") {
+    // @ts-ignore
+    environment[key] = 0
+  }
 }
 
 export = environment

package/src/index.ts

@@ -24,7 +24,7 @@ import * as redis from "./utilities/redis"
 const Sentry = require("@sentry/node")
 const koaSession = require("koa-session")
 const logger = require("koa-pino-logger")
-const destroyable = require("server-destroy")
+import destroyable from "server-destroy"
 
 // this will setup http and https proxies form env variables
 bootstrap()
@@ -79,7 +79,6 @@ server.on("close", async () => {
 
 const shutdown = () => {
   server.close()
-  // @ts-ignore
   server.destroy()
 }
 

package/src/sdk/users/users.ts

@@ -25,6 +25,7 @@ import {
   InviteUsersRequest,
   InviteUsersResponse,
   MigrationType,
+  PlatformUser,
   PlatformUserByEmail,
   RowResponse,
   SearchUsersRequest,
@@ -153,10 +154,26 @@ const buildUser = async (
   return fullUser
 }
 
+// lookup, could be email or userId, either will return a doc
+export const getPlatformUser = async (
+  identifier: string
+): Promise<PlatformUser | null> => {
+  // use the view here and allow to find anyone regardless of casing
+  // Use lowercase to ensure email login is case insensitive
+  const response = dbUtils.queryPlatformView(
+    ViewName.PLATFORM_USERS_LOWERCASE,
+    {
+      keys: [identifier.toLowerCase()],
+      include_docs: true,
+    }
+  ) as Promise<PlatformUser>
+  return response
+}
+
 const validateUniqueUser = async (email: string, tenantId: string) => {
   // check budibase users in other tenants
   if (env.MULTI_TENANCY) {
-    const tenantUser = await tenancy.getTenantUser(email)
+    const tenantUser = await getPlatformUser(email)
     if (tenantUser != null && tenantUser.tenantId !== tenantId) {
       throw `Unavailable`
     }

package/src/tests/TestConfiguration.ts

@@ -1,4 +1,12 @@
-import "./mocks"
+import mocks from "./mocks"
+
+// init the licensing mock
+import * as pro from "@budibase/pro"
+mocks.licenses.init(pro)
+
+// use unlimited license by default
+mocks.licenses.useUnlimited()
+
 import * as dbConfig from "../db"
 dbConfig.init()
 import env from "../environment"

package/src/tests/api/groups.ts

@@ -0,0 +1,26 @@
+import { UserGroup } from "@budibase/types"
+import TestConfiguration from "../TestConfiguration"
+import { TestAPI } from "./base"
+
+export class GroupsAPI extends TestAPI {
+  constructor(config: TestConfiguration) {
+    super(config)
+  }
+
+  saveGroup = (group: UserGroup) => {
+    return this.request
+      .post(`/api/global/groups`)
+      .send(group)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+  }
+
+  deleteGroup = (id: string, rev: string) => {
+    return this.request
+      .delete(`/api/global/groups/${id}/${rev}`)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+  }
+}

package/src/tests/api/index.ts

@@ -10,7 +10,10 @@ import { MigrationAPI } from "./migrations"
 import { StatusAPI } from "./status"
 import { RestoreAPI } from "./restore"
 import { TenantAPI } from "./tenants"
-
+import { GroupsAPI } from "./groups"
+import { RolesAPI } from "./roles"
+import { TemplatesAPI } from "./templates"
+import { LicenseAPI } from "./license"
 export default class API {
   accounts: AccountAPI
   auth: AuthAPI
@@ -23,6 +26,10 @@ export default class API {
   status: StatusAPI
   restore: RestoreAPI
   tenants: TenantAPI
+  groups: GroupsAPI
+  roles: RolesAPI
+  templates: TemplatesAPI
+  license: LicenseAPI
 
   constructor(config: TestConfiguration) {
     this.accounts = new AccountAPI(config)
@@ -36,5 +43,9 @@ export default class API {
     this.status = new StatusAPI(config)
     this.restore = new RestoreAPI(config)
     this.tenants = new TenantAPI(config)
+    this.groups = new GroupsAPI(config)
+    this.roles = new RolesAPI(config)
+    this.templates = new TemplatesAPI(config)
+    this.license = new LicenseAPI(config)
   }
 }

package/src/tests/api/license.ts

@@ -0,0 +1,17 @@
+import TestConfiguration from "../TestConfiguration"
+import { TestAPI } from "./base"
+
+export class LicenseAPI extends TestAPI {
+  constructor(config: TestConfiguration) {
+    super(config)
+  }
+
+  activate = async (licenseKey: string) => {
+    return this.request
+      .post("/api/global/license/activate")
+      .send({ licenseKey: licenseKey })
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+  }
+}

package/src/tests/api/roles.ts

@@ -0,0 +1,32 @@
+import TestConfiguration from "../TestConfiguration"
+import { TestAPI, TestAPIOpts } from "./base"
+
+export class RolesAPI extends TestAPI {
+  constructor(config: TestConfiguration) {
+    super(config)
+  }
+
+  get = (opts?: TestAPIOpts) => {
+    return this.request
+      .get(`/api/global/roles`)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(opts?.status ? opts.status : 200)
+  }
+
+  find = (appId: string, opts?: TestAPIOpts) => {
+    return this.request
+      .get(`/api/global/roles/${appId}`)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(opts?.status ? opts.status : 200)
+  }
+
+  remove = (appId: string, opts?: TestAPIOpts) => {
+    return this.request
+      .delete(`/api/global/roles/${appId}`)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(opts?.status ? opts.status : 200)
+  }
+}

package/src/tests/api/templates.ts

@@ -0,0 +1,30 @@
+import TestConfiguration from "../TestConfiguration"
+import { TestAPI, TestAPIOpts } from "./base"
+
+export class TemplatesAPI extends TestAPI {
+  constructor(config: TestConfiguration) {
+    super(config)
+  }
+
+  definitions = (opts?: TestAPIOpts) => {
+    return this.request
+      .get(`/api/global/template/definitions`)
+      .set(opts?.headers ? opts.headers : this.config.defaultHeaders())
+      .expect(opts?.status ? opts.status : 200)
+  }
+
+  getTemplate = (opts?: TestAPIOpts) => {
+    return this.request
+      .get(`/api/global/template`)
+      .set(opts?.headers ? opts.headers : this.config.defaultHeaders())
+      .expect(opts?.status ? opts.status : 200)
+  }
+
+  saveTemplate = (data: any, opts?: TestAPIOpts) => {
+    return this.request
+      .post(`/api/global/template`)
+      .send(data)
+      .set(opts?.headers ? opts.headers : this.config.defaultHeaders())
+      .expect(opts?.status ? opts.status : 200)
+  }
+}

package/src/tests/jestSetup.ts

@@ -22,7 +22,9 @@ mocks.fetch.enable()
 const tk = require("timekeeper")
 tk.freeze(mocks.date.MOCK_DATE)
 
-global.console.log = jest.fn() // console.log are ignored in tests
+if (!process.env.DEBUG) {
+  global.console.log = jest.fn() // console.log are ignored in tests
+}
 
 if (!process.env.CI) {
   // set a longer timeout in dev for debugging

package/src/tests/mocks/{email.js → email.ts}

@@ -1,4 +1,4 @@
-exports.mock = () => {
+export function mock() {
   // mock the email system
   const sendMailMock = jest.fn()
   const nodemailer = require("nodemailer")

package/src/tests/mocks/index.ts

@@ -1,7 +1,7 @@
-const email = require("./email")
-import { mocks as coreMocks } from "@budibase/backend-core/tests"
+import * as email from "./email"
+import { mocks } from "@budibase/backend-core/tests"
 
 export = {
   email,
-  ...coreMocks,
+  ...mocks,
 }

package/src/tests/structures/configs.ts

@@ -1,5 +1,5 @@
-const { Config } = require("../../constants")
-const { utils } = require("@budibase/backend-core")
+import { Config } from "../../constants"
+import { utils } from "@budibase/backend-core"
 
 export function oidc(conf?: any) {
   return {

package/src/tests/structures/groups.ts

@@ -4,7 +4,7 @@ export const UserGroup = () => {
     color: "var(--spectrum-global-color-blue-600)",
     icon: "UserGroup",
     name: "New group",
-    roles: {},
+    roles: { app_uuid1: "ADMIN", app_uuid2: "POWER" },
     users: [],
   }
   return group

package/src/tests/structures/users.ts

@@ -10,7 +10,7 @@ export const user = (userProps?: any): User => {
   return {
     email: newEmail(),
     password: "test",
-    roles: {},
+    roles: { app_test: "admin" },
     ...userProps,
   }
 }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "package.json"
   ],
   "exclude": [
-    "node_modules",
     "dist"
   ]
 }