@budibase/worker 2.2.26 → 2.2.27-alpha.0

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,3 +1,8 @@
+import {
+  EmailTemplatePurpose,
+  TemplateMetadata,
+  TemplateType,
+} from "../../../../constants"
 import { TestConfiguration } from "../../../../tests"
 
 // TODO
@@ -18,18 +23,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/api/routes/global/users.ts

@@ -38,6 +38,13 @@ function buildInviteMultipleValidation() {
   ))
 }
 
+function buildInviteLookupValidation() {
+  // prettier-ignore
+  return auth.joiValidator.params(Joi.object({
+    code: Joi.string().required()
+  }).unknown(true))
+}
+
 const createUserAdminOnly = (ctx: any, next: any) => {
   if (!ctx.request.body._id) {
     return auth.adminOnly(ctx, next)
@@ -51,6 +58,8 @@ function buildInviteAcceptValidation() {
   return auth.joiValidator.body(Joi.object({
     inviteCode: Joi.string().required(),
     password: Joi.string().required(),
+    firstName: Joi.string().required(),
+    lastName: Joi.string().optional(),
   }).required().unknown(true))
 }
 
@@ -91,6 +100,11 @@ router
   )
 
   // non-global endpoints
+  .get(
+    "/api/global/users/invite/:code",
+    buildInviteLookupValidation(),
+    controller.checkInvite
+  )
   .post(
     "/api/global/users/invite/accept",
     buildInviteAcceptValidation(),
@@ -113,4 +127,4 @@ router
     selfController.updateSelf
   )
 
-export = router
+export default router

package/src/api/routes/global/workspaces.ts

@@ -34,4 +34,4 @@ router
   .get("/api/global/workspaces", controller.fetch)
   .get("/api/global/workspaces/:id", controller.find)
 
-export = router
+export default router

package/src/api/routes/index.ts

@@ -7,6 +7,7 @@ import templateRoutes from "./global/templates"
 import emailRoutes from "./global/email"
 import authRoutes from "./global/auth"
 import roleRoutes from "./global/roles"
+import eventRoutes from "./global/events"
 import environmentRoutes from "./system/environment"
 import tenantsRoutes from "./system/tenants"
 import statusRoutes from "./system/status"
@@ -34,4 +35,5 @@ export const routes: Router[] = [
   migrationRoutes,
   accountRoutes,
   restoreRoutes,
+  eventRoutes,
 ]

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

@@ -16,4 +16,4 @@ router
     controller.destroy
   )
 
-export = router
+export default router

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

@@ -5,4 +5,4 @@ const router: Router = new Router()
 
 router.get("/api/system/environment", controller.fetch)
 
-export = router
+export default router

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

@@ -16,4 +16,4 @@ router
     migrationsController.fetchDefinitions
   )
 
-export = router
+export default router

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

@@ -5,4 +5,4 @@ const router: Router = new Router()
 
 router.post("/api/system/restored", controller.systemRestored)
 
-export = router
+export default router

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

@@ -5,4 +5,4 @@ const router: Router = new Router()
 
 router.get("/api/system/status", controller.fetch)
 
-export = router
+export default router

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

@@ -10,4 +10,4 @@ router.delete(
   controller.delete
 )
 
-export = router
+export default router

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

