@budibase/worker 3.18.4 → 3.18.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.18.4",
+  "version": "3.18.6",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -109,5 +109,5 @@
       }
     }
   },
-  "gitHead": "b82c05d3d0949d198b49415d20980e72cc61ca5b"
+  "gitHead": "0062775fce7e68e01263a9c5a5e94bf978da8746"
 }

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

@@ -1,18 +1,15 @@
-import * as email from "../../../utilities/email"
-import env from "../../../environment"
-import * as auth from "./auth"
 import {
   BadRequestError,
-  ForbiddenError,
   cache,
   configs,
-  db as dbCore,
   env as coreEnv,
+  db as dbCore,
   events,
+  ForbiddenError,
   objectStore,
   tenancy,
 } from "@budibase/backend-core"
-import { checkAnyUserExists } from "../../../utilities/users"
+import * as pro from "@budibase/pro"
 import {
   AIInnerConfig,
   Config,
@@ -44,7 +41,10 @@ import {
   UploadConfigFileResponse,
   UserCtx,
 } from "@budibase/types"
-import * as pro from "@budibase/pro"
+import env from "../../../environment"
+import * as email from "../../../utilities/email"
+import { checkAnyUserExists } from "../../../utilities/users"
+import * as auth from "./auth"
 
 const getEventFns = async (config: Config, existing?: Config) => {
   const fns = []
@@ -241,6 +241,8 @@ async function processOIDCConfig(config: OIDCConfigs, existing?: OIDCConfigs) {
     throw new Error("License does not allow OIDC PKCE method support")
   }
 
+  config.configs.filter(c => c.pkce === null).forEach(c => delete c.pkce)
+
   if (existing) {
     for (const c of config.configs) {
       const existingConfig = existing.configs.find(e => e.uuid === c.uuid)
@@ -646,10 +648,13 @@ export async function configChecklist(ctx: Ctx<void, ConfigChecklistResponse>) {
       cache.CacheKey.CHECKLIST,
       env.CHECKLIST_CACHE_TTL,
       async (): Promise<ConfigChecklistResponse> => {
-        let apps = []
+        let workspaces = []
         if (!env.MULTI_TENANCY || tenantId) {
           // Apps exist
-          apps = await dbCore.getAllApps({ idsOnly: true, efficient: true })
+          workspaces = await dbCore.getAllWorkspaces({
+            idsOnly: true,
+            efficient: true,
+          })
         }
 
         // They have set up SMTP
@@ -671,7 +676,7 @@ export async function configChecklist(ctx: Ctx<void, ConfigChecklistResponse>) {
 
         return {
           apps: {
-            checked: apps.length > 0,
+            checked: workspaces.length > 0,
             label: "Create your first app",
             link: "/builder/portal/workspaces",
           },

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

@@ -17,22 +17,22 @@ import sdk from "../../../sdk"
 export async function fetch(ctx: Ctx<void, FetchGlobalRolesResponse>) {
   const tenantId = ctx.user!.tenantId
   await context.doInTenant(tenantId, async () => {
-    // always use the dev apps as they'll be most up to date (true)
-    const apps = await dbCore.getAllApps({ all: true })
+    // always use the dev workspaces as they'll be most up to date (true)
+    const workspaces = await dbCore.getAllWorkspaces({ all: true })
     const promises = []
-    for (let app of apps) {
-      // use dev app IDs
-      promises.push(roles.getAllRoles(app.appId))
+    for (let workspace of workspaces) {
+      // use dev workspace IDs
+      promises.push(roles.getAllRoles(workspace.appId))
     }
     const roleList = await Promise.all(promises)
     const response: any = {}
-    for (let app of apps) {
-      const deployedAppId = dbCore.getProdAppID(app.appId)
+    for (let workspace of workspaces) {
+      const deployedAppId = dbCore.getProdWorkspaceID(workspace.appId)
       response[deployedAppId] = {
         roles: roleList.shift(),
-        name: app.name,
-        version: app.version,
-        url: app.url,
+        name: workspace.name,
+        version: workspace.version,
+        url: workspace.url,
       }
     }
     ctx.body = response
@@ -41,16 +41,19 @@ export async function fetch(ctx: Ctx<void, FetchGlobalRolesResponse>) {
 
 export async function find(ctx: Ctx<void, FindGlobalRoleResponse>) {
   const appId = ctx.params.appId
-  await context.doInAppContext(dbCore.getDevAppID(appId), async () => {
-    const db = context.getAppDB()
-    const app = await db.get<Workspace>(dbCore.DocumentType.APP_METADATA)
-    ctx.body = {
-      roles: await roles.getAllRoles(),
-      name: app.name,
-      version: app.version,
-      url: app.url,
+  await context.doInWorkspaceContext(
+    dbCore.getDevWorkspaceID(appId),
+    async () => {
+      const db = context.getWorkspaceDB()
+      const app = await db.get<Workspace>(dbCore.DocumentType.APP_METADATA)
+      ctx.body = {
+        roles: await roles.getAllRoles(),
+        name: app.name,
+        version: app.version,
+        url: app.url,
+      }
     }
-  })
+  )
 }
 
 export async function removeAppRole(ctx: Ctx<void, RemoveAppRoleResponse>) {
@@ -59,7 +62,7 @@ export async function removeAppRole(ctx: Ctx<void, RemoveAppRoleResponse>) {
   const users = await sdk.users.db.allUsers()
   const bulk = []
   const cacheInvalidations = []
-  const prodAppId = dbCore.getProdAppID(appId)
+  const prodAppId = dbCore.getProdWorkspaceID(appId)
   for (let user of users) {
     let updated = false
     if (user.roles[prodAppId]) {

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

@@ -1,13 +1,11 @@
-import * as userSdk from "../../../sdk/users"
 import {
+  auth as authCore,
+  db as dbCore,
+  encryption,
   features,
   tenancy,
-  db as dbCore,
   utils,
-  encryption,
-  auth as authCore,
 } from "@budibase/backend-core"
-import env from "../../../environment"
 import { ai, groups } from "@budibase/pro"
 import {
   DevInfo,
@@ -20,6 +18,8 @@ import {
   User,
   UserCtx,
 } from "@budibase/types"
+import env from "../../../environment"
+import * as userSdk from "../../../sdk/users"
 
 const { newid } = utils
 
@@ -139,8 +139,8 @@ export const syncAppFavourites = async (processedAppIds: string[]) => {
   const tenantId = tenancy.getTenantId()
   const appPrefix =
     tenantId === tenancy.DEFAULT_TENANT_ID
-      ? dbCore.APP_DEV_PREFIX
-      : `${dbCore.APP_DEV_PREFIX}${tenantId}_`
+      ? dbCore.WORKSPACE_DEV_PREFIX
+      : `${dbCore.WORKSPACE_DEV_PREFIX}${tenantId}_`
 
   const apps = await fetchAppsByIds(processedAppIds, appPrefix)
   return apps?.reduce((acc: string[], app) => {
@@ -156,7 +156,7 @@ export const fetchAppsByIds = async (
   processedAppIds: string[],
   appPrefix: string
 ) => {
-  return await dbCore.getAppsByIDs(
+  return await dbCore.getWorkspacesByIDs(
     processedAppIds.map(appId => {
       return `${appPrefix}${appId}`
     })

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

@@ -1,7 +1,7 @@
-import * as controller from "../../controllers/global/configs"
 import { auth } from "@budibase/backend-core"
-import Joi from "joi"
 import { ConfigType, PKCEMethod } from "@budibase/types"
+import Joi from "joi"
+import * as controller from "../../controllers/global/configs"
 import { adminRoutes, loggedInRoutes } from "../endpointGroups"
 
 function smtpValidation() {
@@ -51,7 +51,7 @@ function oidcValidation() {
         uuid: Joi.string().required(),
         activated: Joi.boolean().required(),
         scopes: Joi.array().optional(),
-        pkce: Joi.string().valid(...Object.values(PKCEMethod)).optional()
+        pkce: Joi.string().valid(...Object.values(PKCEMethod)).optional().allow(null)
       })
     ).required()
   }).unknown(true)

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

@@ -1,5 +1,5 @@
-import { mocks, structures } from "@budibase/backend-core/tests"
 import { context, events } from "@budibase/backend-core"
+import { mocks, structures } from "@budibase/backend-core/tests"
 import { Event, IdentityType } from "@budibase/types"
 import { TestConfiguration } from "../../../../tests"
 
@@ -36,7 +36,7 @@ describe("/api/global/auditlogs (%s)", () => {
           for (let i = 0; i < USER_AUDIT_LOG_COUNT; i++) {
             await events.user.created(structures.users.user())
           }
-          await context.doInAppContext(APP_ID, async () => {
+          await context.doInWorkspaceContext(APP_ID, async () => {
             await events.app.created(structures.apps.app(APP_ID))
           })
           // fetch the user created events

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

@@ -1,9 +1,14 @@
 jest.mock("nodemailer")
-import { TestConfiguration, structures, mocks } from "../../../../tests"
+import { configs, events } from "@budibase/backend-core"
+import {
+  Config,
+  ConfigType,
+  GetPublicSettingsResponse,
+  PKCEMethod,
+} from "@budibase/types"
+import { TestConfiguration, mocks, structures } from "../../../../tests"
 
 mocks.email.mock()
-import { configs, events } from "@budibase/backend-core"
-import { GetPublicSettingsResponse, Config, ConfigType } from "@budibase/types"
 
 const { google, smtp, settings, oidc } = structures.configs
 
@@ -13,6 +18,7 @@ describe("configs", () => {
   beforeEach(async () => {
     await config.beforeAll()
     jest.clearAllMocks()
+    mocks.licenses.usePkceOidc()
   })
 
   afterAll(async () => {
@@ -189,6 +195,24 @@ describe("configs", () => {
             "--secret-value--"
           )
         })
+
+        it("should strip pkce field when null", async () => {
+          await saveConfig(oidc({ pkce: null as any }))
+
+          await config.doInTenant(async () => {
+            const rawConf = await configs.getOIDCConfig()
+            expect(rawConf!).not.toHaveProperty("pkce")
+          })
+        })
+
+        it("should preserve pkce field when set to valid value", async () => {
+          await saveConfig(oidc({ pkce: PKCEMethod.S256 }))
+
+          await config.doInTenant(async () => {
+            const rawConf = await configs.getOIDCConfig()
+            expect(rawConf!.pkce).toBe(PKCEMethod.S256)
+          })
+        })
       })
     })
 

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

@@ -16,19 +16,19 @@ jest.mock("@budibase/backend-core", () => {
     },
     context: {
       ...core.context,
-      getAppDB: jest.fn(),
+      getWorkspaceDB: jest.fn(),
     },
   }
 })
 
-let appId: string
-let appDb: Database
+let workspaceId: string
+let workspaceDb: Database
 const ROLE_NAME = "newRole"
 
 async function addAppMetadata() {
-  await appDb.put({
+  await workspaceDb.put({
     _id: "app_metadata",
-    appId: appId,
+    appId: workspaceId,
     name: "New App",
     version: "version",
     url: "url",
@@ -38,8 +38,8 @@ async function addAppMetadata() {
 async function updateAppMetadata(
   update: Partial<WithoutDocMetadata<Workspace>>
 ) {
-  const app = await appDb.get("app_metadata")
-  await appDb.put({
+  const app = await workspaceDb.get("app_metadata")
+  await workspaceDb.put({
     ...app,
     ...update,
   })
@@ -60,13 +60,13 @@ describe("/api/global/roles", () => {
   })
 
   beforeEach(async () => {
-    appId = db.generateAppID(config.tenantId)
-    appDb = db.getDB(appId)
-    const mockAppDB = context.getAppDB as jest.Mock
-    mockAppDB.mockReturnValue(appDb)
+    workspaceId = db.generateWorkspaceID(config.tenantId)
+    workspaceDb = db.getDB(workspaceId)
+    const mockWorkspaceDB = context.getWorkspaceDB as jest.Mock
+    mockWorkspaceDB.mockReturnValue(workspaceDb)
 
     await addAppMetadata()
-    await appDb.put(role)
+    await workspaceDb.put(role)
   })
 
   afterAll(async () => {
@@ -81,8 +81,10 @@ describe("/api/global/roles", () => {
     it("retrieves roles", async () => {
       const res = await config.api.roles.get()
       expect(res.body).toBeDefined()
-      expect(res.body[appId].roles.length).toEqual(5)
-      expect(res.body[appId].roles.map((r: any) => r._id)).toContain(ROLE_NAME)
+      expect(res.body[workspaceId].roles.length).toEqual(5)
+      expect(res.body[workspaceId].roles.map((r: any) => r._id)).toContain(
+        ROLE_NAME
+      )
     })
 
     it.each(["3.0.0", "3.0.1", "3.1.0", "3.0.0+2146.b125a7c"])(
@@ -91,7 +93,7 @@ describe("/api/global/roles", () => {
         await updateAppMetadata({ creationVersion })
         const res = await config.api.roles.get()
         expect(res.body).toBeDefined()
-        expect(res.body[appId].roles.map((r: any) => r._id)).toEqual([
+        expect(res.body[workspaceId].roles.map((r: any) => r._id)).toEqual([
           ROLE_NAME,
           roles.BUILTIN_ROLE_IDS.ADMIN,
           roles.BUILTIN_ROLE_IDS.BASIC,
@@ -106,7 +108,7 @@ describe("/api/global/roles", () => {
         await updateAppMetadata({ creationVersion })
         const res = await config.api.roles.get()
         expect(res.body).toBeDefined()
-        expect(res.body[appId].roles.map((r: any) => r._id)).toEqual([
+        expect(res.body[workspaceId].roles.map((r: any) => r._id)).toEqual([
           ROLE_NAME,
           roles.BUILTIN_ROLE_IDS.ADMIN,
           roles.BUILTIN_ROLE_IDS.POWER,
@@ -122,7 +124,7 @@ describe("/api/global/roles", () => {
         await updateAppMetadata({ creationVersion })
         const res = await config.api.roles.get()
 
-        expect(res.body[appId].roles.map((r: any) => r._id)).toEqual([
+        expect(res.body[workspaceId].roles.map((r: any) => r._id)).toEqual([
           ROLE_NAME,
           roles.BUILTIN_ROLE_IDS.ADMIN,
           roles.BUILTIN_ROLE_IDS.POWER,
@@ -135,7 +137,7 @@ describe("/api/global/roles", () => {
 
   describe("GET api/global/roles/:appId", () => {
     it("finds a role by appId", async () => {
-      const res = await config.api.roles.find(appId)
+      const res = await config.api.roles.find(workspaceId)
       expect(res.body).toBeDefined()
       expect(res.body.name).toEqual("New App")
     })
@@ -160,9 +162,9 @@ describe("/api/global/roles", () => {
         app_test: "role1",
       }
       const userResponse = await config.createUser(user)
-      const res = await config.api.roles.remove(appId)
+      const res = await config.api.roles.remove(workspaceId)
       const updatedUser = await config.api.users.getUser(userResponse._id!)
-      expect(updatedUser.body.roles).not.toHaveProperty(appId)
+      expect(updatedUser.body.roles).not.toHaveProperty(workspaceId)
       expect(res.body.message).toEqual("App role removed from all users")
     })
 
@@ -170,7 +172,7 @@ describe("/api/global/roles", () => {
       const builderUser = await createBuilderUser()
 
       const res = await config.withUser(builderUser, () =>
-        config.api.roles.remove(appId, { status: 403 })
+        config.api.roles.remove(workspaceId, { status: 403 })
       )
       expect(res.body.message).toBe("Admin user only endpoint.")
     })

package/src/sdk/tenants/tenants.ts

@@ -1,6 +1,5 @@
 import { db as dbCore, platform, tenancy } from "@budibase/backend-core"
 import { quotas } from "@budibase/pro"
-import { Workspace } from "@budibase/types"
 
 export async function deleteTenant(tenantId: string) {
   await quotas.bustCache()
@@ -21,9 +20,11 @@ async function removeGlobalDB(tenantId: string) {
 
 async function removeTenantApps(tenantId: string) {
   try {
-    const apps = (await dbCore.getAllApps({ all: true })) as Workspace[]
-    const destroyPromises = apps.map(app => {
-      const db = dbCore.getDB(app.appId)
+    const workspaces = await dbCore.getAllWorkspaces({
+      all: true,
+    })
+    const destroyPromises = workspaces.map(workspace => {
+      const db = dbCore.getDB(workspace.appId)
       return db.destroy()
     })
     await Promise.allSettled(destroyPromises)

package/src/tests/structures/groups.ts

@@ -1,6 +1,6 @@
-import { generator } from "@budibase/backend-core/tests"
 import { db } from "@budibase/backend-core"
-import { UserGroup as UserGroupType, UserGroupRoles } from "@budibase/types"
+import { generator } from "@budibase/backend-core/tests"
+import { UserGroupRoles, UserGroup as UserGroupType } from "@budibase/types"
 
 export function UserGroup(): UserGroupType {
   const appsCount = generator.integer({ min: 0, max: 3 })
@@ -8,7 +8,11 @@ export function UserGroup(): UserGroupType {
     (p: UserGroupRoles) => {
       return {
         ...p,
-        [db.generateAppID()]: generator.pickone(["ADMIN", "POWER", "BASIC"]),
+        [db.generateWorkspaceID()]: generator.pickone([
+          "ADMIN",
+          "POWER",
+          "BASIC",
+        ]),
       }
     },
     {}