@budibase/worker 2.8.29-alpha.1 → 2.8.29-alpha.10

package/jest.config.ts

@@ -1,9 +1,7 @@
 import { Config } from "@jest/types"
 import * as fs from "fs"
-const preset = require("ts-jest/jest-preset")
 
 const config: Config.InitialOptions = {
-  ...preset,
   preset: "@trendyol/jest-testcontainers",
   setupFiles: ["./src/tests/jestEnv.ts"],
   setupFilesAfterEnv: ["./src/tests/jestSetup.ts"],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.8.29-alpha.1",
+  "version": "2.8.29-alpha.10",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -38,10 +38,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.8.29-alpha.1",
-    "@budibase/pro": "2.8.29-alpha.1",
-    "@budibase/string-templates": "2.8.29-alpha.1",
-    "@budibase/types": "2.8.29-alpha.1",
+    "@budibase/backend-core": "2.8.29-alpha.10",
+    "@budibase/pro": "2.8.29-alpha.10",
+    "@budibase/string-templates": "2.8.29-alpha.10",
+    "@budibase/types": "2.8.29-alpha.10",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -74,10 +74,10 @@
     "server-destroy": "1.0.1"
   },
   "devDependencies": {
-    "@swc/core": "^1.3.25",
-    "@swc/jest": "^0.2.24",
-    "@trendyol/jest-testcontainers": "^2.1.1",
-    "@types/jest": "28.1.1",
+    "@swc/core": "1.3.71",
+    "@swc/jest": "0.2.27",
+    "@trendyol/jest-testcontainers": "2.1.1",
+    "@types/jest": "29.5.3",
     "@types/jsonwebtoken": "8.5.1",
     "@types/koa": "2.13.4",
     "@types/koa__router": "8.0.8",
@@ -91,14 +91,13 @@
     "@typescript-eslint/parser": "5.45.0",
     "copyfiles": "2.4.1",
     "eslint": "6.8.0",
-    "jest": "28.1.1",
+    "jest": "29.6.2",
     "lodash": "4.17.21",
     "nodemon": "2.0.15",
     "pouchdb-adapter-memory": "7.2.2",
     "rimraf": "3.0.2",
     "supertest": "6.2.2",
     "timekeeper": "2.2.0",
-    "ts-jest": "28.0.4",
     "ts-node": "10.8.1",
     "tsconfig-paths": "4.0.0",
     "typescript": "4.7.3",
@@ -118,5 +117,5 @@
       }
     }
   },
-  "gitHead": "22e6d6f053f4ce55f24a07e86c7221f56c05f14c"
+  "gitHead": "470257346fcc8aaac746d73e337e1b2333a5fed6"
 }

package/src/api/controllers/global/auth.ts

