@budibase/worker 2.1.30 → 2.1.32-alpha.0

package/jest.config.ts

@@ -0,0 +1,29 @@
+import { Config } from "@jest/types"
+import * as fs from "fs"
+
+const config: Config.InitialOptions = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  setupFiles: ["./src/tests/jestSetup.ts"],
+  collectCoverageFrom: ["src/**/*.{js,ts}"],
+  coverageReporters: ["lcov", "json", "clover"],
+}
+
+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",
+    "^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/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.1.30",
+  "version": "2.1.32-alpha.0",
   "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": "jest --runInBand",
+    "test": "jest --coverage --runInBand",
     "test:watch": "jest --watch",
     "env:multi:enable": "node scripts/multiTenancy.js enable",
     "env:multi:disable": "node scripts/multiTenancy.js disable",
@@ -36,10 +36,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "^2.1.30",
-    "@budibase/pro": "2.1.29",
-    "@budibase/string-templates": "^2.1.30",
-    "@budibase/types": "^2.1.30",
+    "@budibase/backend-core": "2.1.32-alpha.0",
+    "@budibase/pro": "2.1.31",
+    "@budibase/string-templates": "2.1.32-alpha.0",
+    "@budibase/types": "2.1.32-alpha.0",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -71,38 +71,28 @@
   },
   "devDependencies": {
     "@types/jest": "26.0.23",
+    "@types/jsonwebtoken": "8.5.1",
     "@types/koa": "2.13.4",
     "@types/koa__router": "8.0.11",
     "@types/node": "14.18.20",
+    "@types/node-fetch": "2.6.1",
     "@types/pouchdb": "6.4.0",
     "@types/uuid": "8.3.4",
     "@typescript-eslint/parser": "5.12.0",
     "copyfiles": "2.4.1",
     "eslint": "6.8.0",
-    "jest": "27.4.7",
+    "jest": "28.1.1",
     "nodemon": "2.0.15",
     "pouchdb-adapter-memory": "7.2.2",
     "prettier": "2.3.1",
     "rimraf": "3.0.2",
     "supertest": "6.2.2",
     "timekeeper": "2.2.0",
-    "ts-jest": "27.1.3",
-    "ts-node": "10.4.0",
+    "ts-jest": "28.0.4",
+    "ts-node": "10.8.1",
     "tsconfig-paths": "4.0.0",
-    "typescript": "4.5.5",
+    "typescript": "4.7.3",
     "update-dotenv": "1.1.1"
   },
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node",
-    "moduleNameMapper": {
-      "@budibase/backend-core/(.*)": "<rootDir>/../backend-core/$1",
-      "@budibase/backend-core": "<rootDir>/../backend-core/src",
-      "@budibase/types": "<rootDir>/../types/src"
-    },
-    "setupFiles": [
-      "./scripts/jestSetup.js"
-    ]
-  },
-  "gitHead": "105b7bb83f432105bc412077364b69f124fc8791"
+  "gitHead": "f192fc72b3035780f5d1b7595f24227841f50cf6"
 }

package/scripts/localdomain.js

@@ -2,6 +2,36 @@
 const updateDotEnv = require("update-dotenv")
 
 const arg = process.argv.slice(2)[0]
+const isEnable = arg === "enable"
+
+let domain = process.argv.slice(2)[1]
+if (!domain) {
+  domain = "local.com"
+}
+
+const getAccountPortalUrl = () => {
+  if (isEnable) {
+    return `http://account.${domain}:10001`
+  } else {
+    return `http://localhost:10001`
+  }
+}
+
+const getBudibaseUrl = () => {
+  if (isEnable) {
+    return `http://${domain}:10000`
+  } else {
+    return `http://localhost:10000`
+  }
+}
+
+const getCookieDomain = () => {
+  if (isEnable) {
+    return `.${domain}`
+  } else {
+    return ""
+  }
+}
 
 /**
  * For testing multi tenancy sub domains locally.
@@ -16,11 +46,7 @@ const arg = process.argv.slice(2)[0]
  * 127.0.0.1   t2.local.com
  */
 updateDotEnv({
-  ACCOUNT_PORTAL_URL:
-    arg === "enable"
-      ? "http://account.local.com:10001"
-      : "http://localhost:10001",
-  COOKIE_DOMAIN: arg === "enable" ? ".local.com" : "",
-  PLATFORM_URL:
-    arg === "enable" ? "http://local.com:10000" : "http://localhost:10000",
+  ACCOUNT_PORTAL_URL: getAccountPortalUrl(),
+  COOKIE_DOMAIN: getCookieDomain(),
+  PLATFORM_URL: getBudibaseUrl(),
 }).then(() => console.log("Updated worker!"))

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

