@budibase/worker 2.3.18-alpha.9 → 2.3.18

package/jest.config.ts

@@ -1,10 +1,8 @@
 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",
+  testEnvironment: "node",
   setupFiles: ["./src/tests/jestEnv.ts"],
   setupFilesAfterEnv: ["./src/tests/jestSetup.ts"],
   collectCoverageFrom: ["src/**/*.{js,ts}"],
@@ -12,19 +10,25 @@ const config: Config.InitialOptions = {
   transform: {
     "^.+\\.ts?$": "@swc/jest",
   },
-  moduleNameMapper: {
+}
+
+if (!process.env.CI) {
+  // use sources when not in CI
+  config.moduleNameMapper = {
     "@budibase/backend-core/(.*)": "<rootDir>/../backend-core/$1",
     "@budibase/backend-core": "<rootDir>/../backend-core/src",
     "@budibase/types": "<rootDir>/../types/src",
-  },
-}
-
-// add pro sources if they exist
-if (fs.existsSync("../../../budibase-pro")) {
-  config.moduleNameMapper["@budibase/pro/(.*)"] =
-    "<rootDir>/../../../budibase-pro/packages/pro/$1"
-  config.moduleNameMapper["@budibase/pro"] =
-    "<rootDir>/../../../budibase-pro/packages/pro/src"
+    "^axios.*$": "<rootDir>/node_modules/axios/lib/axios.js",
+  }
+  // add pro sources if they exist
+  if (fs.existsSync("../../../budibase-pro")) {
+    config.moduleNameMapper["@budibase/pro/(.*)"] =
+      "<rootDir>/../../../budibase-pro/packages/pro/$1"
+    config.moduleNameMapper["@budibase/pro"] =
+      "<rootDir>/../../../budibase-pro/packages/pro/src"
+  }
+} else {
+  console.log("Running tests with compiled dependency sources")
 }
 
 export default config

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.3.18-alpha.9",
+  "version": "2.3.18",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -22,7 +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",
-    "test": "bash scripts/test.sh",
+    "test": "jest --coverage --maxWorkers=2",
     "test:watch": "jest --watch",
     "env:multi:enable": "node scripts/multiTenancy.js enable",
     "env:multi:disable": "node scripts/multiTenancy.js disable",
@@ -36,17 +36,16 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.3.18-alpha.9",
-    "@budibase/pro": "2.3.18-alpha.8",
-    "@budibase/string-templates": "2.3.18-alpha.9",
-    "@budibase/types": "2.3.18-alpha.9",
+    "@budibase/backend-core": "^2.3.18",
+    "@budibase/pro": "2.3.17",
+    "@budibase/string-templates": "^2.3.18",
+    "@budibase/types": "^2.3.18",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
     "@types/global-agent": "2.1.1",
     "aws-sdk": "2.1030.0",
     "bcryptjs": "2.4.3",
-    "dd-trace": "3.13.2",
     "dotenv": "8.6.0",
     "elastic-apm-node": "3.38.0",
     "global-agent": "3.0.0",
@@ -73,8 +72,7 @@
   "devDependencies": {
     "@swc/core": "^1.3.25",
     "@swc/jest": "^0.2.24",
-    "@trendyol/jest-testcontainers": "^2.1.1",
-    "@types/jest": "28.1.1",
+    "@types/jest": "26.0.23",
     "@types/jsonwebtoken": "8.5.1",
     "@types/koa": "2.13.4",
     "@types/koa__router": "8.0.8",
@@ -82,7 +80,6 @@
     "@types/node-fetch": "2.6.1",
     "@types/pouchdb": "6.4.0",
     "@types/server-destroy": "1.0.1",
-    "@types/supertest": "2.0.12",
     "@types/uuid": "8.3.4",
     "@typescript-eslint/parser": "5.45.0",
     "copyfiles": "2.4.1",
@@ -100,5 +97,5 @@
     "typescript": "4.7.3",
     "update-dotenv": "1.1.1"
   },
-  "gitHead": "6ee4594457f55a76147914f1370912a401c46a86"
+  "gitHead": "7a59ee813fc92b82f415225421ff10e5f53a6b81"
 }

package/scripts/dev/manage.js

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

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

@@ -1,55 +1,49 @@
 import {
-  auth as authCore,
+  auth,
   constants,
   context,
   db as dbCore,
   events,
   tenancy,
-  utils as utilsCore,
+  users as usersCore,
+  utils,
 } from "@budibase/backend-core"
