@budibase/worker 2.4.44-alpha.3 → 2.4.44-alpha.32

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.4.44-alpha.3",
+  "version": "2.4.44-alpha.32",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -22,6 +22,7 @@
     "build:docker": "docker build . -t worker-service --label version=$BUDIBASE_RELEASE_VERSION",
     "dev:stack:init": "node ./scripts/dev/manage.js init",
     "dev:builder": "npm run dev:stack:init && nodemon",
+    "dev:built": "yarn run dev:stack:init && yarn run run:docker",
     "test": "bash scripts/test.sh",
     "test:watch": "jest --watch",
     "env:multi:enable": "node scripts/multiTenancy.js enable",
@@ -36,10 +37,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.4.44-alpha.3",
-    "@budibase/pro": "2.4.44-alpha.2",
-    "@budibase/string-templates": "2.4.44-alpha.3",
-    "@budibase/types": "2.4.44-alpha.3",
+    "@budibase/backend-core": "2.4.44-alpha.32",
+    "@budibase/pro": "2.4.44-alpha.31",
+    "@budibase/string-templates": "2.4.44-alpha.32",
+    "@budibase/types": "2.4.44-alpha.32",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -56,7 +57,6 @@
     "koa-body": "4.2.0",
     "koa-compress": "4.0.1",
     "koa-passport": "4.1.4",
-    "koa-pino-logger": "3.0.0",
     "koa-send": "5.0.1",
     "koa-session": "5.13.1",
     "koa-static": "5.0.0",
@@ -66,7 +66,6 @@
     "passport-google-oauth": "2.0.0",
     "passport-jwt": "4.0.0",
     "passport-local": "1.0.0",
-    "pino-pretty": "4.8.0",
     "pouchdb": "7.3.0",
     "pouchdb-all-dbs": "1.1.1",
     "server-destroy": "1.0.1"
@@ -103,5 +102,5 @@
     "typescript": "4.7.3",
     "update-dotenv": "1.1.1"
   },
-  "gitHead": "e6449a30351b2c3ffe9fe3d8b5e5fa02861b3ae3"
+  "gitHead": "d00d19161a9dd1de465d179274f6308d9a99fec1"
 }

package/scripts/dev/manage.js