@@ -1,22 +1,26 @@
-const core = require("@budibase/backend-core")
-const { Configs, EmailTemplatePurpose } = require("../../../constants")
-const { sendEmail, isEmailConfigured } = require("../../../utilities/email")
-const { setCookie, getCookie, clearCookie, hash, platformLogout } = core.utils
-const { Cookies, Headers } = core.constants
-const { passport, ssoCallbackUrl, google, oidc } = core.auth
-const { checkResetPasswordCode } = require("../../../utilities/redis")
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const env = require("../../../environment")
-import { events, users as usersCore, context } from "@budibase/backend-core"
+import core from "@budibase/backend-core"
+import {
+  events,
+  users as usersCore,
+  context,
+  tenancy,
+} from "@budibase/backend-core"
+import { Config, EmailTemplatePurpose } from "../../../constants"
+import { sendEmail, isEmailConfigured } from "../../../utilities/email"
+import { checkResetPasswordCode } from "../../../utilities/redis"
+import env from "../../../environment"
 import sdk from "../../../sdk"
 import { User } from "@budibase/types"
+const { setCookie, getCookie, clearCookie, hash, platformLogout } = core.utils
+const { Cookie, Header } = core.constants
+const { passport, ssoCallbackUrl, google, oidc } = core.auth
 
 export const googleCallbackUrl = async (config: any) => {
-  return ssoCallbackUrl(getGlobalDB(), config, "google")
+  return ssoCallbackUrl(tenancy.getGlobalDB(), config, "google")
 }
 
 export const oidcCallbackUrl = async (config: any) => {
-  return ssoCallbackUrl(getGlobalDB(), config, "oidc")
+  return ssoCallbackUrl(tenancy.getGlobalDB(), config, "oidc")
 }
 
 async function authInternal(ctx: any, user: any, err = null, info = null) {
@@ -30,13 +34,13 @@ async function authInternal(ctx: any, user: any, err = null, info = null) {
   }
 
   // set a cookie for browser access
-  setCookie(ctx, user.token, Cookies.Auth, { sign: false })
+  setCookie(ctx, user.token, Cookie.Auth, { sign: false })
   // set the token in a header as well for APIs
-  ctx.set(Headers.TOKEN, user.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()) {
-    clearCookie(ctx, Cookies.CurrentApp)
+    clearCookie(ctx, Cookie.CurrentApp)
   }
 }
 
