@budibase/worker 1.0.219 → 1.0.220-alpha.2

package/.yarnrc

@@ -0,0 +1 @@
+network-timeout 100000

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "1.0.219",
+  "version": "1.0.220-alpha.2",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -34,9 +34,9 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "^1.0.219",
-    "@budibase/pro": "1.0.218",
-    "@budibase/string-templates": "^1.0.219",
+    "@budibase/backend-core": "^1.0.220-alpha.2",
+    "@budibase/pro": "1.0.220-alpha.1",
+    "@budibase/string-templates": "^1.0.220-alpha.2",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -66,7 +66,7 @@
     "server-destroy": "1.0.1"
   },
   "devDependencies": {
-    "@budibase/types": "^1.0.219",
+    "@budibase/types": "^1.0.220-alpha.2",
     "@types/jest": "26.0.23",
     "@types/koa": "2.13.4",
     "@types/koa-router": "7.4.4",
@@ -100,5 +100,5 @@
       "./scripts/jestSetup.js"
     ]
   },
-  "gitHead": "231b038a3c99f730dd27a595f870663dd84b7837"
+  "gitHead": "80b7a2da2fba39ff25622873c95598fa931ea6ed"
 }

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

@@ -1,49 +1,22 @@
 const core = require("@budibase/backend-core")
-const { getScopedConfig } = require("@budibase/backend-core/db")
-const { google } = require("@budibase/backend-core/middleware")
-const { oidc } = require("@budibase/backend-core/middleware")
 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 } = core.auth
+const { passport, ssoCallbackUrl, google, oidc } = core.auth
 const { checkResetPasswordCode } = require("../../../utilities/redis")
-const {
-  getGlobalDB,
-  getTenantId,
-  isMultiTenant,
-} = require("@budibase/backend-core/tenancy")
+const { getGlobalDB } = require("@budibase/backend-core/tenancy")
 const env = require("../../../environment")
 import { events, users as usersCore, context } from "@budibase/backend-core"
 import { users } from "../../../sdk"
 import { User } from "@budibase/types"
 
-const ssoCallbackUrl = async (config: any, type: any) => {
-  // incase there is a callback URL from before
-  if (config && config.callbackURL) {
-    return config.callbackURL
-  }
-
-  const db = getGlobalDB()
-  const publicConfig = await getScopedConfig(db, {
-    type: Configs.SETTINGS,
-  })
-
-  let callbackUrl = `/api/global/auth`
-  if (isMultiTenant()) {
-    callbackUrl += `/${getTenantId()}`
-  }
-  callbackUrl += `/${type}/callback`
-
-  return `${publicConfig.platformUrl}${callbackUrl}`
-}
-
 export const googleCallbackUrl = async (config: any) => {
-  return ssoCallbackUrl(config, "google")
+  return ssoCallbackUrl(getGlobalDB(), config, "google")
 }
 
 export const oidcCallbackUrl = async (config: any) => {
-  return ssoCallbackUrl(config, "oidc")
+  return ssoCallbackUrl(getGlobalDB(), config, "oidc")
 }
 
 async function authInternal(ctx: any, user: any, err = null, info = null) {
@@ -198,6 +171,8 @@ export const googlePreAuth = async (ctx: any, next: any) => {
 
   return passport.authenticate(strategy, {
     scope: ["profile", "email"],
+    accessType: "offline",
+    prompt: "consent",
   })(ctx, next)
 }
 
@@ -224,7 +199,7 @@ export const googleAuth = async (ctx: any, next: any) => {
   )(ctx, next)
 }
 
