@budibase/worker 2.3.18-alpha.9 → 2.3.18

package/src/sdk/users/users.ts

@@ -6,11 +6,12 @@ import {
   cache,
   constants,
   db as dbUtils,
+  deprovisioning,
   events,
   HTTPError,
+  migrations,
   sessions,
   tenancy,
-  platform,
   users as usersCore,
   utils,
   ViewName,
@@ -20,22 +21,21 @@ import {
   AllDocsResponse,
   BulkUserResponse,
   CloudAccount,
+  CreateUserResponse,
   InviteUsersRequest,
   InviteUsersResponse,
-  isSSOAccount,
-  isSSOUser,
+  MigrationType,
   PlatformUser,
   PlatformUserByEmail,
   RowResponse,
   SearchUsersRequest,
-  UpdateSelf,
   User,
-  SaveUserOpts,
+  ThirdPartyUser,
+  isUser,
 } from "@budibase/types"
 import { sendEmail } from "../../utilities/email"
 import { EmailTemplatePurpose } from "../../constants"
 import { groups as groupsSdk } from "@budibase/pro"
-import * as accountSdk from "../accounts"
 
 const PAGE_LIMIT = 8
 
@@ -94,23 +94,26 @@ export const paginatedUsers = async ({
   })
 }
 
-export async function getUserByEmail(email: string) {
-  return usersCore.getGlobalUserByEmail(email)
-}
-
 /**
  * Gets a user by ID from the global database, based on the current tenancy.
  */
 export const getUser = async (userId: string) => {
-  const user = await usersCore.getById(userId)
+  const db = tenancy.getGlobalDB()
+  let user = await db.get(userId)
   if (user) {
     delete user.password
   }
   return user
 }
 
