@budibase/backend-core 2.5.9 → 2.5.10-alpha.0

package/src/users.ts

@@ -1,15 +1,18 @@
 import {
-  ViewName,
-  getUsersByAppParams,
-  getProdAppID,
+  directCouchFind,
+  DocumentType,
   generateAppUserID,
+  getGlobalUserParams,
+  getProdAppID,
+  getUsersByAppParams,
+  pagination,
   queryGlobalView,
-  UNICODE_MAX,
-  DocumentType,
+  queryGlobalViewRaw,
   SEPARATOR,
-  directCouchFind,
+  UNICODE_MAX,
+  ViewName,
 } from "./db"
-import { BulkDocsResponse, User } from "@budibase/types"
+import { BulkDocsResponse, SearchUsersRequest, User } from "@budibase/types"
 import { getGlobalDB } from "./context"
 import * as context from "./context"
 
@@ -199,3 +202,49 @@ export const searchGlobalUsersByEmail = async (
   }
   return users
 }
+
+const PAGE_LIMIT = 8
+export const paginatedUsers = async ({
+  page,
+  email,
+  appId,
+}: SearchUsersRequest = {}) => {
+  const db = 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: User[],
+    property = "_id",
+    getKey
+  if (appId) {
+    userList = await searchGlobalUsersByApp(appId, opts)
+    getKey = (doc: any) => getGlobalUserByAppPage(appId, doc)
+  } else if (email) {
+    userList = await searchGlobalUsersByEmail(email, opts)
+    property = "email"
+  } else {
+    // no search, query allDocs
+    const response = await db.allDocs(getGlobalUserParams(null, opts))
+    userList = response.rows.map((row: any) => row.doc)
+  }
+  return pagination(userList, PAGE_LIMIT, {
+    paginate: true,
+    property,
+    getKey,
+  })
+}
+
+export async function getUserCount() {
+  const response = await queryGlobalViewRaw(ViewName.USER_BY_EMAIL, {
+    limit: 0, // to be as fast as possible - we just want the total rows count
+    include_docs: false,
+  })
+  return response.total_rows
+}

package/src/utils/hashing.ts

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

package/src/utils/index.ts

@@ -1,2 +1,3 @@
 export * from "./hashing"
 export * from "./utils"
+export * from "./stringUtils"

package/src/utils/stringUtils.ts

@@ -0,0 +1,8 @@
+export function validEmail(value: string) {
+  return (
+    value &&
+    !!value.match(
+      /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
+    )
+  )
+}

package/src/utils/tests/utils.spec.ts

@@ -1,4 +1,5 @@
-import { structures, DBTestConfiguration } from "../../../tests"
+import { structures } from "../../../tests"
+import { DBTestConfiguration } from "../../../tests/extra"
 import * as utils from "../../utils"
 import * as db from "../../db"
 import { Header } from "../../constants"

package/src/utils/utils.ts

@@ -46,8 +46,9 @@ export async function resolveAppUrl(ctx: Ctx) {
   }
 
   // search prod apps for a url that matches