-async function oidcStrategyFactory(ctx: any, configId: any) {
+export const oidcStrategyFactory = async (ctx: any, configId: any) => {
   const db = getGlobalDB()
   const config = await core.db.getScopedConfig(db, {
     type: Configs.OIDC,
@@ -234,7 +209,12 @@ async function oidcStrategyFactory(ctx: any, configId: any) {
   const chosenConfig = config.configs.filter((c: any) => c.uuid === configId)[0]
   let callbackUrl = await exports.oidcCallbackUrl(chosenConfig)
 
-  return oidc.strategyFactory(chosenConfig, callbackUrl, users.save)
+  //Remote Config
+  const enrichedConfig = await oidc.fetchStrategyConfig(
+    chosenConfig,
+    callbackUrl
+  )
+  return oidc.strategyFactory(enrichedConfig, users.save)
 }
 
 /**
@@ -249,7 +229,7 @@ export const oidcPreAuth = async (ctx: any, next: any) => {
 
   return passport.authenticate(strategy, {
     // required 'openid' scope is added by oidc strategy factory
-    scope: ["profile", "email"],
+    scope: ["profile", "email", "offline_access"], //auth0 offline_access scope required for the refresh token behaviour.
   })(ctx, next)
 }
 

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

@@ -1,7 +1,6 @@
 const {
   generateConfigID,
   getConfigParams,
-  getGlobalUserParams,
   getScopedFullConfig,
   getAllApps,
 } = require("@budibase/backend-core/db")
@@ -18,8 +17,10 @@ const {
   withCache,
   CacheKeys,
   bustCache,
+  cache,
 } = require("@budibase/backend-core/cache")
 const { events } = require("@budibase/backend-core")
+const { checkAnyUserExists } = require("../../../utilities/users")
 
 const BB_TENANT_CDN = "https://tenants.cdn.budi.live"
 
@@ -365,9 +366,9 @@ exports.upload = async function (ctx) {
 exports.destroy = async function (ctx) {
   const db = getGlobalDB()
   const { id, rev } = ctx.params
-
   try {
     await db.remove(id, rev)
+    await cache.delete(CacheKeys.CHECKLIST)
     ctx.body = { message: "Config deleted successfully" }
   } catch (err) {
     ctx.throw(err.status, err)
@@ -405,12 +406,7 @@ exports.configChecklist = async function (ctx) {
         })
 
         // They have set up an global user
-        const users = await db.allDocs(
-          getGlobalUserParams(null, {
-            include_docs: true,
-            limit: 1,
-          })
-        )
+        const userExists = await checkAnyUserExists()
         return {
           apps: {
             checked: apps.length > 0,
@@ -423,7 +419,7 @@ exports.configChecklist = async function (ctx) {
             link: "/builder/portal/manage/email",
           },
           adminUser: {
-            checked: users && users.rows.length >= 1,
+            checked: userExists,
             label: "Create your first user",
             link: "/builder/portal/manage/users",
           },

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

@@ -7,7 +7,7 @@ const {
 const { doInAppContext, getAppDB } = require("@budibase/backend-core/context")
 const { user: userCache } = require("@budibase/backend-core/cache")
 const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const { users } = require("../../../sdk")
+const { allUsers } = require("../../../sdk/users")
 
 exports.fetch = async ctx => {
   const tenantId = ctx.user.tenantId
@@ -49,10 +49,10 @@ exports.find = async ctx => {
 exports.removeAppRole = async ctx => {
   const { appId } = ctx.params
   const db = getGlobalDB()
-  const allUsers = await users.allUsers(ctx)
+  const users = await allUsers(ctx)
   const bulk = []
   const cacheInvalidations = []
-  for (let user of allUsers) {
+  for (let user of users) {
     if (user.roles[appId]) {
       cacheInvalidations.push(userCache.invalidateUser(user._id))
       delete user.roles[appId]

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

@@ -8,16 +8,15 @@ import {
   events,
   errors,
   accounts,
-  db as dbUtils,
   users as usersCore,
   tenancy,
   cache,
 } from "@budibase/backend-core"
+import { checkAnyUserExists } from "../../../utilities/users"
 
 export const save = async (ctx: any) => {
   try {
-    const user = await users.save(ctx.request.body)
-    ctx.body = user
+    ctx.body = await users.save(ctx.request.body)
   } catch (err: any) {
     ctx.throw(err.status || 400, err)
   }
@@ -39,15 +38,8 @@ export const adminUser = async (ctx: any) => {
       ctx.throw(403, "Organisation already exists.")
     }
 
-    const response = await tenancy.doWithGlobalDB(tenantId, async (db: any) => {
-      return db.allDocs(
-        dbUtils.getGlobalUserParams(null, {
-          include_docs: true,
-        })
-      )
-    })
-
-    if (response.rows.some((row: any) => row.doc.admin)) {
+    const userExists = await checkAnyUserExists()
+    if (userExists) {
       ctx.throw(
         403,
         "You cannot initialise once an global user has been created."
@@ -68,11 +60,13 @@ export const adminUser = async (ctx: any) => {
       tenantId,
     }
     try {
+      // always bust checklist beforehand, if an error occurs but can proceed, don't get
+      // stuck in a cycle
+      await cache.bustCache(cache.CacheKeys.CHECKLIST)
       const finalUser = await users.save(user, {
         hashPassword,
         requirePassword,
       })
-      await cache.bustCache(cache.CacheKeys.CHECKLIST)
 
       // events
       let account: CloudAccount | undefined
@@ -96,6 +90,17 @@ export const destroy = async (ctx: any) => {
   }
 }
 
+export const search = async (ctx: any) => {
+  const paginated = await users.paginatedUsers(ctx.request.body)
+  // user hashed password shouldn't ever be returned
+  for (let user of paginated.data) {
+    if (user) {
+      delete user.password
+    }
+  }
+  ctx.body = paginated
+}
+
 // called internally by app server user fetch
 export const fetch = async (ctx: any) => {
   const all = await users.allUsers()

package/src/api/routes/global/users.js

@@ -46,6 +46,7 @@ router
     controller.save
   )
   .get("/api/global/users", builderOrAdmin, controller.fetch)
+  .post("/api/global/users/search", builderOrAdmin, controller.search)
   .delete("/api/global/users/:id", adminOnly, controller.destroy)
   .get("/api/global/roles/:appId")
   .post(

package/src/api/routes/tests/auth.spec.js

@@ -77,27 +77,30 @@ describe("/api/global/auth", () => {
   describe("oidc", () => {
     const auth = require("@budibase/backend-core/auth")
 
+    const passportSpy = jest.spyOn(auth.passport, "authenticate")
+    let oidcConf
+    let chosenConfig
+    let configId
+
     // mock the oidc strategy implementation and return value
     let strategyFactory = jest.fn()
     let mockStrategyReturn = jest.fn()
+    let mockStrategyConfig = jest.fn()
+    auth.oidc.fetchStrategyConfig = mockStrategyConfig
+    
     strategyFactory.mockReturnValue(mockStrategyReturn)
     auth.oidc.strategyFactory = strategyFactory
 
-    const passportSpy = jest.spyOn(auth.passport, "authenticate")
-    let oidcConf
-    let chosenConfig
-    let configId
-
     beforeEach(async () => {
       oidcConf = await config.saveOIDCConfig()
       chosenConfig = oidcConf.config.configs[0]
       configId = chosenConfig.uuid
+      mockStrategyConfig.mockReturnValue(chosenConfig)
     })
 
     afterEach(() => {
       expect(strategyFactory).toBeCalledWith(
         chosenConfig, 
-        `http://localhost:10000/api/global/auth/${TENANT_ID}/oidc/callback`,
         expect.any(Function)
       )
     })
@@ -107,7 +110,7 @@ describe("/api/global/auth", () => {
         await request.get(`/api/global/auth/${TENANT_ID}/oidc/configs/${configId}`)
 
         expect(passportSpy).toBeCalledWith(mockStrategyReturn, {
-          scope: ["profile", "email"],
+          scope: ["profile", "email", "offline_access"]
         })
         expect(passportSpy.mock.calls.length).toBe(1);
       })

package/src/sdk/users/users.ts

@@ -17,9 +17,8 @@ import {
 } from "@budibase/backend-core"
 import { MigrationType } from "@budibase/types"
 
-/**
- * Retrieves all users from the current tenancy.
- */
+const PAGE_LIMIT = 8
+
 export const allUsers = async () => {
   const db = tenancy.getGlobalDB()
   const response = await db.allDocs(
@@ -30,6 +29,37 @@ export const allUsers = async () => {
   return response.rows.map((row: any) => row.doc)
 }
 
+export const paginatedUsers = async ({
+  page,
+  search,
+}: { page?: string; search?: string } = {}) => {
+  const db = tenancy.getGlobalDB()
+  // get one extra document, to have the next page
+  const opts: any = {
+    include_docs: true,
+    limit: PAGE_LIMIT + 1,
+  }
+  // add a startkey if the page was specified (anchor)
+  if (page) {
+    opts.startkey = page
+  }
+  // property specifies what to use for the page/anchor
+  let userList, property
+  // no search, query allDocs
+  if (!search) {
+    const response = await db.allDocs(dbUtils.getGlobalUserParams(null, opts))
+    userList = response.rows.map((row: any) => row.doc)
+    property = "_id"
+  } else {
+    userList = await usersCore.searchGlobalUsersByEmail(search, opts)
+    property = "email"
+  }
+  return dbUtils.pagination(userList, PAGE_LIMIT, {
+    paginate: true,
+    property,
+  })
+}
+
 /**
  * Gets a user by ID from the global database, based on the current tenancy.
  */

package/src/utilities/users.js

@@ -0,0 +1,17 @@
+const { getGlobalDB } = require("@budibase/backend-core/tenancy")
+const { getGlobalUserParams } = require("@budibase/backend-core/db")
+
+exports.checkAnyUserExists = async () => {
+  try {
+    const db = getGlobalDB()
+    const users = await db.allDocs(
+      getGlobalUserParams(null, {
+        include_docs: true,
+        limit: 1,
+      })
+    )
+    return users && users.rows.length >= 1
+  } catch (err) {
+    throw new Error("Unable to retrieve user list")
+  }
+}