@@ -30,6 +30,7 @@ async function init() {
       DEPLOYMENT_ENVIRONMENT: "development",
       TENANT_FEATURE_FLAGS: "*:LICENSING,*:USER_GROUPS,*:ONBOARDING_TOUR",
       ENABLE_EMAIL_TEST_MODE: 1,
+      HTTP_LOGGING: 0,
     }
     let envFile = ""
     Object.keys(envFileJson).forEach(key => {

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

@@ -2,6 +2,7 @@ import tk from "timekeeper"
 import _ from "lodash"
 import { mocks, structures } from "@budibase/backend-core/tests"
 import {
+  ScimCreateUserRequest,
   ScimGroupResponse,
   ScimUpdateRequest,
   ScimUserResponse,
@@ -176,7 +177,9 @@ describe("scim", () => {
           const response = await getScimUsers({
             params: {
               filter: encodeURI(
-                `emails[type eq "work"].value eq "${userToFetch?.emails[0].value}"`
+                `emails[type eq "work"].value eq "${
+                  userToFetch?.emails![0].value
+                }"`
               ),
             },
           })
@@ -252,6 +255,45 @@ describe("scim", () => {
           )
         })
 
+        it("a new user can minim information", async () => {
+          const userData = {
+            externalId: structures.uuid(),
+            email: structures.generator.email(),
+            username: structures.generator.name(),
+            firstName: undefined,
+            lastName: undefined,
+          }
+          const body = structures.scim.createUserRequest(userData)
+
+          const response = await postScimUser({ body })
+
+          const expectedScimUser = {
+            schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"],
+            id: expect.any(String),
+            externalId: userData.externalId,
+            meta: {
+              resourceType: "User",
+              created: mocks.date.MOCK_DATE.toISOString(),
+              lastModified: mocks.date.MOCK_DATE.toISOString(),
+            },
+            userName: userData.username,
+            active: true,
+            emails: [
+              {
+                value: userData.email,
+                type: "work",
+                primary: true,
+              },
+            ],
+          }
+          expect(response).toEqual(expectedScimUser)
+
+          const persistedUsers = await config.api.scimUsersAPI.get()
+          expect(persistedUsers.Resources).toEqual(
+            expect.arrayContaining([expectedScimUser])
+          )
+        })
+
         it("an event is dispatched", async () => {
           const body = structures.scim.createUserRequest()
 
@@ -259,6 +301,70 @@ describe("scim", () => {
 
           expect(events.user.created).toBeCalledTimes(1)
         })
+
+        it("if the username is an email, the user name will be used as email", async () => {
+          const email = structures.generator.email()
+
+          const body: ScimCreateUserRequest = structures.scim.createUserRequest(
+            { username: email }
+          )
+          delete body.emails
+
+          await postScimUser({ body })
+
+          const user = await config.getUser(email)
+          expect(user).toBeDefined()
+          expect(user.email).toEqual(email)
+        })
+
+        it("if multiple emails are provided, the first primary one is used as email", async () => {
+          const email = structures.generator.email()
+
+          const body: ScimCreateUserRequest = {
+            ...structures.scim.createUserRequest(),
+            emails: [
+              {
+                primary: false,
+                type: "work",
+                value: structures.generator.email(),
+              },
+              {
+                primary: true,
+                type: "work",
+                value: email,
+              },
+              {
+                primary: true,
+                type: "work",
+                value: structures.generator.email(),
+              },
+            ],
+          }
+
+          await postScimUser({ body })
+
+          const user = await config.getUser(email)
+          expect(user).toBeDefined()
+          expect(user.email).toEqual(email)
+        })
+
+        it("if no email is provided and the user name is not an email, an exception is thrown", async () => {
+          const body: ScimCreateUserRequest = structures.scim.createUserRequest(
+            { username: structures.generator.name() }
+          )
+          delete body.emails
+
+          await postScimUser({ body }, { expect: 500 })
+        })
+      })
+
+      it("creating an existing user name returns a conflict", async () => {
+        const body = structures.scim.createUserRequest()
+
+        await postScimUser({ body })
+
+        const res = await postScimUser({ body }, { expect: 409 })
+        expect((res as any).message).toBe("Email already in use")
       })
     })
 
@@ -331,7 +437,7 @@ describe("scim", () => {
           name: {
             ...user.name,
             familyName: newFamilyName,
-            formatted: `${user.name.givenName} ${newFamilyName}`,
+            formatted: `${user.name!.givenName} ${newFamilyName}`,
           },
         }
         expect(response).toEqual(expectedScimUser)
@@ -341,72 +447,40 @@ describe("scim", () => {
       })
 
       it.each([false, "false", "False"])(
-        "can deactive an active user (sending %s)",
+        "deactivating an active user (sending %s) will delete it",
         async activeValue => {
           const body: ScimUpdateRequest = {
             schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
             Operations: [{ op: "Replace", path: "active", value: activeValue }],
           }
 
-          const response = await patchScimUser({ id: user.id, body })
-
-          const expectedScimUser: ScimUserResponse = {
-            ...user,
-            active: false,
-          }
-          expect(response).toEqual(expectedScimUser)
-
-          const persistedUser = await config.api.scimUsersAPI.find(user.id)
-          expect(persistedUser).toEqual(expectedScimUser)
-        }
-      )
-
-      it.each([true, "true", "True"])(
-        "can activate an inactive user (sending %s)",
-        async activeValue => {
-          // Deactivate user
-          await patchScimUser({
-            id: user.id,
-            body: {
-              schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
-              Operations: [{ op: "Replace", path: "active", value: true }],
-            },
-          })
-
-          const body: ScimUpdateRequest = {
-            schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
-            Operations: [{ op: "Replace", path: "active", value: activeValue }],
-          }
-
-          const response = await patchScimUser({ id: user.id, body })
-
-          const expectedScimUser: ScimUserResponse = {
-            ...user,
-            active: true,
-          }
-          expect(response).toEqual(expectedScimUser)
+          await patchScimUser(
+            { id: user.id, body },
+            { expect: 204, skipContentTypeCheck: true }
+          )
 
-          const persistedUser = await config.api.scimUsersAPI.find(user.id)
-          expect(persistedUser).toEqual(expectedScimUser)
+          await config.api.scimUsersAPI.find(user.id, { expect: 404 })
         }
       )
 
       it("supports updating unmapped fields", async () => {
+        const value = structures.generator.letter()
         const body: ScimUpdateRequest = {
           schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
           Operations: [
             {
               op: "Add",
               path: "preferredLanguage",
-              value: structures.generator.letter(),
+              value,
             },
           ],
         }
 
         const response = await patchScimUser({ id: user.id, body })
 
-        const expectedScimUser: ScimUserResponse = {
+        const expectedScimUser = {
           ...user,
+          preferredLanguage: value,
         }
         expect(response).toEqual(expectedScimUser)
 

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

@@ -48,7 +48,7 @@ describe("/api/global/users", () => {
         400
       )
 
-      expect(res.body.message).toBe("Unavailable")
+      expect(res.body.message).toBe(`Unavailable`)
       expect(sendMailMock).toHaveBeenCalledTimes(0)
       expect(code).toBeUndefined()
       expect(events.user.invited).toBeCalledTimes(0)
@@ -225,7 +225,9 @@ describe("/api/global/users", () => {
 
       const response = await config.api.users.saveUser(user, 400)
 
-      expect(response.body.message).toBe(`Unavailable`)
+      expect(response.body.message).toBe(
+        `Email already in use: '${user.email}'`
+      )
       expect(events.user.created).toBeCalledTimes(0)
     })
 
@@ -237,7 +239,9 @@ describe("/api/global/users", () => {
         delete user._id
         const response = await config.api.users.saveUser(user, 400)
 
-        expect(response.body.message).toBe(`Unavailable`)
+        expect(response.body.message).toBe(
+          `Email already in use: '${user.email}'`
+        )
         expect(events.user.created).toBeCalledTimes(0)
       })
     })
@@ -249,7 +253,9 @@ describe("/api/global/users", () => {
 
       const response = await config.api.users.saveUser(user, 400)
 
-      expect(response.body.message).toBe(`Unavailable`)
+      expect(response.body.message).toBe(
+        `Email already in use: '${user.email}'`
+      )
       expect(events.user.created).toBeCalledTimes(0)
     })
 

package/src/environment.ts

@@ -47,7 +47,6 @@ const environment = {
   // flags
   NODE_ENV: process.env.NODE_ENV,
   SELF_HOSTED: !!parseInt(process.env.SELF_HOSTED || ""),
-  LOG_LEVEL: process.env.LOG_LEVEL,
   MULTI_TENANCY: process.env.MULTI_TENANCY,
   DISABLE_ACCOUNT_PORTAL: process.env.DISABLE_ACCOUNT_PORTAL,
   SMTP_FALLBACK_ENABLED: process.env.SMTP_FALLBACK_ENABLED,

package/src/index.ts

@@ -2,10 +2,6 @@ if (process.env.DD_APM_ENABLED) {
   require("./ddApm")
 }
 
-if (process.env.ELASTIC_APM_ENABLED) {
-  require("./elasticApm")
-}
-
 // need to load environment first
 import env from "./environment"
 import { Scope } from "@sentry/node"
@@ -31,7 +27,6 @@ import api from "./api"
 import * as redis from "./utilities/redis"
 const Sentry = require("@sentry/node")
 const koaSession = require("koa-session")
-const logger = require("koa-pino-logger")
 const { userAgent } = require("koa-useragent")
 
 import destroyable from "server-destroy"
@@ -60,8 +55,8 @@ app.use(handleScimBody)
 app.use(koaBody({ multipart: true }))
 
 app.use(koaSession(app))
-app.use(middleware.logging)
-app.use(logger(logging.pinoSettings()))
+app.use(middleware.correlation)
+app.use(middleware.pino)
 app.use(userAgent)
 
 // authentication

package/src/sdk/users/users.ts

@@ -16,6 +16,7 @@ import {
   ViewName,
   env as coreEnv,
   context,
+  EmailUnavailableError,
 } from "@budibase/backend-core"
 import {
   AccountMetadata,
@@ -158,7 +159,7 @@ const validateUniqueUser = async (email: string, tenantId: string) => {
   if (env.MULTI_TENANCY) {
     const tenantUser = await getPlatformUser(email)
     if (tenantUser != null && tenantUser.tenantId !== tenantId) {
-      throw `Unavailable`
+      throw new EmailUnavailableError(email)
     }
   }
 
@@ -166,7 +167,7 @@ const validateUniqueUser = async (email: string, tenantId: string) => {
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
     const account = await accounts.getAccount(email)
     if (account && account.verified && account.tenantId !== tenantId) {
-      throw `Unavailable`
+      throw new EmailUnavailableError(email)
     }
   }
 }
@@ -235,7 +236,7 @@ export const save = async (
     // no id was specified - load from email instead
     dbUser = await usersCore.getGlobalUserByEmail(email)
     if (dbUser && dbUser._id !== _id) {
-      throw `Unavailable`
+      throw new EmailUnavailableError(email)
     }
   }
 

package/src/tests/api/scim/shared.ts

@@ -4,6 +4,7 @@ import { TestAPI } from "../base"
 const defaultConfig = {
   expect: 200,
   setHeaders: true,
+  skipContentTypeCheck: false,
 }
 
 export type RequestSettings = typeof defaultConfig
@@ -27,7 +28,7 @@ export abstract class ScimTestAPI extends TestAPI {
       "application/scim+json; charset=utf-8"
     )
 
-    if (method !== "delete") {
+    if (method !== "delete" && !requestSettings?.skipContentTypeCheck) {
       request = request.expect("Content-Type", /json/)
     }
 

package/src/tests/jestEnv.ts

@@ -2,7 +2,6 @@ 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.MULTI_TENANCY = "1"
 process.env.MINIO_URL = "http://localhost"
 process.env.MINIO_ACCESS_KEY = "test"

package/src/tests/jestSetup.ts

@@ -1,5 +1,3 @@
-import "./logging"
-
 import { mocks, testContainerUtils } from "@budibase/backend-core/tests"
 import env from "../environment"
 import { env as coreEnv, timers } from "@budibase/backend-core"

package/src/elasticApm.ts

@@ -1,10 +0,0 @@
-import apm from "elastic-apm-node"
-
-// enable APM if configured
-if (process.env.ELASTIC_APM_ENABLED) {
-  console.log("Starting elastic-apm-node")
-  apm.start({
-    serviceName: process.env.SERVICE,
-    environment: process.env.BUDIBASE_ENVIRONMENT,
-  })
-}

package/src/tests/logging.ts

@@ -1,34 +0,0 @@
-export enum LogLevel {
-  TRACE = "trace",
-  DEBUG = "debug",
-  INFO = "info",
-  WARN = "warn",
-  ERROR = "error",
-}
-
-const LOG_INDEX: { [key in LogLevel]: number } = {
-  [LogLevel.TRACE]: 1,
-  [LogLevel.DEBUG]: 2,
-  [LogLevel.INFO]: 3,
-  [LogLevel.WARN]: 4,
-  [LogLevel.ERROR]: 5,
-}
-
-const setIndex = LOG_INDEX[process.env.LOG_LEVEL as LogLevel]
-
-if (setIndex > LOG_INDEX.trace) {
-  global.console.trace = jest.fn()
-}
-
-if (setIndex > LOG_INDEX.debug) {
-  global.console.debug = jest.fn()
-}
-
-if (setIndex > LOG_INDEX.info) {
-  global.console.info = jest.fn()
-  global.console.log = jest.fn()
-}
-
-if (setIndex > LOG_INDEX.warn) {
-  global.console.warn = jest.fn()
-}