@@ -55,8 +55,8 @@ async function passportCallback(
 export const login = async (ctx: Ctx<LoginRequest>, next: any) => {
   const email = ctx.request.body.username
 
-  const user = await userSdk.getUserByEmail(email)
-  if (user && (await userSdk.isPreventPasswordActions(user))) {
+  const user = await userSdk.db.getUserByEmail(email)
+  if (user && (await userSdk.db.isPreventPasswordActions(user))) {
     ctx.throw(403, "Invalid credentials")
   }
 
@@ -174,7 +174,7 @@ export const googlePreAuth = async (ctx: any, next: any) => {
   const strategy = await google.strategyFactory(
     config,
     callbackUrl,
-    userSdk.save
+    userSdk.db.save
   )
 
   return passport.authenticate(strategy, {
@@ -193,7 +193,7 @@ export const googleCallback = async (ctx: any, next: any) => {
   const strategy = await google.strategyFactory(
     config,
     callbackUrl,
-    userSdk.save
+    userSdk.db.save
   )
 
   return passport.authenticate(
@@ -228,7 +228,7 @@ export const oidcStrategyFactory = async (ctx: any, configId: any) => {
 
   //Remote Config
   const enrichedConfig = await oidc.fetchStrategyConfig(config, callbackUrl)
-  return oidc.strategyFactory(enrichedConfig, userSdk.save)
+  return oidc.strategyFactory(enrichedConfig, userSdk.db.save)
 }
 
 /**

package/src/api/controllers/global/roles.ts

@@ -5,10 +5,10 @@ import {
   cache,
   tenancy,
 } from "@budibase/backend-core"
-import { BBContext, App } from "@budibase/types"
-import { allUsers } from "../../../sdk/users"
+import sdk from "../../../sdk"
+import { Ctx, App } from "@budibase/types"
 
-export async function fetch(ctx: BBContext) {
+export async function fetch(ctx: Ctx) {
   const tenantId = ctx.user!.tenantId
   // always use the dev apps as they'll be most up to date (true)
   const apps = (await dbCore.getAllApps({ tenantId, all: true })) as App[]
@@ -31,7 +31,7 @@ export async function fetch(ctx: BBContext) {
   ctx.body = response
 }
 
-export async function find(ctx: BBContext) {
+export async function find(ctx: Ctx) {
   const appId = ctx.params.appId
   await context.doInAppContext(dbCore.getDevAppID(appId), async () => {
     const db = context.getAppDB()
@@ -45,10 +45,10 @@ export async function find(ctx: BBContext) {
   })
 }
 
-export async function removeAppRole(ctx: BBContext) {
+export async function removeAppRole(ctx: Ctx) {
   const { appId } = ctx.params
   const db = tenancy.getGlobalDB()
-  const users = await allUsers()
+  const users = await sdk.users.db.allUsers()
   const bulk = []
   const cacheInvalidations = []
   for (let user of users) {

package/src/api/controllers/global/self.ts

@@ -91,7 +91,7 @@ export async function getSelf(ctx: any) {
   }
 
   // get the main body of the user
-  const user = await userSdk.getUser(userId)
+  const user = await userSdk.db.getUser(userId)
   ctx.body = await groups.enrichUserRolesFromGroups(user)
 
   // add the feature flags for this tenant
@@ -106,12 +106,12 @@ export async function updateSelf(
 ) {
   const update = ctx.request.body
 
-  let user = await userSdk.getUser(ctx.user._id!)
+  let user = await userSdk.db.getUser(ctx.user._id!)
   user = {
     ...user,
     ...update,
   }
-  user = await userSdk.save(user, { requirePassword: false })
+  user = await userSdk.db.save(user, { requirePassword: false })
 
   if (update.password) {
     // Log all other sessions out apart from the current one

package/src/api/controllers/global/users.ts

@@ -41,7 +41,7 @@ export const save = async (ctx: UserCtx<User, SaveUserResponse>) => {
     const currentUserId = ctx.user?._id
     const requestUser = ctx.request.body
 
-    const user = await userSdk.save(requestUser, { currentUserId })
+    const user = await userSdk.db.save(requestUser, { currentUserId })
 
     ctx.body = {
       _id: user._id!,
@@ -57,7 +57,7 @@ const bulkDelete = async (userIds: string[], currentUserId: string) => {
   if (userIds?.indexOf(currentUserId) !== -1) {
     throw new Error("Unable to delete self.")
   }
-  return await userSdk.bulkDelete(userIds)
+  return await userSdk.db.bulkDelete(userIds)
 }
 
 const bulkCreate = async (users: User[], groupIds: string[]) => {
@@ -66,7 +66,7 @@ const bulkCreate = async (users: User[], groupIds: string[]) => {
       "Max limit for upload is 1000 users. Please reduce file size and try again."
     )
   }
-  return await userSdk.bulkCreate(users, groupIds)
+  return await userSdk.db.bulkCreate(users, groupIds)
 }
 
 export const bulkUpdate = async (
@@ -141,7 +141,7 @@ export const adminUser = async (
       // always bust checklist beforehand, if an error occurs but can proceed, don't get
       // stuck in a cycle
       await cache.bustCache(cache.CacheKey.CHECKLIST)
-      const finalUser = await userSdk.save(user, {
+      const finalUser = await userSdk.db.save(user, {
         hashPassword,
         requirePassword,
       })
@@ -167,7 +167,7 @@ export const adminUser = async (
 export const countByApp = async (ctx: any) => {
   const appId = ctx.params.appId
   try {
-    ctx.body = await userSdk.countUsersByApp(appId)
+    ctx.body = await userSdk.db.countUsersByApp(appId)
   } catch (err: any) {
     ctx.throw(err.status || 400, err)
   }
@@ -179,7 +179,7 @@ export const destroy = async (ctx: any) => {
     ctx.throw(400, "Unable to delete self.")
   }
 
-  await userSdk.destroy(id)
+  await userSdk.db.destroy(id)
 
   ctx.body = {
     message: `User ${id} deleted.`,
@@ -188,7 +188,7 @@ export const destroy = async (ctx: any) => {
 
 export const getAppUsers = async (ctx: Ctx<SearchUsersRequest>) => {
   const body = ctx.request.body
-  const users = await userSdk.getUsersByAppAccess(body?.appId)
+  const users = await userSdk.db.getUsersByAppAccess(body?.appId)
 
   ctx.body = { data: users }
 }
@@ -212,7 +212,7 @@ export const search = async (ctx: Ctx<SearchUsersRequest>) => {
 
 // called internally by app server user fetch
 export const fetch = async (ctx: any) => {
-  const all = await userSdk.allUsers()
+  const all = await userSdk.db.allUsers()
   // user hashed password shouldn't ever be returned
   for (let user of all) {
     if (user) {
@@ -224,12 +224,12 @@ export const fetch = async (ctx: any) => {
 
 // called internally by app server user find
 export const find = async (ctx: any) => {
-  ctx.body = await userSdk.getUser(ctx.params.id)
+  ctx.body = await userSdk.db.getUser(ctx.params.id)
 }
 
 export const tenantUserLookup = async (ctx: any) => {
   const id = ctx.params.id
-  const user = await userSdk.getPlatformUser(id)
+  const user = await userSdk.core.getPlatformUser(id)
   if (user) {
     ctx.body = user
   } else {
@@ -252,7 +252,7 @@ export const onboardUsers = async (ctx: Ctx<InviteUsersRequest>) => {
     // @ts-ignore
     const { users, groups, roles } = request.create
     const assignUsers = users.map((user: User) => (user.roles = roles))
-    onboardingResponse = await userSdk.bulkCreate(assignUsers, groups)
+    onboardingResponse = await userSdk.db.bulkCreate(assignUsers, groups)
     ctx.body = onboardingResponse
   } else if (emailConfigured) {
     onboardingResponse = await inviteMultiple(ctx)
@@ -277,7 +277,7 @@ export const onboardUsers = async (ctx: Ctx<InviteUsersRequest>) => {
         tenantId: tenancy.getTenantId(),
       }
     })
-    let bulkCreateReponse = await userSdk.bulkCreate(users, [])
+    let bulkCreateReponse = await userSdk.db.bulkCreate(users, [])
 
     // Apply temporary credentials
     let createWithCredentials = {
@@ -410,7 +410,7 @@ export const inviteAccept = async (
         ...info,
       }
 
-      const saved = await userSdk.save(request)
+      const saved = await userSdk.db.save(request)
       const db = tenancy.getGlobalDB()
       const user = await db.get<User>(saved._id)
       await events.user.inviteAccepted(user)

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

@@ -0,0 +1,62 @@
+import { TestConfiguration, structures } from "../../../../tests"
+import { mocks } from "@budibase/backend-core/tests"
+import { User } from "@budibase/types"
+
+const MOCK_APP_ID = "app_a"
+
+describe("/api/global/users/:userId/app/builder", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  async function newUser() {
+    const base = structures.users.user()
+    return await config.createUser(base)
+  }
+
+  async function getUser(userId: string) {
+    const response = await config.api.users.getUser(userId)
+    return response.body as User
+  }
+
+  describe("Confirm pro license", () => {
+    it("should 400 with licensing", async () => {
+      const user = await newUser()
+      const resp = await config.api.users.grantBuilderToApp(
+        user._id!,
+        MOCK_APP_ID,
+        400
+      )
+      expect(resp.body.message).toContain("Feature not enabled")
+    })
+  })
+
+  describe("PATCH /api/global/users/:userId/app/:appId/builder", () => {
+    it("should be able to grant a user access to a particular app", async () => {
+      mocks.licenses.useAppBuilders()
+      const user = await newUser()
+      await config.api.users.grantBuilderToApp(user._id!, MOCK_APP_ID)
+      const updated = await getUser(user._id!)
+      expect(updated.builder?.apps![0]).toBe(MOCK_APP_ID)
+    })
+  })
+
+  describe("DELETE /api/global/users/:userId/app/:appId/builder", () => {
+    it("should allow revoking access", async () => {
+      mocks.licenses.useAppBuilders()
+      const user = await newUser()
+      await config.api.users.grantBuilderToApp(user._id!, MOCK_APP_ID)
+      let updated = await getUser(user._id!)
+      expect(updated.builder?.apps![0]).toBe(MOCK_APP_ID)
+      await config.api.users.revokeBuilderFromApp(user._id!, MOCK_APP_ID)
+      updated = await getUser(user._id!)
+      expect(updated.builder?.apps!.length).toBe(0)
+    })
+  })
+})

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

@@ -41,7 +41,7 @@ describe("/api/global/auth", () => {
 
   async function createSSOUser() {
     return config.doInTenant(async () => {
-      return userSdk.save(structures.users.ssoUser(), {
+      return userSdk.db.save(structures.users.ssoUser(), {
         requirePassword: false,
       })
     })
@@ -245,7 +245,7 @@ describe("/api/global/auth", () => {
             const ssoUser = user as SSOUser
             ssoUser.providerType = structures.sso.providerType()
             delete ssoUser.password
-            await config.doInTenant(() => userSdk.save(ssoUser))
+            await config.doInTenant(() => userSdk.db.save(ssoUser))
 
             await testSSOUser(code!)
           })

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

@@ -314,7 +314,7 @@ describe("scim", () => {
 
           const user = await config.getUser(email)
           expect(user).toBeDefined()
-          expect(user.email).toEqual(email)
+          expect(user!.email).toEqual(email)
         })
 
         it("if multiple emails are provided, the first primary one is used as email", async () => {
@@ -345,7 +345,7 @@ describe("scim", () => {
 
           const user = await config.getUser(email)
           expect(user).toBeDefined()
-          expect(user.email).toEqual(email)
+          expect(user!.email).toEqual(email)
         })
 
         it("if no email is provided and the user name is not an email, an exception is thrown", async () => {

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

@@ -66,7 +66,7 @@ describe("/api/global/users", () => {
       expect(res.body._id).toBeDefined()
       const user = await config.getUser(email)
       expect(user).toBeDefined()
-      expect(user._id).toEqual(res.body._id)
+      expect(user!._id).toEqual(res.body._id)
       expect(events.user.inviteAccepted).toBeCalledTimes(1)
       expect(events.user.inviteAccepted).toBeCalledWith(user)
     })
@@ -480,7 +480,7 @@ describe("/api/global/users", () => {
       function createSSOUser() {
         return config.doInTenant(() => {
           const user = structures.users.ssoUser()
-          return userSdk.save(user, { requirePassword: false })
+          return userSdk.db.save(user, { requirePassword: false })
         })
       }
 

package/src/api/routes/index.ts

@@ -23,6 +23,7 @@ import env from "../../environment"
 export const routes: Router[] = [
   configRoutes,
   userRoutes,
+  pro.users,
   workspaceRoutes,
   authRoutes,
   templateRoutes,

package/src/environment.ts

@@ -1,4 +1,8 @@
-const { join } = require("path")
+import { env as coreEnv } from "@budibase/backend-core"
+import { ServiceType } from "@budibase/types"
+import { join } from "path"
+
+coreEnv._set("SERVICE_TYPE", ServiceType.WORKER)
 
 function isDev() {
   return process.env.NODE_ENV !== "production"

package/src/initPro.ts

@@ -2,12 +2,5 @@ import { sdk as proSdk } from "@budibase/pro"
 import * as userSdk from "./sdk/users"
 
 export const initPro = async () => {
-  await proSdk.init({
-    scimUserServiceConfig: {
-      functions: {
-        saveUser: userSdk.save,
-        removeUser: (id: string) => userSdk.destroy(id),
-      },
-    },
-  })
+  await proSdk.init({})
 }

package/src/migrations/functions/globalInfoSyncUsers.ts

@@ -10,7 +10,7 @@ import { platform } from "@budibase/backend-core"
  * Re-sync the global-db users to the global-info db users
  */
 export const run = async (globalDb: any) => {
-  const users = (await usersSdk.allUsers()) as User[]
+  const users = (await usersSdk.db.allUsers()) as User[]
   const promises = []
   for (let user of users) {
     promises.push(

package/src/sdk/auth/auth.ts

@@ -1,11 +1,11 @@
 import {
   auth as authCore,
-  tenancy,
-  utils as coreUtils,
-  sessions,
+  env as coreEnv,
   events,
   HTTPError,
-  env as coreEnv,
+  sessions,
+  tenancy,
+  utils as coreUtils,
 } from "@budibase/backend-core"
 import { PlatformLogoutOpts, User } from "@budibase/types"
 import jwt from "jsonwebtoken"
@@ -20,7 +20,7 @@ export async function loginUser(user: User) {
   const sessionId = coreUtils.newid()
   const tenantId = tenancy.getTenantId()
   await sessions.createASession(user._id!, { sessionId, tenantId })
-  const token = jwt.sign(
+  return jwt.sign(
     {
       userId: user._id,
       sessionId,
@@ -28,7 +28,6 @@ export async function loginUser(user: User) {
     },
     coreEnv.JWT_SECRET!
   )
-  return token
 }
 
 export async function logout(opts: PlatformLogoutOpts) {
@@ -58,7 +57,7 @@ export const reset = async (email: string) => {
   }
 
   // exit if user has sso
-  if (await userSdk.isPreventPasswordActions(user)) {
+  if (await userSdk.db.isPreventPasswordActions(user)) {
     return
   }
 
@@ -76,9 +75,9 @@ export const reset = async (email: string) => {
 export const resetUpdate = async (resetCode: string, password: string) => {
   const { userId } = await redis.checkResetPasswordCode(resetCode)
 
-  let user = await userSdk.getUser(userId)
+  let user = await userSdk.db.getUser(userId)
   user.password = password
-  user = await userSdk.save(user)
+  user = await userSdk.db.save(user)
 
   // remove password from the user before sending events
   delete user.password

package/src/sdk/users/index.ts

@@ -1,2 +1,7 @@
 export * from "./users"
+import { users } from "@budibase/backend-core"
+import * as pro from "@budibase/pro"
+// pass in the components which are specific to the worker/the parts of pro which backend-core cannot access
+users.UserDB.init(pro.quotas, pro.groups, pro.features)
+export const db = users.UserDB
 export { users as core } from "@budibase/backend-core"

package/src/sdk/users/tests/users.spec.ts

@@ -1,8 +1,8 @@
 import { structures, mocks } from "../../../tests"
 import { env, context } from "@budibase/backend-core"
 import * as users from "../users"
+import { db as userDb } from "../"
 import { CloudAccount } from "@budibase/types"
-import { isPreventPasswordActions } from "../users"
 
 describe("users", () => {
   beforeEach(() => {
@@ -13,7 +13,7 @@ describe("users", () => {
     it("returns false for non sso user", async () => {
       await context.doInTenant(structures.tenant.id(), async () => {
         const user = structures.users.user()
-        const result = await users.isPreventPasswordActions(user)
+        const result = await userDb.isPreventPasswordActions(user)
         expect(result).toBe(false)
       })
     })
@@ -24,7 +24,7 @@ describe("users", () => {
         const account = structures.accounts.ssoAccount() as CloudAccount
         account.email = user.email
         mocks.accounts.getAccountByTenantId.mockResolvedValueOnce(account)
-        const result = await users.isPreventPasswordActions(user)
+        const result = await userDb.isPreventPasswordActions(user)
         expect(result).toBe(true)
       })
     })
@@ -34,7 +34,7 @@ describe("users", () => {
         const user = structures.users.user()
         const account = structures.accounts.ssoAccount() as CloudAccount
         mocks.accounts.getAccountByTenantId.mockResolvedValueOnce(account)
-        const result = await users.isPreventPasswordActions(user)
+        const result = await userDb.isPreventPasswordActions(user)
         expect(result).toBe(false)
       })
     })
@@ -42,7 +42,7 @@ describe("users", () => {
     it("returns true for sso user", async () => {
       await context.doInTenant(structures.tenant.id(), async () => {
         const user = structures.users.ssoUser()
-        const result = await users.isPreventPasswordActions(user)
+        const result = await userDb.isPreventPasswordActions(user)
         expect(result).toBe(true)
       })
     })
@@ -52,7 +52,7 @@ describe("users", () => {
         await context.doInTenant(structures.tenant.id(), async () => {
           const user = structures.users.user()
           mocks.pro.features.isSSOEnforced.mockResolvedValueOnce(true)
-          const result = await users.isPreventPasswordActions(user)
+          const result = await userDb.isPreventPasswordActions(user)
           expect(result).toBe(true)
         })
       })
@@ -70,7 +70,7 @@ describe("users", () => {
       describe("non-admin user", () => {
         it("returns true", async () => {
           const user = structures.users.ssoUser()
-          const result = await users.isPreventPasswordActions(user)
+          const result = await userDb.isPreventPasswordActions(user)
           expect(result).toBe(true)
         })
       })
@@ -80,7 +80,7 @@ describe("users", () => {
           const user = structures.users.ssoUser({
             user: structures.users.adminUser(),
           })
-          const result = await users.isPreventPasswordActions(user)
+          const result = await userDb.isPreventPasswordActions(user)
           expect(result).toBe(false)
         })
       })