@budibase/backend-core 2.13.14 → 2.13.16

package/src/events/processors/posthog/tests/PosthogProcessor.spec.ts

@@ -1,7 +1,9 @@
 import { testEnv } from "../../../../../tests/extra"
 import PosthogProcessor from "../PosthogProcessor"
 import { Event, IdentityType, Hosting } from "@budibase/types"
+
 const tk = require("timekeeper")
+
 import * as cache from "../../../../cache/generic"
 import { CacheKey } from "../../../../cache/generic"
 import * as context from "../../../../context"

package/src/features/index.ts

@@ -1,5 +1,6 @@
 import env from "../environment"
 import * as context from "../context"
+
 export * from "./installation"
 
 /**

package/src/index.ts

@@ -38,6 +38,7 @@ export * as docIds from "./docIds"
 // circular dependencies
 import * as context from "./context"
 import * as _tenancy from "./tenancy"
+
 export const tenancy = {
   ..._tenancy,
   ...context,

package/src/installation.ts

@@ -1,7 +1,6 @@
 import { newid } from "./utils"
 import * as events from "./events"
-import { StaticDatabases } from "./db"
-import { doWithDB } from "./db"
+import { StaticDatabases, doWithDB } from "./db"
 import { Installation, IdentityType, Database } from "@budibase/types"
 import * as context from "./context"
 import semver from "semver"

package/src/logging/correlation/correlation.ts

@@ -1,4 +1,5 @@
 import { Header } from "../../constants"
+
 const correlator = require("correlation-id")
 
 export const setHeader = (headers: any) => {

package/src/logging/correlation/middleware.ts

@@ -1,5 +1,6 @@
 import { Header } from "../../constants"
 import { v4 as uuid } from "uuid"
+
 const correlator = require("correlation-id")
 
 const correlation = (ctx: any, next: any) => {

package/src/logging/pino/middleware.ts

@@ -1,9 +1,12 @@
 import env from "../../environment"
 import { logger } from "./logger"
 import { IncomingMessage } from "http"
+
 const pino = require("koa-pino-logger")
+
 import { Options } from "pino-http"
 import { Ctx } from "@budibase/types"
+
 const correlator = require("correlation-id")
 
 export function pinoSettings(): Options {

package/src/middleware/index.ts

@@ -2,6 +2,7 @@ export * as local from "./passport/local"
 export * as google from "./passport/sso/google"
 export * as oidc from "./passport/sso/oidc"
 import * as datasourceGoogle from "./passport/datasource/google"
+
 export const datasource = {
   google: datasourceGoogle,
 }

package/src/middleware/passport/sso/google.ts

@@ -8,6 +8,7 @@ import {
   SaveSSOUserFunction,
   GoogleInnerConfig,
 } from "@budibase/types"
+
 const GoogleStrategy = require("passport-google-oauth").OAuth2Strategy
 
 export function buildVerifyFn(saveUserFn: SaveSSOUserFunction) {

package/src/middleware/passport/sso/tests/google.spec.ts

@@ -6,6 +6,7 @@ const mockStrategy = require("passport-google-oauth").OAuth2Strategy
 
 jest.mock("../sso")
 import * as _sso from "../sso"
+
 const sso = jest.mocked(_sso)
 
 const mockSaveUserFn = jest.fn()

package/src/middleware/passport/sso/tests/sso.spec.ts

@@ -11,6 +11,7 @@ const mockSaveUser = jest.fn()
 
 jest.mock("../../../../users")
 import * as _users from "../../../../users"
+
 const users = jest.mocked(_users)
 
 const getErrorMessage = () => {

package/src/middleware/tests/builder.spec.ts

@@ -5,6 +5,7 @@ import { structures } from "../../../tests"
 import { ContextUser, ServiceType } from "@budibase/types"
 import { doInAppContext } from "../../context"
 import env from "../../environment"
+
 env._set("SERVICE_TYPE", ServiceType.APPS)
 
 const appId = "app_aaa"

package/src/objectStore/objectStore.ts

@@ -1,4 +1,5 @@
 const sanitize = require("sanitize-s3-objectkey")
+
 import AWS from "aws-sdk"
 import stream, { Readable } from "stream"
 import fetch from "node-fetch"

package/src/security/permissions.ts

@@ -160,4 +160,5 @@ export function isPermissionLevelHigherThanRead(level: PermissionLevel) {
 
 // utility as a lot of things need simply the builder permission
 export const BUILDER = PermissionType.BUILDER
+export const CREATOR = PermissionType.CREATOR
 export const GLOBAL_BUILDER = PermissionType.GLOBAL_BUILDER

package/src/security/roles.ts

@@ -1,7 +1,12 @@
 import { BuiltinPermissionID, PermissionLevel } from "./permissions"
-import { prefixRoleID, getRoleParams, DocumentType, SEPARATOR } from "../db"
+import {
+  prefixRoleID,
+  getRoleParams,
+  DocumentType,
+  SEPARATOR,
+  doWithDB,
+} from "../db"
 import { getAppDB } from "../context"
-import { doWithDB } from "../db"
 import { Screen, Role as RoleDoc } from "@budibase/types"
 import cloneDeep from "lodash/fp/cloneDeep"
 

package/src/security/sessions.ts

@@ -1,6 +1,7 @@
 const redis = require("../redis/init")
 const { v4: uuidv4 } = require("uuid")
 const { logWarn } = require("../logging")
+
 import env from "../environment"
 import {
   Session,

package/src/users/db.ts

@@ -1,9 +1,8 @@
 import env from "../environment"
 import * as eventHelpers from "./events"
-import * as accounts from "../accounts"
 import * as accountSdk from "../accounts"
 import * as cache from "../cache"
-import { getGlobalDB, getIdentity, getTenantId } from "../context"
+import { doInTenant, getGlobalDB, getIdentity, getTenantId } from "../context"
 import * as dbUtils from "../db"
 import { EmailUnavailableError, HTTPError } from "../errors"
 import * as platform from "../platform"
@@ -11,12 +10,10 @@ import * as sessions from "../security/sessions"
 import * as usersCore from "./users"
 import {
   Account,
-  AllDocsResponse,
   BulkUserCreated,
   BulkUserDeleted,
   isSSOAccount,
   isSSOUser,
-  RowResponse,
   SaveUserOpts,
   User,
   UserStatus,
@@ -149,12 +146,12 @@ export class UserDB {
 
   static async allUsers() {
     const db = getGlobalDB()
-    const response = await db.allDocs(
+    const response = await db.allDocs<User>(
       dbUtils.getGlobalUserParams(null, {
         include_docs: true,
       })
     )
-    return response.rows.map((row: any) => row.doc)
+    return response.rows.map(row => row.doc!)
   }
 
   static async countUsersByApp(appId: string) {
@@ -212,13 +209,6 @@ export class UserDB {
       throw new Error("_id or email is required")
     }
 
-    if (
-      user.builder?.apps?.length &&
-      !(await UserDB.features.isAppBuildersEnabled())
-    ) {
-      throw new Error("Unable to update app builders, please check license")
-    }
-
     let dbUser: User | undefined
     if (_id) {
       // try to get existing user from db
@@ -467,7 +457,7 @@ export class UserDB {
     if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) {
       // root account holder can't be deleted from inside budibase
       const email = dbUser.email
-      const account = await accounts.getAccount(email)
+      const account = await accountSdk.getAccount(email)
       if (account) {
         if (dbUser.userId === getIdentity()!._id) {
           throw new HTTPError('Please visit "Account" to delete this user', 400)
@@ -488,6 +478,37 @@ export class UserDB {
     await sessions.invalidateSessions(userId, { reason: "deletion" })
   }
 
+  static async createAdminUser(
+    email: string,
+    password: string,
+    tenantId: string,
+    opts?: { ssoId?: string; hashPassword?: boolean; requirePassword?: boolean }
+  ) {
+    const user: User = {
+      email: email,
+      password: password,
+      createdAt: Date.now(),
+      roles: {},
+      builder: {
+        global: true,
+      },
+      admin: {
+        global: true,
+      },
+      tenantId,
+    }
+    if (opts?.ssoId) {
+      user.ssoId = opts.ssoId
+    }
+    // always bust checklist beforehand, if an error occurs but can proceed, don't get
+    // stuck in a cycle
+    await cache.bustCache(cache.CacheKey.CHECKLIST)
+    return await UserDB.save(user, {
+      hashPassword: opts?.hashPassword,
+      requirePassword: opts?.requirePassword,
+    })
+  }
+
   static async getGroups(groupIds: string[]) {
     return await this.groups.getBulk(groupIds)
   }

package/src/users/users.ts

@@ -25,6 +25,7 @@ import {
 import { getGlobalDB } from "../context"
 import * as context from "../context"
 import { isCreator } from "./utils"
+import { UserDB } from "./db"
 
 type GetOpts = { cleanup?: boolean }
 
@@ -43,7 +44,7 @@ function removeUserPassword(users: User | User[]) {
   return users
 }
 
-export const isSupportedUserSearch = (query: SearchQuery) => {
+export function isSupportedUserSearch(query: SearchQuery) {
   const allowed = [
     { op: SearchQueryOperators.STRING, key: "email" },
     { op: SearchQueryOperators.EQUAL, key: "_id" },
@@ -68,10 +69,10 @@ export const isSupportedUserSearch = (query: SearchQuery) => {
   return true
 }
 
-export const bulkGetGlobalUsersById = async (
+export async function bulkGetGlobalUsersById(
   userIds: string[],
   opts?: GetOpts
-) => {
+) {
   const db = getGlobalDB()
   let users = (
     await db.allDocs({
@@ -85,7 +86,7 @@ export const bulkGetGlobalUsersById = async (
   return users
 }
 
-export const getAllUserIds = async () => {
+export async function getAllUserIds() {
   const db = getGlobalDB()
   const startKey = `${DocumentType.USER}${SEPARATOR}`
   const response = await db.allDocs({
@@ -95,7 +96,7 @@ export const getAllUserIds = async () => {
   return response.rows.map(row => row.id)
 }
 
-export const bulkUpdateGlobalUsers = async (users: User[]) => {
+export async function bulkUpdateGlobalUsers(users: User[]) {
   const db = getGlobalDB()
   return (await db.bulkDocs(users)) as BulkDocsResponse
 }
@@ -113,10 +114,10 @@ export async function getById(id: string, opts?: GetOpts): Promise<User> {
  * Given an email address this will use a view to search through
  * all the users to find one with this email address.
  */