-import {
-  ConfigType,
-  User,
-  Ctx,
-  LoginRequest,
-  SSOUser,
-  PasswordResetRequest,
-  PasswordResetUpdateRequest,
-} from "@budibase/types"
+import { EmailTemplatePurpose } from "../../../constants"
+import { isEmailConfigured, sendEmail } from "../../../utilities/email"
+import { checkResetPasswordCode } from "../../../utilities/redis"
 import env from "../../../environment"
+import sdk from "../../../sdk"
+import { ConfigType, User } from "@budibase/types"
 
-import * as authSdk from "../../../sdk/auth"
-import * as userSdk from "../../../sdk/users"
-
+const { setCookie, getCookie, clearCookie, hash, platformLogout } = utils
 const { Cookie, Header } = constants
-const { passport, ssoCallbackUrl, google, oidc } = authCore
-const { setCookie, getCookie, clearCookie } = utilsCore
+const { passport, ssoCallbackUrl, google, oidc } = auth
+
+export async function googleCallbackUrl(config?: { callbackURL?: string }) {
+  return ssoCallbackUrl(tenancy.getGlobalDB(), config, ConfigType.GOOGLE)
+}
 
-// LOGIN / LOGOUT
+export async function oidcCallbackUrl(config?: { callbackURL?: string }) {
+  return ssoCallbackUrl(tenancy.getGlobalDB(), config, ConfigType.OIDC)
+}
 
