@budibase/worker 2.1.46-alpha.4 → 2.1.46-alpha.6

package/jest.config.ts

@@ -19,6 +19,8 @@ if (!process.env.CI) {
   }
   // add pro sources if they exist
   if (fs.existsSync("../../../budibase-pro")) {
+    config.moduleNameMapper["@budibase/pro/(.*)"] =
+      "<rootDir>/../../../budibase-pro/packages/pro/$1"
     config.moduleNameMapper["@budibase/pro"] =
       "<rootDir>/../../../budibase-pro/packages/pro/src"
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.1.46-alpha.4",
+  "version": "2.1.46-alpha.6",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -36,10 +36,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.1.46-alpha.4",
-    "@budibase/pro": "2.1.46-alpha.3",
-    "@budibase/string-templates": "2.1.46-alpha.4",
-    "@budibase/types": "2.1.46-alpha.4",
+    "@budibase/backend-core": "2.1.46-alpha.6",
+    "@budibase/pro": "2.1.46-alpha.5",
+    "@budibase/string-templates": "2.1.46-alpha.6",
+    "@budibase/types": "2.1.46-alpha.6",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -94,5 +94,5 @@
     "typescript": "4.7.3",
     "update-dotenv": "1.1.1"
   },
-  "gitHead": "eb7eb957aa1915405c330ecb223106913ad52ac5"
+  "gitHead": "694c0013a8e7380f5c8953a2be61a515e5fbf820"
 }

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

@@ -0,0 +1,58 @@
+import { events } from "@budibase/backend-core"
+import { structures, TestConfiguration, mocks } from "../../../../tests"
+
+describe("/api/global/groups", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  beforeEach(async () => {
+    mocks.licenses.useGroups()
+  })
+
+  describe("create", () => {
+    it("should be able to create a new group", async () => {
+      const group = structures.groups.UserGroup()
+      await config.api.groups.saveGroup(group)
+      expect(events.group.created).toBeCalledTimes(1)
+      expect(events.group.updated).not.toBeCalled()
+      expect(events.group.permissionsEdited).not.toBeCalled()
+    })
+  })
+
+  describe("update", () => {
+    it("should be able to update a basic group", async () => {
+      const group = structures.groups.UserGroup()
+      let oldGroup = await config.api.groups.saveGroup(group)
+
+      let updatedGroup = {
+        ...oldGroup.body,
+        ...group,
+        name: "New Name",
+      }
+      await config.api.groups.saveGroup(updatedGroup)
+
+      expect(events.group.updated).toBeCalledTimes(1)
+      expect(events.group.permissionsEdited).not.toBeCalled()
+    })
+
+    describe("destroy", () => {
+      it("should be able to delete a basic group", async () => {
+        const group = structures.groups.UserGroup()
+        let oldGroup = await config.api.groups.saveGroup(group)
+        await config.api.groups.deleteGroup(
+          oldGroup.body._id,
+          oldGroup.body._rev
+        )
+
+        expect(events.group.deleted).toBeCalledTimes(1)
+      })
+    })
+  })
+})

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

@@ -1,7 +1,5 @@
 import { TestConfiguration } from "../../../../tests"
 
-// TODO
-
 describe("/api/global/license", () => {
   const config = new TestConfiguration()
 

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

@@ -1,11 +1,47 @@
-import { TestConfiguration } from "../../../../tests"
+import { structures, TestConfiguration } from "../../../../tests"
+import { context, db, permissions, roles } from "@budibase/backend-core"
+import { Mock } from "jest-mock"
 
-// TODO
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    db: {
+      ...core.db,
+    },
+    context: {
+      ...core.context,
+      getAppDB: jest.fn(),
+    },
+  }
+})
+
+const appDb = db.getDB("app_test")
+const mockAppDB = context.getAppDB as Mock
+mockAppDB.mockReturnValue(appDb)
+
+async function addAppMetadata() {
+  await appDb.put({
+    _id: "app_metadata",
+    appId: "app_test",
+    name: "New App",
+    version: "version",
+    url: "url",
+  })
+}
 
 describe("/api/global/roles", () => {
   const config = new TestConfiguration()
+  const role = new roles.Role(
+    db.generateRoleID("newRole"),
+    roles.BUILTIN_ROLE_IDS.BASIC,
+    permissions.BuiltinPermissionID.READ_ONLY
+  )
 
   beforeAll(async () => {
+    console.debug(role)
+    appDb.put(role)
+    await addAppMetadata()
     await config.beforeAll()
   })
 
@@ -18,10 +54,35 @@ describe("/api/global/roles", () => {
   })
 
   describe("GET /api/global/roles", () => {
-    it("retrieves roles", () => {})
+    it("retrieves roles", async () => {
+      const res = await config.api.roles.get()
+      expect(res.body).toBeDefined()
+      expect(res.body["app_test"].roles.length).toEqual(5)
+      expect(res.body["app_test"].roles.map((r: any) => r._id)).toContain(
+        role._id
+      )
+    })
   })
 
-  describe("GET /api/global/roles/:appId", () => {})
+  describe("GET api/global/roles/:appId", () => {
+    it("finds a role by appId", async () => {
+      const res = await config.api.roles.find("app_test")
+      expect(res.body).toBeDefined()
+      expect(res.body.name).toEqual("New App")
+    })
+  })
 
-  describe("DELETE /api/global/roles/:appId", () => {})
+  describe("DELETE /api/global/roles/:appId", () => {
+    it("removes an app role", async () => {
+      let user = structures.users.user()
+      user.roles = {
+        app_test: "role1",
+      }
+      const userResponse = await config.createUser(user)
+      const res = await config.api.roles.remove("app_test")
+      const updatedUser = await config.api.users.getUser(userResponse._id!)
+      expect(updatedUser.body.roles).not.toHaveProperty("app_test")
+      expect(res.body.message).toEqual("App role removed from all users")
+    })
+  })
 })

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/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/mocks/index.ts

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

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"
   ]
 }