-export const getGlobalUserByEmail = async (
+export async function getGlobalUserByEmail(
   email: String,
   opts?: GetOpts
-): Promise<User | undefined> => {
+): Promise<User | undefined> {
   if (email == null) {
     throw "Must supply an email address to view"
   }
@@ -139,11 +140,23 @@ export const getGlobalUserByEmail = async (
   return user
 }
 
-export const searchGlobalUsersByApp = async (
+export async function doesUserExist(email: string) {
+  try {
+    const user = await getGlobalUserByEmail(email)
+    if (Array.isArray(user) || user != null) {
+      return true
+    }
+  } catch (err) {
+    return false
+  }
+  return false
+}
+
+export async function searchGlobalUsersByApp(
   appId: any,
   opts: DatabaseQueryOpts,
   getOpts?: GetOpts
-) => {
+) {
   if (typeof appId !== "string") {
     throw new Error("Must provide a string based app ID")
   }
@@ -167,10 +180,10 @@ export const searchGlobalUsersByApp = async (
   Return any user who potentially has access to the application
   Admins, developers and app users with the explicitly role.
 */
-export const searchGlobalUsersByAppAccess = async (
+export async function searchGlobalUsersByAppAccess(
   appId: any,
   opts?: { limit?: number }
-) => {
+) {
   const roleSelector = `roles.${appId}`
 
   let orQuery: any[] = [
@@ -205,7 +218,7 @@ export const searchGlobalUsersByAppAccess = async (
   return resp.rows
 }
 
-export const getGlobalUserByAppPage = (appId: string, user: User) => {
+export function getGlobalUserByAppPage(appId: string, user: User) {
   if (!user) {
     return
   }
@@ -215,11 +228,11 @@ export const getGlobalUserByAppPage = (appId: string, user: User) => {
 /**
  * Performs a starts with search on the global email view.
  */
-export const searchGlobalUsersByEmail = async (
+export async function searchGlobalUsersByEmail(
   email: string | unknown,
   opts: any,
   getOpts?: GetOpts
-) => {
+) {
   if (typeof email !== "string") {
     throw new Error("Must provide a string to search by")
   }
@@ -242,12 +255,12 @@ export const searchGlobalUsersByEmail = async (
 }
 
 const PAGE_LIMIT = 8
-export const paginatedUsers = async ({
+export async function paginatedUsers({
   bookmark,
   query,
   appId,
   limit,
-}: SearchUsersRequest = {}) => {
+}: SearchUsersRequest = {}) {
   const db = getGlobalDB()
   const pageSize = limit ?? PAGE_LIMIT
   const pageLimit = pageSize + 1
@@ -324,3 +337,20 @@ export function cleanseUserObject(user: User | ContextUser, base?: User) {
   }
   return user
 }
+
+export async function addAppBuilder(user: User, appId: string) {
+  const prodAppId = getProdAppID(appId)
+  user.builder ??= {}
+  user.builder.creator = true
+  user.builder.apps ??= []
+  user.builder.apps.push(prodAppId)
+  await UserDB.save(user, { hashPassword: false })
+}
+
+export async function removeAppBuilder(user: User, appId: string) {
+  const prodAppId = getProdAppID(appId)
+  if (user.builder && user.builder.apps?.includes(prodAppId)) {
+    user.builder.apps = user.builder.apps.filter(id => id !== prodAppId)
+  }
+  await UserDB.save(user, { hashPassword: false })
+}

package/src/utils/hashing.ts

@@ -1,4 +1,5 @@
 import env from "../environment"
+
 export * from "../docIds/newid"
 const bcrypt = env.JS_BCRYPT ? require("bcryptjs") : require("bcrypt")
 

package/src/utils/utils.ts

@@ -11,6 +11,7 @@ import {
   TenantResolutionStrategy,
 } from "@budibase/types"
 import type { SetOption } from "cookies"
+
 const jwt = require("jsonwebtoken")
 
 const APP_PREFIX = DocumentType.APP + SEPARATOR

package/tests/core/utilities/mocks/alerts.ts

@@ -1,3 +1,4 @@
 jest.mock("../../../../src/logging/alerts")
 import * as _alerts from "../../../../src/logging/alerts"
+
 export const alerts = jest.mocked(_alerts)

package/tests/core/utilities/mocks/index.ts

@@ -1,5 +1,6 @@
 jest.mock("../../../../src/accounts")
 import * as _accounts from "../../../../src/accounts"
+
 export const accounts = jest.mocked(_accounts)
 
 export * as date from "./date"

package/tests/core/utilities/structures/generator.ts

@@ -1,2 +1,3 @@
 import Chance from "./Chance"
+
 export const generator = new Chance()

package/tests/jestSetup.ts

@@ -9,6 +9,7 @@ mocks.fetch.enable()
 // mock all dates to 2020-01-01T00:00:00.000Z
 // use tk.reset() to use real dates in individual tests
 import tk from "timekeeper"
+
 tk.freeze(mocks.date.MOCK_DATE)
 
 if (!process.env.DEBUG) {