-  const apps: App[] = await context.doInTenant(tenantId, () =>
-    getAllApps({ dev: false })
+  const apps: App[] = await context.doInTenant(
+    tenantId,
+    () => getAllApps({ dev: false }) as Promise<App[]>
   )
   const app = apps.filter(
     a => a.url && a.url.toLowerCase() === possibleAppUrl
@@ -221,27 +222,6 @@ export function isClient(ctx: Ctx) {
   return ctx.headers[Header.TYPE] === "client"
 }
 
-async function getBuilders() {
-  const builders = await queryGlobalView(ViewName.USER_BY_BUILDERS, {
-    include_docs: false,
-  })
-
-  if (!builders) {
-    return []
-  }
-
-  if (Array.isArray(builders)) {
-    return builders
-  } else {
-    return [builders]
-  }
-}
-
-export async function getBuildersCount() {
-  const builders = await getBuilders()
-  return builders.length
-}
-
 export function timeout(timeMs: number) {
   return new Promise(resolve => setTimeout(resolve, timeMs))
 }

package/tests/{utilities → core/utilities}/index.ts

@@ -1,9 +1,6 @@
 export * as mocks from "./mocks"
 export * as structures from "./structures"
 export { generator } from "./structures"
-export * as testEnv from "./testEnv"
 export * as testContainerUtils from "./testContainerUtils"
-
+export * as utils from "./utils"
 export * from "./jestUtils"
-
-export { default as DBTestConfiguration } from "./DBTestConfiguration"

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

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

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

@@ -0,0 +1,133 @@
+import * as events from "../../../../src/events"
+
+beforeAll(async () => {
+  const processors = await import("../../../../src/events/processors")
+  const events = await import("../../../../src/events")
+  jest.spyOn(processors.analyticsProcessor, "processEvent")
+
+  jest.spyOn(events.identification, "identifyTenantGroup")
+  jest.spyOn(events.identification, "identifyUser")
+
+  jest.spyOn(events.backfill, "appSucceeded")
+  jest.spyOn(events.backfill, "tenantSucceeded")
+
+  jest.spyOn(events.account, "created")
+  jest.spyOn(events.account, "deleted")
+  jest.spyOn(events.account, "verified")
+
+  jest.spyOn(events.app, "created")
+  jest.spyOn(events.app, "updated")
+  jest.spyOn(events.app, "deleted")
+  jest.spyOn(events.app, "published")
+  jest.spyOn(events.app, "unpublished")
+  jest.spyOn(events.app, "templateImported")
+  jest.spyOn(events.app, "fileImported")
+  jest.spyOn(events.app, "versionUpdated")
+  jest.spyOn(events.app, "versionReverted")
+  jest.spyOn(events.app, "reverted")
+  jest.spyOn(events.app, "exported")
+
+  jest.spyOn(events.auth, "login")
+  jest.spyOn(events.auth, "logout")
+  jest.spyOn(events.auth, "SSOCreated")
+  jest.spyOn(events.auth, "SSOUpdated")
+  jest.spyOn(events.auth, "SSOActivated")
+  jest.spyOn(events.auth, "SSODeactivated")
+
+  jest.spyOn(events.automation, "created")
+  jest.spyOn(events.automation, "deleted")
+  jest.spyOn(events.automation, "tested")
+  jest.spyOn(events.automation, "stepCreated")
+  jest.spyOn(events.automation, "stepDeleted")
+  jest.spyOn(events.automation, "triggerUpdated")
+
+  jest.spyOn(events.datasource, "created")
+  jest.spyOn(events.datasource, "updated")
+  jest.spyOn(events.datasource, "deleted")
+
+  jest.spyOn(events.email, "SMTPCreated")
+  jest.spyOn(events.email, "SMTPUpdated")
+
+  jest.spyOn(events.layout, "created")
+  jest.spyOn(events.layout, "deleted")
+
+  jest.spyOn(events.org, "nameUpdated")
+  jest.spyOn(events.org, "logoUpdated")
+  jest.spyOn(events.org, "platformURLUpdated")
+  jest.spyOn(events.org, "analyticsOptOut")
+
+  jest.spyOn(events.installation, "versionChecked")
+
+  jest.spyOn(events.query, "created")
+  jest.spyOn(events.query, "updated")
+  jest.spyOn(events.query, "deleted")
+  jest.spyOn(events.query, "imported")
+  jest.spyOn(events.query, "previewed")
+
+  jest.spyOn(events.role, "created")
+  jest.spyOn(events.role, "updated")
+  jest.spyOn(events.role, "deleted")
+  jest.spyOn(events.role, "assigned")
+  jest.spyOn(events.role, "unassigned")
+
+  jest.spyOn(events.rows, "imported")
+  jest.spyOn(events.rows, "created")
+
+  jest.spyOn(events.screen, "created")
+  jest.spyOn(events.screen, "deleted")
+
+  jest.spyOn(events.user, "created")
+  jest.spyOn(events.user, "updated")
+  jest.spyOn(events.user, "deleted")
+  jest.spyOn(events.user, "permissionAdminAssigned")
+  jest.spyOn(events.user, "permissionAdminRemoved")
+  jest.spyOn(events.user, "permissionBuilderAssigned")
+  jest.spyOn(events.user, "permissionBuilderRemoved")
+  jest.spyOn(events.user, "invited")
+  jest.spyOn(events.user, "inviteAccepted")
+  jest.spyOn(events.user, "passwordForceReset")
+  jest.spyOn(events.user, "passwordUpdated")
+  jest.spyOn(events.user, "passwordResetRequested")
+  jest.spyOn(events.user, "passwordReset")
+
+  jest.spyOn(events.group, "created")
+  jest.spyOn(events.group, "updated")
+  jest.spyOn(events.group, "deleted")
+  jest.spyOn(events.group, "usersAdded")
+  jest.spyOn(events.group, "usersDeleted")
+  jest.spyOn(events.group, "createdOnboarding")
+  jest.spyOn(events.group, "permissionsEdited")
+
+  jest.spyOn(events.serve, "servedBuilder")
+  jest.spyOn(events.serve, "servedApp")
+  jest.spyOn(events.serve, "servedAppPreview")
+
+  jest.spyOn(events.table, "created")
+  jest.spyOn(events.table, "updated")
+  jest.spyOn(events.table, "deleted")
+  jest.spyOn(events.table, "exported")
+  jest.spyOn(events.table, "imported")
+
+  jest.spyOn(events.view, "created")
+  jest.spyOn(events.view, "updated")
+  jest.spyOn(events.view, "deleted")
+  jest.spyOn(events.view, "exported")
+  jest.spyOn(events.view, "filterCreated")
+  jest.spyOn(events.view, "filterUpdated")
+  jest.spyOn(events.view, "filterDeleted")
+  jest.spyOn(events.view, "calculationCreated")
+  jest.spyOn(events.view, "calculationUpdated")
+  jest.spyOn(events.view, "calculationDeleted")
+
+  jest.spyOn(events.plugin, "init")
+  jest.spyOn(events.plugin, "imported")
+  jest.spyOn(events.plugin, "deleted")
+
+  jest.spyOn(events.license, "planChanged")
+  jest.spyOn(events.license, "activated")
+  jest.spyOn(events.license, "checkoutOpened")
+  jest.spyOn(events.license, "checkoutSuccess")
+  jest.spyOn(events.license, "portalOpened")
+  jest.spyOn(events.license, "paymentFailed")
+  jest.spyOn(events.license, "paymentRecovered")
+})

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

@@ -0,0 +1,17 @@
+const mockFetch = jest.fn((url: any, opts: any) => {
+  const fetch = jest.requireActual("node-fetch")
+  const env = jest.requireActual("../../../../src/environment").default
+  if (url.includes(env.COUCH_DB_URL) || url.includes("raw.github")) {
+    return fetch(url, opts)
+  }
+  return undefined
+})
+
+const enable = () => {
+  jest.mock("node-fetch", () => mockFetch)
+}
+
+export default {
+  ...mockFetch,
+  enable,
+}

package/tests/{utilities → core/utilities}/mocks/index.ts

@@ -1,9 +1,10 @@
-jest.mock("../../../src/accounts")
-import * as _accounts from "../../../src/accounts"
+jest.mock("../../../../src/accounts")
+import * as _accounts from "../../../../src/accounts"
 export const accounts = jest.mocked(_accounts)
 
 export * as date from "./date"
 export * as licenses from "./licenses"
 export { default as fetch } from "./fetch"
-import "./posthog"
+export * from "./alerts"
 import "./events"
+import "./posthog"

package/tests/{utilities → core/utilities}/mocks/licenses.ts

@@ -86,6 +86,10 @@ export const useAuditLogs = () => {
   return useFeature(Feature.AUDIT_LOGS)
 }
 
+export const useScimIntegration = () => {
+  return useFeature(Feature.SCIM)
+}
+
 // QUOTAS
 
 export const setAutomationLogsQuota = (value: number) => {

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

@@ -0,0 +1,20 @@
+import Chance from "chance"
+
+export default class CustomChance extends Chance {
+  arrayOf<T>(
+    generateFn: () => T,
+    opts: { min?: number; max?: number } = {}
+  ): T[] {
+    const itemCount = this.integer({
+      min: opts.min != null ? opts.min : 1,
+      max: opts.max != null ? opts.max : 50,
+    })
+
+    const items = []
+    for (let i = 0; i < itemCount; i++) {
+      items.push(generateFn())
+    }
+
+    return items
+  }
+}

package/tests/{utilities → core/utilities}/structures/accounts.ts

@@ -1,5 +1,5 @@
-import { generator, uuid } from "."
-import * as db from "../../../src/db/utils"
+import { generator, uuid, quotas } from "."
+import { generateGlobalUserID } from "../../../../src/docIds"
 import {
   Account,
   AccountSSOProvider,
@@ -28,6 +28,7 @@ export const account = (): Account => {
     name: generator.name(),
     size: "10+",
     profession: "Software Engineer",
+    quotaUsage: quotas.usage(),
   }
 }
 
@@ -39,7 +40,7 @@ export const cloudAccount = (): CloudAccount => {
   return {
     ...account(),
     hosting: Hosting.CLOUD,
-    budibaseUserId: db.generateGlobalUserID(),
+    budibaseUserId: generateGlobalUserID(),
   }
 }
 

package/tests/{utilities → core/utilities}/structures/apps.ts

@@ -1,6 +1,6 @@
 import { generator } from "."
 import { App } from "@budibase/types"
-import { DEFAULT_TENANT_ID, DocumentType } from "../../../src/constants"
+import { DEFAULT_TENANT_ID, DocumentType } from "../../../../src/constants"
 
 export function app(id: string): App {
   return {

package/tests/{utilities → core/utilities}/structures/db.ts

@@ -1,5 +1,5 @@
 import { structures } from ".."
-import { newid } from "../../../src/newid"
+import { newid } from "../../../../src/docIds/newid"
 
 export function id() {
   return `db_${newid()}`

package/tests/{utilities → core/utilities}/structures/generator.ts

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

package/tests/{utilities → core/utilities}/structures/index.ts

@@ -10,3 +10,5 @@ export * as tenant from "./tenants"
 export * as users from "./users"
 export * as userGroups from "./userGroups"
 export { generator } from "./generator"
+export * as scim from "./scim"
+export * as quotas from "./quotas"

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

@@ -0,0 +1,145 @@
+import {
+  Billing,
+  Customer,
+  Feature,
+  License,
+  PlanModel,
+  PlanType,
+  PriceDuration,
+  PurchasedPlan,
+  PurchasedPrice,
+  Quotas,
+  Subscription,
+} from "@budibase/types"
+
+export function price(): PurchasedPrice {
+  return {
+    amount: 10000,
+    amountMonthly: 10000,
+    currency: "usd",
+    duration: PriceDuration.MONTHLY,
+    priceId: "price_123",
+    dayPasses: undefined,
+    isPerUser: true,
+  }
+}
+
+export const plan = (type: PlanType = PlanType.FREE): PurchasedPlan => {
+  return {
+    type,
+    usesInvoicing: false,
+    model: PlanModel.PER_USER,
+    price: type !== PlanType.FREE ? price() : undefined,
+  }
+}
+
+export function quotas(): Quotas {
+  return {
+    usage: {
+      monthly: {
+        queries: {
+          name: "Queries",
+          value: 1,
+          triggers: [],
+        },
+        automations: {
+          name: "Queries",
+          value: 1,
+          triggers: [],
+        },
+        dayPasses: {
+          name: "Queries",
+          value: 1,
+          triggers: [],
+        },
+      },
+      static: {
+        rows: {
+          name: "Rows",
+          value: 1,
+          triggers: [],
+        },
+        apps: {
+          name: "Apps",
+          value: 1,
+          triggers: [],
+        },
+        users: {
+          name: "Users",
+          value: 1,
+          triggers: [],
+        },
+        userGroups: {
+          name: "User Groups",
+          value: 1,
+          triggers: [],
+        },
+        plugins: {
+          name: "Plugins",
+          value: 1,
+          triggers: [],
+        },
+      },
+    },
+    constant: {
+      automationLogRetentionDays: {
+        name: "Automation Logs",
+        value: 1,
+        triggers: [],
+      },
+      appBackupRetentionDays: {
+        name: "Backups",
+        value: 1,
+        triggers: [],
+      },
+    },
+  }
+}
+
+export function billing(
+  opts: { customer?: Customer; subscription?: Subscription } = {}
+): Billing {
+  return {
+    customer: opts.customer || customer(),
+    subscription: opts.subscription || subscription(),
+  }
+}
+
+export function customer(): Customer {
+  return {
+    balance: 0,
+    currency: "usd",
+  }
+}
+
+export function subscription(): Subscription {
+  return {
+    amount: 10000,
+    cancelAt: undefined,
+    currency: "usd",
+    currentPeriodEnd: 0,
+    currentPeriodStart: 0,
+    downgradeAt: 0,
+    duration: PriceDuration.MONTHLY,
+    pastDueAt: undefined,
+    quantity: 0,
+    status: "active",
+  }
+}
+
+export const license = (
+  opts: {
+    quotas?: Quotas
+    plan?: PurchasedPlan
+    planType?: PlanType
+    features?: Feature[]
+    billing?: Billing
+  } = {}
+): License => {
+  return {
+    features: opts.features || [],
+    quotas: opts.quotas || quotas(),
+    plan: opts.plan || plan(opts.planType),
+    billing: opts.billing || billing(),
+  }
+}

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

@@ -0,0 +1,67 @@
+import { MonthlyQuotaName, QuotaUsage } from "@budibase/types"
+
+export const usage = (): QuotaUsage => {
+  return {
+    _id: "usage_quota",
+    quotaReset: new Date().toISOString(),
+    apps: {
+      app_1: {
+        // @ts-ignore - the apps definition doesn't match up to actual usage
+        usageQuota: {
+          rows: 0,
+        },
+      },
+    },
+    monthly: {
+      "01-2023": {
+        automations: 0,
+        dayPasses: 0,
+        queries: 0,
+        triggers: {},
+        breakdown: {
+          rowQueries: {
+            parent: MonthlyQuotaName.QUERIES,
+            values: {
+              row_1: 0,
+              row_2: 0,
+            },
+          },
+          datasourceQueries: {
+            parent: MonthlyQuotaName.QUERIES,
+            values: {
+              ds_1: 0,
+              ds_2: 0,
+            },
+          },
+          automations: {
+            parent: MonthlyQuotaName.AUTOMATIONS,
+            values: {
+              auto_1: 0,
+              auto_2: 0,
+            },
+          },
+        },
+      },
+      "02-2023": {
+        automations: 0,
+        dayPasses: 0,
+        queries: 0,
+        triggers: {},
+      },
+      current: {
+        automations: 0,
+        dayPasses: 0,
+        queries: 0,
+        triggers: {},
+      },
+    },
+    usageQuota: {
+      apps: 0,
+      plugins: 0,
+      users: 0,
+      userGroups: 0,
+      rows: 0,
+      triggers: {},
+    },
+  }
+}