@@ -20,7 +20,7 @@ describe("/api/system/environment", () => {
       const env = await config.api.environment.getEnvironment()
       expect(env.body).toEqual({
         cloud: true,
-        disableAccountPortal: false,
+        disableAccountPortal: 0,
         isDev: false,
         multiTenancy: true,
       })

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

@@ -1,4 +1,4 @@
-import core from "@budibase/backend-core"
+import * as core from "@budibase/backend-core"
 import env from "../environment"
 
 export const init = () => {

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
+export default environment

package/src/index.ts

@@ -14,7 +14,7 @@ import { Event } from "@sentry/types/dist/event"
 import Application from "koa"
 import { bootstrap } from "global-agent"
 import * as db from "./db"
-import { auth, logging, events, pinoSettings } from "@budibase/backend-core"
+import { auth, logging, events, middleware } from "@budibase/backend-core"
 db.init()
 import Koa from "koa"
 import koaBody from "koa-body"
@@ -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()
@@ -36,7 +36,8 @@ app.keys = ["secret", "key"]
 // set up top level koa middleware
 app.use(koaBody({ multipart: true }))
 app.use(koaSession(app))
-app.use(logger(pinoSettings()))
+app.use(middleware.logging)
+app.use(logger(logging.pinoSettings()))
 
 // authentication
 app.use(auth.passport.initialize())
@@ -79,11 +80,10 @@ server.on("close", async () => {
 
 const shutdown = () => {
   server.close()
-  // @ts-ignore
   server.destroy()
 }
 
-export = server.listen(parseInt(env.PORT || "4002"), async () => {
+export default server.listen(parseInt(env.PORT || "4002"), async () => {
   console.log(`Worker running on ${JSON.stringify(server.address())}`)
   await redis.init()
 })

package/src/middleware/cloudRestricted.ts

@@ -6,7 +6,7 @@ import { BBContext } from "@budibase/types"
  * This is a restricted endpoint in the cloud.
  * Ensure that the correct API key has been supplied.
  */
-export = async (ctx: BBContext, next: any) => {
+export default async (ctx: BBContext, next: any) => {
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
     const apiKey = ctx.request.headers[constants.Header.API_KEY]
     if (apiKey !== env.INTERNAL_API_KEY) {

package/src/sdk/users/events.ts

@@ -73,6 +73,10 @@ export const handleSaveEvents = async (
       await events.user.permissionAdminRemoved(user)
     }
 
+    if (isOnboardingComplete(user, existingUser)) {
+      await events.user.onboardingComplete(user)
+    }
+
     if (
       !existingUser.forceResetPassword &&
       user.forceResetPassword &&
@@ -114,6 +118,10 @@ const isRemovingAdmin = (user: any, existingUser: any) => {
   return isRemovingPermission(user, existingUser, isAdmin)
 }
 
+const isOnboardingComplete = (user: any, existingUser: any) => {
+  return !existingUser?.onboardedAt && typeof user.onboardedAt === "string"
+}
+
 /**
  * Check if a permission is being added to a new or existing user.
  */

package/src/sdk/users/users.ts

@@ -25,11 +25,13 @@ import {
   InviteUsersRequest,
   InviteUsersResponse,
   MigrationType,
+  PlatformUser,
   PlatformUserByEmail,
   RowResponse,
   SearchUsersRequest,
   User,
   ThirdPartyUser,
+  isUser,
 } from "@budibase/types"
 import { sendEmail } from "../../utilities/email"
 import { EmailTemplatePurpose } from "../../constants"
@@ -153,10 +155,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`
     }
@@ -248,8 +266,9 @@ export const save = async (
     await eventHelpers.handleSaveEvents(builtUser, dbUser)
     await addTenant(tenantId, _id, email)
     await cache.user.invalidateUser(response.id)
+
     // let server know to sync user
-    await apps.syncUserInApps(_id)
+    await apps.syncUserInApps(_id, dbUser)
 
     await Promise.all(groupPromises)
 
@@ -555,7 +574,7 @@ export const destroy = async (id: string, currentUser: any) => {
   await cache.user.invalidateUser(userId)
   await sessions.invalidateSessions(userId, { reason: "deletion" })
   // let server know to sync user
-  await apps.syncUserInApps(userId)
+  await apps.syncUserInApps(userId, dbUser)
 }
 
 const bulkDeleteProcessing = async (dbUser: User) => {
@@ -565,7 +584,7 @@ const bulkDeleteProcessing = async (dbUser: User) => {
   await cache.user.invalidateUser(userId)
   await sessions.invalidateSessions(userId, { reason: "bulk-deletion" })
   // let server know to sync user
-  await apps.syncUserInApps(userId)
+  await apps.syncUserInApps(userId, dbUser)
 }
 
 export const invite = async (

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"
@@ -43,7 +51,7 @@ class TestConfiguration {
 
     if (opts.openServer) {
       env.PORT = "0" // random port
-      this.server = require("../index")
+      this.server = require("../index").default
       // we need the request for logging in, involves cookies, hard to fake
       this.request = supertest(this.server)
     }
@@ -319,4 +327,4 @@ class TestConfiguration {
   }
 }
 
-export = TestConfiguration
+export default TestConfiguration

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)
+  }
+}