@budibase/worker 2.2.26 → 2.2.27-alpha.1

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

@@ -1,14 +1,9 @@
 import { InviteUsersResponse, User } from "@budibase/types"
 
 jest.mock("nodemailer")
-import {
-  TestConfiguration,
-  mocks,
-  structures,
-  TENANT_1,
-} from "../../../../tests"
+import { TestConfiguration, mocks, structures } from "../../../../tests"
 const sendMailMock = mocks.email.mock()
-import { events, tenancy } from "@budibase/backend-core"
+import { context, events, tenancy } from "@budibase/backend-core"
 
 describe("/api/global/users", () => {
   const config = new TestConfiguration()
@@ -27,16 +22,18 @@ describe("/api/global/users", () => {
 
   describe("invite", () => {
     it("should be able to generate an invitation", async () => {
-      const email = structures.users.newEmail()
-      const { code, res } = await config.api.users.sendUserInvite(
-        sendMailMock,
-        email
-      )
-
-      expect(res.body).toEqual({ message: "Invitation has been sent." })
-      expect(sendMailMock).toHaveBeenCalled()
-      expect(code).toBeDefined()
-      expect(events.user.invited).toBeCalledTimes(1)
+      await context.doInTenant(config.tenant1User!.tenantId, async () => {
+        const email = structures.users.newEmail()
+        const { code, res } = await config.api.users.sendUserInvite(
+          sendMailMock,
+          email
+        )
+
+        expect(res.body).toEqual({ message: "Invitation has been sent." })
+        expect(sendMailMock).toHaveBeenCalled()
+        expect(code).toBeDefined()
+        expect(events.user.invited).toBeCalledTimes(1)
+      })
     })
 
     it("should not be able to generate an invitation for existing user", async () => {
@@ -53,20 +50,22 @@ describe("/api/global/users", () => {
     })
 
     it("should be able to create new user from invite", async () => {
-      const email = structures.users.newEmail()
-      const { code } = await config.api.users.sendUserInvite(
-        sendMailMock,
-        email
-      )
-
-      const res = await config.api.users.acceptInvite(code)
-
-      expect(res.body._id).toBeDefined()
-      const user = await config.getUser(email)
-      expect(user).toBeDefined()
-      expect(user._id).toEqual(res.body._id)
-      expect(events.user.inviteAccepted).toBeCalledTimes(1)
-      expect(events.user.inviteAccepted).toBeCalledWith(user)
+      await context.doInTenant(config.tenant1User!.tenantId, async () => {
+        const email = structures.users.newEmail()
+        const { code } = await config.api.users.sendUserInvite(
+          sendMailMock,
+          email
+        )
+
+        const res = await config.api.users.acceptInvite(code)
+
+        expect(res.body._id).toBeDefined()
+        const user = await config.getUser(email)
+        expect(user).toBeDefined()
+        expect(user._id).toEqual(res.body._id)
+        expect(events.user.inviteAccepted).toBeCalledTimes(1)
+        expect(events.user.inviteAccepted).toBeCalledWith(user)
+      })
     })
   })
 
@@ -116,9 +115,9 @@ 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 () => {
+      await tenancy.doInTenant(config.getTenantId(), async () => {
         const response = await config.api.users.bulkCreateUsers([user])
 
         expect(response.created?.successful.length).toBe(0)
@@ -229,9 +228,9 @@ 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 () => {
+      await tenancy.doInTenant(config.getTenantId(), async () => {
         delete user._id
         const response = await config.api.users.saveUser(user, 400)
 
@@ -444,7 +443,7 @@ describe("/api/global/users", () => {
     })
 
     it("should not be able to update email address", async () => {
-      const email = "email@test.com"
+      const email = structures.email()
       const user = await config.createUser(structures.users.user({ email }))
       user.email = "new@test.com"
 

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`
     }
@@ -246,10 +264,10 @@ export const save = async (
     builtUser._rev = response.rev
 
     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 +573,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 +583,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"
@@ -12,22 +20,44 @@ import {
   auth,
   constants,
   env as coreEnv,
+  DEFAULT_TENANT_ID,
 } from "@budibase/backend-core"
-import structures, { TENANT_ID, TENANT_1, CSRF_TOKEN } from "./structures"
+import structures, { TENANT_ID, CSRF_TOKEN } from "./structures"
 import { CreateUserResponse, User, AuthToken } from "@budibase/types"
 import API from "./api"
+import sdk from "../sdk"
 
 enum Mode {
   CLOUD = "cloud",
   SELF = "self",
 }
 
+async function retry<T extends (...arg0: any[]) => any>(
+  fn: T,
+  maxTry: number = 5,
+  retryCount = 1
+): Promise<Awaited<ReturnType<T>>> {
+  const currRetry = typeof retryCount === "number" ? retryCount : 1
+  try {
+    const result = await fn()
+    return result
+  } catch (e) {
+    console.log(`Retry ${currRetry} failed.`)
+    if (currRetry > maxTry) {
+      console.log(`All ${maxTry} retry attempts exhausted`)
+      throw e
+    }
+    return retry(fn, maxTry, currRetry + 1)
+  }
+}
+
 class TestConfiguration {
   server: any
   request: any
   api: API
   defaultUser?: User
   tenant1User?: User
+  #tenantId?: string
 
   constructor(
     opts: { openServer: boolean; mode: Mode } = {
@@ -43,7 +73,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)
     }
@@ -104,13 +134,21 @@ class TestConfiguration {
   // SETUP / TEARDOWN
 
   async beforeAll() {
-    await this.createDefaultUser()
-    await this.createSession(this.defaultUser!)
+    try {
+      this.#tenantId = structures.tenant.id()
 
-    await tenancy.doInTenant(TENANT_1, async () => {
-      await this.createTenant1User()
-      await this.createSession(this.tenant1User!)
-    })
+      // Running tests in parallel causes issues creating the globaldb twice. This ensures the db is properly created before starting
+      await retry(async () => await this.createDefaultUser())
+      await this.createSession(this.defaultUser!)
+
+      await tenancy.doInTenant(this.#tenantId, async () => {
+        await this.createTenant1User()
+        await this.createSession(this.tenant1User!)
+      })
+    } catch (e: any) {
+      console.log(e)
+      throw new Error(e.message)
+    }
   }
 
   async afterAll() {
@@ -125,6 +163,8 @@ class TestConfiguration {
     // create user / new tenant
     const res = await this.api.users.createAdminUser()
 
+    await sdk.users.addTenant(res.tenantId, res.userId, res.email)
+
     // return the created user
     const userRes = await this.api.users.getUser(res.userId, {
       headers: {
@@ -144,7 +184,7 @@ class TestConfiguration {
     try {
       return tenancy.getTenantId()
     } catch (e: any) {
-      return TENANT_ID
+      return DEFAULT_TENANT_ID
     }
   }
 
@@ -195,7 +235,7 @@ class TestConfiguration {
     const tenantId = this.getTenantId()
     if (tenantId === TENANT_ID) {
       return this.authHeaders(this.defaultUser!)
-    } else if (tenantId === TENANT_1) {
+    } else if (tenantId === this.getTenantId()) {
       return this.authHeaders(this.tenant1User!)
     } else {
       throw new Error("could not determine auth headers to use")
@@ -214,7 +254,6 @@ class TestConfiguration {
 
   async createDefaultUser() {
     const user = structures.users.adminUser({
-      email: "test@test.com",
       password: "test",
     })
     this.defaultUser = await this.createUser(user)
@@ -222,7 +261,6 @@ class TestConfiguration {
 
   async createTenant1User() {
     const user = structures.users.adminUser({
-      email: "tenant1@test.com",
       password: "test",
     })
     this.tenant1User = await this.createUser(user)
@@ -319,4 +357,4 @@ class TestConfiguration {
   }
 }
 
-export = TestConfiguration
+export default TestConfiguration

package/src/tests/api/auth.ts

@@ -1,3 +1,4 @@
+import structures from "../structures"
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
 
@@ -24,14 +25,17 @@ export class AuthAPI extends TestAPI {
       .expect(200)
   }
 
-  requestPasswordReset = async (sendMailMock: any) => {
+  requestPasswordReset = async (sendMailMock: any, userEmail: string) => {
     await this.config.saveSmtpConfig()
     await this.config.saveSettingsConfig()
-    await this.config.createUser()
+    await this.config.createUser({
+      ...structures.users.user(),
+      email: userEmail,
+    })
     const res = await this.request
       .post(`/api/global/auth/${this.config.getTenantId()}/reset`)
       .send({
-        email: "test@test.com",
+        email: userEmail,
       })
       .expect("Content-Type", /json/)
       .expect(200)

package/src/tests/api/configs.ts

@@ -10,8 +10,8 @@ export class ConfigAPI extends TestAPI {
     return this.request
       .get(`/api/global/configs/checklist`)
       .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
       .expect(200)
+      .expect("Content-Type", /json/)
   }
 
   saveConfig = (data: any) => {
@@ -19,8 +19,8 @@ export class ConfigAPI extends TestAPI {
       .post(`/api/global/configs`)
       .send(data)
       .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
       .expect(200)
+      .expect("Content-Type", /json/)
   }
 
   OIDCCallback = (configId: string, preAuthRes: any) => {

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