+export interface SaveUserOpts {
+  hashPassword?: boolean
+  requirePassword?: boolean
+  currentUserId?: string
+}
+
 const buildUser = async (
-  user: User,
+  user: User | ThirdPartyUser,
   opts: SaveUserOpts = {
     hashPassword: true,
     requirePassword: true,
@@ -118,13 +121,11 @@ const buildUser = async (
   tenantId: string,
   dbUser?: any
 ): Promise<User> => {
-  let { password, _id } = user
+  let fullUser = user as User
+  let { password, _id } = fullUser
 
   let hashedPassword
   if (password) {
-    if (await isPreventSSOPasswords(user)) {
-      throw new HTTPError("SSO user cannot set password", 400)
-    }
     hashedPassword = opts.hashPassword ? await utils.hash(password) : password
   } else if (dbUser) {
     hashedPassword = dbUser.password
@@ -134,10 +135,10 @@ const buildUser = async (
 
   _id = _id || dbUtils.generateGlobalUserID()
 
-  const fullUser = {
+  fullUser = {
     createdAt: Date.now(),
     ...dbUser,
-    ...user,
+    ...fullUser,
     _id,
     password: hashedPassword,
     tenantId,
@@ -188,36 +189,10 @@ const validateUniqueUser = async (email: string, tenantId: string) => {
   }
 }
 
-export async function isPreventSSOPasswords(user: User) {
-  // when in maintenance mode we allow sso users with the admin role
-  // to perform any password action - this prevents lockout
-  if (env.ENABLE_SSO_MAINTENANCE_MODE && user.admin?.global) {
-    return false
-  }
-
-  // Check local sso
-  if (isSSOUser(user)) {
-    return true
-  }
-
-  // Check account sso
-  const account = await accountSdk.api.getAccount(user.email)
-  return !!(account && isSSOAccount(account))
-}
-
-export async function updateSelf(id: string, data: UpdateSelf) {
-  let user = await getUser(id)
-  user = {
-    ...user,
-    ...data,
-  }
-  return save(user)
-}
-
 export const save = async (
-  user: User,
+  user: User | ThirdPartyUser,
   opts: SaveUserOpts = {}
-): Promise<User> => {
+): Promise<CreateUserResponse> => {
   // default booleans to true
   if (opts.hashPassword == null) {
     opts.hashPassword = true
@@ -289,7 +264,7 @@ export const save = async (
     builtUser._rev = response.rev
 
     await eventHelpers.handleSaveEvents(builtUser, dbUser)
-    await platform.users.addUser(tenantId, builtUser._id!, builtUser.email)
+    await addTenant(tenantId, _id, email)
     await cache.user.invalidateUser(response.id)
 
     // let server know to sync user
@@ -297,8 +272,11 @@ export const save = async (
 
     await Promise.all(groupPromises)
 
-    // finally returned the saved user from the db
-    return db.get(builtUser._id!)
+    return {
+      _id: response.id,
+      _rev: response.rev,
+      email,
+    }
   } catch (err: any) {
     if (err.status === 409) {
       throw "User exists already"
@@ -308,6 +286,21 @@ export const save = async (
   }
 }
 
+export const addTenant = async (
+  tenantId: string,
+  _id: string,
+  email: string
+) => {
+  if (env.MULTI_TENANCY) {
+    const afterCreateTenant = () =>
+      migrations.backPopulateMigrations({
+        type: MigrationType.GLOBAL,
+        tenantId,
+      })
+    await tenancy.tryAddTenant(tenantId, _id, email, afterCreateTenant)
+  }
+}
+
 const getExistingTenantUsers = async (emails: string[]): Promise<User[]> => {
   const lcEmails = emails.map(email => email.toLowerCase())
   const params = {
@@ -439,7 +432,7 @@ export const bulkCreate = async (
   for (const user of usersToBulkSave) {
     // TODO: Refactor to bulk insert users into the info db
     // instead of relying on looping tenant creation
-    await platform.users.addUser(tenantId, user._id, user.email)
+    await addTenant(tenantId, user._id, user.email)
     await eventHelpers.handleSaveEvents(user, undefined)
     await apps.syncUserInApps(user._id)
   }
@@ -557,7 +550,7 @@ export const bulkDelete = async (
 
 export const destroy = async (id: string, currentUser: any) => {
   const db = tenancy.getGlobalDB()
-  const dbUser = (await db.get(id)) as User
+  const dbUser = await db.get(id)
   const userId = dbUser._id as string
 
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
@@ -573,7 +566,7 @@ export const destroy = async (id: string, currentUser: any) => {
     }
   }
 
-  await platform.users.removeUser(dbUser)
+  await deprovisioning.removeUserFromInfoDB(dbUser)
 
   await db.remove(userId, dbUser._rev)
 
@@ -586,7 +579,7 @@ export const destroy = async (id: string, currentUser: any) => {
 
 const bulkDeleteProcessing = async (dbUser: User) => {
   const userId = dbUser._id as string
-  await platform.users.removeUser(dbUser)
+  await deprovisioning.removeUserFromInfoDB(dbUser)
   await eventHelpers.handleDeleteEvents(dbUser)
   await cache.user.invalidateUser(userId)
   await sessions.invalidateSessions(userId, { reason: "bulk-deletion" })

package/src/tests/TestConfiguration.ts

@@ -15,29 +15,39 @@ const supertest = require("supertest")
 import { Config } from "../constants"
 import {
   users,
-  context,
+  tenancy,
   sessions,
   auth,
   constants,
   env as coreEnv,
 } from "@budibase/backend-core"
-import structures, { CSRF_TOKEN } from "./structures"
-import { SaveUserResponse, User, AuthToken } from "@budibase/types"
+import structures, { TENANT_ID, TENANT_1, CSRF_TOKEN } from "./structures"
+import { CreateUserResponse, User, AuthToken } from "@budibase/types"
 import API from "./api"
 
+enum Mode {
+  CLOUD = "cloud",
+  SELF = "self",
+}
+
 class TestConfiguration {
   server: any
   request: any
   api: API
-  tenantId: string
-  user?: User
-  userPassword = "test"
-
-  constructor(opts: { openServer: boolean } = { openServer: true }) {
-    // default to cloud hosting
-    this.cloudHosted()
+  defaultUser?: User
+  tenant1User?: User
 
-    this.tenantId = structures.tenant.id()
+  constructor(
+    opts: { openServer: boolean; mode: Mode } = {
+      openServer: true,
+      mode: Mode.CLOUD,
+    }
+  ) {
+    if (opts.mode === Mode.CLOUD) {
+      this.modeCloud()
+    } else if (opts.mode === Mode.SELF) {
+      this.modeSelf()
+    }
 
     if (opts.openServer) {
       env.PORT = "0" // random port
@@ -53,19 +63,26 @@ class TestConfiguration {
     return this.request
   }
 
-  // HOSTING
+  // MODES
+
+  setMultiTenancy = (value: boolean) => {
+    env._set("MULTI_TENANCY", value)
+    coreEnv._set("MULTI_TENANCY", value)
+  }
 
   setSelfHosted = (value: boolean) => {
     env._set("SELF_HOSTED", value)
     coreEnv._set("SELF_HOSTED", value)
   }
 
-  cloudHosted = () => {
+  modeCloud = () => {
     this.setSelfHosted(false)
+    this.setMultiTenancy(true)
   }
 
-  selfHosted = () => {
+  modeSelf = () => {
     this.setSelfHosted(true)
+    this.setMultiTenancy(false)
   }
 
   // UTILS
@@ -86,7 +103,7 @@ class TestConfiguration {
     if (params) {
       request.params = params
     }
-    await context.doInTenant(this.getTenantId(), () => {
+    await tenancy.doInTenant(this.getTenantId(), () => {
       return controlFunc(request)
     })
     return request.body
@@ -95,13 +112,13 @@ class TestConfiguration {
   // SETUP / TEARDOWN
 
   async beforeAll() {
-    try {
-      await this.createDefaultUser()
-      await this.createSession(this.user!)
-    } catch (e: any) {
-      console.error(e)
-      throw new Error(e.message)
-    }
+    await this.createDefaultUser()
+    await this.createSession(this.defaultUser!)
+
+    await tenancy.doInTenant(TENANT_1, async () => {
+      await this.createTenant1User()
+      await this.createSession(this.tenant1User!)
+    })
   }
 
   async afterAll() {
@@ -112,12 +129,6 @@ class TestConfiguration {
 
   // TENANCY
 
-  doInTenant(task: any) {
-    return context.doInTenant(this.tenantId, () => {
-      return task()
-    })
-  }
-
   createTenant = async (): Promise<User> => {
     // create user / new tenant
     const res = await this.api.users.createAdminUser()
@@ -139,9 +150,9 @@ class TestConfiguration {
 
   getTenantId() {
     try {
-      return context.getTenantId()
-    } catch (e) {
-      return this.tenantId!
+      return tenancy.getTenantId()
+    } catch (e: any) {
+      return TENANT_ID
     }
   }
 
@@ -189,11 +200,14 @@ class TestConfiguration {
   }
 
   defaultHeaders() {
-    return this.authHeaders(this.user!)
-  }
-
-  tenantIdHeaders() {
-    return { [constants.Header.TENANT_ID]: this.tenantId }
+    const tenantId = this.getTenantId()
+    if (tenantId === TENANT_ID) {
+      return this.authHeaders(this.defaultUser!)
+    } else if (tenantId === TENANT_1) {
+      return this.authHeaders(this.tenant1User!)
+    } else {
+      throw new Error("could not determine auth headers to use")
+    }
   }
 
   internalAPIHeaders() {
@@ -208,15 +222,22 @@ class TestConfiguration {
 
   async createDefaultUser() {
     const user = structures.users.adminUser({
-      password: this.userPassword,
+      email: "test@test.com",
+      password: "test",
     })
-    await context.doInTenant(this.tenantId!, async () => {
-      this.user = await this.createUser(user)
+    this.defaultUser = await this.createUser(user)
+  }
+
+  async createTenant1User() {
+    const user = structures.users.adminUser({
+      email: "tenant1@test.com",
+      password: "test",
     })
+    this.tenant1User = await this.createUser(user)
   }
 
   async getUser(email: string): Promise<User> {
-    return context.doInTenant(this.getTenantId(), () => {
+    return tenancy.doInTenant(this.getTenantId(), () => {
       return users.getGlobalUserByEmail(email)
     })
   }
@@ -226,7 +247,7 @@ class TestConfiguration {
       user = structures.users.user()
     }
     const response = await this._req(user, null, controllers.users.save)
-    const body = response as SaveUserResponse
+    const body = response as CreateUserResponse
     return this.getUser(body.email)
   }
 

package/src/tests/api/auth.ts

@@ -1,39 +1,20 @@
 import TestConfiguration from "../TestConfiguration"
-import { TestAPI, TestAPIOpts } from "./base"
+import { TestAPI } from "./base"
 
 export class AuthAPI extends TestAPI {
   constructor(config: TestConfiguration) {
     super(config)
   }
 
-  updatePassword = (
-    resetCode: string,
-    password: string,
-    opts?: TestAPIOpts
-  ) => {
+  updatePassword = (code: string) => {
     return this.request
       .post(`/api/global/auth/${this.config.getTenantId()}/reset/update`)
       .send({
-        password,
-        resetCode,
+        password: "newpassword",
+        resetCode: code,
       })
       .expect("Content-Type", /json/)
-      .expect(opts?.status ? opts.status : 200)
-  }
-
-  login = (
-    tenantId: string,
-    email: string,
-    password: string,
-    opts?: TestAPIOpts
-  ) => {
-    return this.request
-      .post(`/api/global/auth/${tenantId}/login`)
-      .send({
-        username: email,
-        password: password,
-      })
-      .expect(opts?.status ? opts.status : 200)
+      .expect(200)
   }
 
   logout = () => {
@@ -43,31 +24,22 @@ export class AuthAPI extends TestAPI {
       .expect(200)
   }
 
-  requestPasswordReset = async (
-    sendMailMock: any,
-    email: string,
-    opts?: TestAPIOpts
-  ) => {
+  requestPasswordReset = async (sendMailMock: any) => {
     await this.config.saveSmtpConfig()
     await this.config.saveSettingsConfig()
-
+    await this.config.createUser()
     const res = await this.request
       .post(`/api/global/auth/${this.config.getTenantId()}/reset`)
       .send({
-        email: email,
+        email: "test@test.com",
       })
       .expect("Content-Type", /json/)
-      .expect(opts?.status ? opts.status : 200)
-
-    let code: string | undefined
-    if (res.status === 200) {
-      const emailCall = sendMailMock.mock.calls[0][0]
-      const parts = emailCall.html.split(
-        `http://localhost:10000/builder/auth/reset?code=`
-      )
-      code = parts[1].split('"')[0].split("&")[0]
-    }
-
+      .expect(200)
+    const emailCall = sendMailMock.mock.calls[0][0]
+    const parts = emailCall.html.split(
+      `http://localhost:10000/builder/auth/reset?code=`
+    )
+    const code = parts[1].split('"')[0].split("&")[0]
     return { code, res }
   }
 }

package/src/tests/api/base.ts

@@ -1,5 +1,4 @@
 import TestConfiguration from "../TestConfiguration"
-import { SuperTest, Test } from "supertest"
 
 export interface TestAPIOpts {
   headers?: any
@@ -8,7 +7,7 @@ export interface TestAPIOpts {
 
 export abstract class TestAPI {
   config: TestConfiguration
-  request: SuperTest<Test>
+  request: any
 
   protected constructor(config: TestConfiguration) {
     this.config = config

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(200)
       .expect("Content-Type", /json/)
+      .expect(200)
   }
 
   saveConfig = (data: any) => {
@@ -19,8 +19,8 @@ export class ConfigAPI extends TestAPI {
       .post(`/api/global/configs`)
       .send(data)
       .set(this.config.defaultHeaders())
-      .expect(200)
       .expect("Content-Type", /json/)
+      .expect(200)
   }
 
   OIDCCallback = (configId: string, preAuthRes: any) => {

package/src/tests/api/restore.ts

@@ -9,7 +9,6 @@ export class RestoreAPI extends TestAPI {
   restored = (opts?: TestAPIOpts) => {
     return this.request
       .post(`/api/system/restored`)
-      .set(this.config.tenantIdHeaders())
       .expect(opts?.status ? opts.status : 200)
   }
 }

package/src/tests/api/users.ts

@@ -26,8 +26,8 @@ export class UserAPI extends TestAPI {
         email,
       })
       .set(this.config.defaultHeaders())
-      .expect(status)
       .expect("Content-Type", /json/)
+      .expect(status)
 
     if (status !== 200) {
       return { code: undefined, res }
@@ -100,7 +100,7 @@ export class UserAPI extends TestAPI {
       request = {
         email: structures.email(),
         password: generator.string(),
-        tenantId: structures.tenant.id(),
+        tenantId: structures.uuid(),
       }
     }
     const res = await this.request

package/src/tests/jestEnv.ts

@@ -1,8 +1,7 @@
 process.env.SELF_HOSTED = "0"
 process.env.NODE_ENV = "jest"
 process.env.JWT_SECRET = "test-jwtsecret"
-process.env.LOG_LEVEL = process.env.LOG_LEVEL || "error"
-process.env.ENABLE_4XX_HTTP_LOGGING = "0"
+process.env.LOG_LEVEL = "silent"
 process.env.MULTI_TENANCY = "1"
 process.env.MINIO_URL = "http://localhost"
 process.env.MINIO_ACCESS_KEY = "test"

package/src/tests/jestSetup.ts

@@ -1,8 +1,4 @@
-import "./logging"
-
-import { mocks, testContainerUtils } from "@budibase/backend-core/tests"
-import env from "../environment"
-import { env as coreEnv } from "@budibase/backend-core"
+import { mocks } from "@budibase/backend-core/tests"
 
 // must explicitly enable fetch mock
 mocks.fetch.enable()
@@ -12,12 +8,12 @@ mocks.fetch.enable()
 const tk = require("timekeeper")
 tk.freeze(mocks.date.MOCK_DATE)
 
+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
   // 100 seconds
-  jest.setTimeout(100 * 1000)
-} else {
-  jest.setTimeout(10 * 1000)
+  jest.setTimeout(100000)
 }
-
-testContainerUtils.setupEnv(env, coreEnv)

package/src/tests/structures/index.ts

@@ -1,16 +1,20 @@
 import { structures } from "@budibase/backend-core/tests"
 import * as configs from "./configs"
+import * as users from "./users"
 import * as groups from "./groups"
 import { v4 as uuid } from "uuid"
 
 export const TENANT_ID = "default"
+export const TENANT_1 = "tenant1"
 export const CSRF_TOKEN = "e3727778-7af0-4226-b5eb-f43cbe60a306"
 
 const pkg = {
   ...structures,
   uuid,
   configs,
+  users,
   TENANT_ID,
+  TENANT_1,
   CSRF_TOKEN,
   groups,
 }

package/src/tests/structures/users.ts

@@ -0,0 +1,37 @@
+export const email = "test@test.com"
+import { AdminUser, BuilderUser, User } from "@budibase/types"
+import { v4 as uuid } from "uuid"
+
+export const newEmail = () => {
+  return `${uuid()}@test.com`
+}
+
+export const user = (userProps?: any): User => {
+  return {
+    email: newEmail(),
+    password: "test",
+    roles: { app_test: "admin" },
+    ...userProps,
+  }
+}
+
+export const adminUser = (userProps?: any): AdminUser => {
+  return {
+    ...user(userProps),
+    admin: {
+      global: true,
+    },
+    builder: {
+      global: true,
+    },
+  }
+}
+
+export const builderUser = (userProps?: any): BuilderUser => {
+  return {
+    ...user(userProps),
+    builder: {
+      global: true,
+    },
+  }
+}

package/src/utilities/email.ts

@@ -26,7 +26,7 @@ type SendEmailOpts = {
   automation?: boolean
 }
 
-const TEST_MODE = env.ENABLE_EMAIL_TEST_MODE && env.isDev()
+const TEST_MODE = false
 const TYPE = TemplateType.EMAIL
 
 const FULL_EMAIL_PURPOSES = [
@@ -62,8 +62,8 @@ function createSMTPTransport(config: any) {
       host: "smtp.ethereal.email",
       secure: false,
       auth: {
-        user: "wyatt.zulauf29@ethereal.email",
-        pass: "tEwDtHBWWxusVWAPfa",
+        user: "don.bahringer@ethereal.email",
+        pass: "yCKSH8rWyUPbnhGYk9",
       },
     }
   }

package/src/utilities/redis.ts

@@ -54,8 +54,6 @@ export async function init() {
 export async function shutdown() {
   if (pwResetClient) await pwResetClient.finish()
   if (invitationClient) await invitationClient.finish()
-  // shutdown core clients
-  await redis.clients.shutdown()
   console.log("Redis shutdown")
 }