-async function passportCallback(
-  ctx: Ctx,
-  user: User,
-  err: any = null,
-  info: { message: string } | null = null
-) {
+async function authInternal(ctx: any, user: any, err: any = null, info = null) {
   if (err) {
     console.error("Authentication error")
     console.error(err)
     console.trace(err)
     return ctx.throw(403, info ? info : "Unauthorized")
   }
+
   if (!user) {
     console.error("Authentication error - no user provided")
     return ctx.throw(403, info ? info : "Unauthorized")
   }
 
-  const token = await authSdk.loginUser(user)
-
   // set a cookie for browser access
-  setCookie(ctx, token, Cookie.Auth, { sign: false })
+  setCookie(ctx, user.token, Cookie.Auth, { sign: false })
   // set the token in a header as well for APIs
-  ctx.set(Header.TOKEN, token)
+  ctx.set(Header.TOKEN, user.token)
   // get rid of any app cookies on login
   // have to check test because this breaks cypress
   if (!env.isTest()) {
@@ -57,18 +51,11 @@ 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.isPreventSSOPasswords(user))) {
-    ctx.throw(400, "SSO user cannot login using password")
-  }
-
+export const authenticate = async (ctx: any, next: any) => {
   return passport.authenticate(
     "local",
     async (err: any, user: User, info: any) => {
-      await passportCallback(ctx, user, err, info)
+      await authInternal(ctx, user, err, info)
       await context.identity.doInUserContext(user, async () => {
         await events.auth.login("local")
       })
@@ -77,15 +64,6 @@ export const login = async (ctx: Ctx<LoginRequest>, next: any) => {
   )(ctx, next)
 }
 
-export const logout = async (ctx: any) => {
-  if (ctx.user && ctx.user._id) {
-    await authSdk.logout({ ctx, userId: ctx.user._id })
-  }
-  ctx.body = { message: "User logged out." }
-}
-
-// INIT
-
 export const setInitInfo = (ctx: any) => {
   const initInfo = ctx.request.body
   setCookie(ctx, initInfo, Cookie.Init)
@@ -101,16 +79,32 @@ export const getInitInfo = (ctx: any) => {
   }
 }
 
-// PASSWORD MANAGEMENT
-
 /**
  * Reset the user password, used as part of a forgotten password flow.
  */
-export const reset = async (ctx: Ctx<PasswordResetRequest>) => {
+export const reset = async (ctx: any) => {
   const { email } = ctx.request.body
-
-  await authSdk.reset(email)
-
+  const configured = await isEmailConfigured()
+  if (!configured) {
+    ctx.throw(
+      400,
+      "Please contact your platform administrator, SMTP is not configured."
+    )
+  }
+  try {
+    const user = (await usersCore.getGlobalUserByEmail(email)) as User
+    // only if user exists, don't error though if they don't
+    if (user) {
+      await sendEmail(email, EmailTemplatePurpose.PASSWORD_RECOVERY, {
+        user,
+        subject: "{{ company }} platform password reset",
+      })
+      await events.user.passwordResetRequested(user)
+    }
+  } catch (err) {
+    console.log(err)
+    // don't throw any kind of error to the user, this might give away something
+  }
   ctx.body = {
     message: "Please check your email for a reset link.",
   }
@@ -119,21 +113,32 @@ export const reset = async (ctx: Ctx<PasswordResetRequest>) => {
 /**
  * Perform the user password update if the provided reset code is valid.
  */
-export const resetUpdate = async (ctx: Ctx<PasswordResetUpdateRequest>) => {
+export const resetUpdate = async (ctx: any) => {
   const { resetCode, password } = ctx.request.body
   try {
-    await authSdk.resetUpdate(resetCode, password)
+    const { userId } = await checkResetPasswordCode(resetCode)
+    const db = tenancy.getGlobalDB()
+    const user = await db.get(userId)
+    user.password = await hash(password)
+    await db.put(user)
     ctx.body = {
       message: "password reset successfully.",
     }
+    // remove password from the user before sending events
+    delete user.password
+    await events.user.passwordReset(user)
   } catch (err) {
-    console.warn(err)
-    // hide any details of the error for security
+    console.error(err)
     ctx.throw(400, "Cannot reset password.")
   }
 }
 
-// DATASOURCE
+export const logout = async (ctx: any) => {
+  if (ctx.user && ctx.user._id) {
+    await platformLogout({ ctx, userId: ctx.user._id })
+  }
+  ctx.body = { message: "User logged out." }
+}
 
 export const datasourcePreAuth = async (ctx: any, next: any) => {
   const provider = ctx.params.provider
@@ -161,12 +166,6 @@ export const datasourceAuth = async (ctx: any, next: any) => {
   return handler.postAuth(passport, ctx, next)
 }
 
-// GOOGLE SSO
-
-export async function googleCallbackUrl(config?: { callbackURL?: string }) {
-  return ssoCallbackUrl(tenancy.getGlobalDB(), config, ConfigType.GOOGLE)
-}
-
 /**
  * The initial call that google authentication makes to take you to the google login screen.
  * On a successful login, you will be redirected to the googleAuth callback route.
@@ -182,7 +181,7 @@ export const googlePreAuth = async (ctx: any, next: any) => {
   const strategy = await google.strategyFactory(
     config,
     callbackUrl,
-    userSdk.save
+    sdk.users.save
   )
 
   return passport.authenticate(strategy, {
@@ -192,7 +191,7 @@ export const googlePreAuth = async (ctx: any, next: any) => {
   })(ctx, next)
 }
 
-export const googleCallback = async (ctx: any, next: any) => {
+export const googleAuth = async (ctx: any, next: any) => {
   const db = tenancy.getGlobalDB()
 
   const config = await dbCore.getScopedConfig(db, {
@@ -203,14 +202,14 @@ export const googleCallback = async (ctx: any, next: any) => {
   const strategy = await google.strategyFactory(
     config,
     callbackUrl,
-    userSdk.save
+    sdk.users.save
   )
 
   return passport.authenticate(
     strategy,
     { successRedirect: "/", failureRedirect: "/error" },
-    async (err: any, user: SSOUser, info: any) => {
-      await passportCallback(ctx, user, err, info)
+    async (err: any, user: User, info: any) => {
+      await authInternal(ctx, user, err, info)
       await context.identity.doInUserContext(user, async () => {
         await events.auth.login("google-internal")
       })
@@ -219,12 +218,6 @@ export const googleCallback = async (ctx: any, next: any) => {
   )(ctx, next)
 }
 
-// OIDC SSO
-
-export async function oidcCallbackUrl(config?: { callbackURL?: string }) {
-  return ssoCallbackUrl(tenancy.getGlobalDB(), config, ConfigType.OIDC)
-}
-
 export const oidcStrategyFactory = async (ctx: any, configId: any) => {
   const db = tenancy.getGlobalDB()
   const config = await dbCore.getScopedConfig(db, {
@@ -240,7 +233,7 @@ export const oidcStrategyFactory = async (ctx: any, configId: any) => {
     chosenConfig,
     callbackUrl
   )
-  return oidc.strategyFactory(enrichedConfig, userSdk.save)
+  return oidc.strategyFactory(enrichedConfig, sdk.users.save)
 }
 
 /**
@@ -272,15 +265,15 @@ export const oidcPreAuth = async (ctx: any, next: any) => {
   })(ctx, next)
 }
 
-export const oidcCallback = async (ctx: any, next: any) => {
+export const oidcAuth = async (ctx: any, next: any) => {
   const configId = getCookie(ctx, Cookie.OIDC_CONFIG)
   const strategy = await oidcStrategyFactory(ctx, configId)
 
   return passport.authenticate(
     strategy,
     { successRedirect: "/", failureRedirect: "/error" },
-    async (err: any, user: SSOUser, info: any) => {
-      await passportCallback(ctx, user, err, info)
+    async (err: any, user: any, info: any) => {
+      await authInternal(ctx, user, err, info)
       await context.identity.doInUserContext(user, async () => {
         await events.auth.login("oidc")
       })

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

@@ -1,22 +1,18 @@
-import * as userSdk from "../../../sdk/users"
+import sdk from "../../../sdk"
 import {
+  events,
   featureFlags,
   tenancy,
   constants,
   db as dbCore,
   utils,
+  cache,
   encryption,
-  auth as authCore,
 } from "@budibase/backend-core"
 import env from "../../../environment"
 import { groups } from "@budibase/pro"
-import {
-  UpdateSelfRequest,
-  UpdateSelfResponse,
-  UpdateSelf,
-  UserCtx,
-} from "@budibase/types"
-const { getCookie, clearCookie, newid } = utils
+const { hash, platformLogout, getCookie, clearCookie, newid } = utils
+const { user: userCache } = cache
 
 function newTestApiKey() {
   return env.ENCRYPTED_TEST_PUBLIC_API_KEY
@@ -97,6 +93,17 @@ const addSessionAttributesToUser = (ctx: any) => {
   ctx.body.csrfToken = ctx.user.csrfToken
 }
 
+const sanitiseUserUpdate = (ctx: any) => {
+  const allowed = ["firstName", "lastName", "password", "forceResetPassword"]
+  const resp: { [key: string]: any } = {}
+  for (let [key, value] of Object.entries(ctx.request.body)) {
+    if (allowed.includes(key)) {
+      resp[key] = value
+    }
+  }
+  return resp
+}
+
 export async function getSelf(ctx: any) {
   if (!ctx.user) {
     ctx.throw(403, "User not logged in")
@@ -109,7 +116,7 @@ export async function getSelf(ctx: any) {
   checkCurrentApp(ctx)
 
   // get the main body of the user
-  const user = await userSdk.getUser(userId)
+  const user = await sdk.users.getUser(userId)
   ctx.body = await groups.enrichUserRolesFromGroups(user)
 
   // add the feature flags for this tenant
@@ -119,30 +126,39 @@ export async function getSelf(ctx: any) {
   addSessionAttributesToUser(ctx)
 }
 
-export async function updateSelf(
-  ctx: UserCtx<UpdateSelfRequest, UpdateSelfResponse>
-) {
-  const body = ctx.request.body
-  const update: UpdateSelf = {
-    firstName: body.firstName,
-    lastName: body.lastName,
-    password: body.password,
-    forceResetPassword: body.forceResetPassword,
-  }
-
-  const user = await userSdk.updateSelf(ctx.user._id!, update)
-
-  if (update.password) {
+export async function updateSelf(ctx: any) {
+  const db = tenancy.getGlobalDB()
+  const user = await db.get(ctx.user._id)
+  let passwordChange = false
+
+  const userUpdateObj = sanitiseUserUpdate(ctx)
+  if (userUpdateObj.password) {
+    // changing password
+    passwordChange = true
+    userUpdateObj.password = await hash(userUpdateObj.password)
     // Log all other sessions out apart from the current one
-    await authCore.platformLogout({
+    await platformLogout({
       ctx,
-      userId: ctx.user._id!,
+      userId: ctx.user._id,
       keepActiveSession: true,
     })
   }
 
+  const response = await db.put({
+    ...user,
+    ...userUpdateObj,
+  })
+  await userCache.invalidateUser(user._id)
   ctx.body = {
-    _id: user._id!,
-    _rev: user._rev!,
+    _id: response.id,
+    _rev: response.rev,
+  }
+
+  // remove the old password from the user before sending events
+  user._rev = response.rev
+  delete user.password
+  await events.user.updated(user)
+  if (passwordChange) {
+    await events.user.passwordUpdated(user)
   }
 }