@@ -55,15 +59,15 @@ export const authenticate = async (ctx: any, next: any) => {
 
 export const setInitInfo = (ctx: any) => {
   const initInfo = ctx.request.body
-  setCookie(ctx, initInfo, Cookies.Init)
+  setCookie(ctx, initInfo, Cookie.Init)
   ctx.status = 200
 }
 
 export const getInitInfo = (ctx: any) => {
   try {
-    ctx.body = getCookie(ctx, Cookies.Init) || {}
+    ctx.body = getCookie(ctx, Cookie.Init) || {}
   } catch (err) {
-    clearCookie(ctx, Cookies.Init)
+    clearCookie(ctx, Cookie.Init)
     ctx.body = {}
   }
 }
@@ -106,7 +110,7 @@ export const resetUpdate = async (ctx: any) => {
   const { resetCode, password } = ctx.request.body
   try {
     const { userId } = await checkResetPasswordCode(resetCode)
-    const db = getGlobalDB()
+    const db = tenancy.getGlobalDB()
     const user = await db.get(userId)
     user.password = await hash(password)
     await db.put(user)
@@ -141,14 +145,14 @@ export const datasourcePreAuth = async (ctx: any, next: any) => {
       appId: ctx.query.appId,
       datasourceId: ctx.query.datasourceId,
     },
-    Cookies.DatasourceAuth
+    Cookie.DatasourceAuth
   )
 
   return handler.preAuth(passport, ctx, next)
 }
 
 export const datasourceAuth = async (ctx: any, next: any) => {
-  const authStateCookie = getCookie(ctx, Cookies.DatasourceAuth)
+  const authStateCookie = getCookie(ctx, Cookie.DatasourceAuth)
   const provider = authStateCookie.provider
   const middleware = require(`@budibase/backend-core/middleware`)
   const handler = middleware.datasource[provider]
@@ -160,10 +164,10 @@ export const datasourceAuth = async (ctx: any, next: any) => {
  * On a successful login, you will be redirected to the googleAuth callback route.
  */
 export const googlePreAuth = async (ctx: any, next: any) => {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
 
   const config = await core.db.getScopedConfig(db, {
-    type: Configs.GOOGLE,
+    type: Config.GOOGLE,
     workspace: ctx.query.workspace,
   })
   let callbackUrl = await exports.googleCallbackUrl(config)
@@ -181,10 +185,10 @@ export const googlePreAuth = async (ctx: any, next: any) => {
 }
 
 export const googleAuth = async (ctx: any, next: any) => {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
 
   const config = await core.db.getScopedConfig(db, {
-    type: Configs.GOOGLE,
+    type: Config.GOOGLE,
     workspace: ctx.query.workspace,
   })
   const callbackUrl = await exports.googleCallbackUrl(config)
@@ -208,9 +212,9 @@ export const googleAuth = async (ctx: any, next: any) => {
 }
 
 export const oidcStrategyFactory = async (ctx: any, configId: any) => {
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const config = await core.db.getScopedConfig(db, {
-    type: Configs.OIDC,
+    type: Config.OIDC,
     group: ctx.query.group,
   })
 
@@ -233,11 +237,11 @@ export const oidcPreAuth = async (ctx: any, next: any) => {
   const { configId } = ctx.params
   const strategy = await oidcStrategyFactory(ctx, configId)
 
-  setCookie(ctx, configId, Cookies.OIDC_CONFIG)
+  setCookie(ctx, configId, Cookie.OIDC_CONFIG)
 
-  const db = getGlobalDB()
+  const db = tenancy.getGlobalDB()
   const config = await core.db.getScopedConfig(db, {
-    type: Configs.OIDC,
+    type: Config.OIDC,
     group: ctx.query.group,
   })
 
@@ -255,7 +259,7 @@ export const oidcPreAuth = async (ctx: any, next: any) => {
 }
 
 export const oidcAuth = async (ctx: any, next: any) => {
-  const configId = getCookie(ctx, Cookies.OIDC_CONFIG)
+  const configId = getCookie(ctx, Cookie.OIDC_CONFIG)
   const strategy = await oidcStrategyFactory(ctx, configId)
 
   return passport.authenticate(

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

@@ -4,7 +4,7 @@ const {
   getScopedFullConfig,
   getAllApps,
 } = require("@budibase/backend-core/db")
-const { Configs } = require("../../../constants")
+const { Config } = require("../../../constants")
 const email = require("../../../utilities/email")
 const {
   upload,
@@ -33,25 +33,25 @@ const getEventFns = async (db, config) => {
 
   if (!existing) {
     switch (config.type) {
-      case Configs.SMTP: {
+      case Config.SMTP: {
         fns.push(events.email.SMTPCreated)
         break
       }
-      case Configs.GOOGLE: {
+      case Config.GOOGLE: {
         fns.push(() => events.auth.SSOCreated(type))
         if (config.config.activated) {
           fns.push(() => events.auth.SSOActivated(type))
         }
         break
       }
-      case Configs.OIDC: {
+      case Config.OIDC: {
         fns.push(() => events.auth.SSOCreated(type))
         if (config.config.configs[0].activated) {
           fns.push(() => events.auth.SSOActivated(type))
         }
         break
       }
-      case Configs.SETTINGS: {
+      case Config.SETTINGS: {
         // company
         const company = config.config.company
         if (company && company !== "Budibase") {
@@ -78,11 +78,11 @@ const getEventFns = async (db, config) => {
     }
   } else {
     switch (config.type) {
-      case Configs.SMTP: {
+      case Config.SMTP: {
         fns.push(events.email.SMTPUpdated)
         break
       }
-      case Configs.GOOGLE: {
+      case Config.GOOGLE: {
         fns.push(() => events.auth.SSOUpdated(type))
         if (!existing.config.activated && config.config.activated) {
           fns.push(() => events.auth.SSOActivated(type))
@@ -91,7 +91,7 @@ const getEventFns = async (db, config) => {
         }
         break
       }
-      case Configs.OIDC: {
+      case Config.OIDC: {
         fns.push(() => events.auth.SSOUpdated(type))
         if (
           !existing.config.configs[0].activated &&
@@ -106,7 +106,7 @@ const getEventFns = async (db, config) => {
         }
         break
       }
-      case Configs.SETTINGS: {
+      case Config.SETTINGS: {
         // company
         const existingCompany = existing.config.company
         const company = config.config.company
@@ -155,7 +155,7 @@ exports.save = async function (ctx) {
   try {
     // verify the configuration
     switch (type) {
-      case Configs.SMTP:
+      case Config.SMTP:
         await email.verifyConfig(config)
         break
     }
@@ -237,7 +237,7 @@ exports.publicOidc = async function (ctx) {
   try {
     // Find the config with the most granular scope based on context
     const oidcConfig = await getScopedFullConfig(db, {
-      type: Configs.OIDC,
+      type: Config.OIDC,
     })
 
     if (!oidcConfig) {
@@ -260,15 +260,15 @@ exports.publicSettings = async function (ctx) {
   try {
     // Find the config with the most granular scope based on context
     const publicConfig = await getScopedFullConfig(db, {
-      type: Configs.SETTINGS,
+      type: Config.SETTINGS,
     })
 
     const googleConfig = await getScopedFullConfig(db, {
-      type: Configs.GOOGLE,
+      type: Config.GOOGLE,
     })
 
     const oidcConfig = await getScopedFullConfig(db, {
-      type: Configs.OIDC,
+      type: Config.OIDC,
     })
 
     let config
@@ -390,17 +390,17 @@ exports.configChecklist = async function (ctx) {
 
         // They have set up SMTP
         const smtpConfig = await getScopedFullConfig(db, {
-          type: Configs.SMTP,
+          type: Config.SMTP,
         })
 
         // They have set up Google Auth
         const googleConfig = await getScopedFullConfig(db, {
-          type: Configs.GOOGLE,
+          type: Config.GOOGLE,
         })
 
         // They have set up OIDC
         const oidcConfig = await getScopedFullConfig(db, {
-          type: Configs.OIDC,
+          type: Config.OIDC,
         })
 
         // They have set up an global user

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

@@ -73,12 +73,12 @@ export async function fetchAPIKey(ctx: any) {
 }
 
 const checkCurrentApp = (ctx: any) => {
-  const appCookie = getCookie(ctx, constants.Cookies.CurrentApp)
+  const appCookie = getCookie(ctx, constants.Cookie.CurrentApp)
   if (appCookie && !tenancy.isUserInAppTenant(appCookie.appId)) {
     // there is a currentapp cookie from another tenant
     // remove the cookie as this is incompatible with the builder
     // due to builder and admin permissions being removed
-    clearCookie(ctx, constants.Cookies.CurrentApp)
+    clearCookie(ctx, constants.Cookie.CurrentApp)
   }
 }
 

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

@@ -5,6 +5,7 @@ import {
   BulkUserRequest,
   BulkUserResponse,
   CloudAccount,
+  CreateAdminUserRequest,
   InviteUserRequest,
   InviteUsersRequest,
   SearchUsersRequest,
@@ -67,7 +68,8 @@ const parseBooleanParam = (param: any) => {
 }
 
 export const adminUser = async (ctx: any) => {
-  const { email, password, tenantId } = ctx.request.body
+  const { email, password, tenantId } = ctx.request
+    .body as CreateAdminUserRequest
   await tenancy.doInTenant(tenantId, async () => {
     // account portal sends a pre-hashed password - honour param to prevent double hashing
     const hashPassword = parseBooleanParam(ctx.request.query.hashPassword)

package/src/api/controllers/system/{environment.js → environment.ts}

@@ -1,6 +1,7 @@
-const env = require("../../../environment")
+import { BBContext } from "@budibase/types"
+import env from "../../../environment"
 
-exports.fetch = async ctx => {
+export const fetch = async (ctx: BBContext) => {
   ctx.body = {
     multiTenancy: !!env.MULTI_TENANCY,
     cloud: !env.SELF_HOSTED,

package/src/api/controllers/system/{status.js → status.ts}

@@ -1,7 +1,8 @@
-const accounts = require("@budibase/backend-core/accounts")
-const env = require("../../../environment")
+import { accounts } from "@budibase/backend-core"
+import env from "../../../environment"
+import { BBContext } from "@budibase/types"
 
-exports.fetch = async ctx => {
+export const fetch = async (ctx: BBContext) => {
   if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
     const status = await accounts.getStatus()
     ctx.body = status

package/src/api/controllers/system/tenants.ts

@@ -1,61 +1,18 @@
-const { StaticDatabases, doWithDB } = require("@budibase/backend-core/db")
-const { getTenantId } = require("@budibase/backend-core/tenancy")
-const { deleteTenant } = require("@budibase/backend-core/deprovision")
+import { BBContext } from "@budibase/types"
+import { deprovisioning } from "@budibase/backend-core"
 import { quotas } from "@budibase/pro"
 
-export const exists = async (ctx: any) => {
-  const tenantId = ctx.request.params
-  ctx.body = {
-    exists: await doWithDB(
-      StaticDatabases.PLATFORM_INFO.name,
-      async (db: any) => {
-        let exists = false
-        try {
-          const tenantsDoc = await db.get(
-            StaticDatabases.PLATFORM_INFO.docs.tenants
-          )
-          if (tenantsDoc) {
-            exists = tenantsDoc.tenantIds.indexOf(tenantId) !== -1
-          }
-        } catch (err) {
-          // if error it doesn't exist
-        }
-        return exists
-      }
-    ),
-  }
-}
-
-export const fetch = async (ctx: any) => {
-  ctx.body = await doWithDB(
-    StaticDatabases.PLATFORM_INFO.name,
-    async (db: any) => {
-      let tenants = []
-      try {
-        const tenantsDoc = await db.get(
-          StaticDatabases.PLATFORM_INFO.docs.tenants
-        )
-        if (tenantsDoc) {
-          tenants = tenantsDoc.tenantIds
-        }
-      } catch (err) {
-        // if error it doesn't exist
-      }
-      return tenants
-    }
-  )
-}
-
-const _delete = async (ctx: any) => {
-  const tenantId = getTenantId()
+const _delete = async (ctx: BBContext) => {
+  const user = ctx.user!
+  const tenantId = ctx.params.tenantId
 
-  if (ctx.params.tenantId !== tenantId) {
-    ctx.throw(403, "Unauthorized")
+  if (tenantId !== user.tenantId) {
+    ctx.throw(403, "Tenant ID does not match current user")
   }
 
   try {
-    await deleteTenant(tenantId)
     await quotas.bustCache()
+    await deprovisioning.deleteTenant(tenantId)
     ctx.status = 204
   } catch (err) {
     ctx.log.error(err)

package/src/api/index.ts

@@ -7,11 +7,12 @@ import { errors, auth, middleware } from "@budibase/backend-core"
 import { APIError } from "@budibase/types"
 
 const PUBLIC_ENDPOINTS = [
-  // old deprecated endpoints kept for backwards compat
+  // deprecated single tenant sso callback
   {
     route: "/api/admin/auth/google/callback",
     method: "GET",
   },
+  // deprecated single tenant sso callback
   {
     route: "/api/admin/auth/oidc/callback",
     method: "GET",
@@ -44,17 +45,19 @@ const PUBLIC_ENDPOINTS = [
     method: "POST",
   },
   {
-    route: "api/system/environment",
+    route: "/api/system/environment",
     method: "GET",
   },
   {
-    route: "api/system/status",
+    route: "/api/system/status",
     method: "GET",
   },
+  // TODO: This should be an internal api
   {
     route: "/api/global/users/tenant/:id",
     method: "GET",
   },
+  // TODO: This should be an internal api
   {
     route: "/api/system/restored",
     method: "POST",
@@ -62,17 +65,37 @@ const PUBLIC_ENDPOINTS = [
 ]
 
 const NO_TENANCY_ENDPOINTS = [
-  ...PUBLIC_ENDPOINTS,
+  // system endpoints are not specific to any tenant
   {
     route: "/api/system",
     method: "ALL",
   },
+  // tenant is determined in request body
+  // used for creating the tenant
   {
-    route: "/api/global/users/self",
+    route: "/api/global/users/init",
+    method: "POST",
+  },
+  // deprecated single tenant sso callback
+  {
+    route: "/api/admin/auth/google/callback",
+    method: "GET",
+  },
+  // deprecated single tenant sso callback
+  {
+    route: "/api/admin/auth/oidc/callback",
     method: "GET",
   },
+  // tenant is determined from code in redis
   {
-    route: "/api/global/self",
+    route: "/api/global/users/invite/accept",
+    method: "POST",
+  },
+  // global user search - no tenancy
+  // :id is user id
+  // TODO: this should really be `/api/system/users/:id`
+  {
+    route: "/api/global/users/tenant/:id",
     method: "GET",
   },
 ]