diff --git a/.eslintignore b/.eslintignore index 8d4c64d960..f2c53c2fdc 100644 --- a/.eslintignore +++ b/.eslintignore @@ -6,6 +6,7 @@ packages/server/coverage packages/worker/coverage packages/backend-core/coverage packages/server/client +packages/server/coverage packages/builder/.routify packages/sdk/sdk packages/account-portal/packages/server/build diff --git a/.eslintrc.json b/.eslintrc.json index 3de9d13046..2a40c6cc29 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -34,17 +34,43 @@ }, { "files": ["**/*.ts"], + "excludedFiles": ["qa-core/**"], "parser": "@typescript-eslint/parser", + "plugins": ["@typescript-eslint"], "extends": ["eslint:recommended"], + "globals": { + "NodeJS": true + }, "rules": { "no-unused-vars": "off", - "no-inner-declarations": "off", - "no-case-declarations": "off", - "no-useless-escape": "off", - "no-undef": "off", - "no-prototype-builtins": "off", - "local-rules/no-budibase-imports": "error", - "local-rules/no-test-com": "error" + "@typescript-eslint/no-unused-vars": "error", + "local-rules/no-budibase-imports": "error" + } + }, + { + "files": ["**/*.spec.ts"], + "excludedFiles": ["qa-core/**"], + "parser": "@typescript-eslint/parser", + "plugins": ["jest", "@typescript-eslint"], + "extends": ["eslint:recommended", "plugin:jest/recommended"], + "env": { + "jest/globals": true + }, + "globals": { + "NodeJS": true + }, + "rules": { + "no-unused-vars": "off", + "@typescript-eslint/no-unused-vars": "error", + "local-rules/no-test-com": "error", + "local-rules/email-domain-example-com": "error", + "no-console": "warn", + // We have a lot of tests that don't have assertions, they use our test + // API client that does the assertions for them + "jest/expect-expect": "off", + // We do this in some tests where the behaviour of internal tables + // differs to external, but the API is broadly the same + "jest/no-conditional-expect": "off" } }, { diff --git a/.github/workflows/budibase_ci.yml b/.github/workflows/budibase_ci.yml index 3060660d47..5c474aa826 100644 --- a/.github/workflows/budibase_ci.yml +++ b/.github/workflows/budibase_ci.yml @@ -107,9 +107,9 @@ jobs: - name: Test run: | if ${{ env.USE_NX_AFFECTED }}; then - yarn test --ignore=@budibase/worker --ignore=@budibase/server --ignore=@budibase/pro --since=${{ env.NX_BASE_BRANCH }} + yarn test --ignore=@budibase/worker --ignore=@budibase/server --since=${{ env.NX_BASE_BRANCH }} else - yarn test --ignore=@budibase/worker --ignore=@budibase/server --ignore=@budibase/pro + yarn test --ignore=@budibase/worker --ignore=@budibase/server fi test-worker: @@ -160,31 +160,6 @@ jobs: yarn test --scope=@budibase/server fi - test-pro: - runs-on: ubuntu-latest - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == 'Budibase/budibase' - steps: - - name: Checkout repo and submodules - uses: actions/checkout@v4 - with: - submodules: true - token: ${{ secrets.PERSONAL_ACCESS_TOKEN || github.token }} - fetch-depth: 0 - - - name: Use Node.js 20.x - uses: actions/setup-node@v4 - with: - node-version: 20.x - cache: yarn - - run: yarn --frozen-lockfile - - name: Test - run: | - if ${{ env.USE_NX_AFFECTED }}; then - yarn test --scope=@budibase/pro --since=${{ env.NX_BASE_BRANCH }} - else - yarn test --scope=@budibase/pro - fi - integration-test: runs-on: ubuntu-latest steps: diff --git a/.gitignore b/.gitignore index 21a6c4dfaa..8861a14d20 100644 --- a/.gitignore +++ b/.gitignore @@ -107,5 +107,4 @@ budibase-component budibase-datasource *.iml - .nx \ No newline at end of file diff --git a/charts/budibase/README.md b/charts/budibase/README.md index 342011bdb1..dea7d1dbae 100644 --- a/charts/budibase/README.md +++ b/charts/budibase/README.md @@ -140,7 +140,7 @@ $ helm install --create-namespace --namespace budibase budibase . -f values.yaml | ingress.className | string | `""` | What ingress class to use. | | ingress.enabled | bool | `true` | Whether to create an Ingress resource pointing to the Budibase proxy. | | ingress.hosts | list | `[]` | Standard hosts block for the Ingress resource. Defaults to pointing to the Budibase proxy. | -| nameOverride | string | `""` | Override the name of the deploymen. Defaults to {{ .Chart.Name }}. | +| nameOverride | string | `""` | Override the name of the deployment. Defaults to {{ .Chart.Name }}. | | service.port | int | `10000` | Port to expose on the service. | | service.type | string | `"ClusterIP"` | Service type for the service that points to the main Budibase proxy pod. | | serviceAccount.annotations | object | `{}` | Annotations to add to the service account | diff --git a/charts/budibase/values.yaml b/charts/budibase/values.yaml index 09262df463..19b6c22d6c 100644 --- a/charts/budibase/values.yaml +++ b/charts/budibase/values.yaml @@ -1,6 +1,6 @@ # -- Passed to all pods created by this chart. Should not ordinarily need to be changed. imagePullSecrets: [] -# -- Override the name of the deploymen. Defaults to {{ .Chart.Name }}. +# -- Override the name of the deployment. Defaults to {{ .Chart.Name }}. nameOverride: "" serviceAccount: diff --git a/eslint-local-rules/index.js b/eslint-local-rules/index.js index 71bb5068da..a4866bc1f8 100644 --- a/eslint-local-rules/index.js +++ b/eslint-local-rules/index.js @@ -7,11 +7,12 @@ module.exports = { if ( /^@budibase\/[^/]+\/.*$/.test(importPath) && - importPath !== "@budibase/backend-core/tests" + importPath !== "@budibase/backend-core/tests" && + importPath !== "@budibase/string-templates/test/utils" ) { context.report({ node, - message: `Importing from @budibase is not allowed, except for @budibase/backend-core/tests.`, + message: `Importing from @budibase is not allowed, except for @budibase/backend-core/tests and @budibase/string-templates/test/utils.`, }) } }, @@ -24,11 +25,9 @@ module.exports = { docs: { description: "disallow the use of 'test.com' in strings and replace it with 'example.com'", - category: "Possible Errors", - recommended: false, }, - schema: [], // no options - fixable: "code", // Indicates that this rule supports automatic fixing + schema: [], + fixable: "code", }, create: function (context) { return { @@ -51,4 +50,39 @@ module.exports = { } }, }, + "email-domain-example-com": { + meta: { + type: "problem", + docs: { + description: + "enforce using the example.com domain for generator.email calls", + }, + fixable: "code", + schema: [], + }, + create: function (context) { + return { + CallExpression(node) { + if ( + node.callee.type === "MemberExpression" && + node.callee.object.name === "generator" && + node.callee.property.name === "email" && + node.arguments.length === 0 + ) { + context.report({ + node, + message: + "Prefer using generator.email with the domain \"{ domain: 'example.com' }\".", + fix: function (fixer) { + return fixer.replaceText( + node, + 'generator.email({ domain: "example.com" })' + ) + }, + }) + } + }, + } + }, + }, } diff --git a/hosting/single/Dockerfile b/hosting/single/Dockerfile index ee98b0729d..be01056b53 100644 --- a/hosting/single/Dockerfile +++ b/hosting/single/Dockerfile @@ -12,8 +12,6 @@ COPY .yarnrc . COPY packages/server/package.json packages/server/package.json COPY packages/worker/package.json packages/worker/package.json -# string-templates does not get bundled during the esbuild process, so we want to use the local version -COPY packages/string-templates/package.json packages/string-templates/package.json COPY scripts/removeWorkspaceDependencies.sh scripts/removeWorkspaceDependencies.sh @@ -26,7 +24,7 @@ RUN ./scripts/removeWorkspaceDependencies.sh packages/worker/package.json RUN echo '' > scripts/syncProPackage.js RUN jq 'del(.scripts.postinstall)' package.json > temp.json && mv temp.json package.json RUN ./scripts/removeWorkspaceDependencies.sh package.json -RUN --mount=type=cache,target=/root/.yarn YARN_CACHE_FOLDER=/root/.yarn yarn install --production +RUN --mount=type=cache,target=/root/.yarn YARN_CACHE_FOLDER=/root/.yarn yarn install --production --frozen-lockfile # copy the actual code COPY packages/server/dist packages/server/dist @@ -35,7 +33,6 @@ COPY packages/server/client packages/server/client COPY packages/server/builder packages/server/builder COPY packages/worker/dist packages/worker/dist COPY packages/worker/pm2.config.js packages/worker/pm2.config.js -COPY packages/string-templates packages/string-templates FROM budibase/couchdb:v3.3.3 as runner @@ -52,11 +49,11 @@ RUN apt-get update && \ # Install postgres client for pg_dump utils RUN apt install -y software-properties-common apt-transport-https ca-certificates gnupg \ - && curl -fsSl https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor | tee /usr/share/keyrings/postgresql.gpg > /dev/null \ - && echo deb [arch=amd64,arm64,ppc64el signed-by=/usr/share/keyrings/postgresql.gpg] http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main | tee /etc/apt/sources.list.d/postgresql.list \ - && apt update -y \ - && apt install postgresql-client-15 -y \ - && apt remove software-properties-common apt-transport-https gpg -y + && curl -fsSl https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor | tee /usr/share/keyrings/postgresql.gpg > /dev/null \ + && echo deb [arch=amd64,arm64,ppc64el signed-by=/usr/share/keyrings/postgresql.gpg] http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main | tee /etc/apt/sources.list.d/postgresql.list \ + && apt update -y \ + && apt install postgresql-client-15 -y \ + && apt remove software-properties-common apt-transport-https gpg -y # We use pm2 in order to run multiple node processes in a single container RUN npm install --global pm2 @@ -100,9 +97,6 @@ COPY --from=build /app/node_modules /node_modules COPY --from=build /app/package.json /package.json COPY --from=build /app/packages/server /app COPY --from=build /app/packages/worker /worker -COPY --from=build /app/packages/string-templates /string-templates - -RUN cd /string-templates && yarn link && cd ../app && yarn link @budibase/string-templates && cd ../worker && yarn link @budibase/string-templates EXPOSE 80 diff --git a/lerna.json b/lerna.json index a77a16a24e..9cffdba08a 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.21.3", + "version": "2.22.12", "npmClient": "yarn", "packages": [ "packages/*", diff --git a/package.json b/package.json index 0a20f01d52..7de22ab456 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,7 @@ "esbuild-node-externals": "^1.8.0", "eslint": "^8.52.0", "eslint-plugin-import": "^2.29.0", + "eslint-plugin-jest": "^27.9.0", "eslint-plugin-local-rules": "^2.0.0", "eslint-plugin-svelte": "^2.34.0", "husky": "^8.0.3", @@ -25,6 +26,7 @@ "svelte": "^4.2.10", "svelte-eslint-parser": "^0.33.1", "typescript": "5.2.2", + "typescript-eslint": "^7.3.1", "yargs": "^17.7.2" }, "scripts": { diff --git a/packages/backend-core/package.json b/packages/backend-core/package.json index 3f8c34f823..fe56780982 100644 --- a/packages/backend-core/package.json +++ b/packages/backend-core/package.json @@ -67,7 +67,7 @@ "@types/lodash": "4.14.200", "@types/node-fetch": "2.6.4", "@types/pouchdb": "6.4.0", - "@types/redlock": "4.0.3", + "@types/redlock": "4.0.7", "@types/semver": "7.3.7", "@types/tar-fs": "2.0.1", "@types/uuid": "8.3.4", @@ -78,6 +78,7 @@ "jest-serial-runner": "1.2.1", "pino-pretty": "10.0.0", "pouchdb-adapter-memory": "7.2.2", + "testcontainers": "^10.7.2", "timekeeper": "2.2.0", "typescript": "5.2.2" }, diff --git a/packages/backend-core/scripts/test.sh b/packages/backend-core/scripts/test.sh index 7d19ec96cc..b9937e3a4a 100644 --- a/packages/backend-core/scripts/test.sh +++ b/packages/backend-core/scripts/test.sh @@ -4,10 +4,10 @@ set -e if [[ -n $CI ]] then # --runInBand performs better in ci where resources are limited - echo "jest --coverage --runInBand --forceExit" - jest --coverage --runInBand --forceExit + echo "jest --coverage --runInBand --forceExit $@" + jest --coverage --runInBand --forceExit $@ else # --maxWorkers performs better in development - echo "jest --coverage --detectOpenHandles" - jest --coverage --detectOpenHandles + echo "jest --coverage --forceExit --detectOpenHandles $@" + jest --coverage --forceExit --detectOpenHandles $@ fi \ No newline at end of file diff --git a/packages/backend-core/src/auth/auth.ts b/packages/backend-core/src/auth/auth.ts index 1951c7986c..87ac46cf1c 100644 --- a/packages/backend-core/src/auth/auth.ts +++ b/packages/backend-core/src/auth/auth.ts @@ -133,7 +133,7 @@ export async function refreshOAuthToken( configId?: string ): Promise { switch (providerType) { - case SSOProviderType.OIDC: + case SSOProviderType.OIDC: { if (!configId) { return { err: { data: "OIDC config id not provided" } } } @@ -142,12 +142,14 @@ export async function refreshOAuthToken( return { err: { data: "OIDC configuration not found" } } } return refreshOIDCAccessToken(oidcConfig, refreshToken) - case SSOProviderType.GOOGLE: + } + case SSOProviderType.GOOGLE: { let googleConfig = await configs.getGoogleConfig() if (!googleConfig) { return { err: { data: "Google configuration not found" } } } return refreshGoogleAccessToken(googleConfig, refreshToken) + } } } diff --git a/packages/backend-core/src/auth/tests/auth.spec.ts b/packages/backend-core/src/auth/tests/auth.spec.ts index 3ae691be58..a80e1ea739 100644 --- a/packages/backend-core/src/auth/tests/auth.spec.ts +++ b/packages/backend-core/src/auth/tests/auth.spec.ts @@ -8,7 +8,7 @@ describe("platformLogout", () => { await testEnv.withTenant(async () => { const ctx = structures.koa.newContext() await auth.platformLogout({ ctx, userId: "test" }) - expect(events.auth.logout).toBeCalledTimes(1) + expect(events.auth.logout).toHaveBeenCalledTimes(1) }) }) }) diff --git a/packages/backend-core/src/cache/base/index.ts b/packages/backend-core/src/cache/base/index.ts index 264984c6a5..433941b5c7 100644 --- a/packages/backend-core/src/cache/base/index.ts +++ b/packages/backend-core/src/cache/base/index.ts @@ -23,6 +23,18 @@ export default class BaseCache { return client.keys(pattern) } + async exists(key: string, opts = { useTenancy: true }) { + key = opts.useTenancy ? generateTenantKey(key) : key + const client = await this.getClient() + return client.exists(key) + } + + async scan(key: string, opts = { useTenancy: true }) { + key = opts.useTenancy ? generateTenantKey(key) : key + const client = await this.getClient() + return client.scan(key) + } + /** * Read only from the cache. */ @@ -32,6 +44,15 @@ export default class BaseCache { return client.get(key) } + /** + * Read only from the cache. + */ + async bulkGet(keys: string[], opts = { useTenancy: true }) { + keys = opts.useTenancy ? keys.map(key => generateTenantKey(key)) : keys + const client = await this.getClient() + return client.bulkGet(keys) + } + /** * Write to the cache. */ @@ -46,6 +67,25 @@ export default class BaseCache { await client.store(key, value, ttl) } + /** + * Bulk write to the cache. + */ + async bulkStore( + data: Record, + ttl: number | null = null, + opts = { useTenancy: true } + ) { + if (opts.useTenancy) { + data = Object.entries(data).reduce((acc, [key, value]) => { + acc[generateTenantKey(key)] = value + return acc + }, {} as Record) + } + + const client = await this.getClient() + await client.bulkStore(data, ttl) + } + /** * Remove from cache. */ @@ -55,15 +95,24 @@ export default class BaseCache { return client.delete(key) } + /** + * Remove from cache. + */ + async bulkDelete(keys: string[], opts = { useTenancy: true }) { + keys = opts.useTenancy ? keys.map(key => generateTenantKey(key)) : keys + const client = await this.getClient() + return client.bulkDelete(keys) + } + /** * Read from the cache. Write to the cache if not exists. */ - async withCache( + async withCache( key: string, - ttl: number, - fetchFn: any, + ttl: number | null = null, + fetchFn: () => Promise | T, opts = { useTenancy: true } - ) { + ): Promise { const cachedValue = await this.get(key, opts) if (cachedValue) { return cachedValue @@ -80,7 +129,7 @@ export default class BaseCache { } } - async bustCache(key: string, opts = { client: null }) { + async bustCache(key: string) { const client = await this.getClient() try { await client.delete(generateTenantKey(key)) @@ -89,4 +138,13 @@ export default class BaseCache { throw err } } + + /** + * Delete the entry if the provided value matches the stored one. + */ + async deleteIfValue(key: string, value: any, opts = { useTenancy: true }) { + key = opts.useTenancy ? generateTenantKey(key) : key + const client = await this.getClient() + await client.deleteIfValue(key, value) + } } diff --git a/packages/backend-core/src/cache/docWritethrough.ts b/packages/backend-core/src/cache/docWritethrough.ts new file mode 100644 index 0000000000..05f13a0d91 --- /dev/null +++ b/packages/backend-core/src/cache/docWritethrough.ts @@ -0,0 +1,105 @@ +import { AnyDocument, Database } from "@budibase/types" + +import { JobQueue, Queue, createQueue } from "../queue" +import * as dbUtils from "../db" + +interface ProcessDocMessage { + dbName: string + docId: string + data: Record +} + +const PERSIST_MAX_ATTEMPTS = 100 +let processor: DocWritethroughProcessor | undefined + +export class DocWritethroughProcessor { + private static _queue: Queue + + public static get queue() { + if (!DocWritethroughProcessor._queue) { + DocWritethroughProcessor._queue = createQueue( + JobQueue.DOC_WRITETHROUGH_QUEUE, + { + jobOptions: { + attempts: PERSIST_MAX_ATTEMPTS, + }, + } + ) + } + + return DocWritethroughProcessor._queue + } + + init() { + DocWritethroughProcessor.queue.process(async message => { + try { + await this.persistToDb(message.data) + } catch (err: any) { + if (err.status === 409) { + // If we get a 409, it means that another job updated it meanwhile. We want to retry it to persist it again. + throw new Error( + `Conflict persisting message ${message.id}. Attempt ${message.attemptsMade}` + ) + } + + throw err + } + }) + return this + } + + private async persistToDb({ + dbName, + docId, + data, + }: { + dbName: string + docId: string + data: Record + }) { + const db = dbUtils.getDB(dbName) + let doc: AnyDocument | undefined + try { + doc = await db.get(docId) + } catch { + doc = { _id: docId } + } + + doc = { ...doc, ...data } + await db.put(doc) + } +} + +export class DocWritethrough { + private db: Database + private _docId: string + + constructor(db: Database, docId: string) { + this.db = db + this._docId = docId + } + + get docId() { + return this._docId + } + + async patch(data: Record) { + await DocWritethroughProcessor.queue.add({ + dbName: this.db.name, + docId: this.docId, + data, + }) + } +} + +export function init(): DocWritethroughProcessor { + processor = new DocWritethroughProcessor().init() + return processor +} + +export function getProcessor(): DocWritethroughProcessor { + if (!processor) { + return init() + } + return processor +} diff --git a/packages/backend-core/src/cache/generic.ts b/packages/backend-core/src/cache/generic.ts index 3ac323a8d4..2d6d8b9472 100644 --- a/packages/backend-core/src/cache/generic.ts +++ b/packages/backend-core/src/cache/generic.ts @@ -26,7 +26,8 @@ export const store = (...args: Parameters) => GENERIC.store(...args) export const destroy = (...args: Parameters) => GENERIC.delete(...args) -export const withCache = (...args: Parameters) => - GENERIC.withCache(...args) +export const withCache = ( + ...args: Parameters> +) => GENERIC.withCache(...args) export const bustCache = (...args: Parameters) => GENERIC.bustCache(...args) diff --git a/packages/backend-core/src/cache/index.ts b/packages/backend-core/src/cache/index.ts index 4fa986e4e2..3b25108634 100644 --- a/packages/backend-core/src/cache/index.ts +++ b/packages/backend-core/src/cache/index.ts @@ -5,3 +5,4 @@ export * as writethrough from "./writethrough" export * as invite from "./invite" export * as passwordReset from "./passwordReset" export * from "./generic" +export * as docWritethrough from "./docWritethrough" diff --git a/packages/backend-core/src/cache/invite.ts b/packages/backend-core/src/cache/invite.ts index e43ebc4aa8..e3d698bcc6 100644 --- a/packages/backend-core/src/cache/invite.ts +++ b/packages/backend-core/src/cache/invite.ts @@ -1,5 +1,5 @@ import * as utils from "../utils" -import { Duration, DurationType } from "../utils" +import { Duration } from "../utils" import env from "../environment" import { getTenantId } from "../context" import * as redis from "../redis/init" diff --git a/packages/backend-core/src/cache/tests/docWritethrough.spec.ts b/packages/backend-core/src/cache/tests/docWritethrough.spec.ts new file mode 100644 index 0000000000..47b3f0672f --- /dev/null +++ b/packages/backend-core/src/cache/tests/docWritethrough.spec.ts @@ -0,0 +1,294 @@ +import tk from "timekeeper" + +import _ from "lodash" +import { DBTestConfiguration, generator, structures } from "../../../tests" +import { getDB } from "../../db" + +import { + DocWritethrough, + DocWritethroughProcessor, + init, +} from "../docWritethrough" + +import InMemoryQueue from "../../queue/inMemoryQueue" + +const initialTime = Date.now() + +async function waitForQueueCompletion() { + const queue: InMemoryQueue = DocWritethroughProcessor.queue as never + await queue.waitForCompletion() +} + +describe("docWritethrough", () => { + beforeAll(() => { + init() + }) + + const config = new DBTestConfiguration() + + const db = getDB(structures.db.id()) + let documentId: string + let docWritethrough: DocWritethrough + + describe("patch", () => { + function generatePatchObject(fieldCount: number) { + const keys = generator.unique(() => generator.guid(), fieldCount) + return keys.reduce((acc, c) => { + acc[c] = generator.word() + return acc + }, {} as Record) + } + + beforeEach(async () => { + jest.clearAllMocks() + documentId = structures.uuid() + docWritethrough = new DocWritethrough(db, documentId) + }) + + it("patching will not persist until the messages are persisted", async () => { + await config.doInTenant(async () => { + await docWritethrough.patch(generatePatchObject(2)) + await docWritethrough.patch(generatePatchObject(2)) + + expect(await db.exists(documentId)).toBe(false) + }) + }) + + it("patching will persist when the messages are persisted", async () => { + await config.doInTenant(async () => { + const patch1 = generatePatchObject(2) + const patch2 = generatePatchObject(2) + await docWritethrough.patch(patch1) + await docWritethrough.patch(patch2) + + await waitForQueueCompletion() + + // This will not be persisted + const patch3 = generatePatchObject(3) + await docWritethrough.patch(patch3) + + expect(await db.get(documentId)).toEqual({ + _id: documentId, + ...patch1, + ...patch2, + _rev: expect.stringMatching(/2-.+/), + createdAt: new Date(initialTime).toISOString(), + updatedAt: new Date(initialTime).toISOString(), + }) + }) + }) + + it("patching will persist keeping the previous data", async () => { + await config.doInTenant(async () => { + const patch1 = generatePatchObject(2) + const patch2 = generatePatchObject(2) + await docWritethrough.patch(patch1) + await docWritethrough.patch(patch2) + + await waitForQueueCompletion() + + const patch3 = generatePatchObject(3) + await docWritethrough.patch(patch3) + + await waitForQueueCompletion() + + expect(await db.get(documentId)).toEqual( + expect.objectContaining({ + _id: documentId, + ...patch1, + ...patch2, + ...patch3, + }) + ) + }) + }) + + it("date audit fields are set correctly when persisting", async () => { + await config.doInTenant(async () => { + const patch1 = generatePatchObject(2) + const patch2 = generatePatchObject(2) + await docWritethrough.patch(patch1) + const date1 = new Date() + await waitForQueueCompletion() + await docWritethrough.patch(patch2) + + tk.travel(Date.now() + 100) + const date2 = new Date() + await waitForQueueCompletion() + + expect(date1).not.toEqual(date2) + expect(await db.get(documentId)).toEqual( + expect.objectContaining({ + createdAt: date1.toISOString(), + updatedAt: date2.toISOString(), + }) + ) + }) + }) + + it("concurrent patches will override keys", async () => { + await config.doInTenant(async () => { + const patch1 = generatePatchObject(2) + await docWritethrough.patch(patch1) + await waitForQueueCompletion() + const patch2 = generatePatchObject(1) + await docWritethrough.patch(patch2) + + const keyToOverride = _.sample(Object.keys(patch1))! + expect(await db.get(documentId)).toEqual( + expect.objectContaining({ + [keyToOverride]: patch1[keyToOverride], + }) + ) + + await waitForQueueCompletion() + + const patch3 = { + ...generatePatchObject(3), + [keyToOverride]: generator.word(), + } + await docWritethrough.patch(patch3) + await waitForQueueCompletion() + + expect(await db.get(documentId)).toEqual( + expect.objectContaining({ + ...patch1, + ...patch2, + ...patch3, + }) + ) + }) + }) + + it("concurrent patches to different docWritethrough will not pollute each other", async () => { + await config.doInTenant(async () => { + const secondDocWritethrough = new DocWritethrough( + db, + structures.db.id() + ) + + const doc1Patch = generatePatchObject(2) + await docWritethrough.patch(doc1Patch) + const doc2Patch = generatePatchObject(1) + await secondDocWritethrough.patch(doc2Patch) + + await waitForQueueCompletion() + + const doc1Patch2 = generatePatchObject(3) + await docWritethrough.patch(doc1Patch2) + const doc2Patch2 = generatePatchObject(3) + await secondDocWritethrough.patch(doc2Patch2) + await waitForQueueCompletion() + + expect(await db.get(docWritethrough.docId)).toEqual( + expect.objectContaining({ + ...doc1Patch, + ...doc1Patch2, + }) + ) + + expect(await db.get(secondDocWritethrough.docId)).toEqual( + expect.objectContaining({ + ...doc2Patch, + ...doc2Patch2, + }) + ) + }) + }) + + it("cached values are persisted only once", async () => { + await config.doInTenant(async () => { + const initialPatch = generatePatchObject(5) + + await docWritethrough.patch(initialPatch) + await waitForQueueCompletion() + + expect(await db.get(documentId)).toEqual( + expect.objectContaining(initialPatch) + ) + + await db.remove(await db.get(documentId)) + + await waitForQueueCompletion() + const extraPatch = generatePatchObject(5) + await docWritethrough.patch(extraPatch) + await waitForQueueCompletion() + + expect(await db.get(documentId)).toEqual( + expect.objectContaining(extraPatch) + ) + expect(await db.get(documentId)).not.toEqual( + expect.objectContaining(initialPatch) + ) + }) + }) + + it("concurrent calls will not cause conflicts", async () => { + async function parallelPatch(count: number) { + const patches = Array.from({ length: count }).map(() => + generatePatchObject(1) + ) + await Promise.all(patches.map(p => docWritethrough.patch(p))) + + return patches.reduce((acc, c) => { + acc = { ...acc, ...c } + return acc + }, {}) + } + const queueMessageSpy = jest.spyOn(DocWritethroughProcessor.queue, "add") + + await config.doInTenant(async () => { + let patches = await parallelPatch(5) + expect(queueMessageSpy).toHaveBeenCalledTimes(5) + + await waitForQueueCompletion() + expect(await db.get(documentId)).toEqual( + expect.objectContaining(patches) + ) + + patches = { ...patches, ...(await parallelPatch(40)) } + expect(queueMessageSpy).toHaveBeenCalledTimes(45) + + await waitForQueueCompletion() + expect(await db.get(documentId)).toEqual( + expect.objectContaining(patches) + ) + + patches = { ...patches, ...(await parallelPatch(10)) } + expect(queueMessageSpy).toHaveBeenCalledTimes(55) + + await waitForQueueCompletion() + expect(await db.get(documentId)).toEqual( + expect.objectContaining(patches) + ) + }) + }) + + // This is not yet supported + // eslint-disable-next-line jest/no-disabled-tests + it.skip("patches will execute in order", async () => { + let incrementalValue = 0 + const keyToOverride = generator.word() + async function incrementalPatches(count: number) { + for (let i = 0; i < count; i++) { + await docWritethrough.patch({ [keyToOverride]: incrementalValue++ }) + } + } + + await config.doInTenant(async () => { + await incrementalPatches(5) + + await waitForQueueCompletion() + expect(await db.get(documentId)).toEqual( + expect.objectContaining({ [keyToOverride]: 5 }) + ) + + await incrementalPatches(40) + await waitForQueueCompletion() + expect(await db.get(documentId)).toEqual( + expect.objectContaining({ [keyToOverride]: 45 }) + ) + }) + }) + }) +}) diff --git a/packages/backend-core/src/cache/tests/user.spec.ts b/packages/backend-core/src/cache/tests/user.spec.ts index 80e5bc3063..49a8d51c16 100644 --- a/packages/backend-core/src/cache/tests/user.spec.ts +++ b/packages/backend-core/src/cache/tests/user.spec.ts @@ -55,8 +55,8 @@ describe("user cache", () => { })), }) - expect(UserDB.bulkGet).toBeCalledTimes(1) - expect(UserDB.bulkGet).toBeCalledWith(userIdsToRequest) + expect(UserDB.bulkGet).toHaveBeenCalledTimes(1) + expect(UserDB.bulkGet).toHaveBeenCalledWith(userIdsToRequest) }) it("on a second all, all of them are retrieved from cache", async () => { @@ -82,7 +82,7 @@ describe("user cache", () => { ), }) - expect(UserDB.bulkGet).toBeCalledTimes(1) + expect(UserDB.bulkGet).toHaveBeenCalledTimes(1) }) it("when some users are cached, only the missing ones are retrieved from db", async () => { @@ -110,8 +110,8 @@ describe("user cache", () => { ), }) - expect(UserDB.bulkGet).toBeCalledTimes(1) - expect(UserDB.bulkGet).toBeCalledWith([ + expect(UserDB.bulkGet).toHaveBeenCalledTimes(1) + expect(UserDB.bulkGet).toHaveBeenCalledWith([ userIdsToRequest[1], userIdsToRequest[2], userIdsToRequest[4], diff --git a/packages/backend-core/src/cache/user.ts b/packages/backend-core/src/cache/user.ts index 313b9a4d4a..ecfa20f99e 100644 --- a/packages/backend-core/src/cache/user.ts +++ b/packages/backend-core/src/cache/user.ts @@ -6,7 +6,7 @@ import env from "../environment" import * as accounts from "../accounts" import { UserDB } from "../users" import { sdk } from "@budibase/shared-core" -import { User } from "@budibase/types" +import { User, UserMetadata } from "@budibase/types" const EXPIRY_SECONDS = 3600 @@ -15,7 +15,7 @@ const EXPIRY_SECONDS = 3600 */ async function populateFromDB(userId: string, tenantId: string) { const db = tenancy.getTenantDB(tenantId) - const user = await db.get(userId) + const user = await db.get(userId) user.budibaseAccess = true if (!env.SELF_HOSTED && !env.DISABLE_ACCOUNT_PORTAL) { const account = await accounts.getAccount(user.email) diff --git a/packages/backend-core/src/cache/writethrough.ts b/packages/backend-core/src/cache/writethrough.ts index 5cafe418d7..cd7409ca15 100644 --- a/packages/backend-core/src/cache/writethrough.ts +++ b/packages/backend-core/src/cache/writethrough.ts @@ -8,7 +8,7 @@ const DEFAULT_WRITE_RATE_MS = 10000 let CACHE: BaseCache | null = null interface CacheItem { - doc: any + doc: T lastWrite: number } diff --git a/packages/backend-core/src/constants/db.ts b/packages/backend-core/src/constants/db.ts index ac00483021..f4caac502e 100644 --- a/packages/backend-core/src/constants/db.ts +++ b/packages/backend-core/src/constants/db.ts @@ -57,6 +57,9 @@ export const StaticDatabases = { AUDIT_LOGS: { name: "audit-logs", }, + SCIM_LOGS: { + name: "scim-logs", + }, } export const APP_PREFIX = prefixed(DocumentType.APP) diff --git a/packages/backend-core/src/context/mainContext.ts b/packages/backend-core/src/context/mainContext.ts index 36fd5dcb48..6cea7efeba 100644 --- a/packages/backend-core/src/context/mainContext.ts +++ b/packages/backend-core/src/context/mainContext.ts @@ -10,7 +10,7 @@ import { StaticDatabases, DEFAULT_TENANT_ID, } from "../constants" -import { Database, IdentityContext } from "@budibase/types" +import { Database, IdentityContext, Snippet, App } from "@budibase/types" import { ContextMap } from "./types" let TEST_APP_ID: string | null = null @@ -35,6 +35,17 @@ export function getAuditLogDBName(tenantId?: string) { } } +export function getScimDBName(tenantId?: string) { + if (!tenantId) { + tenantId = getTenantId() + } + if (tenantId === DEFAULT_TENANT_ID) { + return StaticDatabases.SCIM_LOGS.name + } else { + return `${tenantId}${SEPARATOR}${StaticDatabases.SCIM_LOGS.name}` + } +} + export function baseGlobalDBName(tenantId: string | undefined | null) { if (!tenantId || tenantId === DEFAULT_TENANT_ID) { return StaticDatabases.GLOBAL.name @@ -111,10 +122,10 @@ export async function doInAutomationContext(params: { automationId: string task: () => T }): Promise { - const tenantId = getTenantIDFromAppID(params.appId) + await ensureSnippetContext() return newContext( { - tenantId, + tenantId: getTenantIDFromAppID(params.appId), appId: params.appId, automationId: params.automationId, }, @@ -270,6 +281,27 @@ export function doInScimContext(task: any) { return newContext(updates, task) } +export async function ensureSnippetContext() { + const ctx = getCurrentContext() + + // If we've already added snippets to context, continue + if (!ctx || ctx.snippets) { + return + } + + // Otherwise get snippets for this app and update context + let snippets: Snippet[] | undefined + const db = getAppDB() + if (db && !env.isTest()) { + const app = await db.get(DocumentType.APP_METADATA) + snippets = app.snippets + } + + // Always set snippets to a non-null value so that we can tell we've attempted + // to load snippets + ctx.snippets = snippets || [] +} + export function getEnvironmentVariables() { const context = Context.get() if (!context.environmentVariables) { diff --git a/packages/backend-core/src/context/tests/index.spec.ts b/packages/backend-core/src/context/tests/index.spec.ts index cfc820e169..2d89131549 100644 --- a/packages/backend-core/src/context/tests/index.spec.ts +++ b/packages/backend-core/src/context/tests/index.spec.ts @@ -246,7 +246,7 @@ describe("context", () => { context.doInAppMigrationContext(db.generateAppID(), async () => { await otherContextCall() }) - ).rejects.toThrowError( + ).rejects.toThrow( "The context cannot be changed, a migration is currently running" ) } diff --git a/packages/backend-core/src/context/types.ts b/packages/backend-core/src/context/types.ts index 6fb9f44fad..f297d3089f 100644 --- a/packages/backend-core/src/context/types.ts +++ b/packages/backend-core/src/context/types.ts @@ -1,5 +1,4 @@ -import { IdentityContext, VM } from "@budibase/types" -import { ExecutionTimeTracker } from "../timers" +import { IdentityContext, Snippet, VM } from "@budibase/types" // keep this out of Budibase types, don't want to expose context info export type ContextMap = { @@ -10,6 +9,7 @@ export type ContextMap = { isScim?: boolean automationId?: string isMigrating?: boolean - jsExecutionTracker?: ExecutionTimeTracker vm?: VM + cleanup?: (() => void | Promise)[] + snippets?: Snippet[] } diff --git a/packages/backend-core/src/db/Replication.ts b/packages/backend-core/src/db/Replication.ts index f91a37ce8f..9c960d76dd 100644 --- a/packages/backend-core/src/db/Replication.ts +++ b/packages/backend-core/src/db/Replication.ts @@ -1,66 +1,57 @@ +import PouchDB from "pouchdb" import { getPouchDB, closePouchDB } from "./couch" import { DocumentType } from "../constants" class Replication { - source: any - target: any - replication: any + source: PouchDB.Database + target: PouchDB.Database - /** - * - * @param source - the DB you want to replicate or rollback to - * @param target - the DB you want to replicate to, or rollback from - */ - constructor({ source, target }: any) { + constructor({ source, target }: { source: string; target: string }) { this.source = getPouchDB(source) this.target = getPouchDB(target) } - close() { - return Promise.all([closePouchDB(this.source), closePouchDB(this.target)]) + async close() { + await Promise.all([closePouchDB(this.source), closePouchDB(this.target)]) } - promisify(operation: any, opts = {}) { - return new Promise(resolve => { - operation(this.target, opts) - .on("denied", function (err: any) { + replicate(opts: PouchDB.Replication.ReplicateOptions = {}) { + return new Promise>(resolve => { + this.source.replicate + .to(this.target, opts) + .on("denied", function (err) { // a document failed to replicate (e.g. due to permissions) throw new Error(`Denied: Document failed to replicate ${err}`) }) - .on("complete", function (info: any) { + .on("complete", function (info) { return resolve(info) }) - .on("error", function (err: any) { + .on("error", function (err) { throw new Error(`Replication Error: ${err}`) }) }) } - /** - * Two way replication operation, intended to be promise based. - * @param opts - PouchDB replication options - */ - sync(opts = {}) { - this.replication = this.promisify(this.source.sync, opts) - return this.replication - } + appReplicateOpts( + opts: PouchDB.Replication.ReplicateOptions = {} + ): PouchDB.Replication.ReplicateOptions { + if (typeof opts.filter === "string") { + return opts + } - /** - * One way replication operation, intended to be promise based. - * @param opts - PouchDB replication options - */ - replicate(opts = {}) { - this.replication = this.promisify(this.source.replicate.to, opts) - return this.replication - } + const filter = opts.filter + delete opts.filter - appReplicateOpts() { return { - filter: (doc: any) => { + ...opts, + filter: (doc: any, params: any) => { if (doc._id && doc._id.startsWith(DocumentType.AUTOMATION_LOG)) { return false } - return doc._id !== DocumentType.APP_METADATA + if (doc._id === DocumentType.APP_METADATA) { + return false + } + return filter ? filter(doc, params) : true }, } } @@ -75,10 +66,6 @@ class Replication { // take the opportunity to remove deleted tombstones await this.replicate() } - - cancel() { - this.replication.cancel() - } } export default Replication diff --git a/packages/backend-core/src/db/couch/DatabaseImpl.ts b/packages/backend-core/src/db/couch/DatabaseImpl.ts index 7e7c997cbe..416313f520 100644 --- a/packages/backend-core/src/db/couch/DatabaseImpl.ts +++ b/packages/backend-core/src/db/couch/DatabaseImpl.ts @@ -70,7 +70,15 @@ export class DatabaseImpl implements Database { DatabaseImpl.nano = buildNano(couchInfo) } - async exists() { + exists(docId?: string) { + if (docId === undefined) { + return this.dbExists() + } + + return this.docExists(docId) + } + + private async dbExists() { const response = await directCouchUrlCall({ url: `${this.couchInfo.url}/${this.name}`, method: "HEAD", @@ -79,6 +87,15 @@ export class DatabaseImpl implements Database { return response.status === 200 } + private async docExists(id: string): Promise { + try { + await this.performCall(db => () => db.head(id)) + return true + } catch { + return false + } + } + private nano() { return this.instanceNano || DatabaseImpl.nano } diff --git a/packages/backend-core/src/db/instrumentation.ts b/packages/backend-core/src/db/instrumentation.ts index 03010d4c92..795f30d7cd 100644 --- a/packages/backend-core/src/db/instrumentation.ts +++ b/packages/backend-core/src/db/instrumentation.ts @@ -24,9 +24,12 @@ export class DDInstrumentedDatabase implements Database { return this.db.name } - exists(): Promise { + exists(docId?: string): Promise { return tracer.trace("db.exists", span => { - span?.addTags({ db_name: this.name }) + span?.addTags({ db_name: this.name, doc_id: docId }) + if (docId) { + return this.db.exists(docId) + } return this.db.exists() }) } diff --git a/packages/backend-core/src/db/lucene.ts b/packages/backend-core/src/db/lucene.ts index f982ee67d0..987d750d45 100644 --- a/packages/backend-core/src/db/lucene.ts +++ b/packages/backend-core/src/db/lucene.ts @@ -10,10 +10,6 @@ interface SearchResponse { totalRows: number } -interface PaginatedSearchResponse extends SearchResponse { - hasNextPage: boolean -} - export type SearchParams = { tableId?: string sort?: string @@ -247,7 +243,7 @@ export class QueryBuilder { } // Escape characters if (!this.#noEscaping && escape && originalType === "string") { - value = `${value}`.replace(/[ \/#+\-&|!(){}\]^"~*?:\\]/g, "\\$&") + value = `${value}`.replace(/[ /#+\-&|!(){}\]^"~*?:\\]/g, "\\$&") } // Wrap in quotes diff --git a/packages/backend-core/src/db/searchIndexes/searchIndexes.ts b/packages/backend-core/src/db/searchIndexes/searchIndexes.ts index b953e3516e..8742d405f2 100644 --- a/packages/backend-core/src/db/searchIndexes/searchIndexes.ts +++ b/packages/backend-core/src/db/searchIndexes/searchIndexes.ts @@ -34,12 +34,12 @@ export async function createUserIndex() { } let idxKey = prev != null ? `${prev}.${key}` : key if (typeof input[key] === "string") { + // @ts-expect-error index is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore index(idxKey, input[key].toLowerCase(), { facet: true }) } else if (typeof input[key] !== "object") { + // @ts-expect-error index is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore index(idxKey, input[key], { facet: true }) } else { idx(input[key], idxKey) diff --git a/packages/backend-core/src/db/tests/DatabaseImpl.spec.ts b/packages/backend-core/src/db/tests/DatabaseImpl.spec.ts new file mode 100644 index 0000000000..586f13f417 --- /dev/null +++ b/packages/backend-core/src/db/tests/DatabaseImpl.spec.ts @@ -0,0 +1,55 @@ +import _ from "lodash" +import { AnyDocument } from "@budibase/types" +import { generator } from "../../../tests" +import { DatabaseImpl } from "../couch" +import { newid } from "../../utils" + +describe("DatabaseImpl", () => { + const database = new DatabaseImpl(generator.word()) + const documents: AnyDocument[] = [] + + beforeAll(async () => { + const docsToCreate = Array.from({ length: 10 }).map(() => ({ + _id: newid(), + })) + const createdDocs = await database.bulkDocs(docsToCreate) + + documents.push(...createdDocs.map((x: any) => ({ _id: x.id, _rev: x.rev }))) + }) + + describe("document exists", () => { + it("can check existing docs by id", async () => { + const existingDoc = _.sample(documents) + const result = await database.exists(existingDoc!._id!) + + expect(result).toBe(true) + }) + + it("can check non existing docs by id", async () => { + const result = await database.exists(newid()) + + expect(result).toBe(false) + }) + + it("can check an existing doc by id multiple times", async () => { + const existingDoc = _.sample(documents) + const id = existingDoc!._id! + + const results = [] + results.push(await database.exists(id)) + results.push(await database.exists(id)) + results.push(await database.exists(id)) + + expect(results).toEqual([true, true, true]) + }) + + it("returns false after the doc is deleted", async () => { + const existingDoc = _.sample(documents) + const id = existingDoc!._id! + expect(await database.exists(id)).toBe(true) + + await database.remove(existingDoc!) + expect(await database.exists(id)).toBe(false) + }) + }) +}) diff --git a/packages/backend-core/src/docUpdates/index.ts b/packages/backend-core/src/docUpdates/index.ts index 3971f8de12..bd34f4f0cd 100644 --- a/packages/backend-core/src/docUpdates/index.ts +++ b/packages/backend-core/src/docUpdates/index.ts @@ -17,13 +17,8 @@ export function init(processors: ProcessorMap) { // if not processing in this instance, kick it off if (!processingPromise) { processingPromise = asyncEventQueue.process(async job => { - const { event, identity, properties, timestamp } = job.data - await documentProcessor.processEvent( - event, - identity, - properties, - timestamp - ) + const { event, identity, properties } = job.data + await documentProcessor.processEvent(event, identity, properties) }) } } diff --git a/packages/backend-core/src/environment.ts b/packages/backend-core/src/environment.ts index b3179cbeea..2da2a77d67 100644 --- a/packages/backend-core/src/environment.ts +++ b/packages/backend-core/src/environment.ts @@ -186,6 +186,7 @@ const environment = { environment[key] = value }, ROLLING_LOG_MAX_SIZE: process.env.ROLLING_LOG_MAX_SIZE || "10M", + DISABLE_SCIM_CALLS: process.env.DISABLE_SCIM_CALLS, } // clean up any environment variable edge cases diff --git a/packages/backend-core/src/events/processors/AuditLogsProcessor.ts b/packages/backend-core/src/events/processors/AuditLogsProcessor.ts index 94b4e1b09f..3dd2ab9d10 100644 --- a/packages/backend-core/src/events/processors/AuditLogsProcessor.ts +++ b/packages/backend-core/src/events/processors/AuditLogsProcessor.ts @@ -1,7 +1,6 @@ import { Event, Identity, - Group, IdentityType, AuditLogQueueEvent, AuditLogFn, @@ -79,11 +78,11 @@ export default class AuditLogsProcessor implements EventProcessor { } } - async identify(identity: Identity, timestamp?: string | number) { + async identify() { // no-op } - async identifyGroup(group: Group, timestamp?: string | number) { + async identifyGroup() { // no-op } diff --git a/packages/backend-core/src/events/processors/LoggingProcessor.ts b/packages/backend-core/src/events/processors/LoggingProcessor.ts index 0f4d02b99c..9f2dc5a473 100644 --- a/packages/backend-core/src/events/processors/LoggingProcessor.ts +++ b/packages/backend-core/src/events/processors/LoggingProcessor.ts @@ -8,8 +8,7 @@ export default class LoggingProcessor implements EventProcessor { async processEvent( event: Event, identity: Identity, - properties: any, - timestamp?: string + properties: any ): Promise { if (skipLogging) { return @@ -17,14 +16,14 @@ export default class LoggingProcessor implements EventProcessor { console.log(`[audit] [identityType=${identity.type}] ${event}`, properties) } - async identify(identity: Identity, timestamp?: string | number) { + async identify(identity: Identity) { if (skipLogging) { return } console.log(`[audit] identified`, identity) } - async identifyGroup(group: Group, timestamp?: string | number) { + async identifyGroup(group: Group) { if (skipLogging) { return } diff --git a/packages/backend-core/src/events/processors/async/DocumentUpdateProcessor.ts b/packages/backend-core/src/events/processors/async/DocumentUpdateProcessor.ts index 54304ee21b..92afcdc637 100644 --- a/packages/backend-core/src/events/processors/async/DocumentUpdateProcessor.ts +++ b/packages/backend-core/src/events/processors/async/DocumentUpdateProcessor.ts @@ -14,12 +14,7 @@ export default class DocumentUpdateProcessor implements EventProcessor { this.processors = processors } - async processEvent( - event: Event, - identity: Identity, - properties: any, - timestamp?: string | number - ) { + async processEvent(event: Event, identity: Identity, properties: any) { const tenantId = identity.realTenantId const docId = getDocumentId(event, properties) if (!tenantId || !docId) { diff --git a/packages/backend-core/src/events/publishers/app.ts b/packages/backend-core/src/events/publishers/app.ts index d08d59b5f1..af26b09e72 100644 --- a/packages/backend-core/src/events/publishers/app.ts +++ b/packages/backend-core/src/events/publishers/app.ts @@ -13,6 +13,7 @@ import { AppVersionRevertedEvent, AppRevertedEvent, AppExportedEvent, + AppDuplicatedEvent, } from "@budibase/types" const created = async (app: App, timestamp?: string | number) => { @@ -77,6 +78,17 @@ async function fileImported(app: App) { await publishEvent(Event.APP_FILE_IMPORTED, properties) } +async function duplicated(app: App, duplicateAppId: string) { + const properties: AppDuplicatedEvent = { + duplicateAppId, + appId: app.appId, + audited: { + name: app.name, + }, + } + await publishEvent(Event.APP_DUPLICATED, properties) +} + async function templateImported(app: App, templateKey: string) { const properties: AppTemplateImportedEvent = { appId: app.appId, @@ -147,6 +159,7 @@ export default { published, unpublished, fileImported, + duplicated, templateImported, versionUpdated, versionReverted, diff --git a/packages/backend-core/src/logging/pino/logger.ts b/packages/backend-core/src/logging/pino/logger.ts index 7a051e7f12..0a8470a453 100644 --- a/packages/backend-core/src/logging/pino/logger.ts +++ b/packages/backend-core/src/logging/pino/logger.ts @@ -10,6 +10,18 @@ import { formats } from "dd-trace/ext" import { localFileDestination } from "../system" +function isPlainObject(obj: any) { + return typeof obj === "object" && obj !== null && !(obj instanceof Error) +} + +function isError(obj: any) { + return obj instanceof Error +} + +function isMessage(obj: any) { + return typeof obj === "string" +} + // LOGGER let pinoInstance: pino.Logger | undefined @@ -71,23 +83,11 @@ if (!env.DISABLE_PINO_LOGGER) { err?: Error } - function isPlainObject(obj: any) { - return typeof obj === "object" && obj !== null && !(obj instanceof Error) - } - - function isError(obj: any) { - return obj instanceof Error - } - - function isMessage(obj: any) { - return typeof obj === "string" - } - /** * Backwards compatibility between console logging statements * and pino logging requirements. */ - function getLogParams(args: any[]): [MergingObject, string] { + const getLogParams = (args: any[]): [MergingObject, string] => { let error = undefined let objects: any[] = [] let message = "" diff --git a/packages/backend-core/src/middleware/matchers.ts b/packages/backend-core/src/middleware/matchers.ts index efbdec2dbe..757d93a60d 100644 --- a/packages/backend-core/src/middleware/matchers.ts +++ b/packages/backend-core/src/middleware/matchers.ts @@ -11,7 +11,6 @@ export const buildMatcherRegex = ( return patterns.map(pattern => { let route = pattern.route const method = pattern.method - const strict = pattern.strict ? pattern.strict : false // if there is a param in the route // use a wildcard pattern @@ -24,24 +23,17 @@ export const buildMatcherRegex = ( } } - return { regex: new RegExp(route), method, strict, route } + return { regex: new RegExp(route), method, route } }) } export const matches = (ctx: BBContext, options: RegexMatcher[]) => { - return options.find(({ regex, method, strict, route }) => { - let urlMatch - if (strict) { - urlMatch = ctx.request.url === route - } else { - urlMatch = regex.test(ctx.request.url) - } - + return options.find(({ regex, method }) => { + const urlMatch = regex.test(ctx.request.url) const methodMatch = method === "ALL" ? true : ctx.request.method.toLowerCase() === method.toLowerCase() - return urlMatch && methodMatch }) } diff --git a/packages/backend-core/src/middleware/passport/datasource/google.ts b/packages/backend-core/src/middleware/passport/datasource/google.ts index ab4ffee9d2..7f768f1623 100644 --- a/packages/backend-core/src/middleware/passport/datasource/google.ts +++ b/packages/backend-core/src/middleware/passport/datasource/google.ts @@ -3,7 +3,7 @@ import { Cookie } from "../../../constants" import * as configs from "../../../configs" import * as cache from "../../../cache" import * as utils from "../../../utils" -import { UserCtx, SSOProfile, DatasourceAuthCookie } from "@budibase/types" +import { UserCtx, SSOProfile } from "@budibase/types" import { ssoSaveUserNoOp } from "../sso/sso" const GoogleStrategy = require("passport-google-oauth").OAuth2Strategy diff --git a/packages/backend-core/src/middleware/passport/sso/sso.ts b/packages/backend-core/src/middleware/passport/sso/sso.ts index 2fc1184722..ee84f03dae 100644 --- a/packages/backend-core/src/middleware/passport/sso/sso.ts +++ b/packages/backend-core/src/middleware/passport/sso/sso.ts @@ -5,7 +5,6 @@ import * as context from "../../../context" import fetch from "node-fetch" import { SaveSSOUserFunction, - SaveUserOpts, SSOAuthDetails, SSOUser, User, @@ -14,10 +13,8 @@ import { // no-op function for user save // - this allows datasource auth and access token refresh to work correctly // - prefer no-op over an optional argument to ensure function is provided to login flows -export const ssoSaveUserNoOp: SaveSSOUserFunction = ( - user: SSOUser, - opts: SaveUserOpts -) => Promise.resolve(user) +export const ssoSaveUserNoOp: SaveSSOUserFunction = (user: SSOUser) => + Promise.resolve(user) /** * Common authentication logic for third parties. e.g. OAuth, OIDC. diff --git a/packages/backend-core/src/middleware/passport/sso/tests/sso.spec.ts b/packages/backend-core/src/middleware/passport/sso/tests/sso.spec.ts index d3486a5b14..ea9584c284 100644 --- a/packages/backend-core/src/middleware/passport/sso/tests/sso.spec.ts +++ b/packages/backend-core/src/middleware/passport/sso/tests/sso.spec.ts @@ -114,11 +114,11 @@ describe("sso", () => { // tenant id added ssoUser.tenantId = context.getTenantId() - expect(mockSaveUser).toBeCalledWith(ssoUser, { + expect(mockSaveUser).toHaveBeenCalledWith(ssoUser, { hashPassword: false, requirePassword: false, }) - expect(mockDone).toBeCalledWith(null, ssoUser) + expect(mockDone).toHaveBeenCalledWith(null, ssoUser) }) }) }) @@ -159,11 +159,11 @@ describe("sso", () => { // existing id preserved ssoUser._id = existingUser._id - expect(mockSaveUser).toBeCalledWith(ssoUser, { + expect(mockSaveUser).toHaveBeenCalledWith(ssoUser, { hashPassword: false, requirePassword: false, }) - expect(mockDone).toBeCalledWith(null, ssoUser) + expect(mockDone).toHaveBeenCalledWith(null, ssoUser) }) }) @@ -187,11 +187,11 @@ describe("sso", () => { // existing id preserved ssoUser._id = existingUser._id - expect(mockSaveUser).toBeCalledWith(ssoUser, { + expect(mockSaveUser).toHaveBeenCalledWith(ssoUser, { hashPassword: false, requirePassword: false, }) - expect(mockDone).toBeCalledWith(null, ssoUser) + expect(mockDone).toHaveBeenCalledWith(null, ssoUser) }) }) }) diff --git a/packages/backend-core/src/middleware/tests/builder.spec.ts b/packages/backend-core/src/middleware/tests/builder.spec.ts index 0514dc13f0..0f35b0b833 100644 --- a/packages/backend-core/src/middleware/tests/builder.spec.ts +++ b/packages/backend-core/src/middleware/tests/builder.spec.ts @@ -24,13 +24,13 @@ function buildUserCtx(user: ContextUser) { } function passed(throwFn: jest.Func, nextFn: jest.Func) { - expect(throwFn).not.toBeCalled() - expect(nextFn).toBeCalled() + expect(throwFn).not.toHaveBeenCalled() + expect(nextFn).toHaveBeenCalled() } function threw(throwFn: jest.Func) { // cant check next, the throw function doesn't actually throw - so it still continues - expect(throwFn).toBeCalled() + expect(throwFn).toHaveBeenCalled() } describe("adminOnly middleware", () => { diff --git a/packages/backend-core/src/middleware/tests/matchers.spec.ts b/packages/backend-core/src/middleware/tests/matchers.spec.ts index c39bbb6dd3..1b79db2e68 100644 --- a/packages/backend-core/src/middleware/tests/matchers.spec.ts +++ b/packages/backend-core/src/middleware/tests/matchers.spec.ts @@ -34,23 +34,6 @@ describe("matchers", () => { expect(!!matchers.matches(ctx, built)).toBe(true) }) - it("doesn't wildcard path with strict", () => { - const pattern = [ - { - route: "/api/tests", - method: "POST", - strict: true, - }, - ] - const ctx = structures.koa.newContext() - ctx.request.url = "/api/tests/id/something/else" - ctx.request.method = "POST" - - const built = matchers.buildMatcherRegex(pattern) - - expect(!!matchers.matches(ctx, built)).toBe(false) - }) - it("matches with param", () => { const pattern = [ { @@ -67,23 +50,6 @@ describe("matchers", () => { expect(!!matchers.matches(ctx, built)).toBe(true) }) - // TODO: Support the below behaviour - // Strict does not work when a param is present - // it("matches with param with strict", () => { - // const pattern = [{ - // route: "/api/tests/:testId", - // method: "GET", - // strict: true - // }] - // const ctx = structures.koa.newContext() - // ctx.request.url = "/api/tests/id" - // ctx.request.method = "GET" - // - // const built = matchers.buildMatcherRegex(pattern) - // - // expect(!!matchers.matches(ctx, built)).toBe(true) - // }) - it("doesn't match by path", () => { const pattern = [ { diff --git a/packages/backend-core/src/migrations/migrations.ts b/packages/backend-core/src/migrations/migrations.ts index c750bc4882..3f033b8cdb 100644 --- a/packages/backend-core/src/migrations/migrations.ts +++ b/packages/backend-core/src/migrations/migrations.ts @@ -45,10 +45,6 @@ export const runMigration = async ( options: MigrationOptions = {} ) => { const migrationType = migration.type - let tenantId: string | undefined - if (migrationType !== MigrationType.INSTALLATION) { - tenantId = context.getTenantId() - } const migrationName = migration.name const silent = migration.silent diff --git a/packages/backend-core/src/objectStore/buckets/tests/app.spec.ts b/packages/backend-core/src/objectStore/buckets/tests/app.spec.ts index cbbbee6255..4a132ce54d 100644 --- a/packages/backend-core/src/objectStore/buckets/tests/app.spec.ts +++ b/packages/backend-core/src/objectStore/buckets/tests/app.spec.ts @@ -126,7 +126,7 @@ describe("app", () => { it("gets url with embedded minio", async () => { testEnv.withMinio() - await testEnv.withTenant(tenantId => { + await testEnv.withTenant(() => { const url = getAppFileUrl() expect(url).toBe( "/files/signed/prod-budi-app-assets/app_123/attachments/image.jpeg" @@ -136,7 +136,7 @@ describe("app", () => { it("gets url with custom S3", async () => { testEnv.withS3() - await testEnv.withTenant(tenantId => { + await testEnv.withTenant(() => { const url = getAppFileUrl() expect(url).toBe( "http://s3.example.com/prod-budi-app-assets/app_123/attachments/image.jpeg" @@ -146,7 +146,7 @@ describe("app", () => { it("gets url with cloudfront + s3", async () => { testEnv.withCloudfront() - await testEnv.withTenant(tenantId => { + await testEnv.withTenant(() => { const url = getAppFileUrl() // omit rest of signed params expect( diff --git a/packages/backend-core/src/platform/tests/tenants.spec.ts b/packages/backend-core/src/platform/tests/tenants.spec.ts index b2ab75c954..e22003fd45 100644 --- a/packages/backend-core/src/platform/tests/tenants.spec.ts +++ b/packages/backend-core/src/platform/tests/tenants.spec.ts @@ -3,7 +3,7 @@ import { DBTestConfiguration } from "../../../tests/extra" import * as tenants from "../tenants" describe("tenants", () => { - const config = new DBTestConfiguration() + new DBTestConfiguration() describe("addTenant", () => { it("concurrently adds multiple tenants safely", async () => { diff --git a/packages/backend-core/src/queue/constants.ts b/packages/backend-core/src/queue/constants.ts index eb4f21aced..a095c6c769 100644 --- a/packages/backend-core/src/queue/constants.ts +++ b/packages/backend-core/src/queue/constants.ts @@ -4,4 +4,5 @@ export enum JobQueue { AUDIT_LOG = "auditLogQueue", SYSTEM_EVENT_QUEUE = "systemEventQueue", APP_MIGRATION = "appMigration", + DOC_WRITETHROUGH_QUEUE = "docWritethroughQueue", } diff --git a/packages/backend-core/src/queue/inMemoryQueue.ts b/packages/backend-core/src/queue/inMemoryQueue.ts index c05bbffbe9..87e43b324d 100644 --- a/packages/backend-core/src/queue/inMemoryQueue.ts +++ b/packages/backend-core/src/queue/inMemoryQueue.ts @@ -1,5 +1,14 @@ import events from "events" -import { timeout } from "../utils" +import { newid, timeout } from "../utils" +import { Queue, QueueOptions, JobOptions } from "./queue" + +interface JobMessage { + id: string + timestamp: number + queue: string + data: any + opts?: JobOptions +} /** * Bull works with a Job wrapper around all messages that contains a lot more information about @@ -10,12 +19,13 @@ import { timeout } from "../utils" * @returns A new job which can now be put onto the queue, this is mostly an * internal structure so that an in memory queue can be easily swapped for a Bull queue. */ -function newJob(queue: string, message: any) { +function newJob(queue: string, message: any, opts?: JobOptions): JobMessage { return { + id: newid(), timestamp: Date.now(), queue: queue, data: message, - opts: {}, + opts, } } @@ -24,26 +34,29 @@ function newJob(queue: string, message: any) { * It is relatively simple, using an event emitter internally to register when messages are available * to the consumers - in can support many inputs and many consumers. */ -class InMemoryQueue { +class InMemoryQueue implements Partial { _name: string - _opts?: any - _messages: any[] - _emitter: EventEmitter + _opts?: QueueOptions + _messages: JobMessage[] + _queuedJobIds: Set + _emitter: NodeJS.EventEmitter _runCount: number _addCount: number + /** * The constructor the queue, exactly the same as that of Bulls. * @param name The name of the queue which is being configured. * @param opts This is not used by the in memory queue as there is no real use * case when in memory, but is the same API as Bull */ - constructor(name: string, opts?: any) { + constructor(name: string, opts?: QueueOptions) { this._name = name this._opts = opts this._messages = [] this._emitter = new events.EventEmitter() this._runCount = 0 this._addCount = 0 + this._queuedJobIds = new Set() } /** @@ -55,22 +68,42 @@ class InMemoryQueue { * note this is incredibly limited compared to Bull as in reality the Job would contain * a lot more information about the queue and current status of Bull cluster. */ - process(func: any) { + async process(func: any) { this._emitter.on("message", async () => { if (this._messages.length <= 0) { return } let msg = this._messages.shift() + let resp = func(msg) + + async function retryFunc(fnc: any) { + try { + await fnc + } catch (e: any) { + await new Promise(r => setTimeout(() => r(), 50)) + + await retryFunc(func(msg)) + } + } + if (resp.then != null) { - await resp + try { + await retryFunc(resp) + } catch (e: any) { + console.error(e) + } } this._runCount++ + const jobId = msg?.opts?.jobId?.toString() + if (jobId && msg?.opts?.removeOnComplete) { + this._queuedJobIds.delete(jobId) + } }) } async isReady() { - return true + return this as any } // simply puts a message to the queue and emits to the queue for processing @@ -83,27 +116,45 @@ class InMemoryQueue { * @param repeat serves no purpose for the import queue. */ // eslint-disable-next-line no-unused-vars - add(msg: any, repeat: boolean) { - if (typeof msg !== "object") { + async add(data: any, opts?: JobOptions) { + const jobId = opts?.jobId?.toString() + if (jobId && this._queuedJobIds.has(jobId)) { + console.log(`Ignoring already queued job ${jobId}`) + return + } + + if (typeof data !== "object") { throw "Queue only supports carrying JSON." } - this._messages.push(newJob(this._name, msg)) - this._addCount++ - this._emitter.emit("message") + if (jobId) { + this._queuedJobIds.add(jobId) + } + + const pushMessage = () => { + this._messages.push(newJob(this._name, data, opts)) + this._addCount++ + this._emitter.emit("message") + } + + const delay = opts?.delay + if (delay) { + setTimeout(pushMessage, delay) + } else { + pushMessage() + } + return {} as any } /** * replicating the close function from bull, which waits for jobs to finish. */ - async close() { - return [] - } + async close() {} /** * This removes a cron which has been implemented, this is part of Bull API. * @param cronJobId The cron which is to be removed. */ - removeRepeatableByKey(cronJobId: string) { + async removeRepeatableByKey(cronJobId: string) { // TODO: implement for testing console.log(cronJobId) } @@ -111,12 +162,12 @@ class InMemoryQueue { /** * Implemented for tests */ - getRepeatableJobs() { + async getRepeatableJobs() { return [] } - // eslint-disable-next-line no-unused-vars - removeJobs(pattern: string) { + // eslint-disable-next-line @typescript-eslint/no-unused-vars + async removeJobs(pattern: string) { // no-op } @@ -128,18 +179,22 @@ class InMemoryQueue { } async getJob() { - return {} + return null } on() { // do nothing - return this + return this as any } async waitForCompletion() { do { await timeout(50) - } while (this._addCount < this._runCount) + } while (this.hasRunningJobs()) + } + + hasRunningJobs() { + return this._addCount > this._runCount } } diff --git a/packages/backend-core/src/queue/listeners.ts b/packages/backend-core/src/queue/listeners.ts index 063a01bd2f..cd25ff2254 100644 --- a/packages/backend-core/src/queue/listeners.ts +++ b/packages/backend-core/src/queue/listeners.ts @@ -88,6 +88,7 @@ enum QueueEventType { AUDIT_LOG_EVENT = "audit-log-event", SYSTEM_EVENT = "system-event", APP_MIGRATION = "app-migration", + DOC_WRITETHROUGH = "doc-writethrough", } const EventTypeMap: { [key in JobQueue]: QueueEventType } = { @@ -96,6 +97,7 @@ const EventTypeMap: { [key in JobQueue]: QueueEventType } = { [JobQueue.AUDIT_LOG]: QueueEventType.AUDIT_LOG_EVENT, [JobQueue.SYSTEM_EVENT_QUEUE]: QueueEventType.SYSTEM_EVENT, [JobQueue.APP_MIGRATION]: QueueEventType.APP_MIGRATION, + [JobQueue.DOC_WRITETHROUGH_QUEUE]: QueueEventType.DOC_WRITETHROUGH, } function logging(queue: Queue, jobQueue: JobQueue) { @@ -130,7 +132,7 @@ function logging(queue: Queue, jobQueue: JobQueue) { // A Job is waiting to be processed as soon as a worker is idling. console.info(...getLogParams(eventType, BullEvent.WAITING, { jobId })) }) - .on(BullEvent.ACTIVE, async (job: Job, jobPromise: any) => { + .on(BullEvent.ACTIVE, async (job: Job) => { // A job has started. You can use `jobPromise.cancel()`` to abort it. await doInJobContext(job, () => { console.info(...getLogParams(eventType, BullEvent.ACTIVE, { job })) diff --git a/packages/backend-core/src/queue/queue.ts b/packages/backend-core/src/queue/queue.ts index 0bcb25a35f..1838eed92f 100644 --- a/packages/backend-core/src/queue/queue.ts +++ b/packages/backend-core/src/queue/queue.ts @@ -7,6 +7,8 @@ import { addListeners, StalledFn } from "./listeners" import { Duration } from "../utils" import * as timers from "../timers" +export { QueueOptions, Queue, JobOptions } from "bull" + // the queue lock is held for 5 minutes const QUEUE_LOCK_MS = Duration.fromMinutes(5).toMs() // queue lock is refreshed every 30 seconds diff --git a/packages/backend-core/src/redis/init.ts b/packages/backend-core/src/redis/init.ts index f3bcee3209..44ba28a83c 100644 --- a/packages/backend-core/src/redis/init.ts +++ b/packages/backend-core/src/redis/init.ts @@ -9,7 +9,8 @@ let userClient: Client, lockClient: Client, socketClient: Client, inviteClient: Client, - passwordResetClient: Client + passwordResetClient: Client, + docWritethroughClient: Client export async function init() { userClient = await new Client(utils.Databases.USER_CACHE).init() @@ -24,6 +25,9 @@ export async function init() { utils.Databases.SOCKET_IO, utils.SelectableDatabase.SOCKET_IO ).init() + docWritethroughClient = await new Client( + utils.Databases.DOC_WRITE_THROUGH + ).init() } export async function shutdown() { @@ -36,6 +40,7 @@ export async function shutdown() { if (inviteClient) await inviteClient.finish() if (passwordResetClient) await passwordResetClient.finish() if (socketClient) await socketClient.finish() + if (docWritethroughClient) await docWritethroughClient.finish() } process.on("exit", async () => { @@ -104,3 +109,10 @@ export async function getPasswordResetClient() { } return passwordResetClient } + +export async function getDocWritethroughClient() { + if (!writethroughClient) { + await init() + } + return writethroughClient +} diff --git a/packages/backend-core/src/redis/redis.ts b/packages/backend-core/src/redis/redis.ts index d15453ba62..79f75421d3 100644 --- a/packages/backend-core/src/redis/redis.ts +++ b/packages/backend-core/src/redis/redis.ts @@ -1,5 +1,5 @@ import env from "../environment" -import Redis from "ioredis" +import Redis, { Cluster } from "ioredis" // mock-redis doesn't have any typing let MockRedis: any | undefined if (env.MOCK_REDIS) { @@ -28,7 +28,7 @@ const DEFAULT_SELECT_DB = SelectableDatabase.DEFAULT // for testing just generate the client once let CLOSED = false -let CLIENTS: { [key: number]: any } = {} +const CLIENTS: Record = {} let CONNECTED = false // mock redis always connected @@ -36,7 +36,7 @@ if (env.MOCK_REDIS) { CONNECTED = true } -function pickClient(selectDb: number): any { +function pickClient(selectDb: number) { return CLIENTS[selectDb] } @@ -201,12 +201,15 @@ class RedisWrapper { key = `${db}${SEPARATOR}${key}` let stream if (CLUSTERED) { - let node = this.getClient().nodes("master") + let node = (this.getClient() as never as Cluster).nodes("master") stream = node[0].scanStream({ match: key + "*", count: 100 }) } else { - stream = this.getClient().scanStream({ match: key + "*", count: 100 }) + stream = (this.getClient() as Redis).scanStream({ + match: key + "*", + count: 100, + }) } - return promisifyStream(stream, this.getClient()) + return promisifyStream(stream, this.getClient() as any) } async keys(pattern: string) { @@ -221,14 +224,16 @@ class RedisWrapper { async get(key: string) { const db = this._db - let response = await this.getClient().get(addDbPrefix(db, key)) + const response = await this.getClient().get(addDbPrefix(db, key)) // overwrite the prefixed key + // @ts-ignore if (response != null && response.key) { + // @ts-ignore response.key = key } // if its not an object just return the response try { - return JSON.parse(response) + return JSON.parse(response!) } catch (err) { return response } @@ -274,13 +279,37 @@ class RedisWrapper { } } + async bulkStore( + data: Record, + expirySeconds: number | null = null + ) { + const client = this.getClient() + + const dataToStore = Object.entries(data).reduce((acc, [key, value]) => { + acc[addDbPrefix(this._db, key)] = + typeof value === "object" ? JSON.stringify(value) : value + return acc + }, {} as Record) + + const pipeline = client.pipeline() + pipeline.mset(dataToStore) + + if (expirySeconds !== null) { + for (const key of Object.keys(dataToStore)) { + pipeline.expire(key, expirySeconds) + } + } + + await pipeline.exec() + } + async getTTL(key: string) { const db = this._db const prefixedKey = addDbPrefix(db, key) return this.getClient().ttl(prefixedKey) } - async setExpiry(key: string, expirySeconds: number | null) { + async setExpiry(key: string, expirySeconds: number) { const db = this._db const prefixedKey = addDbPrefix(db, key) await this.getClient().expire(prefixedKey, expirySeconds) @@ -291,10 +320,35 @@ class RedisWrapper { await this.getClient().del(addDbPrefix(db, key)) } + async bulkDelete(keys: string[]) { + const db = this._db + await this.getClient().del(keys.map(key => addDbPrefix(db, key))) + } + async clear() { let items = await this.scan() await Promise.all(items.map((obj: any) => this.delete(obj.key))) } + + async increment(key: string) { + const result = await this.getClient().incr(addDbPrefix(this._db, key)) + if (isNaN(result)) { + throw new Error(`Redis ${key} does not contain a number`) + } + return result + } + + async deleteIfValue(key: string, value: any) { + const client = this.getClient() + + const luaScript = ` + if redis.call('GET', KEYS[1]) == ARGV[1] then + redis.call('DEL', KEYS[1]) + end + ` + + await client.eval(luaScript, 1, addDbPrefix(this._db, key), value) + } } export default RedisWrapper diff --git a/packages/backend-core/src/redis/redlockImpl.ts b/packages/backend-core/src/redis/redlockImpl.ts index 7009dc6f55..adeb5b12ec 100644 --- a/packages/backend-core/src/redis/redlockImpl.ts +++ b/packages/backend-core/src/redis/redlockImpl.ts @@ -72,7 +72,7 @@ const OPTIONS: Record = { export async function newRedlock(opts: Redlock.Options = {}) { const options = { ...OPTIONS.DEFAULT, ...opts } const redisWrapper = await getLockClient() - const client = redisWrapper.getClient() + const client = redisWrapper.getClient() as any return new Redlock([client], options) } diff --git a/packages/backend-core/src/redis/tests/redis.spec.ts b/packages/backend-core/src/redis/tests/redis.spec.ts new file mode 100644 index 0000000000..4d11caf220 --- /dev/null +++ b/packages/backend-core/src/redis/tests/redis.spec.ts @@ -0,0 +1,203 @@ +import { GenericContainer, StartedTestContainer } from "testcontainers" +import { generator, structures } from "../../../tests" +import RedisWrapper from "../redis" +import { env } from "../.." + +jest.setTimeout(30000) + +describe("redis", () => { + let redis: RedisWrapper + let container: StartedTestContainer + + beforeAll(async () => { + const container = await new GenericContainer("redis") + .withExposedPorts(6379) + .start() + + env._set( + "REDIS_URL", + `${container.getHost()}:${container.getMappedPort(6379)}` + ) + env._set("MOCK_REDIS", 0) + env._set("REDIS_PASSWORD", 0) + }) + + afterAll(() => container?.stop()) + + beforeEach(async () => { + redis = new RedisWrapper(structures.db.id()) + await redis.init() + }) + + describe("store", () => { + it("a basic value can be persisted", async () => { + const key = structures.uuid() + const value = generator.word() + + await redis.store(key, value) + + expect(await redis.get(key)).toEqual(value) + }) + + it("objects can be persisted", async () => { + const key = structures.uuid() + const value = { [generator.word()]: generator.word() } + + await redis.store(key, value) + + expect(await redis.get(key)).toEqual(value) + }) + }) + + describe("bulkStore", () => { + function createRandomObject( + keyLength: number, + valueGenerator: () => any = () => generator.word() + ) { + return generator + .unique(() => generator.word(), keyLength) + .reduce((acc, key) => { + acc[key] = valueGenerator() + return acc + }, {} as Record) + } + + it("a basic object can be persisted", async () => { + const data = createRandomObject(10) + + await redis.bulkStore(data) + + for (const [key, value] of Object.entries(data)) { + expect(await redis.get(key)).toEqual(value) + } + + expect(await redis.keys("*")).toHaveLength(10) + }) + + it("a complex object can be persisted", async () => { + const data = { + ...createRandomObject(10, () => createRandomObject(5)), + ...createRandomObject(5), + } + + await redis.bulkStore(data) + + for (const [key, value] of Object.entries(data)) { + expect(await redis.get(key)).toEqual(value) + } + + expect(await redis.keys("*")).toHaveLength(15) + }) + + it("no TTL is set by default", async () => { + const data = createRandomObject(10) + + await redis.bulkStore(data) + + for (const [key, value] of Object.entries(data)) { + expect(await redis.get(key)).toEqual(value) + expect(await redis.getTTL(key)).toEqual(-1) + } + }) + + it("a bulk store can be persisted with TTL", async () => { + const ttl = 500 + const data = createRandomObject(8) + + await redis.bulkStore(data, ttl) + + for (const [key, value] of Object.entries(data)) { + expect(await redis.get(key)).toEqual(value) + expect(await redis.getTTL(key)).toEqual(ttl) + } + + expect(await redis.keys("*")).toHaveLength(8) + }) + + it("setting a TTL of -1 will not persist the key", async () => { + const ttl = -1 + const data = createRandomObject(5) + + await redis.bulkStore(data, ttl) + + for (const key of Object.keys(data)) { + expect(await redis.get(key)).toBe(null) + } + + expect(await redis.keys("*")).toHaveLength(0) + }) + }) + + describe("increment", () => { + it("can increment on a new key", async () => { + const key = structures.uuid() + const result = await redis.increment(key) + expect(result).toBe(1) + }) + + it("can increment multiple times", async () => { + const key = structures.uuid() + const results = [ + await redis.increment(key), + await redis.increment(key), + await redis.increment(key), + await redis.increment(key), + await redis.increment(key), + ] + expect(results).toEqual([1, 2, 3, 4, 5]) + }) + + it("can increment multiple times in parallel", async () => { + const key = structures.uuid() + const results = await Promise.all( + Array.from({ length: 100 }).map(() => redis.increment(key)) + ) + expect(results).toHaveLength(100) + expect(results).toEqual(Array.from({ length: 100 }).map((_, i) => i + 1)) + }) + + it("can increment existing set keys", async () => { + const key = structures.uuid() + await redis.store(key, 70) + await redis.increment(key) + + const result = await redis.increment(key) + expect(result).toBe(72) + }) + + it.each([ + generator.word(), + generator.bool(), + { [generator.word()]: generator.word() }, + ])("cannot increment if the store value is not a number", async value => { + const key = structures.uuid() + await redis.store(key, value) + + await expect(redis.increment(key)).rejects.toThrow( + "ERR value is not an integer or out of range" + ) + }) + }) + + describe("deleteIfValue", () => { + it("can delete if the value matches", async () => { + const key = structures.uuid() + const value = generator.word() + await redis.store(key, value) + + await redis.deleteIfValue(key, value) + + expect(await redis.get(key)).toBeNull() + }) + + it("will not delete if the value does not matches", async () => { + const key = structures.uuid() + const value = generator.word() + await redis.store(key, value) + + await redis.deleteIfValue(key, generator.word()) + + expect(await redis.get(key)).toEqual(value) + }) + }) +}) diff --git a/packages/backend-core/src/redis/tests/redlockImpl.spec.ts b/packages/backend-core/src/redis/tests/redlockImpl.spec.ts index a1e83d8e6c..e647b63bf5 100644 --- a/packages/backend-core/src/redis/tests/redlockImpl.spec.ts +++ b/packages/backend-core/src/redis/tests/redlockImpl.spec.ts @@ -96,8 +96,8 @@ describe("redlockImpl", () => { task: mockTask, executionTimeMs: lockTtl * 2, }) - ).rejects.toThrowError( - `Unable to fully release the lock on resource \"lock:${config.tenantId}_persist_writethrough\".` + ).rejects.toThrow( + `Unable to fully release the lock on resource "lock:${config.tenantId}_persist_writethrough".` ) } ) diff --git a/packages/backend-core/src/redis/utils.ts b/packages/backend-core/src/redis/utils.ts index 7b93458b52..7f84f11467 100644 --- a/packages/backend-core/src/redis/utils.ts +++ b/packages/backend-core/src/redis/utils.ts @@ -30,6 +30,7 @@ export enum Databases { LOCKS = "locks", SOCKET_IO = "socket_io", BPM_EVENTS = "bpmEvents", + DOC_WRITE_THROUGH = "docWriteThrough", } /** diff --git a/packages/backend-core/src/security/roles.ts b/packages/backend-core/src/security/roles.ts index 01473ad991..a64be6b319 100644 --- a/packages/backend-core/src/security/roles.ts +++ b/packages/backend-core/src/security/roles.ts @@ -101,10 +101,7 @@ export function getBuiltinRole(roleId: string): Role | undefined { /** * Works through the inheritance ranks to see how far up the builtin stack this ID is. */ -export function builtinRoleToNumber(id?: string) { - if (!id) { - return 0 - } +export function builtinRoleToNumber(id: string) { const builtins = getBuiltinRoles() const MAX = Object.values(builtins).length + 1 if (id === BUILTIN_IDS.ADMIN || id === BUILTIN_IDS.BUILDER) { diff --git a/packages/backend-core/src/tenancy/tests/tenancy.spec.ts b/packages/backend-core/src/tenancy/tests/tenancy.spec.ts index 95dd76a6dd..34e9f87064 100644 --- a/packages/backend-core/src/tenancy/tests/tenancy.spec.ts +++ b/packages/backend-core/src/tenancy/tests/tenancy.spec.ts @@ -158,8 +158,8 @@ describe("getTenantIDFromCtx", () => { ], } expect(getTenantIDFromCtx(ctx, mockOpts)).toBeUndefined() - expect(ctx.throw).toBeCalledTimes(1) - expect(ctx.throw).toBeCalledWith(403, "Tenant id not set") + expect(ctx.throw).toHaveBeenCalledTimes(1) + expect(ctx.throw).toHaveBeenCalledWith(403, "Tenant id not set") }) it("returns undefined if allowNoTenant is true", () => { diff --git a/packages/backend-core/src/timers/timers.ts b/packages/backend-core/src/timers/timers.ts index 9121c576cd..000be74821 100644 --- a/packages/backend-core/src/timers/timers.ts +++ b/packages/backend-core/src/timers/timers.ts @@ -20,41 +20,3 @@ export function cleanup() { } intervals = [] } - -export class ExecutionTimeoutError extends Error { - public readonly name = "ExecutionTimeoutError" -} - -export class ExecutionTimeTracker { - static withLimit(limitMs: number) { - return new ExecutionTimeTracker(limitMs) - } - - constructor(readonly limitMs: number) {} - - private totalTimeMs = 0 - - track(f: () => T): T { - this.checkLimit() - const start = process.hrtime.bigint() - try { - return f() - } finally { - const end = process.hrtime.bigint() - this.totalTimeMs += Number(end - start) / 1e6 - this.checkLimit() - } - } - - get elapsedMS() { - return this.totalTimeMs - } - - checkLimit() { - if (this.totalTimeMs > this.limitMs) { - throw new ExecutionTimeoutError( - `Execution time limit of ${this.limitMs}ms exceeded: ${this.totalTimeMs}ms` - ) - } - } -} diff --git a/packages/backend-core/src/users/test/utils.spec.ts b/packages/backend-core/src/users/test/utils.spec.ts index 0fe27f57a6..cb98b8972b 100644 --- a/packages/backend-core/src/users/test/utils.spec.ts +++ b/packages/backend-core/src/users/test/utils.spec.ts @@ -45,7 +45,7 @@ describe("Users", () => { ...{ _id: groupId, roles: { app1: "ADMIN" } }, } const users: User[] = [] - for (const _ of Array.from({ length: usersInGroup })) { + for (let i = 0; i < usersInGroup; i++) { const userId = `us_${generator.guid()}` const user: User = structures.users.user({ _id: userId, diff --git a/packages/backend-core/tests/core/utilities/mocks/events.ts b/packages/backend-core/tests/core/utilities/mocks/events.ts index fef730768a..96f351de10 100644 --- a/packages/backend-core/tests/core/utilities/mocks/events.ts +++ b/packages/backend-core/tests/core/utilities/mocks/events.ts @@ -15,6 +15,7 @@ beforeAll(async () => { jest.spyOn(events.app, "created") jest.spyOn(events.app, "updated") + jest.spyOn(events.app, "duplicated") jest.spyOn(events.app, "deleted") jest.spyOn(events.app, "published") jest.spyOn(events.app, "unpublished") diff --git a/packages/backend-core/tests/core/utilities/structures/accounts.ts b/packages/backend-core/tests/core/utilities/structures/accounts.ts index 515f94db1e..7dcc2de116 100644 --- a/packages/backend-core/tests/core/utilities/structures/accounts.ts +++ b/packages/backend-core/tests/core/utilities/structures/accounts.ts @@ -18,7 +18,7 @@ export const account = (partial: Partial = {}): Account => { return { accountId: uuid(), tenantId: generator.word(), - email: generator.email(), + email: generator.email({ domain: "example.com" }), tenantName: generator.word(), hosting: Hosting.SELF, createdAt: Date.now(), diff --git a/packages/backend-core/tests/core/utilities/structures/scim.ts b/packages/backend-core/tests/core/utilities/structures/scim.ts index 80f41c605d..f424b2881a 100644 --- a/packages/backend-core/tests/core/utilities/structures/scim.ts +++ b/packages/backend-core/tests/core/utilities/structures/scim.ts @@ -13,7 +13,7 @@ interface CreateUserRequestFields { export function createUserRequest(userData?: Partial) { const defaultValues = { externalId: uuid(), - email: generator.email(), + email: `${uuid()}@example.com`, firstName: generator.first(), lastName: generator.last(), username: generator.name(), diff --git a/packages/backend-core/tests/core/utilities/structures/userGroups.ts b/packages/backend-core/tests/core/utilities/structures/userGroups.ts index 4dc870a00a..4af3f72e51 100644 --- a/packages/backend-core/tests/core/utilities/structures/userGroups.ts +++ b/packages/backend-core/tests/core/utilities/structures/userGroups.ts @@ -3,7 +3,7 @@ import { generator } from "./generator" export function userGroup(): UserGroup { return { - name: generator.word(), + name: generator.guid(), icon: generator.word(), color: generator.word(), } diff --git a/packages/bbui/src/ActionMenu/ActionMenu.svelte b/packages/bbui/src/ActionMenu/ActionMenu.svelte index 642ec4932a..c55d1cb43d 100644 --- a/packages/bbui/src/ActionMenu/ActionMenu.svelte +++ b/packages/bbui/src/ActionMenu/ActionMenu.svelte @@ -38,7 +38,7 @@
- + diff --git a/packages/bbui/src/Actions/click_outside.js b/packages/bbui/src/Actions/click_outside.js index 1961dca47c..eafca657f3 100644 --- a/packages/bbui/src/Actions/click_outside.js +++ b/packages/bbui/src/Actions/click_outside.js @@ -32,19 +32,30 @@ const handleClick = event => { return } + // Ignore clicks for drawers, unless the handler is registered from a drawer + const sourceInDrawer = handler.anchor.closest(".drawer-wrapper") != null + const clickInDrawer = event.target.closest(".drawer-wrapper") != null + if (clickInDrawer && !sourceInDrawer) { + return + } + + if (handler.allowedType && event.type !== handler.allowedType) { + return + } + handler.callback?.(event) }) } document.documentElement.addEventListener("click", handleClick, true) -document.documentElement.addEventListener("contextmenu", handleClick, true) +document.documentElement.addEventListener("mousedown", handleClick, true) /** * Adds or updates a click handler */ -const updateHandler = (id, element, anchor, callback) => { +const updateHandler = (id, element, anchor, callback, allowedType) => { let existingHandler = clickHandlers.find(x => x.id === id) if (!existingHandler) { - clickHandlers.push({ id, element, anchor, callback }) + clickHandlers.push({ id, element, anchor, callback, allowedType }) } else { existingHandler.callback = callback } @@ -68,9 +79,11 @@ const removeHandler = id => { export default (element, opts) => { const id = Math.random() const update = newOpts => { - const callback = newOpts?.callback || newOpts + const callback = + newOpts?.callback || (typeof newOpts === "function" ? newOpts : null) const anchor = newOpts?.anchor || element - updateHandler(id, element, anchor, callback) + const allowedType = newOpts?.allowedType || "click" + updateHandler(id, element, anchor, callback, allowedType) } update(opts) return { diff --git a/packages/bbui/src/Actions/position_dropdown.js b/packages/bbui/src/Actions/position_dropdown.js index cc169eac09..770d1bd507 100644 --- a/packages/bbui/src/Actions/position_dropdown.js +++ b/packages/bbui/src/Actions/position_dropdown.js @@ -15,6 +15,7 @@ export default function positionDropdown(element, opts) { align, maxHeight, maxWidth, + minWidth, useAnchorWidth, offset = 5, customUpdate, @@ -28,18 +29,26 @@ export default function positionDropdown(element, opts) { const elementBounds = element.getBoundingClientRect() let styles = { maxHeight: null, - minWidth: null, + minWidth, maxWidth, left: null, top: null, } if (typeof customUpdate === "function") { - styles = customUpdate(anchorBounds, elementBounds, styles) + styles = customUpdate(anchorBounds, elementBounds, { + ...styles, + offset: opts.offset, + }) } else { // Determine vertical styles - if (align === "right-outside") { - styles.top = anchorBounds.top + if (align === "right-outside" || align === "left-outside") { + styles.top = + anchorBounds.top + anchorBounds.height / 2 - elementBounds.height / 2 + styles.maxHeight = maxHeight + if (styles.top + elementBounds.height > window.innerHeight) { + styles.top = window.innerHeight - elementBounds.height + } } else if ( window.innerHeight - anchorBounds.bottom < (maxHeight || 100) diff --git a/packages/bbui/src/Drawer/Drawer.svelte b/packages/bbui/src/Drawer/Drawer.svelte index 8976bfb81e..89ee92726d 100644 --- a/packages/bbui/src/Drawer/Drawer.svelte +++ b/packages/bbui/src/Drawer/Drawer.svelte @@ -1,28 +1,111 @@ + + {#if visible} - -
- {#if !headless} + + +
+
+
0} + class:modal={$modal} + transition:drawerSlide|local + {style} + >
-
- {title} - - - -
+ {#if $$slots.title} + + {:else} +
{title || "Bindings"}
+ {/if}
+ {#if $resizable} + modal.set(!$modal)} + > + + + {/if}
- {/if} - -
+ +
+
+ {/if} diff --git a/packages/bbui/src/Drawer/DrawerContent.svelte b/packages/bbui/src/Drawer/DrawerContent.svelte index 944a3f4313..f7345afb11 100644 --- a/packages/bbui/src/Drawer/DrawerContent.svelte +++ b/packages/bbui/src/Drawer/DrawerContent.svelte @@ -1,4 +1,8 @@ -
+ + +
{#if $$slots.sidebar}
@@ -13,8 +17,8 @@ diff --git a/packages/bbui/src/Modal/Modal.svelte b/packages/bbui/src/Modal/Modal.svelte index f891d0584d..be9c338892 100644 --- a/packages/bbui/src/Modal/Modal.svelte +++ b/packages/bbui/src/Modal/Modal.svelte @@ -10,6 +10,7 @@ export let inline = false export let disableCancel = false export let autoFocus = true + export let zIndex = 999 const dispatch = createEventDispatcher() let visible = fixed || inline @@ -101,7 +102,11 @@ {#if visible} -
+
diff --git a/packages/bbui/src/Table/CellRenderer.svelte b/packages/bbui/src/Table/CellRenderer.svelte index 4ad6e22d7e..eff1178f6d 100644 --- a/packages/bbui/src/Table/CellRenderer.svelte +++ b/packages/bbui/src/Table/CellRenderer.svelte @@ -12,6 +12,7 @@ export let schema export let value export let customRenderers = [] + export let snippets let renderer const typeMap = { @@ -44,7 +45,7 @@ if (!template) { return value } - return processStringSync(template, { value }) + return processStringSync(template, { value, snippets }) } diff --git a/packages/bbui/src/Table/Table.svelte b/packages/bbui/src/Table/Table.svelte index 36668571bc..868f7b3a0b 100644 --- a/packages/bbui/src/Table/Table.svelte +++ b/packages/bbui/src/Table/Table.svelte @@ -42,6 +42,7 @@ export let customPlaceholder = false export let showHeaderBorder = true export let placeholderText = "No rows found" + export let snippets = [] const dispatch = createEventDispatcher() @@ -425,6 +426,7 @@ @@ -118,6 +120,9 @@ .abs-tooltip { display: contents; } + .spectrum-Tooltip.noWrap .spectrum-Tooltip-label { + width: max-content; + } .spectrum-Tooltip { position: absolute; z-index: 9999; diff --git a/packages/bbui/src/index.js b/packages/bbui/src/index.js index cda6b5acbf..d18c4d6910 100644 --- a/packages/bbui/src/index.js +++ b/packages/bbui/src/index.js @@ -19,7 +19,7 @@ export { default as ActionMenu } from "./ActionMenu/ActionMenu.svelte" export { default as Button } from "./Button/Button.svelte" export { default as ButtonGroup } from "./ButtonGroup/ButtonGroup.svelte" export { default as ClearButton } from "./ClearButton/ClearButton.svelte" -export { default as Icon, directions } from "./Icon/Icon.svelte" +export { default as Icon } from "./Icon/Icon.svelte" export { default as IconAvatar } from "./Icon/IconAvatar.svelte" export { default as Toggle } from "./Form/Toggle.svelte" export { default as RadioGroup } from "./Form/RadioGroup.svelte" diff --git a/packages/builder/package.json b/packages/builder/package.json index e66c747505..f61ac4fe26 100644 --- a/packages/builder/package.json +++ b/packages/builder/package.json @@ -66,10 +66,11 @@ "@spectrum-css/page": "^3.0.1", "@spectrum-css/vars": "^3.0.1", "@zerodevx/svelte-json-view": "^1.0.7", - "codemirror": "^5.59.0", + "codemirror": "^5.65.16", "dayjs": "^1.10.8", "downloadjs": "1.4.7", "fast-json-patch": "^3.1.1", + "json-format-highlight": "^1.0.4", "lodash": "4.17.21", "posthog-js": "^1.36.0", "remixicon": "2.5.0", diff --git a/packages/builder/src/analytics/index.js b/packages/builder/src/analytics/index.js index 6bb10acdb5..3a80a05d7f 100644 --- a/packages/builder/src/analytics/index.js +++ b/packages/builder/src/analytics/index.js @@ -9,13 +9,17 @@ const intercom = new IntercomClient(process.env.INTERCOM_TOKEN) class AnalyticsHub { constructor() { this.clients = [posthog, intercom] + this.initialised = false } async activate() { // Check analytics are enabled const analyticsStatus = await API.getAnalyticsStatus() - if (analyticsStatus.enabled) { - this.clients.forEach(client => client.init()) + if (analyticsStatus.enabled && !this.initialised) { + this.clients.forEach(client => { + client.init() + }) + this.initialised = true } } diff --git a/packages/builder/src/components/automation/AutomationPanel/AutomationPanel.svelte b/packages/builder/src/components/automation/AutomationPanel/AutomationPanel.svelte index 582db950fe..ac1c4f91cb 100644 --- a/packages/builder/src/components/automation/AutomationPanel/AutomationPanel.svelte +++ b/packages/builder/src/components/automation/AutomationPanel/AutomationPanel.svelte @@ -49,7 +49,7 @@
modal.show()} /> diff --git a/packages/builder/src/components/automation/SetupPanel/AutomationBlockSetup.svelte b/packages/builder/src/components/automation/SetupPanel/AutomationBlockSetup.svelte index 707317f9e6..7fa2401c88 100644 --- a/packages/builder/src/components/automation/SetupPanel/AutomationBlockSetup.svelte +++ b/packages/builder/src/components/automation/SetupPanel/AutomationBlockSetup.svelte @@ -12,7 +12,6 @@ Drawer, Modal, notifications, - Icon, Checkbox, DatePicker, } from "@budibase/bbui" @@ -31,7 +30,7 @@ import Editor from "components/integration/QueryEditor.svelte" import ModalBindableInput from "components/common/bindings/ModalBindableInput.svelte" import CodeEditor from "components/common/CodeEditor/CodeEditor.svelte" - import BindingPicker from "components/common/bindings/BindingPicker.svelte" + import BindingSidePanel from "components/common/bindings/BindingSidePanel.svelte" import { BindingHelpers } from "components/common/bindings/utils" import { bindingsToCompletions, @@ -52,11 +51,12 @@ export let testData export let schemaProperties export let isTestModal = false + let webhookModal let drawer - let fillWidth = true let inputData let insertAtPos, getCaretPosition + $: filters = lookForFilters(schemaProperties) || [] $: tempFilters = filters $: stepId = block.stepId @@ -80,7 +80,6 @@ }) $: editingJs = codeMode === EditorModes.JS $: requiredProperties = block.schema.inputs.required || [] - $: stepCompletions = codeMode === EditorModes.Handlebars ? [hbAutocomplete([...bindingsToCompletions(bindings, codeMode)])] @@ -377,12 +376,13 @@
{#each schemaProperties as [key, value]} {#if canShowField(key, value)} + {@const label = getFieldLabel(key, value)}
{#if key !== "fields" && value.type !== "boolean" && shouldRenderField(value)} {label} {/if}
@@ -415,8 +415,7 @@
{:else if value.type === "date"} {:else if value.customType === "filters"} Define filters - + @@ -450,7 +449,6 @@ {schemaFields} datasource={{ type: "table", tableId }} panel={AutomationBindingPanel} - fillWidth on:change={e => (tempFilters = e.detail)} /> @@ -463,19 +461,17 @@ {:else if value.customType === "email"} {#if isTestModal} onChange(e, key)} {bindings} - fillWidth updateOnChange={false} /> {:else}
-
+
{ @@ -563,24 +559,14 @@ autocompleteEnabled={codeMode !== EditorModes.JS} bind:getCaretPosition bind:insertAtPos - height={500} + placeholder={codeMode === EditorModes.Handlebars + ? "Add bindings by typing {{" + : null} /> -
- {#if codeMode === EditorModes.Handlebars} - -
-
- Add available bindings by typing - }} - -
-
- {/if} -
{#if editingJs}
- @@ -609,7 +595,7 @@ {:else if value.type === "string" || value.type === "number" || value.type === "integer"} {#if isTestModal} onChange(e, field)} type="string" {bindings} - fillWidth={true} updateOnChange={false} />
diff --git a/packages/builder/src/components/automation/SetupPanel/QueryParamSelector.svelte b/packages/builder/src/components/automation/SetupPanel/QueryParamSelector.svelte index 4674002d61..f46bca3090 100644 --- a/packages/builder/src/components/automation/SetupPanel/QueryParamSelector.svelte +++ b/packages/builder/src/components/automation/SetupPanel/QueryParamSelector.svelte @@ -52,7 +52,6 @@ on:change={e => onChange(e, field)} type="string" {bindings} - fillWidth={true} updateOnChange={false} />
diff --git a/packages/builder/src/components/automation/SetupPanel/RowSelector.svelte b/packages/builder/src/components/automation/SetupPanel/RowSelector.svelte index 6cc96d8c68..0d15df6c87 100644 --- a/packages/builder/src/components/automation/SetupPanel/RowSelector.svelte +++ b/packages/builder/src/components/automation/SetupPanel/RowSelector.svelte @@ -129,8 +129,7 @@ /> {:else} onChange(e, field)} type="string" bindings={parsedBindings} - fillWidth={true} allowJS={true} updateOnChange={false} + title={schema.name} /> {/if} diff --git a/packages/builder/src/components/backend/DataTable/modals/CreateEditColumn.svelte b/packages/builder/src/components/backend/DataTable/modals/CreateEditColumn.svelte index 1bad1ee221..cfc6e9a7be 100644 --- a/packages/builder/src/components/backend/DataTable/modals/CreateEditColumn.svelte +++ b/packages/builder/src/components/backend/DataTable/modals/CreateEditColumn.svelte @@ -36,6 +36,8 @@ import { ValidColumnNameRegex } from "@budibase/shared-core" import { FieldType, FieldSubtype, SourceName } from "@budibase/types" import RelationshipSelector from "components/common/RelationshipSelector.svelte" + import { RowUtils } from "@budibase/frontend-core" + import ServerBindingPanel from "components/common/bindings/ServerBindingPanel.svelte" const AUTO_TYPE = FIELDS.AUTO.type const FORMULA_TYPE = FIELDS.FORMULA.type @@ -49,43 +51,21 @@ const dispatch = createEventDispatcher() const PROHIBITED_COLUMN_NAMES = ["type", "_id", "_rev", "tableId"] - const { dispatch: gridDispatch } = getContext("grid") + const { dispatch: gridDispatch, rows } = getContext("grid") export let field let mounted = false - const fieldDefinitions = Object.values(FIELDS).reduce( - // Storing the fields by complex field id - (acc, field) => ({ - ...acc, - [makeFieldId(field.type, field.subtype)]: field, - }), - {} - ) - - function makeFieldId(type, subtype, autocolumn) { - // don't make field IDs for auto types - if (type === AUTO_TYPE || autocolumn) { - return type.toUpperCase() - } else { - return `${type}${subtype || ""}`.toUpperCase() - } - } - let originalName let linkEditDisabled let primaryDisplay let indexes = [...($tables.selected.indexes || [])] let isCreating = undefined - let relationshipPart1 = PrettyRelationshipDefinitions.Many let relationshipPart2 = PrettyRelationshipDefinitions.One - let relationshipTableIdPrimary = null let relationshipTableIdSecondary = null - let table = $tables.selected - let confirmDeleteDialog let savingColumn let deleteColName @@ -99,11 +79,6 @@ } let relationshipOpts1 = Object.values(PrettyRelationshipDefinitions) let relationshipOpts2 = Object.values(PrettyRelationshipDefinitions) - - $: if (primaryDisplay) { - editableColumn.constraints.presence = { allowEmpty: false } - } - let relationshipMap = { [RelationshipType.ONE_TO_MANY]: { part1: PrettyRelationshipDefinitions.MANY, @@ -118,7 +93,12 @@ part2: PrettyRelationshipDefinitions.MANY, }, } + let autoColumnInfo = getAutoColumnInformation() + $: rowGoldenSample = RowUtils.generateGoldenSample($rows) + $: if (primaryDisplay) { + editableColumn.constraints.presence = { allowEmpty: false } + } $: { // this parses any changes the user has made when creating a new internal relationship // into what we expect the schema to look like @@ -148,6 +128,76 @@ editableColumn.tableId = relationshipTableIdSecondary } } + $: initialiseField(field, savingColumn) + $: checkConstraints(editableColumn) + $: required = !!editableColumn?.constraints?.presence || primaryDisplay + $: uneditable = + $tables.selected?._id === TableNames.USERS && + UNEDITABLE_USER_FIELDS.includes(editableColumn.name) + $: invalid = + !editableColumn?.name || + (editableColumn?.type === LINK_TYPE && !editableColumn?.tableId) || + Object.keys(errors).length !== 0 + $: errors = checkErrors(editableColumn) + $: datasource = $datasources.list.find( + source => source._id === table?.sourceId + ) + $: tableAutoColumnsTypes = getTableAutoColumnTypes($tables?.selected) + $: availableAutoColumns = Object.keys(autoColumnInfo).reduce((acc, key) => { + if (!tableAutoColumnsTypes.includes(key)) { + acc[key] = autoColumnInfo[key] + } + return acc + }, {}) + $: availableAutoColumnKeys = availableAutoColumns + ? Object.keys(availableAutoColumns) + : [] + $: autoColumnOptions = editableColumn.autocolumn + ? autoColumnInfo + : availableAutoColumns + // used to select what different options can be displayed for column type + $: canBeDisplay = + editableColumn?.type !== LINK_TYPE && + editableColumn?.type !== AUTO_TYPE && + editableColumn?.type !== JSON_TYPE && + !editableColumn.autocolumn + $: canBeRequired = + editableColumn?.type !== LINK_TYPE && + !uneditable && + editableColumn?.type !== AUTO_TYPE && + !editableColumn.autocolumn + $: externalTable = table.sourceType === DB_TYPE_EXTERNAL + // in the case of internal tables the sourceId will just be undefined + $: tableOptions = $tables.list.filter( + opt => + opt.sourceType === table.sourceType && table.sourceId === opt.sourceId + ) + $: typeEnabled = + !originalName || + (originalName && + SWITCHABLE_TYPES.indexOf(editableColumn.type) !== -1 && + !editableColumn?.autocolumn) + + const fieldDefinitions = Object.values(FIELDS).reduce( + // Storing the fields by complex field id + (acc, field) => ({ + ...acc, + [makeFieldId(field.type, field.subtype)]: field, + }), + {} + ) + + function makeFieldId(type, subtype, autocolumn) { + // don't make field IDs for auto types + if (type === AUTO_TYPE || autocolumn) { + return type.toUpperCase() + } else if (type === FieldType.BB_REFERENCE) { + return `${type}${subtype || ""}`.toUpperCase() + } else { + return type.toUpperCase() + } + } + const initialiseField = (field, savingColumn) => { isCreating = !field if (field && !savingColumn) { @@ -187,22 +237,6 @@ } } - $: initialiseField(field, savingColumn) - - $: checkConstraints(editableColumn) - $: required = !!editableColumn?.constraints?.presence || primaryDisplay - $: uneditable = - $tables.selected?._id === TableNames.USERS && - UNEDITABLE_USER_FIELDS.includes(editableColumn.name) - $: invalid = - !editableColumn?.name || - (editableColumn?.type === LINK_TYPE && !editableColumn?.tableId) || - Object.keys(errors).length !== 0 - $: errors = checkErrors(editableColumn) - $: datasource = $datasources.list.find( - source => source._id === table?.sourceId - ) - const getTableAutoColumnTypes = table => { return Object.keys(table?.schema).reduce((acc, key) => { let fieldSchema = table?.schema[key] @@ -213,47 +247,6 @@ }, []) } - let autoColumnInfo = getAutoColumnInformation() - - $: tableAutoColumnsTypes = getTableAutoColumnTypes($tables?.selected) - $: availableAutoColumns = Object.keys(autoColumnInfo).reduce((acc, key) => { - if (!tableAutoColumnsTypes.includes(key)) { - acc[key] = autoColumnInfo[key] - } - return acc - }, {}) - - $: availableAutoColumnKeys = availableAutoColumns - ? Object.keys(availableAutoColumns) - : [] - - $: autoColumnOptions = editableColumn.autocolumn - ? autoColumnInfo - : availableAutoColumns - - // used to select what different options can be displayed for column type - $: canBeDisplay = - editableColumn?.type !== LINK_TYPE && - editableColumn?.type !== AUTO_TYPE && - editableColumn?.type !== JSON_TYPE && - !editableColumn.autocolumn - $: canBeRequired = - editableColumn?.type !== LINK_TYPE && - !uneditable && - editableColumn?.type !== AUTO_TYPE && - !editableColumn.autocolumn - $: externalTable = table.sourceType === DB_TYPE_EXTERNAL - // in the case of internal tables the sourceId will just be undefined - $: tableOptions = $tables.list.filter( - opt => - opt.sourceType === table.sourceType && table.sourceId === opt.sourceId - ) - $: typeEnabled = - !originalName || - (originalName && - SWITCHABLE_TYPES.indexOf(editableColumn.type) !== -1 && - !editableColumn?.autocolumn) - async function saveColumn() { savingColumn = true if (errors?.length) { @@ -479,7 +472,7 @@ newError.name = `Column name already in use.` } - if (fieldInfo.type === "auto" && !fieldInfo.subtype) { + if (fieldInfo.type === FieldType.AUTO && !fieldInfo.subtype) { newError.subtype = `Auto Column requires a type` } @@ -540,18 +533,18 @@ }} /> - {#if editableColumn.type === "string"} + {#if editableColumn.type === FieldType.STRING} - {:else if editableColumn.type === "options"} + {:else if editableColumn.type === FieldType.OPTIONS} - {:else if editableColumn.type === "longform"} + {:else if editableColumn.type === FieldType.LONGFORM}
@@ -569,12 +562,12 @@ text="Enable rich text support (markdown)" />
- {:else if editableColumn.type === "array"} + {:else if editableColumn.type === FieldType.ARRAY} - {:else if editableColumn.type === "datetime" && !editableColumn.autocolumn} + {:else if editableColumn.type === FieldType.DATETIME && !editableColumn.autocolumn}
@@ -613,7 +606,7 @@
{/if} - {:else if editableColumn.type === "number" && !editableColumn.autocolumn} + {:else if editableColumn.type === FieldType.NUMBER && !editableColumn.autocolumn}
@@ -638,7 +631,7 @@ />
- {:else if editableColumn.type === "link"} + {:else if editableColumn.type === FieldType.LINK}
{ @@ -689,6 +683,7 @@ }} bindings={getBindings({ table })} allowJS + context={rowGoldenSample} />
diff --git a/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte b/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte index 6b9524776c..b54ecbf9fd 100644 --- a/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte +++ b/packages/builder/src/components/backend/Datasources/CreateEditRelationship.svelte @@ -40,8 +40,15 @@ part2: PrettyRelationshipDefinitions.MANY, }, } - let relationshipOpts1 = Object.values(PrettyRelationshipDefinitions) - let relationshipOpts2 = Object.values(PrettyRelationshipDefinitions) + $: relationshipOpts1 = + relationshipPart2 === PrettyRelationshipDefinitions.ONE + ? [PrettyRelationshipDefinitions.MANY] + : Object.values(PrettyRelationshipDefinitions) + + $: relationshipOpts2 = + relationshipPart1 === PrettyRelationshipDefinitions.ONE + ? [PrettyRelationshipDefinitions.MANY] + : Object.values(PrettyRelationshipDefinitions) let relationshipPart1 = PrettyRelationshipDefinitions.ONE let relationshipPart2 = PrettyRelationshipDefinitions.MANY diff --git a/packages/builder/src/components/backend/TableNavigator/popovers/EditTablePopover.svelte b/packages/builder/src/components/backend/TableNavigator/popovers/EditTablePopover.svelte index c2cda1f2d8..f2c726c8bf 100644 --- a/packages/builder/src/components/backend/TableNavigator/popovers/EditTablePopover.svelte +++ b/packages/builder/src/components/backend/TableNavigator/popovers/EditTablePopover.svelte @@ -28,7 +28,6 @@ let deleteTableName $: externalTable = table?.sourceType === DB_TYPE_EXTERNAL - $: allowDeletion = !externalTable || table?.created function showDeleteModal() { templateScreens = $screenStore.screens.filter( @@ -56,7 +55,7 @@ $goto(`./datasource/${table.datasourceId}`) } } catch (error) { - notifications.error("Error deleting table") + notifications.error(`Error deleting table - ${error.message}`) } } @@ -86,17 +85,15 @@ } -{#if allowDeletion} - -
- -
- {#if !externalTable} - Edit - {/if} - Delete - -{/if} + +
+ +
+ {#if !externalTable} + Edit + {/if} + Delete + { @@ -82,8 +83,8 @@ }) } - // For handlebars only. - const bindStyle = new MatchDecorator({ + // Match decoration for HBS bindings + const hbsMatchDeco = new MatchDecorator({ regexp: FIND_ANY_HBS_REGEX, decoration: () => { return Decoration.mark({ @@ -94,12 +95,11 @@ }) }, }) - - let plugin = ViewPlugin.define( + const hbsMatchDecoPlugin = ViewPlugin.define( view => ({ - decorations: bindStyle.createDeco(view), + decorations: hbsMatchDeco.createDeco(view), update(u) { - this.decorations = bindStyle.updateDeco(u, this.decorations) + this.decorations = hbsMatchDeco.updateDeco(u, this.decorations) }, }), { @@ -107,7 +107,29 @@ } ) - const dispatch = createEventDispatcher() + // Match decoration for snippets + const snippetMatchDeco = new MatchDecorator({ + regexp: /snippets\.[^\s(]+/g, + decoration: () => { + return Decoration.mark({ + tag: "span", + attributes: { + class: "snippet-wrap", + }, + }) + }, + }) + const snippetMatchDecoPlugin = ViewPlugin.define( + view => ({ + decorations: snippetMatchDeco.createDeco(view), + update(u) { + this.decorations = snippetMatchDeco.updateDeco(u, this.decorations) + }, + }), + { + decorations: v => v.decorations, + } + ) // Theming! let currentTheme = $themeStore?.theme @@ -117,7 +139,7 @@ const indentWithTabCustom = { key: "Tab", run: view => { - if (completionStatus(view.state) == "active") { + if (completionStatus(view.state) === "active") { acceptCompletion(view) return true } @@ -131,7 +153,7 @@ } const buildKeymap = () => { - const baseMap = [ + return [ ...closeBracketsKeymap, ...defaultKeymap, ...historyKeymap, @@ -139,43 +161,25 @@ ...completionKeymap, indentWithTabCustom, ] - return baseMap } const buildBaseExtensions = () => { return [ - ...(mode.name === "handlebars" ? [plugin] : []), - history(), drawSelection(), dropCursor(), bracketMatching(), closeBrackets(), - highlightActiveLine(), syntaxHighlighting(oneDarkHighlightStyle, { fallback: true }), - highlightActiveLineGutter(), highlightSpecialChars(), EditorView.lineWrapping, - EditorView.updateListener.of(v => { - const docStr = v.state.doc?.toString() - if (docStr === value) { - return - } - dispatch("change", docStr) - }), - keymap.of(buildKeymap()), - themeConfig.of([ - getDefaultTheme({ - height: editorHeight, - resize, - dark: isDark, - }), - ...(isDark ? [oneDark] : []), - ]), + themeConfig.of([...(isDark ? [oneDark] : [])]), ] } + // None of this is reactive, but it never has been, so we just assume most + // config flags aren't changed at runtime const buildExtensions = base => { - const complete = [...base] + let complete = [...base] if (autocompleteEnabled) { complete.push( @@ -183,7 +187,10 @@ override: [...completions], closeOnBlur: true, icons: false, - optionClass: () => "autocomplete-option", + optionClass: completion => + completion.simple + ? "autocomplete-option-simple" + : "autocomplete-option", }) ) complete.push( @@ -209,22 +216,49 @@ view.dispatch(tr) return true } - return false }) ) } - if (mode.name == "javascript") { + // JS only plugins + if (mode.name === "javascript") { + complete.push(snippetMatchDecoPlugin) complete.push(javascript()) - complete.push(highlightWhitespace()) - complete.push(lineNumbers()) - complete.push(foldGutter()) + if (!readonly) { + complete.push(highlightWhitespace()) + } + } + // HBS only plugins + else { + complete.push(hbsMatchDecoPlugin) } if (placeholder) { complete.push(placeholderFn(placeholder)) } + + if (readonly) { + complete.push(EditorState.readOnly.of(true)) + } else { + complete = [ + ...complete, + history(), + highlightActiveLine(), + highlightActiveLineGutter(), + lineNumbers(), + foldGutter(), + keymap.of(buildKeymap()), + EditorView.updateListener.of(v => { + const docStr = v.state.doc?.toString() + if (docStr === value) { + return + } + dispatch("change", docStr) + }), + ] + } + return complete } @@ -249,8 +283,6 @@ } } - $: editorHeight = typeof height === "number" ? `${height}px` : height - // Init when all elements are ready $: if (mounted && !isEditorInitialised) { isEditorInitialised = true @@ -265,14 +297,7 @@ // Issue theme compartment update editor.dispatch({ - effects: themeConfig.reconfigure([ - getDefaultTheme({ - height: editorHeight, - resize, - dark: isDark, - }), - ...(isDark ? [oneDark] : []), - ]), + effects: themeConfig.reconfigure([...(isDark ? [oneDark] : [])]), }) } } @@ -298,27 +323,207 @@
diff --git a/packages/builder/src/components/common/CodeEditor/index.js b/packages/builder/src/components/common/CodeEditor/index.js index 0d71a475f0..a04a140ad6 100644 --- a/packages/builder/src/components/common/CodeEditor/index.js +++ b/packages/builder/src/components/common/CodeEditor/index.js @@ -1,4 +1,3 @@ -import { EditorView } from "@codemirror/view" import { getManifest } from "@budibase/string-templates" import sanitizeHtml from "sanitize-html" import { groupBy } from "lodash" @@ -27,123 +26,33 @@ export const SECTIONS = { }, } -export const getDefaultTheme = opts => { - const { height, resize, dark } = opts - return EditorView.theme( - { - "&.cm-focused .cm-cursor": { - borderLeftColor: "var(--spectrum-alias-text-color)", - }, - "&": { - height: height ? `${height}` : "", - lineHeight: "1.3", - border: - "var(--spectrum-alias-border-size-thin) solid var(--spectrum-alias-border-color)", - borderRadius: "var(--border-radius-s)", - backgroundColor: - "var( --spectrum-textfield-m-background-color, var(--spectrum-global-color-gray-50) )", - resize: resize ? `${resize}` : "", - overflow: "hidden", - color: "var(--spectrum-alias-text-color)", - }, - "& .cm-tooltip.cm-tooltip-autocomplete > ul": { - fontFamily: - "var(--spectrum-alias-body-text-font-family, var(--spectrum-global-font-family-base))", - maxHeight: "16em", - }, - "& .cm-placeholder": { - color: "var(--spectrum-alias-text-color)", - fontStyle: "italic", - }, - "&.cm-focused": { - outline: "none", - borderColor: "var(--spectrum-alias-border-color-mouse-focus)", - }, - // AUTO COMPLETE - "& .cm-completionDetail": { - fontStyle: "unset", - textTransform: "uppercase", - fontSize: "10px", - backgroundColor: "var(--spectrum-global-color-gray-100)", - color: "var(--spectrum-global-color-gray-600)", - }, - "& .cm-completionLabel": { - marginLeft: - "calc(var(--spectrum-alias-workflow-icon-size-m) + var(--spacing-m))", - }, - "& .info-bubble": { - fontSize: "var(--font-size-s)", - display: "grid", - gridGap: "var(--spacing-s)", - gridTemplateColumns: "1fr", - color: "var(--spectrum-global-color-gray-800)", - }, - "& .cm-tooltip": { - marginLeft: "var(--spacing-s)", - border: "1px solid var(--spectrum-global-color-gray-300)", - borderRadius: - "var( --spectrum-popover-border-radius, var(--spectrum-alias-border-radius-regular) )", - backgroundColor: "var(--spectrum-global-color-gray-50)", - }, - // Section header - "& .info-section": { - display: "flex", - padding: "var(--spacing-s)", - gap: "var(--spacing-m)", - borderBottom: "1px solid var(--spectrum-global-color-gray-200)", - color: "var(--spectrum-global-color-gray-800)", - fontWeight: "bold", - }, - "& .info-section .spectrum-Icon": { - color: "var(--spectrum-global-color-gray-600)", - }, - // Autocomplete Option - "& .cm-tooltip.cm-tooltip-autocomplete .autocomplete-option": { - display: "flex", - justifyContent: "space-between", - alignItems: "center", - fontSize: "var(--spectrum-alias-font-size-default)", - padding: "var(--spacing-s)", - color: "var(--spectrum-global-color-gray-800)", - }, - "& .cm-tooltip-autocomplete ul li[aria-selected].autocomplete-option": { - backgroundColor: "var(--spectrum-global-color-gray-200)", - }, - "& .binding-wrap": { - color: "var(--spectrum-global-color-blue-700)", - fontFamily: "monospace", - }, - }, - { dark } - ) -} - export const buildHelperInfoNode = (completion, helper) => { const ele = document.createElement("div") ele.classList.add("info-bubble") const exampleNodeHtml = helper.example - ? `
${helper.example}
` + ? `
${helper.example}
` : "" const descriptionMarkup = sanitizeHtml(helper.description, { allowedTags: [], allowedAttributes: {}, }) - const descriptionNodeHtml = `
${descriptionMarkup}
` + const descriptionNodeHtml = `
${descriptionMarkup}
` ele.innerHTML = ` - ${exampleNodeHtml} ${descriptionNodeHtml} + ${exampleNodeHtml} ` return ele } const toSpectrumIcon = name => { return ` ` @@ -152,7 +61,9 @@ const toSpectrumIcon = name => { export const buildSectionHeader = (type, sectionName, icon, rank) => { const ele = document.createElement("div") ele.classList.add("info-section") - ele.classList.add(type) + if (type) { + ele.classList.add(type) + } ele.innerHTML = `${toSpectrumIcon(icon)}${sectionName}` return { name: sectionName, @@ -174,7 +85,7 @@ export const helpersToCompletion = (helpers, mode) => { }, type: "helper", section: helperSection, - detail: "FUNCTION", + detail: "Function", apply: (view, completion, from, to) => { insertBinding(view, from, to, key, mode) }, @@ -191,6 +102,29 @@ export const getHelperCompletions = mode => { }, []) } +export const snippetAutoComplete = snippets => { + return function myCompletions(context) { + if (!snippets?.length) { + return null + } + const word = context.matchBefore(/\w*/) + if (word.from == word.to && !context.explicit) { + return null + } + return { + from: word.from, + options: snippets.map(snippet => ({ + label: `snippets.${snippet.name}`, + type: "text", + simple: true, + apply: (view, completion, from, to) => { + insertSnippet(view, from, to, completion.label) + }, + })), + } + } +} + const bindingFilter = (options, query) => { return options.filter(completion => { const section_parsed = completion.section.name.toLowerCase() @@ -252,21 +186,12 @@ export const jsAutocomplete = baseCompletions => { } export const buildBindingInfoNode = (completion, binding) => { + if (!binding.valueHTML || binding.value == null) { + return null + } const ele = document.createElement("div") ele.classList.add("info-bubble") - - const exampleNodeHtml = binding.readableBinding - ? `
{{ ${binding.readableBinding} }}
` - : "" - - const descriptionNodeHtml = binding.description - ? `
${binding.description}
` - : "" - - ele.innerHTML = ` - ${exampleNodeHtml} - ${descriptionNodeHtml} - ` + ele.innerHTML = `
${binding.valueHTML}
` return ele } @@ -345,6 +270,20 @@ export const insertBinding = (view, from, to, text, mode) => { }) } +export const insertSnippet = (view, from, to, text) => { + let cursorPos = from + text.length + view.dispatch({ + changes: { + from, + to, + insert: text, + }, + selection: { + anchor: cursorPos, + }, + }) +} + export const bindingsToCompletions = (bindings, mode) => { const bindingByCategory = groupBy(bindings, "category") const categoryMeta = bindings?.reduce((acc, ele) => { @@ -374,7 +313,7 @@ export const bindingsToCompletions = (bindings, mode) => { ...bindingByCategory[catKey].reduce((acc, binding) => { let displayType = binding.fieldSchema?.type || binding.display?.type acc.push({ - label: binding.display?.name || "NO NAME", + label: binding.display?.name || binding.readableBinding || "NO NAME", info: completion => { return buildBindingInfoNode(completion, binding) }, diff --git a/packages/builder/src/components/common/NavHeader.svelte b/packages/builder/src/components/common/NavHeader.svelte index a163f354d2..2c67a3f9b3 100644 --- a/packages/builder/src/components/common/NavHeader.svelte +++ b/packages/builder/src/components/common/NavHeader.svelte @@ -59,7 +59,7 @@ class="searchButton" class:hide={search} > - +
- +
diff --git a/packages/builder/src/components/common/NavItem.svelte b/packages/builder/src/components/common/NavItem.svelte index 0819bcb86b..66b21e95a1 100644 --- a/packages/builder/src/components/common/NavItem.svelte +++ b/packages/builder/src/components/common/NavItem.svelte @@ -8,6 +8,7 @@ export let iconTooltip export let withArrow = false export let withActions = true + export let showActions = false export let indentLevel = 0 export let text export let border = true @@ -68,6 +69,8 @@ class:border class:selected class:withActions + class:showActions + class:actionsOpen={highlighted && withActions} class:scrollable class:highlighted class:selectedBy @@ -168,8 +171,10 @@ --avatars-background: var(--spectrum-global-color-gray-300); } .nav-item:hover .actions, - .hovering .actions { - visibility: visible; + .hovering .actions, + .nav-item.withActions.actionsOpen .actions, + .nav-item.withActions.showActions .actions { + opacity: 1; } .nav-item-content { flex: 1 1 auto; @@ -272,7 +277,6 @@ position: relative; display: grid; place-items: center; - visibility: hidden; order: 3; opacity: 0; width: 20px; diff --git a/packages/builder/src/components/common/bindings/BindingPanel.svelte b/packages/builder/src/components/common/bindings/BindingPanel.svelte index 7b567e052b..21d389357f 100644 --- a/packages/builder/src/components/common/bindings/BindingPanel.svelte +++ b/packages/builder/src/components/common/bindings/BindingPanel.svelte @@ -1,74 +1,194 @@ - - + +
- { - if (selectedMode == mode) { - return true - } - - //Get the current mode value - const editorValue = usingJS ? decodeJSBinding(jsValue) : hbsValue - - if (editorValue) { - targetMode = selectedMode - return false - } - return true - }} - > - -
-
-
- {#if targetMode} -
-
- - {`Switch to ${targetMode}?`} - - This will discard anything in your binding -
- - -
-
-
- {/if} - -
-
-
- {#if !valid} -
- Current Handlebars syntax is invalid, please check the - guide - here - for more details. -
- {:else} - -
-
- Add available bindings by typing {{ or use the - menu on the right -
-
- {/if} -
-
- {#if $admin.isDev && allowJS} - { - convert() - targetMode = null - }} - > - Convert To JS - - {/if} - { - sidebar = !sidebar - }} - /> -
-
-
- - {#if sidebar} -
- -
- {/if} + {#if showTabBar} +
+
+ {#each editorModeOptions as editorMode} + changeMode(editorMode)} + > + {capitalise(editorMode)} + + {/each} +
+
+ {#each sidePanelOptions as panel} + changeSidePanel(panel)} + > + + + {/each}
- - {#if allowJS} - -
-
-
- {#if targetMode} -
-
- - {`Switch to ${targetMode}?`} - - This will discard anything in your binding -
- - -
-
-
- {/if} - - -
-
-
- -
-
- Add available bindings by typing $ or use the menu on - the right -
-
-
-
- { - sidebar = !sidebar - }} - /> -
-
-
- - {#if sidebar} -
- -
- {/if} -
- - {/if} -
- {#if typeof drawerActions?.hide === "function" && drawerActions?.headless} - - {/if} - {#if typeof bindingDrawerActions?.save === "function" && drawerActions?.headless} - - {/if}
- + {/if} +
+ {#if mode === Modes.Text} + {#key hbsCompletions} + + {/key} + {:else if mode === Modes.JavaScript} + {#key jsCompletions} + + {/key} + {/if} + {#if targetMode} +
+
+ + Switch to {targetMode}? + + This will discard anything in your binding +
+ + +
+
+
+ {/if} +
- - +
+ {#if sidePanel === SidePanels.Bindings} + + {:else if sidePanel === SidePanels.Evaluation} + + {:else if sidePanel === SidePanels.Snippets} + bindingHelpers.onSelectSnippet(snippet)} + {snippets} + /> + {/if} +
+
+ diff --git a/packages/builder/src/components/common/bindings/BindingPicker.svelte b/packages/builder/src/components/common/bindings/BindingPicker.svelte deleted file mode 100644 index 42057b382b..0000000000 --- a/packages/builder/src/components/common/bindings/BindingPicker.svelte +++ /dev/null @@ -1,399 +0,0 @@ - - - - - -
- {#if hoverTarget.title} -
{hoverTarget.title}
- {/if} - {#if hoverTarget.description} -
- - {@html hoverTarget.description} -
- {/if} - {#if hoverTarget.example} - 
{hoverTarget.example}
- {/if} -
- - - - - - - - - {#if selectedCategory} -
- { - selectedCategory = null - }} - > - Back - -
- {/if} - - {#if !selectedCategory} -
- - - - - { - search = null - }} - class:searching={search} - > - - -
- {/if} - - {#if !selectedCategory && !search} -
    - {#each categoryNames as categoryName} -
  • { - selectedCategory = categoryName - }} - > - - {categoryName} - -
    • - {/each} -
- {/if} - - {#if selectedCategory || search} - {#each filteredCategories as category} - {#if category.bindings?.length} -
-
- {category.name} -
-
    - {#each category.bindings as binding} -
  • { - popoverAnchor = e.target - if (!binding.description) { - return - } - hoverTarget = { - title: binding.display?.name || binding.fieldSchema?.name, - description: binding.description, - } - popover.show() - e.stopPropagation() - }} - on:mouseleave={() => { - popover.hide() - popoverAnchor = null - hoverTarget = null - }} - on:focus={() => {}} - on:blur={() => {}} - on:click={() => addBinding(binding)} - > - - {#if binding.display?.name} - {binding.display.name} - {:else if binding.fieldSchema?.name} - {binding.fieldSchema?.name} - {:else} - {binding.readableBinding} - {/if} - - - {#if binding.display?.type || binding.fieldSchema?.type} - - - {binding.display?.type || binding.fieldSchema?.type} - - - {/if} -
    • - {/each} -
-
- {/if} - {/each} - - {#if selectedCategory === "Helpers" || search} - {#if filteredHelpers?.length} -
-
Helpers
-
    - {#each filteredHelpers as helper} -
  • addHelper(helper, mode.name == "javascript")} - on:mouseenter={e => { - popoverAnchor = e.target - if (!helper.displayText && helper.description) { - return - } - hoverTarget = { - title: helper.displayText, - description: helper.description, - example: getHelperExample( - helper, - mode.name == "javascript" - ), - } - popover.show() - e.stopPropagation() - }} - on:mouseleave={() => { - popover.hide() - popoverAnchor = null - hoverTarget = null - }} - on:focus={() => {}} - on:blur={() => {}} - > - {helper.displayText} - - function - -
    • - {/each} -
-
- {/if} - {/if} - {/if} - - - diff --git a/packages/builder/src/components/common/bindings/BindingSidePanel.svelte b/packages/builder/src/components/common/bindings/BindingSidePanel.svelte new file mode 100644 index 0000000000..6ef2d35a6c --- /dev/null +++ b/packages/builder/src/components/common/bindings/BindingSidePanel.svelte @@ -0,0 +1,446 @@ + + + +
+ {#if hoverTarget.description} +
+ + {@html hoverTarget.description} +
+ {/if} + {#if hoverTarget.code} + + 
{@html hoverTarget.code}
+ {/if} +
+ + + + +
+ + {#if selectedCategory} +
+ (selectedCategory = null)} + /> + {selectedCategory} +
+ {/if} + + {#if !selectedCategory} +
+ {#if searching} +
+ +
+ + {:else} +
Bindings
+ + {/if} +
+ {/if} + {#if !selectedCategory && !search} +
    + {#each categoryNames as categoryName} +
  • { + selectedCategory = categoryName + }} + > + + {categoryName} + +
    • + {/each} +
+ {/if} + + {#if selectedCategory || search} + {#each filteredCategories as category} + {#if category.bindings?.length} +
+ {#if filteredCategories.length > 1} +
+ {category.name} +
+ {/if} +
    + {#each category.bindings as binding} +
  • showBindingPopover(binding, e.target)} + on:mouseleave={hidePopover} + on:click={() => addBinding(binding)} + > + + {#if binding.display?.name} + {binding.display.name} + {:else if binding.fieldSchema?.name} + {binding.fieldSchema?.name} + {:else} + {binding.readableBinding} + {/if} + + {#if binding.display?.type || binding.fieldSchema?.type} + + + {binding.display?.type || binding.fieldSchema?.type} + + + {/if} +
    • + {/each} +
+
+ {/if} + {/each} + + {#if selectedCategory === "Helpers" || search} + {#if filteredHelpers?.length} +
+
    + {#each filteredHelpers as helper} +
  • showHelperPopover(helper, e.target)} + on:mouseleave={hidePopover} + on:click={() => addHelper(helper, mode.name === "javascript")} + > + {helper.displayText} + + function + +
    • + {/each} +
+
+ {/if} + {/if} + {/if} + +
+ + diff --git a/packages/builder/src/components/common/bindings/ClientBindingPanel.svelte b/packages/builder/src/components/common/bindings/ClientBindingPanel.svelte index 7888f2e486..4e5789b563 100644 --- a/packages/builder/src/components/common/bindings/ClientBindingPanel.svelte +++ b/packages/builder/src/components/common/bindings/ClientBindingPanel.svelte @@ -1,12 +1,14 @@ - - - Add the objects on the left to enrich your text. - - - + + (tempValue = event.detail)} {bindings} {allowJS} diff --git a/packages/builder/src/components/common/bindings/DrawerBindableInput.svelte b/packages/builder/src/components/common/bindings/DrawerBindableInput.svelte index 80996a484d..d11ebcf87a 100644 --- a/packages/builder/src/components/common/bindings/DrawerBindableInput.svelte +++ b/packages/builder/src/components/common/bindings/DrawerBindableInput.svelte @@ -13,21 +13,21 @@ export let panel = ClientBindingPanel export let value = "" export let bindings = [] - export let title = "Bindings" + export let title export let placeholder export let label export let disabled = false - export let fillWidth export let allowJS = true export let allowHelpers = true export let updateOnChange = true - export let drawerLeft export let key export let disableBindings = false + export let forceModal = false + export let context = null const dispatch = createEventDispatcher() + let bindingDrawer - let valid = true let currentVal = value $: readableValue = runtimeToReadableBinding(bindings, value) @@ -88,27 +88,20 @@ - - Add the objects on the left to enrich your text. - - + (tempValue = event.detail)} {bindings} {allowJS} {allowHelpers} + {context} /> diff --git a/packages/builder/src/components/common/bindings/DrawerBindableSlot.svelte b/packages/builder/src/components/common/bindings/DrawerBindableSlot.svelte index 4cac24660f..8ce9dda209 100644 --- a/packages/builder/src/components/common/bindings/DrawerBindableSlot.svelte +++ b/packages/builder/src/components/common/bindings/DrawerBindableSlot.svelte @@ -16,7 +16,6 @@ export let placeholder export let label export let disabled = false - export let fillWidth export let allowJS = true export let allowHelpers = true export let updateOnChange = true @@ -26,7 +25,6 @@ const dispatch = createEventDispatcher() let bindingDrawer - let valid = true let currentVal = value $: readableValue = runtimeToReadableBinding(bindings, value) @@ -173,22 +171,14 @@ - - Add the objects on the left to enrich your text. - - + (tempValue = event.detail)} {bindings} diff --git a/packages/builder/src/components/common/bindings/EvaluationSidePanel.svelte b/packages/builder/src/components/common/bindings/EvaluationSidePanel.svelte new file mode 100644 index 0000000000..2c4e6a0991 --- /dev/null +++ b/packages/builder/src/components/common/bindings/EvaluationSidePanel.svelte @@ -0,0 +1,133 @@ + + +
+
+
+ {#if error} + +
Error
+ {#if evaluating} +
+ +
+ {/if} + + + {:else} +
Preview
+ {#if evaluating} +
+ +
+ {/if} + + {#if !empty} + + {/if} + {/if} +
+
+
+ {#if empty} + Your expression will be evaluated here + {:else} + + {@html highlightedResult} + {/if} +
+
+ + diff --git a/packages/builder/src/components/common/bindings/ModalBindableInput.svelte b/packages/builder/src/components/common/bindings/ModalBindableInput.svelte index 41245ceaec..3261dc6b74 100644 --- a/packages/builder/src/components/common/bindings/ModalBindableInput.svelte +++ b/packages/builder/src/components/common/bindings/ModalBindableInput.svelte @@ -1,115 +1,12 @@ - - -
- onChange(event.detail)} - {placeholder} - {updateOnChange} - /> -
- -
-
- - - - Add the objects on the left to enrich your text. - -
- (tempValue = e.detail)} - {bindings} - {allowJS} - /> -
- - - - + diff --git a/packages/builder/src/components/common/bindings/ServerBindingPanel.svelte b/packages/builder/src/components/common/bindings/ServerBindingPanel.svelte index 213e5bbf1d..df0da768e0 100644 --- a/packages/builder/src/components/common/bindings/ServerBindingPanel.svelte +++ b/packages/builder/src/components/common/bindings/ServerBindingPanel.svelte @@ -1,10 +1,11 @@ diff --git a/packages/builder/src/components/common/bindings/SnippetDrawer.svelte b/packages/builder/src/components/common/bindings/SnippetDrawer.svelte new file mode 100644 index 0000000000..d6b6f92b17 --- /dev/null +++ b/packages/builder/src/components/common/bindings/SnippetDrawer.svelte @@ -0,0 +1,160 @@ + + + + + {#if snippet} + {snippet.name} + {:else} +
+ Name + + {#if nameError} + + + + {/if} +
+ {/if} + + + {#if snippet} + + {/if} + + + + {#key key} + (code = e.detail)} + > +
+ +
+ + {/key} + + + + + + diff --git a/packages/builder/src/components/common/bindings/SnippetSidePanel.svelte b/packages/builder/src/components/common/bindings/SnippetSidePanel.svelte new file mode 100644 index 0000000000..c68699fc0f --- /dev/null +++ b/packages/builder/src/components/common/bindings/SnippetSidePanel.svelte @@ -0,0 +1,278 @@ + + + + +
+ +
+ {#if enableSnippets} + {#if searching} +
+ +
+ + {:else} +
Snippets
+ + + {/if} + {:else} +
+ Snippets + + Premium + +
+ {/if} +
+
+ {#if enableSnippets && filteredSnippets?.length} + {#each filteredSnippets as snippet} +
showSnippet(snippet, e.target)} + on:mouseleave={hidePopover} + on:click={() => addSnippet(snippet)} + > + {snippet.name} + editSnippet(e, snippet)} + /> +
+ {/each} + {:else} +
+ + Snippets let you create reusable JS functions and values that can + all be managed in one place + + {#if enableSnippets} + + {:else} + + {/if} +
+ {/if} +
+ +
+ + +
+ {#key hoveredSnippet} + + {/key} +
+ + + + + diff --git a/packages/builder/src/components/common/bindings/utils.js b/packages/builder/src/components/common/bindings/utils.js index a086cd0394..c60374f0f7 100644 --- a/packages/builder/src/components/common/bindings/utils.js +++ b/packages/builder/src/components/common/bindings/utils.js @@ -38,4 +38,11 @@ export class BindingHelpers { this.insertAtPos({ start, end, value: insertVal }) } } + + // Adds a snippet to the expression + onSelectSnippet(snippet) { + const pos = this.getCaretPosition() + const { start, end } = pos + this.insertAtPos({ start, end, value: `snippets.${snippet.name}` }) + } } diff --git a/packages/builder/src/components/deploy/AppActions.svelte b/packages/builder/src/components/deploy/AppActions.svelte index 86427ff761..1d7bb4f65e 100644 --- a/packages/builder/src/components/deploy/AppActions.svelte +++ b/packages/builder/src/components/deploy/AppActions.svelte @@ -19,7 +19,7 @@ import ConfirmDialog from "components/common/ConfirmDialog.svelte" import analytics, { Events, EventSource } from "analytics" import { API } from "api" - import { apps } from "stores/portal" + import { appsStore } from "stores/portal" import { previewStore, builderStore, @@ -32,10 +32,14 @@ import TourWrap from "components/portal/onboarding/TourWrap.svelte" import { TOUR_STEP_KEYS } from "components/portal/onboarding/tours.js" import { goto } from "@roxi/routify" + import { onMount } from "svelte" + import PosthogClient from "../../analytics/PosthogClient" export let application export let loaded + const posthog = new PosthogClient(process.env.POSTHOG_TOKEN) + let unpublishModal let updateAppModal let revertModal @@ -44,8 +48,10 @@ let appActionPopoverOpen = false let appActionPopoverAnchor let publishing = false + let showNpsSurvey = false + let lastOpened - $: filteredApps = $apps.filter(app => app.devId === application) + $: filteredApps = $appsStore.apps.filter(app => app.devId === application) $: selectedApp = filteredApps?.length ? filteredApps[0] : null $: latestDeployments = $deploymentStore .filter(deployment => deployment.status === "SUCCESS") @@ -57,7 +63,7 @@ $appStore.version && $appStore.upgradableVersion !== $appStore.version $: canPublish = !publishing && loaded && $sortedScreens.length > 0 - $: lastDeployed = getLastDeployedString($deploymentStore) + $: lastDeployed = getLastDeployedString($deploymentStore, lastOpened) const initialiseApp = async () => { const applicationPkg = await API.fetchAppPackage($appStore.devId) @@ -97,6 +103,7 @@ type: "success", icon: "GlobeCheck", }) + showNpsSurvey = true await completePublish() } catch (error) { console.error(error) @@ -129,7 +136,7 @@ } try { await API.unpublishApp(selectedApp.prodId) - await apps.load() + await appsStore.load() notifications.send("App unpublished", { type: "success", icon: "GlobeStrike", @@ -141,12 +148,16 @@ const completePublish = async () => { try { - await apps.load() + await appsStore.load() await deploymentStore.load() } catch (err) { notifications.error("Error refreshing app") } } + + onMount(() => { + posthog.init() + }) @@ -164,9 +175,10 @@
{/if}
@@ -200,6 +212,7 @@ class="app-action-button publish app-action-popover" on:click={() => { if (!appActionPopoverOpen) { + lastOpened = new Date() appActionPopover.show() } else { appActionPopover.hide() @@ -209,7 +222,7 @@
- + Publish +{#if showNpsSurvey} +
+{/if} + diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/ButtonActionEditor.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/ButtonActionEditor.svelte index d445c98a1a..f009c975cf 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/ButtonActionEditor.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/ButtonActionEditor.svelte @@ -12,6 +12,7 @@ export let bindings export let nested export let componentInstance + export let title = "Actions" let drawer let tmpValue @@ -37,7 +38,7 @@ {actionText}
- + Define what actions to run. diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/DeleteRow.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/DeleteRow.svelte index b8459ac0eb..5b7844ce53 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/DeleteRow.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/DeleteRow.svelte @@ -31,7 +31,7 @@ (parameters.rowId = value.detail)} /> @@ -45,7 +45,10 @@ {#if parameters.confirm} - + + + + {#if parameters.confirm} - + + + + + + diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/FetchRow.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/FetchRow.svelte index 4478f1bb16..61b7494ab2 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/FetchRow.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/FetchRow.svelte @@ -29,7 +29,7 @@ (parameters.rowId = value.detail)} /> diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveFields.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveFields.svelte index 52bd84c453..e03af75207 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveFields.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveFields.svelte @@ -62,7 +62,7 @@ {/if} updateFieldValue(idx, event.detail)} diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveRow.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveRow.svelte index a1fe773455..d834e9aac9 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveRow.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/SaveRow.svelte @@ -72,7 +72,10 @@ {#if parameters.confirm} - + + + + (parameters.message = e.detail)} diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateFieldValue.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateFieldValue.svelte index 51aa6e8cfd..9c843e35d6 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateFieldValue.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateFieldValue.svelte @@ -72,6 +72,7 @@ {#if parameters.type === "set"} (parameters.value = e.detail)} diff --git a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateState.svelte b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateState.svelte index 16a77692ae..fda05ef45a 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateState.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonActionEditor/actions/UpdateState.svelte @@ -38,6 +38,7 @@ {#if parameters.type === "set"} (parameters.value = e.detail)} diff --git a/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonConfiguration.svelte b/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonConfiguration.svelte index db2289345f..0bad2ffb19 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonConfiguration.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonConfiguration.svelte @@ -14,6 +14,7 @@ export let key export let nested export let max + export let context const dispatch = createEventDispatcher() diff --git a/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonSetting.svelte b/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonSetting.svelte index 2387fda683..9a88875140 100644 --- a/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonSetting.svelte +++ b/packages/builder/src/components/design/settings/controls/ButtonConfiguration/ButtonSetting.svelte @@ -1,5 +1,5 @@ @@ -28,6 +31,7 @@ placeholder="Default" /> (column.template = e.detail)} @@ -40,6 +44,9 @@ icon: "TableColumnMerge", }, ]} + context={{ + value: columnValue, + }} /> diff --git a/packages/builder/src/components/design/settings/controls/ColumnEditor/CellEditor.svelte b/packages/builder/src/components/design/settings/controls/ColumnEditor/CellEditor.svelte index b52e7edc54..04a491c6f3 100644 --- a/packages/builder/src/components/design/settings/controls/ColumnEditor/CellEditor.svelte +++ b/packages/builder/src/components/design/settings/controls/ColumnEditor/CellEditor.svelte @@ -25,7 +25,7 @@ - + "{column.name}" column settings diff --git a/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte b/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte index 0e01c264fc..bf0aa75bed 100644 --- a/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte +++ b/packages/builder/src/components/design/settings/controls/DataSourceSelect/DataSourceSelect.svelte @@ -48,7 +48,6 @@ let drawer let tmpQueryParams let tmpCustomData - let customDataValid = true let modal $: text = value?.label ?? "Choose an option" @@ -267,14 +266,11 @@
- +
Provide a JSON array to use as data
(tmpCustomData = event.detail)} {bindings} diff --git a/packages/builder/src/components/design/settings/controls/EditComponentPopover.svelte b/packages/builder/src/components/design/settings/controls/EditComponentPopover/EditComponentPopover.svelte similarity index 83% rename from packages/builder/src/components/design/settings/controls/EditComponentPopover.svelte rename to packages/builder/src/components/design/settings/controls/EditComponentPopover/EditComponentPopover.svelte index 4e645fe343..39e4bc2ada 100644 --- a/packages/builder/src/components/design/settings/controls/EditComponentPopover.svelte +++ b/packages/builder/src/components/design/settings/controls/EditComponentPopover/EditComponentPopover.svelte @@ -3,6 +3,7 @@ import { componentStore } from "stores/builder" import { cloneDeep } from "lodash/fp" import { createEventDispatcher, getContext } from "svelte" + import { customPositionHandler } from "." import ComponentSettingsSection from "pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsSection.svelte" export let anchor @@ -54,25 +55,6 @@ dispatch("change", nestedComponentInstance) } - - const customPositionHandler = (anchorBounds, eleBounds, cfg) => { - let { left, top } = cfg - let percentageOffset = 30 - // left-outside - left = anchorBounds.left - eleBounds.width - 18 - - // shift up from the anchor, if space allows - let offsetPos = Math.floor(eleBounds.height / 100) * percentageOffset - let defaultTop = anchorBounds.top - offsetPos - - if (window.innerHeight - defaultTop < eleBounds.height) { - top = window.innerHeight - eleBounds.height - 5 - } else { - top = anchorBounds.top - offsetPos - } - - return { ...cfg, left, top } - } 0} maxHeight={600} + offset={18} handlePostionUpdate={customPositionHandler} > diff --git a/packages/builder/src/components/design/settings/controls/EditComponentPopover/index.js b/packages/builder/src/components/design/settings/controls/EditComponentPopover/index.js new file mode 100644 index 0000000000..2dc3f60185 --- /dev/null +++ b/packages/builder/src/components/design/settings/controls/EditComponentPopover/index.js @@ -0,0 +1,18 @@ +export const customPositionHandler = (anchorBounds, eleBounds, cfg) => { + let { left, top, offset } = cfg + let percentageOffset = 30 + // left-outside + left = anchorBounds.left - eleBounds.width - (offset || 5) + + // shift up from the anchor, if space allows + let offsetPos = Math.floor(eleBounds.height / 100) * percentageOffset + let defaultTop = anchorBounds.top - offsetPos + + if (window.innerHeight - defaultTop < eleBounds.height) { + top = window.innerHeight - eleBounds.height - 5 + } else { + top = anchorBounds.top - offsetPos + } + + return { ...cfg, left, top } +} diff --git a/packages/builder/src/components/design/settings/controls/FieldConfiguration/FieldSetting.svelte b/packages/builder/src/components/design/settings/controls/FieldConfiguration/FieldSetting.svelte index 27590a9858..771bcf20e0 100644 --- a/packages/builder/src/components/design/settings/controls/FieldConfiguration/FieldSetting.svelte +++ b/packages/builder/src/components/design/settings/controls/FieldConfiguration/FieldSetting.svelte @@ -1,5 +1,5 @@
{#if label && !labelHidden} @@ -98,6 +105,7 @@ onChange={handleChange} bindings={allBindings} name={key} + title={label} {nested} {key} {type} @@ -115,6 +123,16 @@
diff --git a/packages/builder/src/components/portal/onboarding/TourPopover.svelte b/packages/builder/src/components/portal/onboarding/TourPopover.svelte index 23821d73a3..732ee40e11 100644 --- a/packages/builder/src/components/portal/onboarding/TourPopover.svelte +++ b/packages/builder/src/components/portal/onboarding/TourPopover.svelte @@ -1,6 +1,6 @@ {#if tourKey} @@ -98,7 +95,9 @@ anchor={popoverAnchor} maxWidth={300} dismissible={false} - offset={15} + offset={12} + handlePostionUpdate={tourStep?.positionHandler} + customZindex={3} >
@@ -119,7 +118,7 @@
- {#if typeof tourOnSkip === "function"} + {#if typeof tourOnSkip === "function" && !lastStep} import { tourHandler } from "./tourHandler" - import { TOURS } from "./tours" + import { TOURSBYSTEP, TOURS, getCurrentStepIdx } from "./tours" import { onMount, onDestroy } from "svelte" import { builderStore } from "stores/builder" - export let tourStepKey + export let stepKeys = [] - let currentTourStep let ready = false - let registered = false - let handler + let registered = {} const registerTourNode = (tourKey, stepKey) => { - if (ready && !registered && tourKey) { - currentTourStep = TOURS[tourKey].steps.find(step => step.id === stepKey) - if (!currentTourStep) { - return + const step = TOURSBYSTEP[stepKey] + if (ready && step && !registered[stepKey] && step?.tour === tourKey) { + const elem = document.querySelector(step.query) + registered[stepKey] = tourHandler(elem, stepKey) + } + } + + const scrollToStep = () => { + let tourStepIdx = getCurrentStepIdx( + TOURS[tourKeyWatch]?.steps, + tourStepKeyWatch + ) + let currentStep = TOURS[tourKeyWatch]?.steps?.[tourStepIdx] + if (currentStep?.scrollIntoView) { + let currentNode = $builderStore.tourNodes?.[currentStep.id] + if (currentNode) { + currentNode.scrollIntoView({ behavior: "smooth", block: "center" }) } - const elem = document.querySelector(currentTourStep.query) - handler = tourHandler(elem, stepKey) - registered = true } } $: tourKeyWatch = $builderStore.tourKey - $: registerTourNode(tourKeyWatch, tourStepKey, ready) + $: tourStepKeyWatch = $builderStore.tourStepKey + $: if (tourKeyWatch || stepKeys || ready) { + stepKeys.forEach(tourStepKey => { + registerTourNode(tourKeyWatch, tourStepKey) + }) + } + $: scrollToStep(tourKeyWatch, tourStepKeyWatch) onMount(() => { ready = true }) onDestroy(() => { - if (handler) { + Object.entries(registered).forEach(entry => { + const handler = entry[1] + const stepKey = entry[0] + // Run step destroy, de-register nodes in the builderStore and local cache handler.destroy() - } + delete registered[stepKey] + + // Check if the step is part of an active tour. End the tour if that is the case + const step = TOURSBYSTEP[stepKey] + if (step.tour === tourKeyWatch) { + builderStore.setTour() + } + }) }) diff --git a/packages/builder/src/components/portal/onboarding/steps/NewFormSteps.svelte b/packages/builder/src/components/portal/onboarding/steps/NewFormSteps.svelte new file mode 100644 index 0000000000..7c3679f9e8 --- /dev/null +++ b/packages/builder/src/components/portal/onboarding/steps/NewFormSteps.svelte @@ -0,0 +1,9 @@ +
+ When faced with a sizable form, consider implementing a multi-step approach to + enhance user experience. + +

+ Breaking the form into multiple steps can significantly improve usability by + making the process more digestible for your users. +

+
diff --git a/packages/builder/src/components/portal/onboarding/steps/NewViewUpdateFormRowId.svelte b/packages/builder/src/components/portal/onboarding/steps/NewViewUpdateFormRowId.svelte new file mode 100644 index 0000000000..db34e9cb5d --- /dev/null +++ b/packages/builder/src/components/portal/onboarding/steps/NewViewUpdateFormRowId.svelte @@ -0,0 +1,17 @@ +
+ You can use bindings to set the Row ID on your form. +

+ This will allow you to pull the correct information into your form and allow + you to update! +

+ + How to pass a row ID using bindings + +
+ + diff --git a/packages/builder/src/components/portal/onboarding/steps/index.js b/packages/builder/src/components/portal/onboarding/steps/index.js index 8e27748f36..e15d191652 100644 --- a/packages/builder/src/components/portal/onboarding/steps/index.js +++ b/packages/builder/src/components/portal/onboarding/steps/index.js @@ -1,3 +1,5 @@ export { default as OnboardingData } from "./OnboardingData.svelte" export { default as OnboardingDesign } from "./OnboardingDesign.svelte" export { default as OnboardingPublish } from "./OnboardingPublish.svelte" +export { default as NewViewUpdateFormRowId } from "./NewViewUpdateFormRowId.svelte" +export { default as NewFormSteps } from "./NewFormSteps.svelte" diff --git a/packages/builder/src/components/portal/onboarding/tours.js b/packages/builder/src/components/portal/onboarding/tours.js index 623a00fcc2..fab97cdd03 100644 --- a/packages/builder/src/components/portal/onboarding/tours.js +++ b/packages/builder/src/components/portal/onboarding/tours.js @@ -2,8 +2,15 @@ import { get } from "svelte/store" import { builderStore } from "stores/builder" import { auth } from "stores/portal" import analytics from "analytics" -import { OnboardingData, OnboardingDesign, OnboardingPublish } from "./steps" +import { + OnboardingData, + OnboardingDesign, + OnboardingPublish, + NewViewUpdateFormRowId, + NewFormSteps, +} from "./steps" import { API } from "api" +import { customPositionHandler } from "components/design/settings/controls/EditComponentPopover" const ONBOARDING_EVENT_PREFIX = "onboarding" @@ -14,11 +21,26 @@ export const TOUR_STEP_KEYS = { BUILDER_USER_MANAGEMENT: "builder-user-management", BUILDER_AUTOMATION_SECTION: "builder-automation-section", FEATURE_USER_MANAGEMENT: "feature-user-management", + BUILDER_FORM_CREATE_STEPS: "builder-form-create-steps", + BUILDER_FORM_VIEW_UPDATE_STEPS: "builder-form-view-update-steps", + BUILDER_FORM_ROW_ID: "builder-form-row-id", } export const TOUR_KEYS = { TOUR_BUILDER_ONBOARDING: "builder-onboarding", FEATURE_ONBOARDING: "feature-onboarding", + BUILDER_FORM_CREATE: "builder-form-create", + BUILDER_FORM_VIEW_UPDATE: "builder-form-view-update", +} + +export const getCurrentStepIdx = (steps, tourStepKey) => { + if (!steps?.length) { + return + } + if (steps?.length && !tourStepKey) { + return 0 + } + return steps.findIndex(step => step.id === tourStepKey) } const endUserOnboarding = async ({ skipped = false } = {}) => { @@ -37,13 +59,8 @@ const endUserOnboarding = async ({ skipped = false } = {}) => { // Update the cached user await auth.getSelf() - builderStore.update(state => ({ - ...state, - tourNodes: null, - tourKey: null, - tourStepKey: null, - onboarding: false, - })) + builderStore.endBuilderOnboarding() + builderStore.setTour() } catch (e) { console.error("Onboarding failed", e) return false @@ -52,9 +69,29 @@ const endUserOnboarding = async ({ skipped = false } = {}) => { } } -const tourEvent = eventKey => { +const endTour = async ({ key, skipped = false } = {}) => { + const { tours = {} } = get(auth).user + tours[key] = new Date().toISOString() + + await API.updateSelf({ + tours, + }) + + if (skipped) { + tourEvent(key, skipped) + } + + // Update the cached user + await auth.getSelf() + + // Reset tour state + builderStore.setTour() +} + +const tourEvent = (eventKey, skipped) => { analytics.captureEvent(`${ONBOARDING_EVENT_PREFIX}:${eventKey}`, { eventSource: EventSource.PORTAL, + skipped, }) } @@ -135,7 +172,71 @@ const getTours = () => { }, ], }, + [TOUR_KEYS.BUILDER_FORM_CREATE]: { + steps: [ + { + id: TOUR_STEP_KEYS.BUILDER_FORM_CREATE_STEPS, + title: "Add multiple steps", + layout: NewFormSteps, + query: "#steps-prop-control-wrap", + onComplete: () => { + builderStore.highlightSetting() + endTour({ key: TOUR_KEYS.BUILDER_FORM_CREATE }) + }, + onLoad: () => { + tourEvent(TOUR_STEP_KEYS.BUILDER_FORM_CREATE_STEPS) + builderStore.highlightSetting("steps", "info") + }, + positionHandler: customPositionHandler, + align: "left-outside", + }, + ], + }, + [TOUR_KEYS.BUILDER_FORM_VIEW_UPDATE]: { + steps: [ + { + id: TOUR_STEP_KEYS.BUILDER_FORM_ROW_ID, + title: "Add row ID to update a row", + layout: NewViewUpdateFormRowId, + query: "#rowId-prop-control-wrap", + onLoad: () => { + tourEvent(TOUR_STEP_KEYS.BUILDER_FORM_ROW_ID) + builderStore.highlightSetting("rowId", "info") + }, + positionHandler: customPositionHandler, + align: "left-outside", + }, + { + id: TOUR_STEP_KEYS.BUILDER_FORM_VIEW_UPDATE_STEPS, + title: "Add multiple steps", + layout: NewFormSteps, + query: "#steps-prop-control-wrap", + onComplete: () => { + builderStore.highlightSetting() + endTour({ key: TOUR_KEYS.BUILDER_FORM_VIEW_UPDATE }) + }, + onLoad: () => { + tourEvent(TOUR_STEP_KEYS.BUILDER_FORM_VIEW_UPDATE_STEPS) + builderStore.highlightSetting("steps", "info") + }, + positionHandler: customPositionHandler, + align: "left-outside", + scrollIntoView: true, + }, + ], + onSkip: async () => { + builderStore.highlightSetting() + endTour({ key: TOUR_KEYS.BUILDER_FORM_VIEW_UPDATE, skipped: true }) + }, + }, } } export const TOURS = getTours() +export const TOURSBYSTEP = Object.keys(TOURS).reduce((acc, tour) => { + TOURS[tour].steps.forEach(element => { + acc[element.id] = element + acc[element.id]["tour"] = tour + }) + return acc +}, {}) diff --git a/packages/builder/src/components/start/AppRow.svelte b/packages/builder/src/components/start/AppRow.svelte index 32bddd58a6..6dd4030f3a 100644 --- a/packages/builder/src/components/start/AppRow.svelte +++ b/packages/builder/src/components/start/AppRow.svelte @@ -5,10 +5,14 @@ import { goto } from "@roxi/routify" import { UserAvatars } from "@budibase/frontend-core" import { sdk } from "@budibase/shared-core" + import AppRowContext from "./AppRowContext.svelte" + import FavouriteAppButton from "pages/builder/portal/apps/FavouriteAppButton.svelte" export let app export let lockedAction + let actionsOpen = false + $: editing = app.sessions?.length $: isBuilder = sdk.users.isBuilder($auth.user, app?.devId) $: unclickable = !isBuilder && !app.deployed @@ -42,8 +46,10 @@
@@ -74,21 +80,35 @@ {app.deployed ? "Published" : "Unpublished"}
- {#if isBuilder} +
- - + {#if isBuilder} +
+ +
+
+ { + actionsOpen = true + }} + on:close={() => { + actionsOpen = false + }} + /> +
+ {:else} + + + {/if}
- {:else if app.deployed} - -
- + +
+
- {/if} +
diff --git a/packages/builder/src/components/start/ExportAppModal.svelte b/packages/builder/src/components/start/ExportAppModal.svelte index 734e4448a1..ec0cf42fe0 100644 --- a/packages/builder/src/components/start/ExportAppModal.svelte +++ b/packages/builder/src/components/start/ExportAppModal.svelte @@ -121,6 +121,7 @@ { - const applications = svelteGet(apps) + const applications = svelteGet(appsStore).apps appValidation.name(validation, { apps: applications, currentApp: { @@ -62,7 +62,7 @@ async function updateApp() { try { - await apps.update(app.appId, { + await appsStore.save(app.appId, { name: $values.name?.trim(), url: $values.url?.trim(), icon: { diff --git a/packages/builder/src/dataBinding.js b/packages/builder/src/dataBinding.js index 0442a67da9..8fdf71c156 100644 --- a/packages/builder/src/dataBinding.js +++ b/packages/builder/src/dataBinding.js @@ -1146,7 +1146,7 @@ export const getAllStateVariables = () => { "@budibase/standard-components/multistepformblockstep" ) - steps.forEach(step => { + steps?.forEach(step => { parseComponentSettings(stepDefinition, step) }) }) diff --git a/packages/builder/src/global.css b/packages/builder/src/global.css index bc1f55d9d3..adf4a47070 100644 --- a/packages/builder/src/global.css +++ b/packages/builder/src/global.css @@ -22,6 +22,7 @@ body { --grey-7: var(--spectrum-global-color-gray-700); --grey-8: var(--spectrum-global-color-gray-800); --grey-9: var(--spectrum-global-color-gray-900); + --spectrum-global-color-yellow-1000: #d8b500; color: var(--ink); background-color: var(--background-alt); diff --git a/packages/builder/src/helpers/components.js b/packages/builder/src/helpers/components.js index 4f4f3ed380..a03ebfdfa7 100644 --- a/packages/builder/src/helpers/components.js +++ b/packages/builder/src/helpers/components.js @@ -279,3 +279,11 @@ export const buildContextTreeLookupMap = rootComponent => { }) return map } + +// Get a flat list of ids for all descendants of a component +export const getChildIdsForComponent = component => { + return [ + component._id, + ...(component?._children ?? []).map(getChildIdsForComponent).flat(1), + ] +} diff --git a/packages/builder/src/helpers/duplicate.js b/packages/builder/src/helpers/duplicate.js index 1547fcd4d1..c2a924f97b 100644 --- a/packages/builder/src/helpers/duplicate.js +++ b/packages/builder/src/helpers/duplicate.js @@ -48,3 +48,53 @@ export const duplicateName = (name, allNames) => { return `${baseName} ${number}` } + +/** + * More flexible alternative to the above function, which handles getting the + * next sequential name from an array of existing items while accounting for + * any type of prefix, and being able to deeply retrieve that name from the + * existing item array. + * + * Examples with a prefix of "foo": + * [] => "foo" + * ["foo"] => "foo2" + * ["foo", "foo6"] => "foo7" + * + * Examples with a prefix of "foo " (space at the end): + * [] => "foo" + * ["foo"] => "foo 2" + * ["foo", "foo 6"] => "foo 7" + * + * @param items the array of existing items + * @param prefix the string prefix of each name, including any spaces desired + * @param getName optional function to extract the name for an item, if not a + * flat array of strings + */ +export const getSequentialName = (items, prefix, getName = x => x) => { + if (!prefix?.length || !getName) { + return null + } + const trimmedPrefix = prefix.trim() + if (!items?.length) { + return trimmedPrefix + } + let max = 0 + items.forEach(item => { + const name = getName(item) + if (typeof name !== "string" || !name.startsWith(trimmedPrefix)) { + return + } + const split = name.split(trimmedPrefix) + if (split.length !== 2) { + return + } + if (split[1].trim() === "") { + split[1] = "1" + } + const num = parseInt(split[1]) + if (num > max) { + max = num + } + }) + return max === 0 ? trimmedPrefix : `${prefix}${max + 1}` +} diff --git a/packages/builder/src/helpers/tests/duplicate.test.js b/packages/builder/src/helpers/tests/duplicate.test.js index 400abed0aa..7e51c5ff2a 100644 --- a/packages/builder/src/helpers/tests/duplicate.test.js +++ b/packages/builder/src/helpers/tests/duplicate.test.js @@ -1,5 +1,5 @@ import { expect, describe, it } from "vitest" -import { duplicateName } from "../duplicate" +import { duplicateName, getSequentialName } from "../duplicate" describe("duplicate", () => { describe("duplicates a name ", () => { @@ -40,3 +40,64 @@ describe("duplicate", () => { }) }) }) + +describe("getSequentialName", () => { + it("handles nullish items", async () => { + const name = getSequentialName(null, "foo", () => {}) + expect(name).toBe("foo") + }) + + it("handles nullish prefix", async () => { + const name = getSequentialName([], null, () => {}) + expect(name).toBe(null) + }) + + it("handles nullish getName function", async () => { + const name = getSequentialName([], "foo", null) + expect(name).toBe(null) + }) + + it("handles just the prefix", async () => { + const name = getSequentialName(["foo"], "foo", x => x) + expect(name).toBe("foo2") + }) + + it("handles continuous ranges", async () => { + const name = getSequentialName(["foo", "foo2", "foo3"], "foo", x => x) + expect(name).toBe("foo4") + }) + + it("handles discontinuous ranges", async () => { + const name = getSequentialName(["foo", "foo3"], "foo", x => x) + expect(name).toBe("foo4") + }) + + it("handles a space inside the prefix", async () => { + const name = getSequentialName(["foo", "foo 2", "foo 3"], "foo ", x => x) + expect(name).toBe("foo 4") + }) + + it("handles a space inside the prefix with just the prefix", async () => { + const name = getSequentialName(["foo"], "foo ", x => x) + expect(name).toBe("foo 2") + }) + + it("handles no matches", async () => { + const name = getSequentialName(["aaa", "bbb"], "foo", x => x) + expect(name).toBe("foo") + }) + + it("handles similar names", async () => { + const name = getSequentialName( + ["fooo1", "2foo", "a3foo4", "5foo5"], + "foo", + x => x + ) + expect(name).toBe("foo") + }) + + it("handles non-string names", async () => { + const name = getSequentialName([null, 4123, [], {}], "foo", x => x) + expect(name).toBe("foo") + }) +}) diff --git a/packages/builder/src/pages/builder/_layout.svelte b/packages/builder/src/pages/builder/_layout.svelte index 62d3951fb5..95ca05b87b 100644 --- a/packages/builder/src/pages/builder/_layout.svelte +++ b/packages/builder/src/pages/builder/_layout.svelte @@ -71,6 +71,10 @@ await auth.getSelf() await admin.init() + if ($admin.maintenance.length > 0) { + $redirect("./maintenance") + } + if ($auth.user) { await licensing.init() } diff --git a/packages/builder/src/pages/builder/app/[application]/_components/BuilderSidePanel.svelte b/packages/builder/src/pages/builder/app/[application]/_components/BuilderSidePanel.svelte index 7c1cc583e1..035dc5a2ef 100644 --- a/packages/builder/src/pages/builder/app/[application]/_components/BuilderSidePanel.svelte +++ b/packages/builder/src/pages/builder/app/[application]/_components/BuilderSidePanel.svelte @@ -15,7 +15,14 @@ FancySelect, } from "@budibase/bbui" import { builderStore, appStore, roles } from "stores/builder" - import { groups, licensing, apps, users, auth, admin } from "stores/portal" + import { + groups, + licensing, + appsStore, + users, + auth, + admin, + } from "stores/portal" import { fetchData, Constants, @@ -54,7 +61,7 @@ let inviteFailureResponse = "" $: validEmail = emailValidator(email) === true - $: prodAppId = apps.getProdAppID($appStore.appId) + $: prodAppId = appsStore.getProdAppID($appStore.appId) $: promptInvite = showInvite( filteredInvites, filteredUsers, @@ -122,10 +129,7 @@ filteredUsers = $usersFetch.rows .filter(user => user.email !== $auth.user.email) .map(user => { - const isAdminOrGlobalBuilder = sdk.users.isAdminOrGlobalBuilder( - user, - prodAppId - ) + const isAdminOrGlobalBuilder = sdk.users.isAdminOrGlobalBuilder(user) const isAppBuilder = user.builder?.apps?.includes(prodAppId) let role if (isAdminOrGlobalBuilder) { diff --git a/packages/builder/src/pages/builder/app/[application]/_layout.svelte b/packages/builder/src/pages/builder/app/[application]/_layout.svelte index dd66f5bc34..fd6a97560d 100644 --- a/packages/builder/src/pages/builder/app/[application]/_layout.svelte +++ b/packages/builder/src/pages/builder/app/[application]/_layout.svelte @@ -8,7 +8,7 @@ userStore, deploymentStore, } from "stores/builder" - import { auth, apps } from "stores/portal" + import { auth, appsStore } from "stores/portal" import { TENANT_FEATURE_FLAGS, isEnabled } from "helpers/featureFlags" import { Icon, @@ -52,7 +52,7 @@ const pkg = await API.fetchAppPackage(application) await initialise(pkg) - await apps.load() + await appsStore.load() await deploymentStore.load() loaded = true @@ -96,7 +96,7 @@ const release_date = new Date("2023-03-01T00:00:00.000Z") const onboarded = new Date($auth.user?.onboardedAt) if (onboarded < release_date) { - builderStore.startTour(TOUR_KEYS.FEATURE_ONBOARDING) + builderStore.setTour(TOUR_KEYS.FEATURE_ONBOARDING) } } } @@ -144,7 +144,7 @@ {#each $layout.children as { path, title }} - + - + diff --git a/packages/builder/src/pages/builder/app/[application]/automation/_layout.svelte b/packages/builder/src/pages/builder/app/[application]/automation/_layout.svelte index c4ee060149..57180625b1 100644 --- a/packages/builder/src/pages/builder/app/[application]/automation/_layout.svelte +++ b/packages/builder/src/pages/builder/app/[application]/automation/_layout.svelte @@ -40,7 +40,7 @@
-
+
{#if $automationStore.automations?.length} {:else} diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsPanel.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsPanel.svelte index 8b778a2ce7..7a5372e883 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsPanel.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Component/ComponentSettingsPanel.svelte @@ -16,6 +16,14 @@ } from "dataBinding" import { ActionButton, notifications } from "@budibase/bbui" import { capitalise } from "helpers" + import TourWrap from "components/portal/onboarding/TourWrap.svelte" + import { TOUR_STEP_KEYS } from "components/portal/onboarding/tours.js" + + const { + BUILDER_FORM_CREATE_STEPS, + BUILDER_FORM_VIEW_UPDATE_STEPS, + BUILDER_FORM_ROW_ID, + } = TOUR_STEP_KEYS const onUpdateName = async value => { try { @@ -46,7 +54,6 @@ $: id = $selectedComponent?._id $: id, (section = tabs[0]) - $: componentName = getComponentName(componentInstance) @@ -92,13 +99,21 @@
{#if section == "settings"} - + + + {/if} {#if section == "styles"} import { helpers } from "@budibase/shared-core" import { DetailSummary, notifications } from "@budibase/bbui" - import { componentStore } from "stores/builder" + import { componentStore, builderStore } from "stores/builder" import PropertyControl from "components/design/settings/controls/PropertyControl.svelte" import ResetFieldsButton from "components/design/settings/controls/ResetFieldsButton.svelte" import EjectBlockButton from "components/design/settings/controls/EjectBlockButton.svelte" @@ -177,9 +177,7 @@ defaultValue={setting.defaultValue} nested={setting.nested} onChange={val => updateSetting(setting, val)} - highlighted={$componentStore.highlightedSettingKey === - setting.key} - propertyFocus={$componentStore.propertyFocus === setting.key} + propertyFocus={$builderStore.propertyFocus === setting.key} info={setting.info} disableBindings={setting.disableBindings} props={{ diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Navigation/index.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Navigation/index.svelte index 50e1ad0cf8..4db218f60b 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Navigation/index.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/_components/Navigation/index.svelte @@ -24,6 +24,13 @@ navigationStore, } from "stores/builder" import { DefaultAppTheme } from "constants" + import BarButtonList from "/src/components/design/settings/controls/BarButtonList.svelte" + + $: alignmentOptions = [ + { value: "Left", barIcon: "TextAlignLeft" }, + { value: "Center", barIcon: "TextAlignCenter" }, + { value: "Right", barIcon: "TextAlignRight" }, + ] $: screenRouteOptions = $screenStore.screens .map(screen => screen.routing?.route) @@ -46,6 +53,10 @@ notifications.error("Error updating navigation settings") } } + + const updateTextAlign = textAlignValue => { + navigationStore.syncAppNavigation({ textAlign: textAlignValue }) + } update("title", e.detail)} updateOnChange={false} /> + +
+ +
+ {/if}
diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/new/_components/componentStructure.json b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/new/_components/componentStructure.json index 96e8faf93c..b66c9cca3a 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/new/_components/componentStructure.json +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/[componentId]/new/_components/componentStructure.json @@ -3,8 +3,6 @@ "name": "Blocks", "icon": "Article", "children": [ - "gridblock", - "tableblock", "cardsblock", "repeaterblock", "formblock", @@ -16,7 +14,7 @@ { "name": "Layout", "icon": "ClassicGridView", - "children": ["container", "section", "grid", "sidepanel"] + "children": ["container", "section", "sidepanel"] }, { "name": "Data", @@ -24,7 +22,7 @@ "children": [ "dataprovider", "repeater", - "table", + "gridblock", "spreadsheet", "dynamicfilter", "daterangepicker" diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPanel.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPanel.svelte index 5867021386..4617814485 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPanel.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPanel.svelte @@ -6,6 +6,7 @@
+
@@ -32,7 +33,17 @@ flex-direction: column; justify-content: flex-start; align-items: stretch; - padding: 9px var(--spacing-m); + padding: 9px 10px 12px 10px; + position: relative; + transition: width 360ms ease-out; + } + .drawer-container { + position: absolute; + height: 100%; + width: 100%; + overflow: hidden; + top: 0; + left: 0; } .header { display: flex; diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPreview.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPreview.svelte index fa126bbc99..e74a05ff99 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPreview.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/AppPreview.svelte @@ -10,6 +10,8 @@ navigationStore, selectedScreen, hoverStore, + componentTreeNodesStore, + snippets, } from "stores/builder" import ConfirmDialog from "components/common/ConfirmDialog.svelte" import { @@ -68,6 +70,7 @@ hostname: window.location.hostname, port: window.location.port, }, + snippets: $snippets, } // Refresh the preview when required @@ -130,6 +133,7 @@ error = event.error || "An unknown error occurred" } else if (type === "select-component" && data.id) { componentStore.select(data.id) + componentTreeNodesStore.makeNodeVisible(data.id) } else if (type === "hover-component") { hoverStore.hover(data.id, false) } else if (type === "update-prop") { @@ -174,7 +178,7 @@ } else if (type === "request-add-component") { toggleAddComponent() } else if (type === "highlight-setting") { - builderStore.highlightSetting(data.setting) + builderStore.highlightSetting(data.setting, "error") // Also scroll setting into view const selector = `#${data.setting}-prop-control` @@ -196,6 +200,16 @@ } else if (type === "add-parent-component") { const { componentId, parentType } = data await componentStore.addParent(componentId, parentType) + } else if (type === "provide-context") { + let context = data?.context + if (context) { + try { + context = JSON.parse(context) + } catch (error) { + context = null + } + } + previewStore.setSelectedComponentContext(context) } else { console.warn(`Client sent unknown event type: ${type}`) } diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentKeyHandler.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentKeyHandler.svelte index f6bbac39a5..7e9c113a77 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentKeyHandler.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentKeyHandler.svelte @@ -4,12 +4,12 @@ selectedScreen, componentStore, selectedComponent, + componentTreeNodesStore, } from "stores/builder" - import { findComponent } from "helpers/components" + import { findComponent, getChildIdsForComponent } from "helpers/components" import { goto, isActive } from "@roxi/routify" import { notifications } from "@budibase/bbui" import ConfirmDialog from "components/common/ConfirmDialog.svelte" - import componentTreeNodesStore from "stores/portal/componentTreeNodesStore" let confirmDeleteDialog let confirmEjectDialog @@ -63,38 +63,25 @@ componentStore.selectNext() }, ["ArrowRight"]: component => { - componentTreeNodesStore.expandNode(component._id) + componentTreeNodesStore.expandNodes([component._id]) }, ["ArrowLeft"]: component => { - componentTreeNodesStore.collapseNode(component._id) + // Select the collapsing root component to ensure the currently selected component is not + // hidden in a collapsed node + componentStore.select(component._id) + componentTreeNodesStore.collapseNodes([component._id]) }, ["Ctrl+ArrowRight"]: component => { - componentTreeNodesStore.expandNode(component._id) - - const expandChildren = component => { - const children = component._children ?? [] - - children.forEach(child => { - componentTreeNodesStore.expandNode(child._id) - expandChildren(child) - }) - } - - expandChildren(component) + const childIds = getChildIdsForComponent(component) + componentTreeNodesStore.expandNodes(childIds) }, ["Ctrl+ArrowLeft"]: component => { - componentTreeNodesStore.collapseNode(component._id) + // Select the collapsing root component to ensure the currently selected component is not + // hidden in a collapsed node + componentStore.select(component._id) - const collapseChildren = component => { - const children = component._children ?? [] - - children.forEach(child => { - componentTreeNodesStore.collapseNode(child._id) - collapseChildren(child) - }) - } - - collapseChildren(component) + const childIds = getChildIdsForComponent(component) + componentTreeNodesStore.collapseNodes(childIds) }, ["Escape"]: () => { if ($isActive(`./:componentId/new`)) { diff --git a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentTree.svelte b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentTree.svelte index f24235ad07..0219dc304d 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentTree.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/[screenId]/_components/ComponentList/ComponentTree.svelte @@ -7,8 +7,8 @@ componentStore, userSelectedResourceMap, selectedComponent, - selectedComponentPath, hoverStore, + componentTreeNodesStore, } from "stores/builder" import { findComponentPath, @@ -17,7 +17,6 @@ } from "helpers/components" import { get } from "svelte/store" import { dndStore } from "./dndStore" - import componentTreeNodesStore from "stores/portal/componentTreeNodesStore" export let components = [] export let level = 0 @@ -64,14 +63,11 @@ } } - const isOpen = (component, selectedComponentPath, openNodes) => { + const isOpen = component => { if (!component?._children?.length) { return false } - if (selectedComponentPath.slice(0, -1).includes(component._id)) { - return true - } - return openNodes[`nodeOpen-${component._id}`] + return componentTreeNodesStore.isNodeExpanded(component._id) } const isChildOfSelectedComponent = component => { @@ -83,6 +79,11 @@ return findComponentPath($selectedComponent, component._id)?.length > 0 } + const handleIconClick = componentId => { + componentStore.select(componentId) + componentTreeNodesStore.toggleNode(componentId) + } + const hover = hoverStore.hover @@ -90,7 +91,7 @@
    {#each filteredComponents || [] as component, index (component._id)} - {@const opened = isOpen(component, $selectedComponentPath, openNodes)} + {@const opened = isOpen(component, openNodes)}
  • { componentStore.select(component._id) @@ -104,7 +105,7 @@ on:dragend={dndStore.actions.reset} on:dragstart={() => dndStore.actions.dragstart(component)} on:dragover={dragover(component, index)} - on:iconClick={() => componentTreeNodesStore.toggleNode(component._id)} + on:iconClick={() => handleIconClick(component._id)} on:drop={onDrop} hovering={$hoverStore.componentId === component._id} on:mouseenter={() => hover(component._id)} diff --git a/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/CreateScreenModal.svelte b/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/CreateScreenModal.svelte index eadd9d4257..b49e38d9cd 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/CreateScreenModal.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/CreateScreenModal.svelte @@ -3,13 +3,24 @@ import DatasourceModal from "./DatasourceModal.svelte" import ScreenRoleModal from "./ScreenRoleModal.svelte" import sanitizeUrl from "helpers/sanitizeUrl" + import FormTypeModal from "./FormTypeModal.svelte" import { Modal, notifications } from "@budibase/bbui" - import { screenStore, navigationStore, tables } from "stores/builder" + import { + screenStore, + navigationStore, + tables, + builderStore, + } from "stores/builder" + import { auth } from "stores/portal" import { get } from "svelte/store" import getTemplates from "templates" import { Roles } from "constants/backend" import { capitalise } from "helpers" import { goto } from "@roxi/routify" + import { TOUR_KEYS } from "components/portal/onboarding/tours.js" + import formScreen from "templates/formScreen" + import gridListScreen from "templates/gridListScreen" + import gridDetailsScreen from "templates/gridDetailsScreen" let mode let pendingScreen @@ -18,12 +29,18 @@ let screenDetailsModal let datasourceModal let screenAccessRoleModal + let formTypeModal // Cache variables for workflow let screenAccessRole = Roles.BASIC - let selectedTemplates = null + + let templates = null + let screens = null + + let selectedDatasources = null let blankScreenUrl = null let screenMode = null + let formType = null // Creates an array of screens, checking and sanitising their URLs const createScreens = async ({ screens, screenAccessRole }) => { @@ -32,7 +49,7 @@ } try { - let screenId + let createdScreens = [] for (let screen of screens) { // Check we aren't clashing with an existing URL @@ -56,7 +73,7 @@ // Create the screen const response = await screenStore.save(screen) - screenId = response._id + createdScreens.push(response) // Add link in layout. We only ever actually create 1 screen now, even // for autoscreens, so it's always safe to do this. @@ -66,9 +83,7 @@ ) } - // Go to new screen - $goto(`./${screenId}`) - screenStore.select(screenId) + return createdScreens } catch (error) { console.error(error) notifications.error("Error creating screens") @@ -104,13 +119,16 @@ // Handler for NewScreenModal export const show = newMode => { mode = newMode - selectedTemplates = null + templates = null + screens = null + selectedDatasources = null blankScreenUrl = null screenMode = mode pendingScreen = null screenAccessRole = Roles.BASIC + formType = null - if (mode === "table" || mode === "grid") { + if (mode === "grid" || mode === "gridDetails" || mode === "form") { datasourceModal.show() } else if (mode === "blank") { let templates = getTemplates($tables.list) @@ -125,19 +143,29 @@ } // Handler for DatasourceModal confirmation, move to screen access select - const confirmScreenDatasources = async ({ templates }) => { - selectedTemplates = templates - screenAccessRoleModal.show() + const confirmScreenDatasources = async ({ datasources }) => { + selectedDatasources = datasources + if (screenMode === "form") { + formTypeModal.show() + } else { + screenAccessRoleModal.show() + } } // Handler for Datasource Screen Creation const completeDatasourceScreenCreation = async () => { - const screens = selectedTemplates.map(template => { + templates = + mode === "grid" + ? gridListScreen(selectedDatasources) + : gridDetailsScreen(selectedDatasources) + + const screens = templates.map(template => { let screenTemplate = template.create() screenTemplate.autoTableId = template.resourceId return screenTemplate }) - await createScreens({ screens, screenAccessRole }) + const createdScreens = await createScreens({ screens, screenAccessRole }) + loadNewScreen(createdScreens) } const confirmScreenBlank = async ({ screenUrl }) => { @@ -154,7 +182,54 @@ return } pendingScreen.routing.route = screenUrl - await createScreens({ screens: [pendingScreen], screenAccessRole }) + const createdScreens = await createScreens({ + screens: [pendingScreen], + screenAccessRole, + }) + loadNewScreen(createdScreens) + } + + const onConfirmFormType = () => { + screenAccessRoleModal.show() + } + + const loadNewScreen = createdScreens => { + const lastScreen = createdScreens.slice(-1)[0] + + // Go to new screen + if (lastScreen?.props?._children.length) { + // Focus on the main component for the streen type + const mainComponent = lastScreen?.props?._children?.[0]._id + $goto(`./${lastScreen._id}/${mainComponent}`) + } else { + $goto(`./${lastScreen._id}`) + } + + screenStore.select(lastScreen._id) + } + + const confirmFormScreenCreation = async () => { + templates = formScreen(selectedDatasources, { actionType: formType }) + screens = templates.map(template => { + let screenTemplate = template.create() + return screenTemplate + }) + const createdScreens = await createScreens({ screens, screenAccessRole }) + + if (formType === "Update" || formType === "Create") { + const associatedTour = + formType === "Update" + ? TOUR_KEYS.BUILDER_FORM_VIEW_UPDATE + : TOUR_KEYS.BUILDER_FORM_CREATE + + const tourRequired = !$auth?.user?.tours?.[associatedTour] + if (tourRequired) { + builderStore.setTour(associatedTour) + } + } + + // Go to new screen + loadNewScreen(createdScreens) } // Submit screen config for creation. @@ -164,6 +239,8 @@ screenUrl: blankScreenUrl, screenAccessRole, }) + } else if (screenMode === "form") { + confirmFormScreenCreation() } else { completeDatasourceScreenCreation() } @@ -179,19 +256,18 @@ - + { + confirmScreenCreation() + }} bind:screenAccessRole + onCancel={roleSelectBack} screenUrl={blankScreenUrl} + confirmText={screenMode === "form" ? "Confirm" : "Done"} /> @@ -201,3 +277,17 @@ initialUrl={blankScreenUrl} /> + + + { + formTypeModal.hide() + datasourceModal.show() + }} + on:select={e => { + formType = e.detail + }} + type={formType} + /> + diff --git a/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/DatasourceModal.svelte b/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/DatasourceModal.svelte index bb6c47c4b1..8e2428d832 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/DatasourceModal.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/DatasourceModal.svelte @@ -4,37 +4,33 @@ import ICONS from "components/backend/DatasourceNavigator/icons" import { IntegrationNames } from "constants" import { onMount } from "svelte" - import rowListScreen from "templates/rowListScreen" import DatasourceTemplateRow from "./DatasourceTemplateRow.svelte" - export let mode export let onCancel export let onConfirm - export let initialScreens = [] - let selectedScreens = [...initialScreens] + let selectedSources = [] $: filteredSources = $datasources.list?.filter(datasource => { return datasource.source !== IntegrationNames.REST && datasource["entities"] }) const toggleSelection = datasource => { - const { resourceId } = datasource - if (selectedScreens.find(s => s.resourceId === resourceId)) { - selectedScreens = selectedScreens.filter( - screen => screen.resourceId !== resourceId + const exists = selectedSources.find( + d => d.resourceId === datasource.resourceId + ) + if (exists) { + selectedSources = selectedSources.filter( + d => d.resourceId === datasource.resourceId ) } else { - selectedScreens = [ - ...selectedScreens, - rowListScreen([datasource], mode)[0], - ] + selectedSources = [...selectedSources, datasource] } } const confirmDatasourceSelection = async () => { await onConfirm({ - templates: selectedScreens, + datasources: selectedSources, }) } @@ -54,7 +50,7 @@ cancelText="Back" onConfirm={confirmDatasourceSelection} {onCancel} - disabled={!selectedScreens.length} + disabled={!selectedSources.length} size="L" > @@ -85,8 +81,8 @@ resourceId: table._id, type: "table", }} - {@const selected = selectedScreens.find( - screen => screen.resourceId === tableDS.resourceId + {@const selected = selectedSources.find( + datasource => datasource.resourceId === tableDS.resourceId )} toggleSelection(tableDS)} @@ -103,7 +99,7 @@ tableId: view.tableId, type: "viewV2", }} - {@const selected = selectedScreens.find( + {@const selected = selectedSources.find( x => x.resourceId === viewDS.resourceId )} + import { ModalContent, Layout, Body, Icon } from "@budibase/bbui" + import { createEventDispatcher } from "svelte" + + export let onCancel = () => {} + export let onConfirm = () => {} + export let type + + const dispatch = createEventDispatcher() + + + + + + + +
    { + dispatch("select", "Create") + }} + > +
    +
    + Create a new row + + For capturing and storing new data from your users + +
    + {#if type === "Create"} + + + + {/if} +
    +
    +
    { + dispatch("select", "Update") + }} + > +
    +
    + Update an existing row + For viewing and updating existing data +
    + {#if type === "Update"} + + + + {/if} +
    +
    +
    { + dispatch("select", "View") + }} + > +
    +
    + View an existing row + For a read only view of your data +
    + {#if type === "View"} + + + + {/if} +
    +
    +     +     +     + + diff --git a/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/ScreenRoleModal.svelte b/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/ScreenRoleModal.svelte index 5e34d32219..8605412c1c 100644 --- a/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/ScreenRoleModal.svelte +++ b/packages/builder/src/pages/builder/app/[application]/design/_components/NewScreen/ScreenRoleModal.svelte @@ -9,6 +9,7 @@ export let onCancel export let screenUrl export let screenAccessRole + export let confirmText = "Done" let error @@ -40,7 +41,7 @@ import { Body } from "@budibase/bbui" import CreationPage from "components/common/CreationPage.svelte" - import blankImage from "./blank.png" - import tableImage from "./table.png" - import gridImage from "./grid.png" + import blankImage from "./images/blank.png" + import tableInline from "./images/tableInline.png" + import tableDetails from "./images/tableDetails.png" + import formImage from "./images/form.png" import CreateScreenModal from "./CreateScreenModal.svelte" import { screenStore } from "stores/builder" @@ -37,23 +38,33 @@
-
createScreenModal.show("table")}> +
createScreenModal.show("grid")}>
- +
- Table - View, edit and delete rows on a table + Table with inline editing + View, edit and delete rows inline
-
createScreenModal.show("grid")}> +
createScreenModal.show("gridDetails")}>
- +
- Grid - View and manipulate rows on a grid + Table with details panel + Manage your row details in a side panel +
+
+ +
createScreenModal.show("form")}> +
+ +
+
+ Form + Capture data from your users
@@ -102,6 +113,11 @@ width: 100%; } + .card .image { + min-height: 130px; + min-width: 235px; + } + .text { border: 1px solid var(--grey-4); border-radius: 0 0 4px 4px; diff --git a/packages/builder/src/pages/builder/app/[application]/settings/_layout.svelte b/packages/builder/src/pages/builder/app/[application]/settings/_layout.svelte index da4f743f04..67befddcb9 100644 --- a/packages/builder/src/pages/builder/app/[application]/settings/_layout.svelte +++ b/packages/builder/src/pages/builder/app/[application]/settings/_layout.svelte @@ -3,7 +3,7 @@ import { Page, Layout, AbsTooltip, TooltipPosition } from "@budibase/bbui" import { url, isActive } from "@roxi/routify" import DeleteModal from "components/deploy/DeleteModal.svelte" - import { isOnlyUser } from "stores/builder" + import { isOnlyUser, appStore } from "stores/builder" let deleteModal @@ -67,7 +67,11 @@
- + diff --git a/packages/builder/src/pages/builder/portal/_components/BudibaseLogo.svelte b/packages/builder/src/pages/builder/portal/_components/BudibaseLogo.svelte new file mode 100644 index 0000000000..b0dc4cda50 --- /dev/null +++ b/packages/builder/src/pages/builder/portal/_components/BudibaseLogo.svelte @@ -0,0 +1,15 @@ + + + + +Budibase Logo $goto("./apps")} /> + + diff --git a/packages/builder/src/pages/builder/portal/_layout.svelte b/packages/builder/src/pages/builder/portal/_layout.svelte index aad33f852a..18378c37e9 100644 --- a/packages/builder/src/pages/builder/portal/_layout.svelte +++ b/packages/builder/src/pages/builder/portal/_layout.svelte @@ -1,7 +1,7 @@ + + { + e.stopPropagation() + const userAppFavourites = new Set([...($auth.user.appFavourites || [])]) + let processedAppIds = [] + + if ($auth.user.appFavourites && app?.appId) { + if (userAppFavourites.has(app.appId)) { + userAppFavourites.delete(app.appId) + } else { + userAppFavourites.add(app.appId) + } + processedAppIds = [...userAppFavourites] + } else { + processedAppIds = [app.appId] + } + + await auth.updateSelf({ + appFavourites: processedAppIds, + }) + }} + disabled={!app} +/> diff --git a/packages/builder/src/pages/builder/portal/apps/[appId]/_layout.svelte b/packages/builder/src/pages/builder/portal/apps/[appId]/_layout.svelte index f1ed686a3a..871326eb91 100644 --- a/packages/builder/src/pages/builder/portal/apps/[appId]/_layout.svelte +++ b/packages/builder/src/pages/builder/portal/apps/[appId]/_layout.svelte @@ -1,8 +1,8 @@ + +
{#if $sideBarCollapsed} - sideBarCollapsed.set(false)} - > - Menu - +
sideBarCollapsed.set(false)}> + +
{:else} - sideBarCollapsed.set(true)} - > - Collapse - +
sideBarCollapsed.set(true)}> + +
{/if} {#if isBuilder} - $goto(`/builder/app/${app.devId}`)} > Edit - + {/if} - window.open(iframeUrl, "_blank")} - > - Fullscreen - +
+ +
+
window.open(iframeUrl, "_blank")}> + +
+
{#if noScreens}
@@ -83,6 +113,15 @@
diff --git a/packages/builder/src/pages/builder/portal/apps/_layout.svelte b/packages/builder/src/pages/builder/portal/apps/_layout.svelte index 8810edca9c..00719dc6d5 100644 --- a/packages/builder/src/pages/builder/portal/apps/_layout.svelte +++ b/packages/builder/src/pages/builder/portal/apps/_layout.svelte @@ -2,7 +2,7 @@ import { notifications } from "@budibase/bbui" import { admin, - apps, + appsStore, templates, licensing, groups, @@ -14,7 +14,7 @@ import PortalSideBar from "./_components/PortalSideBar.svelte" // Don't block loading if we've already hydrated state - let loaded = !!$apps?.length + let loaded = !!$appsStore.apps?.length onMount(async () => { try { @@ -34,7 +34,10 @@ } // Go to new app page if no apps exists - if (!$apps.length && sdk.users.hasBuilderPermissions($auth.user)) { + if ( + !$appsStore.apps.length && + sdk.users.hasBuilderPermissions($auth.user) + ) { $redirect("./onboarding") } } catch (error) { @@ -46,7 +49,7 @@ {#if loaded}
- {#if $apps.length > 0} + {#if $appsStore.apps.length > 0} {/if} diff --git a/packages/builder/src/pages/builder/portal/apps/create.svelte b/packages/builder/src/pages/builder/portal/apps/create.svelte index 1f2c579071..1248c41cf8 100644 --- a/packages/builder/src/pages/builder/portal/apps/create.svelte +++ b/packages/builder/src/pages/builder/portal/apps/create.svelte @@ -5,7 +5,7 @@ import CreateAppModal from "components/start/CreateAppModal.svelte" import TemplateDisplay from "components/common/TemplateDisplay.svelte" import AppLimitModal from "components/portal/licensing/AppLimitModal.svelte" - import { apps, templates, licensing } from "stores/portal" + import { appsStore, templates, licensing } from "stores/portal" import { Breadcrumbs, Breadcrumb, Header } from "components/portal/page" let template @@ -35,7 +35,7 @@ } -{#if !$apps.length} +{#if !$appsStore.apps.length} {:else} diff --git a/packages/builder/src/pages/builder/portal/apps/index.svelte b/packages/builder/src/pages/builder/portal/apps/index.svelte index a1aa242a36..9a073d041f 100644 --- a/packages/builder/src/pages/builder/portal/apps/index.svelte +++ b/packages/builder/src/pages/builder/portal/apps/index.svelte @@ -19,13 +19,18 @@ import { automationStore, initialise } from "stores/builder" import { API } from "api" import { onMount } from "svelte" - import { apps, auth, admin, licensing, environment } from "stores/portal" + import { + appsStore, + auth, + admin, + licensing, + environment, + enrichedApps, + } from "stores/portal" import { goto } from "@roxi/routify" import AppRow from "components/start/AppRow.svelte" - import { AppStatus } from "constants" import Logo from "assets/bb-space-man.svg" - let sortBy = "name" let template let creationModal let appLimitModal @@ -33,56 +38,27 @@ let searchTerm = "" let creatingFromTemplate = false let automationErrors - let accessFilterList = null $: welcomeHeader = `Welcome ${$auth?.user?.firstName || "back"}` - $: enrichedApps = enrichApps($apps, $auth.user, sortBy) - $: filteredApps = enrichedApps.filter( - app => - (searchTerm - ? app?.name?.toLowerCase().includes(searchTerm.toLowerCase()) - : true) && - (accessFilterList !== null - ? accessFilterList?.includes( - `${app?.type}_${app?.tenantId}_${app?.appId}` - ) - : true) - ) - $: automationErrors = getAutomationErrors(enrichedApps) + $: filteredApps = filterApps($enrichedApps, searchTerm) + $: automationErrors = getAutomationErrors(filteredApps || []) $: isOwner = $auth.accountPortalAccess && $admin.cloud + const filterApps = (apps, searchTerm) => { + return apps?.filter(app => { + const query = searchTerm?.trim()?.replace(/\s/g, "") + if (query) { + return app?.name?.toLowerCase().includes(query.toLowerCase()) + } else { + return true + } + }) + } + const usersLimitLockAction = $licensing?.errUserLimit ? () => accountLockedModal.show() : null - const enrichApps = (apps, user, sortBy) => { - const enrichedApps = apps.map(app => ({ - ...app, - deployed: app.status === AppStatus.DEPLOYED, - lockedYou: app.lockedBy && app.lockedBy.email === user?.email, - lockedOther: app.lockedBy && app.lockedBy.email !== user?.email, - })) - - if (sortBy === "status") { - return enrichedApps.sort((a, b) => { - if (a.status === b.status) { - return a.name?.toLowerCase() < b.name?.toLowerCase() ? -1 : 1 - } - return a.status === AppStatus.DEPLOYED ? -1 : 1 - }) - } else if (sortBy === "updated") { - return enrichedApps.sort((a, b) => { - const aUpdated = a.updatedAt || "9999" - const bUpdated = b.updatedAt || "9999" - return aUpdated < bUpdated ? 1 : -1 - }) - } else { - return enrichedApps.sort((a, b) => { - return a.name?.toLowerCase() < b.name?.toLowerCase() ? -1 : 1 - }) - } - } - const getAutomationErrors = apps => { const automationErrors = {} for (let app of apps) { @@ -109,7 +85,7 @@ } const automationErrorMessage = appId => { - const app = enrichedApps.find(app => app.devId === appId) + const app = $enrichedApps.find(app => app.devId === appId) const errors = automationErrors[appId] return `${app.name} - Automation error (${errorCount(errors)})` } @@ -117,7 +93,7 @@ const initiateAppCreation = async () => { if ($licensing?.usageMetrics?.apps >= 100) { appLimitModal.show() - } else if ($apps?.length) { + } else if ($appsStore.apps?.length) { $goto("/builder/portal/apps/create") } else { template = null @@ -136,7 +112,7 @@ const templateKey = template.key.split("/")[1] let appName = templateKey.replace(/-/g, " ") - const appsWithSameName = $apps.filter(app => + const appsWithSameName = $appsStore.apps.filter(app => app.name?.startsWith(appName) ) appName = `${appName} ${appsWithSameName.length + 1}` @@ -217,7 +193,7 @@ : "View error"} on:dismiss={async () => { await automationStore.actions.clearLogErrors({ appId }) - await apps.load() + await appsStore.load() }} message={automationErrorMessage(appId)} /> @@ -233,7 +209,7 @@
- {#if enrichedApps.length} + {#if $appsStore.apps.length}
{#if $auth.user && sdk.users.canCreateApps($auth.user)} @@ -245,7 +221,7 @@ > Create new app - {#if $apps?.length > 0 && !$admin.offlineMode} + {#if $appsStore.apps?.length > 0 && !$admin.offlineMode} +
- +
+ +
+ + diff --git a/packages/builder/src/pages/builder/portal/users/groups/_components/GroupNameTableRenderer.svelte b/packages/builder/src/pages/builder/portal/users/groups/_components/GroupNameTableRenderer.svelte index 831ac6e20b..30da076e9c 100644 --- a/packages/builder/src/pages/builder/portal/users/groups/_components/GroupNameTableRenderer.svelte +++ b/packages/builder/src/pages/builder/portal/users/groups/_components/GroupNameTableRenderer.svelte @@ -1,5 +1,6 @@
- {#if !scimEnabled} + {#if isScimGroup} + + {:else if !readonly} - {:else} - {/if}
diff --git a/packages/builder/src/pages/builder/portal/users/groups/index.svelte b/packages/builder/src/pages/builder/portal/users/groups/index.svelte index ab0a0eb938..5636d555ae 100644 --- a/packages/builder/src/pages/builder/portal/users/groups/index.svelte +++ b/packages/builder/src/pages/builder/portal/users/groups/index.svelte @@ -13,7 +13,7 @@ Search, notifications, } from "@budibase/bbui" - import { groups, auth, licensing, admin, features } from "stores/portal" + import { groups, auth, licensing, admin } from "stores/portal" import { onMount } from "svelte" import CreateEditGroupModal from "./_components/CreateEditGroupModal.svelte" import { cloneDeep } from "lodash/fp" @@ -21,7 +21,6 @@ import UsersTableRenderer from "./_components/UsersTableRenderer.svelte" import GroupNameTableRenderer from "./_components/GroupNameTableRenderer.svelte" import { goto } from "@roxi/routify" - import ScimBanner from "../_components/SCIMBanner.svelte" import { sdk } from "@budibase/shared-core" const DefaultGroup = { @@ -110,14 +109,10 @@
{#if $licensing.groupsEnabled} - {#if !$features.isScimEnabled} - - - {:else} - - {/if} + + {:else} -
- - addGroup(e.detail)} - on:deselect={e => removeGroup(e.detail)} - iconComponent={GroupIcon} - extractIconProps={item => ({ group: item, size: "S" })} - /> - + {#if internalGroups?.length && isAdmin} +
+ +
+ + addGroup(e.detail)} + on:deselect={e => removeGroup(e.detail)} + iconComponent={GroupIcon} + extractIconProps={item => ({ group: item, size: "S" })} + /> + + {/if}
!g?.scimInfo?.isSync) + function removeInput(idx) { userData = userData.filter((e, i) => i !== idx) } @@ -133,12 +135,12 @@ {/if} - {#if $licensing.groupsEnabled} + {#if $licensing.groupsEnabled && internalGroups?.length} option.name} getOptionValue={option => option._id} /> diff --git a/packages/builder/src/pages/builder/portal/users/users/_components/AppsTableRenderer.svelte b/packages/builder/src/pages/builder/portal/users/users/_components/AppsTableRenderer.svelte index 32e50ef05f..28057f609c 100644 --- a/packages/builder/src/pages/builder/portal/users/users/_components/AppsTableRenderer.svelte +++ b/packages/builder/src/pages/builder/portal/users/users/_components/AppsTableRenderer.svelte @@ -1,6 +1,6 @@ + +{value} +{#if row.scimInfo?.isSync} + +{/if} diff --git a/packages/builder/src/pages/builder/portal/users/users/_components/ImportUsersModal.svelte b/packages/builder/src/pages/builder/portal/users/users/_components/ImportUsersModal.svelte index bb03f166b3..432fb7abb7 100644 --- a/packages/builder/src/pages/builder/portal/users/users/_components/ImportUsersModal.svelte +++ b/packages/builder/src/pages/builder/portal/users/users/_components/ImportUsersModal.svelte @@ -34,6 +34,8 @@ label: `${option.label} - ${option.subtitle}`, })) + $: internalGroups = $groups?.filter(g => !g?.scimInfo?.isSync) + const validEmails = userEmails => { if ($admin.cloud && userEmails.length > MAX_USERS_UPLOAD_LIMIT) { notifications.error( @@ -106,12 +108,12 @@ {/if} - {#if $licensing.groupsEnabled} + {#if $licensing.groupsEnabled && internalGroups?.length} option.name} getOptionValue={option => option._id} /> diff --git a/packages/builder/src/pages/builder/portal/users/users/_components/RemoveGroupTableRenderer.svelte b/packages/builder/src/pages/builder/portal/users/users/_components/RemoveGroupTableRenderer.svelte index df25ae7d30..5eacdec944 100644 --- a/packages/builder/src/pages/builder/portal/users/users/_components/RemoveGroupTableRenderer.svelte +++ b/packages/builder/src/pages/builder/portal/users/users/_components/RemoveGroupTableRenderer.svelte @@ -5,6 +5,7 @@ import { sdk } from "@budibase/shared-core" export let value + export let row const groupContext = getContext("groups") @@ -12,12 +13,11 @@ e.stopPropagation() groupContext.removeGroup(value) } + + $: disabled = !sdk.users.isAdmin($auth.user) || row?.scimInfo?.isSync + $: tooltip = row?.scimInfo?.isSync && "This group is managed via your AD" -Remove - Remove - diff --git a/packages/builder/src/pages/builder/portal/users/users/index.svelte b/packages/builder/src/pages/builder/portal/users/users/index.svelte index 18ee4f7d43..c2fbce5747 100644 --- a/packages/builder/src/pages/builder/portal/users/users/index.svelte +++ b/packages/builder/src/pages/builder/portal/users/users/index.svelte @@ -19,7 +19,6 @@ auth, licensing, organisation, - features, admin, } from "stores/portal" import { onMount } from "svelte" @@ -28,6 +27,7 @@ import GroupsTableRenderer from "./_components/GroupsTableRenderer.svelte" import AppsTableRenderer from "./_components/AppsTableRenderer.svelte" import RoleTableRenderer from "./_components/RoleTableRenderer.svelte" + import EmailTableRenderer from "./_components/EmailTableRenderer.svelte" import { goto } from "@roxi/routify" import OnboardingTypeModal from "./_components/OnboardingTypeModal.svelte" import PasswordModal from "./_components/PasswordModal.svelte" @@ -37,7 +37,6 @@ import { Constants, Utils, fetchData } from "@budibase/frontend-core" import { API } from "api" import { OnboardingType } from "constants" - import ScimBanner from "../_components/SCIMBanner.svelte" import { sdk } from "@budibase/shared-core" const fetch = fetchData({ @@ -63,6 +62,7 @@ let selectedRows = [] let bulkSaveResponse let customRenderers = [ + { column: "email", component: EmailTableRenderer }, { column: "userGroups", component: GroupsTableRenderer }, { column: "apps", component: AppsTableRenderer }, { column: "role", component: RoleTableRenderer }, @@ -73,7 +73,7 @@ let parsedInvites = [] $: isOwner = $auth.accountPortalAccess && $admin.cloud - $: readonly = !sdk.users.isAdmin($auth.user) || $features.isScimEnabled + $: readonly = !sdk.users.isAdmin($auth.user) $: debouncedUpdateFetch(searchEmail) $: schema = { email: { @@ -247,19 +247,25 @@ } } - const deleteRows = async () => { + const deleteUsers = async () => { try { let ids = selectedRows.map(user => user._id) if (ids.includes(get(auth).user._id)) { notifications.error("You cannot delete yourself") return } + + if (selectedRows.some(u => u.scimInfo?.isSync)) { + notifications.error("You cannot remove users created via your AD") + return + } + await users.bulkDelete(ids) notifications.success(`Successfully deleted ${selectedRows.length} rows`) selectedRows = [] await fetch.refresh() } catch (error) { - notifications.error("Error deleting rows") + notifications.error("Error deleting users") } } @@ -320,8 +326,6 @@ Import - {:else} - {/if}
@@ -330,7 +334,7 @@ item="user" on:updaterows {selectedRows} - {deleteRows} + deleteRows={deleteUsers} /> {/if}
@@ -346,6 +350,7 @@ {customRenderers} loading={!$fetch.loaded || !groupsLoaded} /> + +
({ ...state, - highlightedSettingKey: key, + highlightedSetting: key ? { key, type: type || "info" } : null, })) } @@ -135,25 +133,20 @@ export class BuilderStore extends BudiStore { })) } - startTour(tourKey) { + endBuilderOnboarding() { this.update(state => ({ ...state, - tourKey: tourKey, + onboarding: false, })) } - hover(componentId, notifyClient = true) { - const store = get(this.store) - if (componentId === store.hoveredComponentId) { - return - } - this.update(state => { - state.hoveredComponentId = componentId - return state - }) - if (notifyClient) { - previewStore.sendEvent("hover-component", componentId) - } + setTour(tourKey) { + this.update(state => ({ + ...state, + tourStepKey: null, + tourNodes: null, + tourKey: tourKey, + })) } } diff --git a/packages/builder/src/stores/builder/componentTreeNodes.js b/packages/builder/src/stores/builder/componentTreeNodes.js new file mode 100644 index 0000000000..a8e09a2051 --- /dev/null +++ b/packages/builder/src/stores/builder/componentTreeNodes.js @@ -0,0 +1,67 @@ +import { get } from "svelte/store" +import { createSessionStorageStore } from "@budibase/frontend-core" +import { selectedScreen as selectedScreenStore } from "./screens" +import { findComponentPath } from "helpers/components" + +const baseStore = createSessionStorageStore("openNodes", {}) + +const toggleNode = componentId => { + baseStore.update(openNodes => { + openNodes[`nodeOpen-${componentId}`] = !openNodes[`nodeOpen-${componentId}`] + + return openNodes + }) +} + +const expandNodes = componentIds => { + baseStore.update(openNodes => { + const newNodes = Object.fromEntries( + componentIds.map(id => [`nodeOpen-${id}`, true]) + ) + + return { ...openNodes, ...newNodes } + }) +} + +const collapseNodes = componentIds => { + baseStore.update(openNodes => { + const newNodes = Object.fromEntries( + componentIds.map(id => [`nodeOpen-${id}`, false]) + ) + + return { ...openNodes, ...newNodes } + }) +} + +// Will ensure all parents of a node are expanded so that it is visible in the tree +const makeNodeVisible = componentId => { + const selectedScreen = get(selectedScreenStore) + + const path = findComponentPath(selectedScreen.props, componentId) + + const componentIds = path.map(component => component._id) + + baseStore.update(openNodes => { + const newNodes = Object.fromEntries( + componentIds.map(id => [`nodeOpen-${id}`, true]) + ) + + return { ...openNodes, ...newNodes } + }) +} + +const isNodeExpanded = componentId => { + const openNodes = get(baseStore) + return !!openNodes[`nodeOpen-${componentId}`] +} + +const store = { + subscribe: baseStore.subscribe, + toggleNode, + expandNodes, + makeNodeVisible, + collapseNodes, + isNodeExpanded, +} + +export default store diff --git a/packages/builder/src/stores/builder/components.js b/packages/builder/src/stores/builder/components.js index d7572dca60..fe5f4e8a05 100644 --- a/packages/builder/src/stores/builder/components.js +++ b/packages/builder/src/stores/builder/components.js @@ -19,6 +19,7 @@ import { appStore, previewStore, tables, + componentTreeNodesStore, } from "stores/builder/index" import { buildFormSchema, getSchemaForDatasource } from "dataBinding" import { @@ -27,9 +28,8 @@ import { DB_TYPE_INTERNAL, DB_TYPE_EXTERNAL, } from "constants/backend" -import BudiStore from "./BudiStore" +import BudiStore from "../BudiStore" import { Utils } from "@budibase/frontend-core" -import componentTreeNodesStore from "stores/portal/componentTreeNodesStore" export const INITIAL_COMPONENTS_STATE = { components: {}, @@ -279,12 +279,10 @@ export class ComponentStore extends BudiStore { else { if (setting.type === "dataProvider") { // Validate data provider exists, or else clear it - const treeId = parent?._id || component._id - const path = findComponentPath(screen?.props, treeId) - const providers = path.filter(component => - component._component?.endsWith("/dataprovider") + const providers = findAllMatchingComponents( + screen?.props, + x => x._component === "@budibase/standard-components/dataprovider" ) - // Validate non-empty values const valid = providers?.some(dp => value.includes?.(dp._id)) if (!valid) { if (providers.length) { @@ -653,8 +651,11 @@ export class ComponentStore extends BudiStore { this.update(state => { state.selectedScreenId = targetScreenId state.selectedComponentId = newComponentId + return state }) + + componentTreeNodesStore.makeNodeVisible(newComponentId) } getPrevious() { @@ -663,7 +664,6 @@ export class ComponentStore extends BudiStore { const screen = get(selectedScreen) const parent = findComponentParent(screen.props, componentId) const index = parent?._children.findIndex(x => x._id === componentId) - const componentTreeNodes = get(componentTreeNodesStore) // Check for screen and navigation component edge cases const screenComponentId = `${screen._id}-screen` @@ -680,16 +680,16 @@ export class ComponentStore extends BudiStore { // If we have siblings above us, choose the sibling or a descendant if (index > 0) { - // If sibling before us accepts children, select a descendant + // If sibling before us accepts children, and is not collapsed, select a descendant const previousSibling = parent._children[index - 1] if ( previousSibling._children?.length && - componentTreeNodes[`nodeOpen-${previousSibling._id}`] + componentTreeNodesStore.isNodeExpanded(previousSibling._id) ) { let target = previousSibling while ( target._children?.length && - componentTreeNodes[`nodeOpen-${target._id}`] + componentTreeNodesStore.isNodeExpanded(target._id) ) { target = target._children[target._children.length - 1] } @@ -711,7 +711,6 @@ export class ComponentStore extends BudiStore { const screen = get(selectedScreen) const parent = findComponentParent(screen.props, componentId) const index = parent?._children.findIndex(x => x._id === componentId) - const componentTreeNodes = get(componentTreeNodesStore) // Check for screen and navigation component edge cases const screenComponentId = `${screen._id}-screen` @@ -720,11 +719,11 @@ export class ComponentStore extends BudiStore { return navComponentId } - // If we have children, select first child + // If we have children, select first child, and the node is not collapsed if ( component._children?.length && (state.selectedComponentId === navComponentId || - componentTreeNodes[`nodeOpen-${component._id}`]) + componentTreeNodesStore.isNodeExpanded(component._id)) ) { return component._children[0]._id } else if (!parent) { @@ -803,7 +802,10 @@ export class ComponentStore extends BudiStore { // sibling const previousSibling = parent._children[index - 1] const definition = this.getDefinition(previousSibling._component) - if (definition.hasChildren) { + if ( + definition.hasChildren && + componentTreeNodesStore.isNodeExpanded(previousSibling._id) + ) { previousSibling._children.push(originalComponent) } @@ -852,10 +854,13 @@ export class ComponentStore extends BudiStore { // Move below the next sibling if we are not the last sibling if (index < parent._children.length) { - // If the next sibling has children, become the first child + // If the next sibling has children, and is not collapsed, become the first child const nextSibling = parent._children[index] const definition = this.getDefinition(nextSibling._component) - if (definition.hasChildren) { + if ( + definition.hasChildren && + componentTreeNodesStore.isNodeExpanded(nextSibling._id) + ) { nextSibling._children.splice(0, 0, originalComponent) } @@ -1151,13 +1156,3 @@ export const selectedComponent = derived( return clone } ) - -export const selectedComponentPath = derived( - [componentStore, selectedScreen], - ([$store, $selectedScreen]) => { - return findComponentPath( - $selectedScreen?.props, - $store.selectedComponentId - ).map(component => component._id) - } -) diff --git a/packages/builder/src/stores/builder/hover.js b/packages/builder/src/stores/builder/hover.js index 064d5c15cf..98cdc9e416 100644 --- a/packages/builder/src/stores/builder/hover.js +++ b/packages/builder/src/stores/builder/hover.js @@ -1,18 +1,31 @@ import { get } from "svelte/store" import { previewStore } from "stores/builder" -import BudiStore from "./BudiStore" +import BudiStore from "../BudiStore" export const INITIAL_HOVER_STATE = { componentId: null, } export class HoverStore extends BudiStore { + hoverTimeout + constructor() { super({ ...INITIAL_HOVER_STATE }) this.hover = this.hover.bind(this) } hover(componentId, notifyClient = true) { + clearTimeout(this.hoverTimeout) + if (componentId) { + this.processHover(componentId, notifyClient) + } else { + this.hoverTimeout = setTimeout(() => { + this.processHover(componentId, notifyClient) + }, 10) + } + } + + processHover(componentId, notifyClient) { if (componentId === get(this.store).componentId) { return } diff --git a/packages/builder/src/stores/builder/index.js b/packages/builder/src/stores/builder/index.js index bac9fb8826..5e94ce0552 100644 --- a/packages/builder/src/stores/builder/index.js +++ b/packages/builder/src/stores/builder/index.js @@ -1,10 +1,6 @@ import { layoutStore } from "./layouts.js" import { appStore } from "./app.js" -import { - componentStore, - selectedComponent, - selectedComponentPath, -} from "./components" +import { componentStore, selectedComponent } from "./components" import { navigationStore } from "./navigation.js" import { themeStore } from "./theme.js" import { screenStore, selectedScreen, sortedScreens } from "./screens.js" @@ -18,6 +14,7 @@ import { } from "./automations.js" import { userStore, userSelectedResourceMap, isOnlyUser } from "./users.js" import { deploymentStore } from "./deployments.js" +import { snippets } from "./snippets" // Backend import { tables } from "./tables" @@ -30,8 +27,10 @@ import { integrations } from "./integrations" import { sortedIntegrations } from "./sortedIntegrations" import { queries } from "./queries" import { flags } from "./flags" +import componentTreeNodesStore from "./componentTreeNodes" export { + componentTreeNodesStore, layoutStore, appStore, componentStore, @@ -50,7 +49,6 @@ export { isOnlyUser, deploymentStore, selectedComponent, - selectedComponentPath, tables, views, viewsV2, @@ -62,6 +60,7 @@ export { queries, flags, hoverStore, + snippets, } export const reset = () => { @@ -101,6 +100,7 @@ export const initialise = async pkg => { builderStore.init(application) navigationStore.syncAppNavigation(application?.navigation) themeStore.syncAppTheme(application) + snippets.syncMetadata(application) screenStore.syncAppScreens(pkg) layoutStore.syncAppLayouts(pkg) resetBuilderHistory() diff --git a/packages/builder/src/stores/builder/layouts.js b/packages/builder/src/stores/builder/layouts.js index e9a84a1d4a..30d6935b19 100644 --- a/packages/builder/src/stores/builder/layouts.js +++ b/packages/builder/src/stores/builder/layouts.js @@ -1,6 +1,6 @@ import { derived, get } from "svelte/store" import { componentStore } from "stores/builder" -import BudiStore from "./BudiStore" +import BudiStore from "../BudiStore" import { API } from "api" export const INITIAL_LAYOUT_STATE = { diff --git a/packages/builder/src/stores/builder/navigation.js b/packages/builder/src/stores/builder/navigation.js index 6d53a41019..0cc4923c56 100644 --- a/packages/builder/src/stores/builder/navigation.js +++ b/packages/builder/src/stores/builder/navigation.js @@ -1,7 +1,7 @@ import { get } from "svelte/store" import { API } from "api" import { appStore } from "stores/builder" -import BudiStore from "./BudiStore" +import BudiStore from "../BudiStore" export const INITIAL_NAVIGATION_STATE = { navigation: "Top", @@ -11,6 +11,7 @@ export const INITIAL_NAVIGATION_STATE = { hideLogo: null, logoUrl: null, hideTitle: null, + textAlign: "Left", navBackground: null, navWidth: null, navTextColor: null, diff --git a/packages/builder/src/stores/builder/preview.js b/packages/builder/src/stores/builder/preview.js index ecdd4573de..4923185ee7 100644 --- a/packages/builder/src/stores/builder/preview.js +++ b/packages/builder/src/stores/builder/preview.js @@ -4,6 +4,7 @@ const INITIAL_PREVIEW_STATE = { previewDevice: "desktop", previewEventHandler: null, showPreview: false, + selectedComponentContext: null, } export const createPreviewStore = () => { @@ -52,6 +53,17 @@ export const createPreviewStore = () => { }) } + const setSelectedComponentContext = context => { + store.update(state => { + state.selectedComponentContext = context + return state + }) + } + + const requestComponentContext = () => { + sendEvent("request-context") + } + return { subscribe: store.subscribe, setDevice, @@ -60,6 +72,8 @@ export const createPreviewStore = () => { startDrag, stopDrag, showPreview, + setSelectedComponentContext, + requestComponentContext, } } diff --git a/packages/builder/src/stores/builder/screens.js b/packages/builder/src/stores/builder/screens.js index a646dee2f8..7339593960 100644 --- a/packages/builder/src/stores/builder/screens.js +++ b/packages/builder/src/stores/builder/screens.js @@ -12,7 +12,7 @@ import { } from "stores/builder" import { createHistoryStore } from "stores/builder/history" import { API } from "api" -import BudiStore from "./BudiStore" +import BudiStore from "../BudiStore" export const INITIAL_SCREENS_STATE = { screens: [], diff --git a/packages/builder/src/stores/builder/snippets.js b/packages/builder/src/stores/builder/snippets.js new file mode 100644 index 0000000000..72ab274730 --- /dev/null +++ b/packages/builder/src/stores/builder/snippets.js @@ -0,0 +1,41 @@ +import { writable, get } from "svelte/store" +import { API } from "api" +import { appStore } from "./app" + +const createsnippets = () => { + const store = writable([]) + + const syncMetadata = metadata => { + store.set(metadata?.snippets || []) + } + + const saveSnippet = async updatedSnippet => { + const snippets = [ + ...get(store).filter(snippet => snippet.name !== updatedSnippet.name), + updatedSnippet, + ] + const app = await API.saveAppMetadata({ + appId: get(appStore).appId, + metadata: { snippets }, + }) + syncMetadata(app) + } + + const deleteSnippet = async snippetName => { + const snippets = get(store).filter(snippet => snippet.name !== snippetName) + const app = await API.saveAppMetadata({ + appId: get(appStore).appId, + metadata: { snippets }, + }) + syncMetadata(app) + } + + return { + ...store, + syncMetadata, + saveSnippet, + deleteSnippet, + } +} + +export const snippets = createsnippets() diff --git a/packages/builder/src/stores/builder/tests/builder.test.js b/packages/builder/src/stores/builder/tests/builder.test.js index 7aac2489db..e6f52689aa 100644 --- a/packages/builder/src/stores/builder/tests/builder.test.js +++ b/packages/builder/src/stores/builder/tests/builder.test.js @@ -88,14 +88,42 @@ describe("Builder store", () => { ) }) - it("Sync a highlighted setting key to state", ctx => { - expect(ctx.test.store.highlightedSettingKey).toBeNull() + it("Sync a highlighted setting key to state. Default to info type", ctx => { + expect(ctx.test.store.highlightedSetting).toBeNull() ctx.test.builderStore.highlightSetting("testing") expect(ctx.test.store).toStrictEqual({ ...INITIAL_BUILDER_STATE, - highlightedSettingKey: "testing", + highlightedSetting: { + key: "testing", + type: "info", + }, + }) + }) + + it("Sync a highlighted setting key to state. Use provided type", ctx => { + expect(ctx.test.store.highlightedSetting).toBeNull() + + ctx.test.builderStore.highlightSetting("testing", "error") + + expect(ctx.test.store).toStrictEqual({ + ...INITIAL_BUILDER_STATE, + highlightedSetting: { + key: "testing", + type: "error", + }, + }) + }) + + it("Sync a highlighted setting key to state. Unset when no value is passed", ctx => { + expect(ctx.test.store.highlightedSetting).toBeNull() + + ctx.test.builderStore.highlightSetting("testing", "error") + ctx.test.builderStore.highlightSetting() + + expect(ctx.test.store).toStrictEqual({ + ...INITIAL_BUILDER_STATE, }) }) diff --git a/packages/builder/src/stores/builder/websocket.js b/packages/builder/src/stores/builder/websocket.js index bbdf7b6d63..7df5ab9adb 100644 --- a/packages/builder/src/stores/builder/websocket.js +++ b/packages/builder/src/stores/builder/websocket.js @@ -6,11 +6,12 @@ import { themeStore, navigationStore, deploymentStore, + snippets, datasources, tables, } from "stores/builder" import { get } from "svelte/store" -import { auth, apps } from "stores/portal" +import { auth, appsStore } from "stores/portal" import { screenStore } from "./screens" import { SocketEvent, BuilderSocketEvent, helpers } from "@budibase/shared-core" import { notifications } from "@budibase/bbui" @@ -64,11 +65,12 @@ export const createBuilderWebsocket = appId => { appStore.syncMetadata(metadata) themeStore.syncMetadata(metadata) navigationStore.syncMetadata(metadata) + snippets.syncMetadata(metadata) }) socket.onOther( BuilderSocketEvent.AppPublishChange, async ({ user, published }) => { - await apps.load() + await appsStore.load() if (published) { await deploymentStore.load() } diff --git a/packages/builder/src/stores/portal/admin.js b/packages/builder/src/stores/portal/admin.js index 2106acac27..29d4585c06 100644 --- a/packages/builder/src/stores/portal/admin.js +++ b/packages/builder/src/stores/portal/admin.js @@ -17,6 +17,7 @@ export const DEFAULT_CONFIG = { adminUser: { checked: false }, sso: { checked: false }, }, + maintenance: [], offlineMode: false, } @@ -48,6 +49,7 @@ export function createAdminStore() { store.isDev = environment.isDev store.baseUrl = environment.baseUrl store.offlineMode = environment.offlineMode + store.maintenance = environment.maintenance return store }) } diff --git a/packages/builder/src/stores/portal/apps.js b/packages/builder/src/stores/portal/apps.js index 5fcf567ef5..84c4348075 100644 --- a/packages/builder/src/stores/portal/apps.js +++ b/packages/builder/src/stores/portal/apps.js @@ -1,39 +1,61 @@ -import { writable } from "svelte/store" +import { derived } from "svelte/store" import { AppStatus } from "constants" import { API } from "api" +import { auth } from "./auth" +import BudiStore from "../BudiStore" // move this // properties that should always come from the dev app, not the deployed const DEV_PROPS = ["updatedBy", "updatedAt"] -const extractAppId = id => { - const split = id?.split("_") || [] - return split.length ? split[split.length - 1] : null +export const INITIAL_APPS_STATE = { + apps: [], + sortBy: "name", } -const getProdAppID = appId => { - if (!appId) { - return appId - } - let rest, - separator = "" - if (appId.startsWith("app_dev")) { - // split to take off the app_dev element, then join it together incase any other app_ exist - const split = appId.split("app_dev") - split.shift() - rest = split.join("app_dev") - } else if (!appId.startsWith("app")) { - rest = appId - separator = "_" - } else { - return appId - } - return `app${separator}${rest}` -} +export class AppsStore extends BudiStore { + constructor() { + super({ ...INITIAL_APPS_STATE }) -export function createAppStore() { - const store = writable([]) + this.extractAppId = this.extractAppId.bind(this) + this.getProdAppID = this.getProdAppID.bind(this) + this.updateSort = this.updateSort.bind(this) + this.load = this.load.bind(this) + this.save = this.save.bind(this) + } - async function load() { + extractAppId(id) { + const split = id?.split("_") || [] + return split.length ? split[split.length - 1] : null + } + + getProdAppID(appId) { + if (!appId) { + return appId + } + let rest, + separator = "" + if (appId.startsWith("app_dev")) { + // split to take off the app_dev element, then join it together incase any other app_ exist + const split = appId.split("app_dev") + split.shift() + rest = split.join("app_dev") + } else if (!appId.startsWith("app")) { + rest = appId + separator = "_" + } else { + return appId + } + return `app${separator}${rest}` + } + + updateSort(sortBy) { + this.update(state => ({ + ...state, + sortBy, + })) + } + + async load() { const json = await API.getApps() if (Array.isArray(json)) { // Merge apps into one sensible list @@ -43,7 +65,7 @@ export function createAppStore() { // First append all dev app version devApps.forEach(app => { - const id = extractAppId(app.appId) + const id = this.extractAppId(app.appId) appMap[id] = { ...app, devId: app.appId, @@ -53,7 +75,7 @@ export function createAppStore() { // Then merge with all prod app versions deployedApps.forEach(app => { - const id = extractAppId(app.appId) + const id = this.extractAppId(app.appId) // Skip any deployed apps which don't have a dev counterpart if (!appMap[id]) { @@ -81,39 +103,80 @@ export function createAppStore() { // Transform into an array and clean up const apps = Object.values(appMap) apps.forEach(app => { - app.appId = extractAppId(app.devId) + app.appId = this.extractAppId(app.devId) delete app._id delete app._rev }) - store.set(apps) + this.update(state => ({ + ...state, + apps, + })) } else { - store.set([]) + this.update(state => ({ + ...state, + apps: [], + })) } } - async function update(appId, value) { + async save(appId, value) { await API.saveAppMetadata({ appId, metadata: value, }) - store.update(state => { - const updatedAppIndex = state.findIndex(app => app.instance._id === appId) + this.update(state => { + const updatedAppIndex = state.apps.findIndex( + app => app.instance._id === appId + ) if (updatedAppIndex !== -1) { - let updatedApp = state[updatedAppIndex] + let updatedApp = state.apps[updatedAppIndex] updatedApp = { ...updatedApp, ...value } - state.apps = state.splice(updatedAppIndex, 1, updatedApp) + state.apps = state.apps.splice(updatedAppIndex, 1, updatedApp) } return state }) } - - return { - subscribe: store.subscribe, - load, - update, - extractAppId, - getProdAppID, - } } -export const apps = createAppStore() +export const appsStore = new AppsStore() + +// Centralise any logic that enriches the apps list +export const enrichedApps = derived([appsStore, auth], ([$store, $auth]) => { + const enrichedApps = $store.apps + ? $store.apps.map(app => ({ + ...app, + deployed: app.status === AppStatus.DEPLOYED, + lockedYou: app.lockedBy && app.lockedBy.email === $auth.user?.email, + lockedOther: app.lockedBy && app.lockedBy.email !== $auth.user?.email, + favourite: $auth?.user.appFavourites?.includes(app.appId), + })) + : [] + + if ($store.sortBy === "status") { + return enrichedApps.sort((a, b) => { + if (a.favourite === b.favourite) { + if (a.status === b.status) { + return a.name?.toLowerCase() < b.name?.toLowerCase() ? -1 : 1 + } + return a.status === AppStatus.DEPLOYED ? -1 : 1 + } + return a.favourite ? -1 : 1 + }) + } else if ($store.sortBy === "updated") { + return enrichedApps?.sort((a, b) => { + if (a.favourite === b.favourite) { + const aUpdated = a.updatedAt || "9999" + const bUpdated = b.updatedAt || "9999" + return aUpdated < bUpdated ? 1 : -1 + } + return a.favourite ? -1 : 1 + }) + } else { + return enrichedApps?.sort((a, b) => { + if (a.favourite === b.favourite) { + return a.name?.toLowerCase() < b.name?.toLowerCase() ? -1 : 1 + } + return a.favourite ? -1 : 1 + }) + } +}) diff --git a/packages/builder/src/stores/portal/componentTreeNodesStore.js b/packages/builder/src/stores/portal/componentTreeNodesStore.js deleted file mode 100644 index a6c07ae03b..0000000000 --- a/packages/builder/src/stores/portal/componentTreeNodesStore.js +++ /dev/null @@ -1,36 +0,0 @@ -import { createSessionStorageStore } from "@budibase/frontend-core" - -const baseStore = createSessionStorageStore("openNodes", {}) - -const toggleNode = componentId => { - baseStore.update(openNodes => { - openNodes[`nodeOpen-${componentId}`] = !openNodes[`nodeOpen-${componentId}`] - - return openNodes - }) -} - -const expandNode = componentId => { - baseStore.update(openNodes => { - openNodes[`nodeOpen-${componentId}`] = true - - return openNodes - }) -} - -const collapseNode = componentId => { - baseStore.update(openNodes => { - openNodes[`nodeOpen-${componentId}`] = false - - return openNodes - }) -} - -const store = { - subscribe: baseStore.subscribe, - toggleNode, - expandNode, - collapseNode, -} - -export default store diff --git a/packages/builder/src/stores/portal/groups.js b/packages/builder/src/stores/portal/groups.js index a505029627..1edc8a461c 100644 --- a/packages/builder/src/stores/portal/groups.js +++ b/packages/builder/src/stores/portal/groups.js @@ -35,7 +35,10 @@ export function createGroupsStore() { get: getGroup, save: async group => { - const response = await API.saveGroup(group) + const { ...dataToSave } = group + delete dataToSave.scimInfo + delete dataToSave.userGroups + const response = await API.saveGroup(dataToSave) group._id = response._id group._rev = response._rev updateStore(group) diff --git a/packages/builder/src/stores/portal/index.js b/packages/builder/src/stores/portal/index.js index ad2a59ddcd..ab3be2ce79 100644 --- a/packages/builder/src/stores/portal/index.js +++ b/packages/builder/src/stores/portal/index.js @@ -3,7 +3,7 @@ import { writable } from "svelte/store" export { organisation } from "./organisation" export { users } from "./users" export { admin } from "./admin" -export { apps } from "./apps" +export { appsStore, enrichedApps } from "./apps" export { email } from "./email" export { auth } from "./auth" export { oidc } from "./oidc" diff --git a/packages/builder/src/templates/formScreen.js b/packages/builder/src/templates/formScreen.js new file mode 100644 index 0000000000..b99744e8e8 --- /dev/null +++ b/packages/builder/src/templates/formScreen.js @@ -0,0 +1,43 @@ +import { Screen } from "./Screen" +import { Component } from "./Component" +import sanitizeUrl from "helpers/sanitizeUrl" + +export const FORM_TEMPLATE = "FORM_TEMPLATE" +export const formUrl = datasource => sanitizeUrl(`/${datasource.label}-form`) + +// Mode not really necessary +export default function (datasources, config) { + if (!Array.isArray(datasources)) { + return [] + } + return datasources.map(datasource => { + return { + name: `${datasource.label} - Form`, + create: () => createScreen(datasource, config), + id: FORM_TEMPLATE, + resourceId: datasource.resourceId, + } + }) +} + +const generateMultistepFormBlock = (dataSource, { actionType } = {}) => { + const multistepFormBlock = new Component( + "@budibase/standard-components/multistepformblock" + ) + multistepFormBlock + .customProps({ + actionType, + dataSource, + steps: [{}], + }) + .instanceName(`${dataSource.label} - Multistep Form block`) + return multistepFormBlock +} + +const createScreen = (datasource, config) => { + return new Screen() + .route(formUrl(datasource)) + .instanceName(`${datasource.label} - Form`) + .addChild(generateMultistepFormBlock(datasource, config)) + .json() +} diff --git a/packages/builder/src/templates/gridDetailsScreen.js b/packages/builder/src/templates/gridDetailsScreen.js new file mode 100644 index 0000000000..35ab651268 --- /dev/null +++ b/packages/builder/src/templates/gridDetailsScreen.js @@ -0,0 +1,158 @@ +import sanitizeUrl from "helpers/sanitizeUrl" +import { Screen } from "./Screen" +import { Component } from "./Component" +import { generate } from "shortid" +import { makePropSafe as safe } from "@budibase/string-templates" +import { Utils } from "@budibase/frontend-core" + +export default function (datasources) { + if (!Array.isArray(datasources)) { + return [] + } + return datasources.map(datasource => { + return { + name: `${datasource.label} - List with panel`, + create: () => createScreen(datasource), + id: GRID_DETAILS_TEMPLATE, + resourceId: datasource.resourceId, + } + }) +} + +export const GRID_DETAILS_TEMPLATE = "GRID_DETAILS_TEMPLATE" +export const gridDetailsUrl = datasource => sanitizeUrl(`/${datasource.label}`) + +const createScreen = datasource => { + /* + Create Row + */ + const createRowSidePanel = new Component( + "@budibase/standard-components/sidepanel" + ).instanceName("New row side panel") + + const buttonGroup = new Component("@budibase/standard-components/buttongroup") + const createButton = new Component("@budibase/standard-components/button") + + createButton.customProps({ + onClick: [ + { + id: 0, + "##eventHandlerType": "Open Side Panel", + parameters: { + id: createRowSidePanel._json._id, + }, + }, + ], + text: "Create row", + type: "cta", + }) + + buttonGroup.instanceName(`${datasource.label} - Create`).customProps({ + hAlign: "right", + buttons: [createButton.json()], + }) + + const gridHeader = new Component("@budibase/standard-components/container") + .instanceName("Heading container") + .customProps({ + direction: "row", + hAlign: "stretch", + }) + + const heading = new Component("@budibase/standard-components/heading") + .instanceName("Table heading") + .customProps({ + text: datasource?.label, + }) + + gridHeader.addChild(heading) + gridHeader.addChild(buttonGroup) + + const createFormBlock = new Component( + "@budibase/standard-components/formblock" + ) + createFormBlock.instanceName("Create row form block").customProps({ + dataSource: datasource, + labelPosition: "left", + buttonPosition: "top", + actionType: "Create", + title: "Create row", + buttons: Utils.buildFormBlockButtonConfig({ + _id: createFormBlock._json._id, + showDeleteButton: false, + showSaveButton: true, + saveButtonLabel: "Save", + actionType: "Create", + dataSource: datasource, + }), + }) + + createRowSidePanel.addChild(createFormBlock) + + /* + Edit Row + */ + const stateKey = `ID_${generate()}` + const detailsSidePanel = new Component( + "@budibase/standard-components/sidepanel" + ).instanceName("Edit row side panel") + + const editFormBlock = new Component("@budibase/standard-components/formblock") + editFormBlock.instanceName("Edit row form block").customProps({ + dataSource: datasource, + labelPosition: "left", + buttonPosition: "top", + actionType: "Update", + title: "Edit", + rowId: `{{ ${safe("state")}.${safe(stateKey)} }}`, + buttons: Utils.buildFormBlockButtonConfig({ + _id: editFormBlock._json._id, + showDeleteButton: true, + showSaveButton: true, + saveButtonLabel: "Save", + deleteButtonLabel: "Delete", + actionType: "Update", + dataSource: datasource, + }), + }) + + detailsSidePanel.addChild(editFormBlock) + + const gridBlock = new Component("@budibase/standard-components/gridblock") + gridBlock + .customProps({ + table: datasource, + allowAddRows: false, + allowEditRows: false, + allowDeleteRows: false, + onRowClick: [ + { + id: 0, + "##eventHandlerType": "Update State", + parameters: { + key: stateKey, + type: "set", + persist: false, + value: `{{ ${safe("eventContext")}.${safe("row")}._id }}`, + }, + }, + { + id: 1, + "##eventHandlerType": "Open Side Panel", + parameters: { + id: detailsSidePanel._json._id, + }, + }, + ], + }) + .instanceName(`${datasource.label} - Table`) + + return new Screen() + .route(gridDetailsUrl(datasource)) + .instanceName(`${datasource.label} - List and details`) + .addChild(gridHeader) + .addChild(gridBlock) + .addChild(createRowSidePanel) + .addChild(detailsSidePanel) + .json() +} diff --git a/packages/builder/src/templates/gridListScreen.js b/packages/builder/src/templates/gridListScreen.js new file mode 100644 index 0000000000..c98d5d4baf --- /dev/null +++ b/packages/builder/src/templates/gridListScreen.js @@ -0,0 +1,41 @@ +import sanitizeUrl from "helpers/sanitizeUrl" +import { Screen } from "./Screen" +import { Component } from "./Component" + +export default function (datasources) { + if (!Array.isArray(datasources)) { + return [] + } + return datasources.map(datasource => { + return { + name: `${datasource.label} - List`, + create: () => createScreen(datasource), + id: GRID_LIST_TEMPLATE, + resourceId: datasource.resourceId, + } + }) +} + +export const GRID_LIST_TEMPLATE = "GRID_LIST_TEMPLATE" +export const gridListUrl = datasource => sanitizeUrl(`/${datasource.label}`) + +const createScreen = datasource => { + const heading = new Component("@budibase/standard-components/heading") + .instanceName("Table heading") + .customProps({ + text: datasource?.label, + }) + + const gridBlock = new Component("@budibase/standard-components/gridblock") + .instanceName(`${datasource.label} - Table`) + .customProps({ + table: datasource, + }) + + return new Screen() + .route(gridListUrl(datasource)) + .instanceName(`${datasource.label} - List`) + .addChild(heading) + .addChild(gridBlock) + .json() +} diff --git a/packages/builder/src/templates/index.js b/packages/builder/src/templates/index.js index 3ff42fdec6..b00b8cb621 100644 --- a/packages/builder/src/templates/index.js +++ b/packages/builder/src/templates/index.js @@ -1,7 +1,13 @@ -import rowListScreen from "./rowListScreen" +import gridListScreen from "./gridListScreen" +import gridDetailsScreen from "./gridDetailsScreen" import createFromScratchScreen from "./createFromScratchScreen" +import formScreen from "./formScreen" -const allTemplates = datasources => [...rowListScreen(datasources)] +const allTemplates = datasources => [ + ...gridListScreen(datasources), + ...gridDetailsScreen(datasources), + ...formScreen(datasources), +] // Allows us to apply common behaviour to all create() functions const createTemplateOverride = template => () => { @@ -19,6 +25,7 @@ export default datasources => { }) const fromScratch = enrichTemplate(createFromScratchScreen) const tableTemplates = allTemplates(datasources).map(enrichTemplate) + return [ fromScratch, ...tableTemplates.sort((templateA, templateB) => { diff --git a/packages/builder/src/templates/rowListScreen.js b/packages/builder/src/templates/rowListScreen.js deleted file mode 100644 index 7781a3d067..0000000000 --- a/packages/builder/src/templates/rowListScreen.js +++ /dev/null @@ -1,63 +0,0 @@ -import sanitizeUrl from "helpers/sanitizeUrl" -import { Screen } from "./Screen" -import { Component } from "./Component" - -export default function (datasources, mode = "table") { - if (!Array.isArray(datasources)) { - return [] - } - return datasources.map(datasource => { - return { - name: `${datasource.label} - List`, - create: () => createScreen(datasource, mode), - id: ROW_LIST_TEMPLATE, - resourceId: datasource.resourceId, - } - }) -} - -export const ROW_LIST_TEMPLATE = "ROW_LIST_TEMPLATE" -export const rowListUrl = datasource => sanitizeUrl(`/${datasource.label}`) - -const generateTableBlock = datasource => { - const tableBlock = new Component("@budibase/standard-components/tableblock") - tableBlock - .customProps({ - title: datasource.label, - dataSource: datasource, - sortOrder: "Ascending", - size: "spectrum--medium", - paginate: true, - rowCount: 8, - clickBehaviour: "details", - showTitleButton: true, - titleButtonText: "Create row", - titleButtonClickBehaviour: "new", - sidePanelSaveLabel: "Save", - sidePanelDeleteLabel: "Delete", - }) - .instanceName(`${datasource.label} - Table block`) - return tableBlock -} - -const generateGridBlock = datasource => { - const gridBlock = new Component("@budibase/standard-components/gridblock") - gridBlock - .customProps({ - table: datasource, - }) - .instanceName(`${datasource.label} - Grid block`) - return gridBlock -} - -const createScreen = (datasource, mode) => { - return new Screen() - .route(rowListUrl(datasource)) - .instanceName(`${datasource.label} - List`) - .addChild( - mode === "table" - ? generateTableBlock(datasource) - : generateGridBlock(datasource) - ) - .json() -} diff --git a/packages/builder/tsconfig.json b/packages/builder/tsconfig.json index b2084dba65..be79dfd85c 100644 --- a/packages/builder/tsconfig.json +++ b/packages/builder/tsconfig.json @@ -4,6 +4,16 @@ "composite": true, "declaration": true, "sourceMap": true, - "baseUrl": "." + "baseUrl": ".", + "paths": { + "assets/*": ["./assets/*"], + "@budibase/*": [ + "../*/src/index.ts", + "../*/src/index.js", + "../*", + "../../node_modules/@budibase/*" + ], + "*": ["./src/*"] + } } } diff --git a/packages/cli/tsconfig.build.json b/packages/cli/tsconfig.build.json index 9fbccadd31..e52d886194 100644 --- a/packages/cli/tsconfig.build.json +++ b/packages/cli/tsconfig.build.json @@ -11,11 +11,13 @@ "types": ["node", "jest"], "outDir": "dist", "skipLibCheck": true, + "baseUrl": ".", "paths": { "@budibase/types": ["../types/src"], "@budibase/backend-core": ["../backend-core/src"], "@budibase/backend-core/*": ["../backend-core/*"], - "@budibase/shared-core": ["../shared-core/src"] + "@budibase/shared-core": ["../shared-core/src"], + "@budibase/string-templates": ["../string-templates/src"] } }, "include": ["src/**/*"], diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json index 6ca641e214..bf51d7ed76 100644 --- a/packages/cli/tsconfig.json +++ b/packages/cli/tsconfig.json @@ -1,16 +1,8 @@ { "extends": "./tsconfig.build.json", - "compilerOptions": { - "composite": true, - "declaration": true, - "sourceMap": true, - "baseUrl": ".", - "resolveJsonModule": true - }, "ts-node": { "require": ["tsconfig-paths/register"], "swc": true }, - "include": ["src/**/*", "package.json"], "exclude": ["node_modules", "dist"] } diff --git a/packages/client/manifest.json b/packages/client/manifest.json index 43b75ebe26..a6e14be4ef 100644 --- a/packages/client/manifest.json +++ b/packages/client/manifest.json @@ -525,6 +525,38 @@ "barTitle": "Disable button", "key": "disabled" }, + { + "type": "icon", + "label": "Icon", + "key": "icon" + }, + { + "type": "select", + "label": "Gap", + "key": "gap", + "showInBar": true, + "barStyle": "picker", + "dependsOn": "icon", + "options": [ + { + "label": "None", + "value": "N" + }, + { + "label": "Small", + "value": "S" + }, + { + "label": "Medium", + "value": "M" + }, + { + "label": "Large", + "value": "L" + } + ], + "defaultValue": "M" + }, { "type": "event", "label": "On click", @@ -1105,6 +1137,12 @@ "key": "color", "showInBar": true }, + { + "type": "color", + "label": "Text Color", + "key": "textColor", + "showInBar": true + }, { "type": "boolean", "label": "Allow delete", @@ -4635,6 +4673,7 @@ } }, "table": { + "deprecated": true, "name": "Table", "icon": "Table", "illegalChildren": ["section"], @@ -5380,6 +5419,7 @@ ] }, "tableblock": { + "deprecated": true, "block": true, "name": "Table Block", "icon": "Table", @@ -6557,7 +6597,7 @@ ] }, "gridblock": { - "name": "Grid Block", + "name": "Table", "icon": "Table", "styles": ["size"], "size": { diff --git a/packages/client/src/components/ClientApp.svelte b/packages/client/src/components/ClientApp.svelte index 4efa8af4e6..e6cda03270 100644 --- a/packages/client/src/components/ClientApp.svelte +++ b/packages/client/src/components/ClientApp.svelte @@ -17,6 +17,7 @@ appStore, devToolsStore, devToolsEnabled, + environmentStore, } from "stores" import NotificationDisplay from "components/overlay/NotificationDisplay.svelte" import ConfirmationDisplay from "components/overlay/ConfirmationDisplay.svelte" @@ -36,7 +37,9 @@ import DevToolsHeader from "components/devtools/DevToolsHeader.svelte" import DevTools from "components/devtools/DevTools.svelte" import FreeFooter from "components/FreeFooter.svelte" + import MaintenanceScreen from "components/MaintenanceScreen.svelte" import licensing from "../licensing" + import SnippetsProvider from "./context/SnippetsProvider.svelte" // Provide contexts setContext("sdk", SDK) @@ -111,122 +114,130 @@ class="spectrum spectrum--medium {$themeStore.baseTheme} {$themeStore.theme}" class:builder={$builderStore.inBuilder} > - - - - - - - - {#key $builderStore.selectedComponentId} - {#if $builderStore.inBuilder} - - {/if} - {/key} + {#if $environmentStore.maintenance.length > 0} + + {:else} + + + + + + + + + {#key $builderStore.selectedComponentId} + {#if $builderStore.inBuilder} + + {/if} + {/key} - -
- -
- {#if showDevTools} - - {/if} + +
+ +
+ {#if showDevTools} + + {/if} -
- {#if permissionError} -
- - - {@html ErrorSVG} - - You don't have permission to use this app - - - Ask your administrator to grant you access - - -
- {:else if !$screenStore.activeLayout} -
- - - {@html ErrorSVG} - - Something went wrong rendering your app - - - Get in touch with support if this issue persists - - -
- {:else if embedNoScreens} -
- - - {@html ErrorSVG} - - This Budibase app is not publicly accessible - - -
- {:else} - - {#key $screenStore.activeLayout._id} - - {/key} +
+ {#if permissionError} +
+ + + {@html ErrorSVG} + + You don't have permission to use this app + + + Ask your administrator to grant you access + + +
+ {:else if !$screenStore.activeLayout} +
+ + + {@html ErrorSVG} + + Something went wrong rendering your app + + + Get in touch with support if this issue persists + + +
+ {:else if embedNoScreens} +
+ + + {@html ErrorSVG} + + This Budibase app is not publicly accessible + + +
+ {:else} + + {#key $screenStore.activeLayout._id} + + {/key} - -
+
- -
+ +
- - - - - + + + + + + {/if} + + {#if showDevTools} + + {/if} +
+ + {#if !$builderStore.inBuilder && licensing.logoEnabled()} + + {/if} +
+ + + {#if $appStore.isDevApp} + {/if} - - {#if showDevTools} - + {#if $builderStore.inBuilder || $devToolsStore.allowSelection} + + {/if} + {#if $builderStore.inBuilder} + + {/if}
- - {#if !$builderStore.inBuilder && licensing.logoEnabled()} - - {/if} -
- - - {#if $appStore.isDevApp} - - {/if} - {#if $builderStore.inBuilder || $devToolsStore.allowSelection} - - {/if} - {#if $builderStore.inBuilder} - - - {/if} -
- - - - - + + + + + + + {/if}
{/if} diff --git a/packages/client/src/components/Component.svelte b/packages/client/src/components/Component.svelte index 6d6af91dcc..378fa64b73 100644 --- a/packages/client/src/components/Component.svelte +++ b/packages/client/src/components/Component.svelte @@ -246,15 +246,18 @@ return } + const cacheId = `${definition.name}${ + definition?.deprecated === true ? "_deprecated" : "" + }` // Get the settings definition for this component, and cache it - if (SettingsDefinitionCache[definition.name]) { - settingsDefinition = SettingsDefinitionCache[definition.name] - settingsDefinitionMap = SettingsDefinitionMapCache[definition.name] + if (SettingsDefinitionCache[cacheId]) { + settingsDefinition = SettingsDefinitionCache[cacheId] + settingsDefinitionMap = SettingsDefinitionMapCache[cacheId] } else { settingsDefinition = getSettingsDefinition(definition) settingsDefinitionMap = getSettingsDefinitionMap(settingsDefinition) - SettingsDefinitionCache[definition.name] = settingsDefinition - SettingsDefinitionMapCache[definition.name] = settingsDefinitionMap + SettingsDefinitionCache[cacheId] = settingsDefinition + SettingsDefinitionMapCache[cacheId] = settingsDefinitionMap } // Parse the instance settings, and cache them @@ -565,7 +568,8 @@ // If we don't know, check and cache if (used == null) { - used = bindingString.indexOf(`[${key}]`) !== -1 + const searchString = key === "snippets" ? key : `[${key}]` + used = bindingString.indexOf(searchString) !== -1 knownContextKeyMap[key] = used } @@ -575,6 +579,15 @@ } } + const getDataContext = () => { + const normalContext = get(context) + const additionalContext = ref?.getAdditionalDataContext?.() + return { + ...normalContext, + ...additionalContext, + } + } + onMount(() => { // Register this component instance for external access if ($appStore.isDevApp) { @@ -583,7 +596,7 @@ component: instance._component, getSettings: () => cachedSettings, getRawSettings: () => ({ ...staticSettings, ...dynamicSettings }), - getDataContext: () => get(context), + getDataContext, reload: () => initialise(instance, true), setEphemeralStyles: styles => (ephemeralStyles = styles), state: store, diff --git a/packages/client/src/components/MaintenanceScreen.svelte b/packages/client/src/components/MaintenanceScreen.svelte new file mode 100644 index 0000000000..a44c1292dd --- /dev/null +++ b/packages/client/src/components/MaintenanceScreen.svelte @@ -0,0 +1,53 @@ + + + +
+ {#each maintenanceList as maintenance} + {#if maintenance.type === MaintenanceType.SQS_MISSING} + + Budibase installation requires maintenance + + The administrator of this Budibase installation needs to take actions + to update components that are out of date. Please contact them and + show them this warning. More information will be available when they + log into their account. + + + {/if} + {/each} +
+ + diff --git a/packages/client/src/components/app/Button.svelte b/packages/client/src/components/app/Button.svelte index 361e64a983..c43face1bb 100644 --- a/packages/client/src/components/app/Button.svelte +++ b/packages/client/src/components/app/Button.svelte @@ -13,9 +13,10 @@ export let size = "M" export let type = "cta" export let quiet = false + export let icon = null + export let gap = "M" // For internal use only for now - not defined in the manifest - export let icon = null export let active = false const handleOnClick = async () => { @@ -47,7 +48,7 @@ {#key $component.editing} @@ -92,4 +85,13 @@ .active { color: var(--spectrum-global-color-blue-600); } + .gap-S { + gap: 8px; + } + .gap-M { + gap: 16px; + } + .gap-L { + gap: 32px; + } diff --git a/packages/client/src/components/app/ButtonGroup.svelte b/packages/client/src/components/app/ButtonGroup.svelte index 3ee703e253..2cf6b3db7d 100644 --- a/packages/client/src/components/app/ButtonGroup.svelte +++ b/packages/client/src/components/app/ButtonGroup.svelte @@ -20,7 +20,7 @@ wrap: true, }} > - {#each buttons as { text, type, quiet, disabled, onClick, size }} + {#each buttons as { text, type, quiet, disabled, onClick, size, icon, gap }} diff --git a/packages/client/src/components/app/GridBlock.svelte b/packages/client/src/components/app/GridBlock.svelte index 0a343cac51..46a507387d 100644 --- a/packages/client/src/components/app/GridBlock.svelte +++ b/packages/client/src/components/app/GridBlock.svelte @@ -30,6 +30,7 @@ ActionTypes, createContextStore, Provider, + generateGoldenSample, } = getContext("sdk") let grid @@ -48,6 +49,19 @@ }, ] + // Provide additional data context for live binding eval + export const getAdditionalDataContext = () => { + const rows = get(grid?.getContext()?.rows) + const goldenRow = generateGoldenSample(rows) + const id = get(component).id + return { + [id]: goldenRow, + eventContext: { + row: goldenRow, + }, + } + } + // Parses columns to fix older formats const getParsedColumns = columns => { // If the first element has an active key all elements should be in the new format diff --git a/packages/client/src/components/app/Layout.svelte b/packages/client/src/components/app/Layout.svelte index f1dcdf6b37..992a166143 100644 --- a/packages/client/src/components/app/Layout.svelte +++ b/packages/client/src/components/app/Layout.svelte @@ -36,6 +36,7 @@ export let pageWidth export let logoLinkUrl export let openLogoLinkInNewTab + export let textAlign export let embedded = false @@ -226,7 +227,7 @@ {/if} {/if} {#if !hideTitle && title} - {title} + {title} {/if}
{#if !embedded} @@ -290,7 +291,10 @@
diff --git a/packages/client/src/components/app/Tag.svelte b/packages/client/src/components/app/Tag.svelte index 2d0a26ac71..4644161506 100644 --- a/packages/client/src/components/app/Tag.svelte +++ b/packages/client/src/components/app/Tag.svelte @@ -6,6 +6,7 @@ export let onClick export let text = "" export let color + export let textColor export let closable = false export let size = "M" @@ -14,7 +15,7 @@ // Add color styles to main styles object, otherwise the styleable helper // overrides the color when it's passed as inline style. - $: styles = enrichStyles($component.styles, color) + $: styles = enrichStyles($component.styles, color, textColor) $: componentText = getComponentText(text, $builderStore, $component) const getComponentText = (text, builderState, componentState) => { @@ -24,7 +25,7 @@ return text || componentState.name || "Placeholder text" } - const enrichStyles = (styles, color) => { + const enrichStyles = (styles, color, textColor) => { if (!color) { return styles } @@ -34,7 +35,7 @@ ...styles?.normal, "background-color": color, "border-color": color, - color: "white", + color: textColor || "white", "--spectrum-clearbutton-medium-icon-color": "white", }, } diff --git a/packages/client/src/components/app/blocks/CardsBlock.svelte b/packages/client/src/components/app/blocks/CardsBlock.svelte index 008fa7e730..bd2b69d352 100644 --- a/packages/client/src/components/app/blocks/CardsBlock.svelte +++ b/packages/client/src/components/app/blocks/CardsBlock.svelte @@ -4,6 +4,7 @@ import BlockComponent from "components/BlockComponent.svelte" import { makePropSafe as safe } from "@budibase/string-templates" import { enrichSearchColumns, enrichFilter } from "utils/blocks.js" + import { get } from "svelte/store" export let title export let dataSource @@ -31,7 +32,9 @@ export let linkColumn export let noRowsMessage - const { fetchDatasourceSchema } = getContext("sdk") + const context = getContext("context") + const { fetchDatasourceSchema, generateGoldenSample } = getContext("sdk") + const component = getContext("component") let formId let dataProviderId @@ -62,6 +65,16 @@ }, ] + // Provide additional data context for live binding eval + export const getAdditionalDataContext = () => { + const rows = get(context)[dataProviderId]?.rows || [] + const goldenRow = generateGoldenSample(rows) + const id = get(component).id + return { + [`${id}-repeater`]: goldenRow, + } + } + // Builds a full details page URL for the card title const buildFullCardUrl = (link, url, repeaterId, linkColumn) => { if (!link || !url || !repeaterId) { diff --git a/packages/client/src/components/app/blocks/FormBlockComponent.svelte b/packages/client/src/components/app/blocks/FormBlockComponent.svelte new file mode 100644 index 0000000000..ea1c3b0a37 --- /dev/null +++ b/packages/client/src/components/app/blocks/FormBlockComponent.svelte @@ -0,0 +1,86 @@ + + +{#if getComponentForField(field) && field.active} + +{/if} diff --git a/packages/client/src/components/app/blocks/MultiStepFormblock.svelte b/packages/client/src/components/app/blocks/MultiStepFormblock.svelte index b24c2f418a..bcc62b5229 100644 --- a/packages/client/src/components/app/blocks/MultiStepFormblock.svelte +++ b/packages/client/src/components/app/blocks/MultiStepFormblock.svelte @@ -5,7 +5,8 @@ import { builderStore } from "stores" import { Utils } from "@budibase/frontend-core" import FormBlockWrapper from "./form/FormBlockWrapper.svelte" - import { writable } from "svelte/store" + import { get, writable } from "svelte/store" + import FormBlockComponent from "./FormBlockComponent.svelte" export let actionType export let rowId @@ -15,7 +16,7 @@ export let buttonPosition = "bottom" export let size - const { fetchDatasourceSchema } = getContext("sdk") + const { fetchDatasourceSchema, generateGoldenSample } = getContext("sdk") const component = getContext("component") const context = getContext("context") @@ -23,73 +24,41 @@ const currentStep = writable(1) setContext("current-step", currentStep) - const FieldTypeToComponentMap = { - string: "stringfield", - number: "numberfield", - bigint: "bigintfield", - options: "optionsfield", - array: "multifieldselect", - boolean: "booleanfield", - longform: "longformfield", - datetime: "datetimefield", - attachment: "attachmentfield", - link: "relationshipfield", - json: "jsonfield", - barcodeqr: "codescanner", - bb_reference: "bbreferencefield", - } - let schema + $: id = $component.id + $: selected = $component.selected + $: builderStep = $builderStore.metadata?.step $: fetchSchema(dataSource) - $: enrichedSteps = enrichSteps(steps, schema, $component.id, $currentStep) - $: updateCurrentStep(enrichedSteps, $builderStore, $component) + $: enrichedSteps = enrichSteps(steps, schema, id) + $: updateCurrentStep(enrichedSteps, selected, builderStep) - const updateCurrentStep = (steps, builderStore, component) => { - const { componentId, step } = builderStore.metadata || {} + // Provide additional data context for live binding eval + export const getAdditionalDataContext = () => { + const id = get(component).id + const rows = get(context)[`${id}-provider`]?.rows || [] + const goldenRow = generateGoldenSample(rows) + return { + [`${id}-repeater`]: goldenRow, + } + } - // If we aren't in the builder or aren't selected then don't update the step - // context at all, allowing the normal form to take control. - if ( - !component.selected || - !builderStore.inBuilder || - componentId !== component.id - ) { + const updateCurrentStep = (steps, selected, builderStep) => { + // If we aren't selected in the builder then just allowing the normal form + // to take control. + if (!selected) { return } // Ensure we have a valid step selected - let newStep = Math.min(step || 0, steps.length - 1) - - // Sanity check + let newStep = Math.min(builderStep || 0, steps.length - 1) newStep = Math.max(newStep, 0) // Add 1 because the form component expects 1 indexed rather than 0 indexed currentStep.set(newStep + 1) } - const getPropsForField = field => { - if (field._component) { - return field - } - return { - field: field.name, - label: field.name, - placeholder: field.name, - _instanceName: field.name, - } - } - - const getComponentForField = field => { - const fieldSchemaName = field.field || field.name - if (!fieldSchemaName || !schema?.[fieldSchemaName]) { - return null - } - const type = schema[fieldSchemaName].type - return FieldTypeToComponentMap[type] - } - - const fetchSchema = async () => { + const fetchSchema = async dataSource => { schema = (await fetchDatasourceSchema(dataSource)) || {} } @@ -101,6 +70,7 @@ .filter(field => !field.autocolumn) .map(field => ({ name: field.name, + active: true, })) } @@ -195,15 +165,7 @@ class:mobile={$context.device.mobile} > {#each step.fields as field, fieldIdx (`${field.field || field.name}_${fieldIdx}`)} - {#if getComponentForField(field)} - - {/if} + {/each}
diff --git a/packages/client/src/components/app/blocks/RepeaterBlock.svelte b/packages/client/src/components/app/blocks/RepeaterBlock.svelte index 30fbdddcdc..878b827c78 100644 --- a/packages/client/src/components/app/blocks/RepeaterBlock.svelte +++ b/packages/client/src/components/app/blocks/RepeaterBlock.svelte @@ -4,6 +4,7 @@ import Placeholder from "components/app/Placeholder.svelte" import { getContext } from "svelte" import { makePropSafe as safe } from "@budibase/string-templates" + import { get } from "svelte/store" export let dataSource export let filter @@ -18,8 +19,20 @@ export let gap const component = getContext("component") + const context = getContext("context") + const { generateGoldenSample } = getContext("sdk") let providerId + + // Provide additional data context for live binding eval + export const getAdditionalDataContext = () => { + const rows = get(context)[providerId]?.rows || [] + const goldenRow = generateGoldenSample(rows) + const id = get(component).id + return { + [`${id}-repeater`]: goldenRow, + } + } diff --git a/packages/client/src/components/app/blocks/RowExplorer.svelte b/packages/client/src/components/app/blocks/RowExplorer.svelte index 8fadcb5006..1e2357713a 100644 --- a/packages/client/src/components/app/blocks/RowExplorer.svelte +++ b/packages/client/src/components/app/blocks/RowExplorer.svelte @@ -3,25 +3,35 @@ import BlockComponent from "components/BlockComponent.svelte" import { makePropSafe as safe } from "@budibase/string-templates" import { generate } from "shortid" + import { get } from "svelte/store" + import { getContext } from "svelte" export let dataSource export let height - export let cardTitle export let cardSubtitle export let cardDescription export let cardImageURL export let cardSearchField - export let detailFields export let detailTitle - export let noRowsMessage const stateKey = generate() + const context = getContext("context") + const { generateGoldenSample } = getContext("sdk") let listDataProviderId let listRepeaterId + + // Provide additional data context for live binding eval + export const getAdditionalDataContext = () => { + const rows = get(context)[listDataProviderId]?.rows || [] + const goldenRow = generateGoldenSample(rows) + return { + [listRepeaterId]: goldenRow, + } + } diff --git a/packages/client/src/components/app/blocks/form/FormBlock.svelte b/packages/client/src/components/app/blocks/form/FormBlock.svelte index cdf1a05628..d249569731 100644 --- a/packages/client/src/components/app/blocks/form/FormBlock.svelte +++ b/packages/client/src/components/app/blocks/form/FormBlock.svelte @@ -3,6 +3,7 @@ import InnerFormBlock from "./InnerFormBlock.svelte" import { Utils } from "@budibase/frontend-core" import FormBlockWrapper from "./FormBlockWrapper.svelte" + import { get } from "svelte/store" export let actionType export let dataSource @@ -11,7 +12,6 @@ export let fields export let buttons export let buttonPosition - export let title export let description export let rowId @@ -25,8 +25,57 @@ export let saveButtonLabel export let deleteButtonLabel - const { fetchDatasourceSchema } = getContext("sdk") + const { fetchDatasourceSchema, generateGoldenSample } = getContext("sdk") const component = getContext("component") + const context = getContext("context") + + let schema + + $: formattedFields = convertOldFieldFormat(fields) + $: fieldsOrDefault = getDefaultFields(formattedFields, schema) + $: fetchSchema(dataSource) + $: id = $component.id + // We could simply spread $$props into the inner form and append our + // additions, but that would create svelte warnings about unused props and + // make maintenance in future more confusing as we typically always have a + // proper mapping of schema settings to component exports, without having to + // search multiple files + $: innerProps = { + dataSource, + actionUrl, + actionType, + size, + disabled, + fields: fieldsOrDefault, + title, + description, + schema, + notificationOverride, + buttons: + buttons || + Utils.buildFormBlockButtonConfig({ + _id: id, + showDeleteButton, + showSaveButton, + saveButtonLabel, + deleteButtonLabel, + notificationOverride, + actionType, + actionUrl, + dataSource, + }), + buttonPosition: buttons ? buttonPosition : "top", + } + + // Provide additional data context for live binding eval + export const getAdditionalDataContext = () => { + const id = get(component).id + const rows = get(context)[`${id}-provider`]?.rows || [] + const goldenRow = generateGoldenSample(rows) + return { + [`${id}-repeater`]: goldenRow, + } + } const convertOldFieldFormat = fields => { if (!fields) { @@ -68,42 +117,6 @@ return [...fields, ...defaultFields].filter(field => field.active) } - let schema - - $: formattedFields = convertOldFieldFormat(fields) - $: fieldsOrDefault = getDefaultFields(formattedFields, schema) - $: fetchSchema(dataSource) - // We could simply spread $$props into the inner form and append our - // additions, but that would create svelte warnings about unused props and - // make maintenance in future more confusing as we typically always have a - // proper mapping of schema settings to component exports, without having to - // search multiple files - $: innerProps = { - dataSource, - actionUrl, - actionType, - size, - disabled, - fields: fieldsOrDefault, - title, - description, - schema, - notificationOverride, - buttons: - buttons || - Utils.buildFormBlockButtonConfig({ - _id: $component.id, - showDeleteButton, - showSaveButton, - saveButtonLabel, - deleteButtonLabel, - notificationOverride, - actionType, - actionUrl, - dataSource, - }), - buttonPosition: buttons ? buttonPosition : "top", - } const fetchSchema = async () => { schema = (await fetchDatasourceSchema(dataSource)) || {} } diff --git a/packages/client/src/components/app/blocks/form/InnerFormBlock.svelte b/packages/client/src/components/app/blocks/form/InnerFormBlock.svelte index 24d4cfa14c..b0733f3f4b 100644 --- a/packages/client/src/components/app/blocks/form/InnerFormBlock.svelte +++ b/packages/client/src/components/app/blocks/form/InnerFormBlock.svelte @@ -2,6 +2,7 @@ import BlockComponent from "components/BlockComponent.svelte" import Placeholder from "components/app/Placeholder.svelte" import { getContext } from "svelte" + import FormBlockComponent from "../FormBlockComponent.svelte" export let dataSource export let actionType @@ -14,49 +15,11 @@ export let buttonPosition = "bottom" export let schema - const FieldTypeToComponentMap = { - string: "stringfield", - number: "numberfield", - bigint: "bigintfield", - options: "optionsfield", - array: "multifieldselect", - boolean: "booleanfield", - longform: "longformfield", - datetime: "datetimefield", - attachment: "attachmentfield", - link: "relationshipfield", - json: "jsonfield", - barcodeqr: "codescanner", - bb_reference: "bbreferencefield", - } const context = getContext("context") let formId $: renderHeader = buttons || title - - const getComponentForField = field => { - const fieldSchemaName = field.field || field.name - if (!fieldSchemaName || !schema?.[fieldSchemaName]) { - return null - } - const type = schema[fieldSchemaName].type - return FieldTypeToComponentMap[type] - } - - const getPropsForField = field => { - let fieldProps = field._component - ? { - ...field, - } - : { - field: field.name, - label: field.name, - placeholder: field.name, - _instanceName: field.name, - } - return fieldProps - } {#if fields?.length} @@ -132,15 +95,7 @@
{#each fields as field, idx} - {#if getComponentForField(field) && field.active} - - {/if} + {/each}
diff --git a/packages/client/src/components/app/blocks/index.js b/packages/client/src/components/app/blocks/index.js index 2c8d81cf96..c1df620285 100644 --- a/packages/client/src/components/app/blocks/index.js +++ b/packages/client/src/components/app/blocks/index.js @@ -1,4 +1,3 @@ -export { default as tableblock } from "./TableBlock.svelte" export { default as cardsblock } from "./CardsBlock.svelte" export { default as repeaterblock } from "./RepeaterBlock.svelte" export { default as formblock } from "./form/FormBlock.svelte" diff --git a/packages/client/src/components/app/blocks/TableBlock.svelte b/packages/client/src/components/app/deprecated/TableBlock.svelte similarity index 94% rename from packages/client/src/components/app/blocks/TableBlock.svelte rename to packages/client/src/components/app/deprecated/TableBlock.svelte index 7c58f90508..5fd197bc02 100644 --- a/packages/client/src/components/app/blocks/TableBlock.svelte +++ b/packages/client/src/components/app/deprecated/TableBlock.svelte @@ -1,5 +1,6 @@ + + + + diff --git a/packages/client/src/components/preview/DNDHandler.svelte b/packages/client/src/components/preview/DNDHandler.svelte index e93c42b863..767efc9e3a 100644 --- a/packages/client/src/components/preview/DNDHandler.svelte +++ b/packages/client/src/components/preview/DNDHandler.svelte @@ -345,8 +345,7 @@ diff --git a/packages/client/src/components/preview/HoverIndicator.svelte b/packages/client/src/components/preview/HoverIndicator.svelte index 164ec32ab4..d204d77f49 100644 --- a/packages/client/src/components/preview/HoverIndicator.svelte +++ b/packages/client/src/components/preview/HoverIndicator.svelte @@ -1,10 +1,11 @@
({ + // Cached props + componentId, + color, + zIndex, + prefix, + allowResizeAnchors, + + // Computed state + indicators: [], + text: null, + icon: null, + insideGrid: false, + error: false, + }) + let interval - let text - let icon - let insideGrid = false - let errorState = false - - $: visibleIndicators = indicators.filter(x => x.visible) - $: offset = $builderStore.inBuilder ? 0 : 2 - + let state = defaultState() + let nextState = null let updating = false let observers = [] let callbackCount = 0 - let nextIndicators = [] + + $: visibleIndicators = state.indicators.filter(x => x.visible) + $: offset = $builderStore.inBuilder ? 0 : 2 + $: $$props, debouncedUpdate() const checkInsideGrid = id => { const component = document.getElementsByClassName(id)[0] @@ -44,10 +56,10 @@ if (callbackCount >= observers.length) { return } - nextIndicators[idx].visible = - nextIndicators[idx].insideSidePanel || entries[0].isIntersecting + nextState.indicators[idx].visible = + nextState.indicators[idx].insideSidePanel || entries[0].isIntersecting if (++callbackCount === observers.length) { - indicators = nextIndicators + state = nextState updating = false } } @@ -59,7 +71,7 @@ // Sanity check if (!componentId) { - indicators = [] + state = defaultState() return } @@ -68,25 +80,25 @@ callbackCount = 0 observers.forEach(o => o.disconnect()) observers = [] - nextIndicators = [] + nextState = defaultState() // Check if we're inside a grid if (allowResizeAnchors) { - insideGrid = checkInsideGrid(componentId) + nextState.insideGrid = checkInsideGrid(componentId) } // Determine next set of indicators const parents = document.getElementsByClassName(componentId) if (parents.length) { - text = parents[0].dataset.name - if (prefix) { - text = `${prefix} ${text}` + nextState.text = parents[0].dataset.name + if (nextState.prefix) { + nextState.text = `${nextState.prefix} ${nextState.text}` } if (parents[0].dataset.icon) { - icon = parents[0].dataset.icon + nextState.icon = parents[0].dataset.icon } } - errorState = parents?.[0]?.classList.contains("error") + nextState.error = parents?.[0]?.classList.contains("error") // Batch reads to minimize reflow const scrollX = window.scrollX @@ -102,8 +114,9 @@ // If there aren't any nodes then reset if (!children.length) { - indicators = [] + state = defaultState() updating = false + return } const device = document.getElementById("app-root") @@ -119,7 +132,7 @@ observers.push(observer) const elBounds = child.getBoundingClientRect() - nextIndicators.push({ + nextState.indicators.push({ top: elBounds.top + scrollY - deviceBounds.top - offset, left: elBounds.left + scrollX - deviceBounds.left - offset, width: elBounds.width + 4, @@ -144,20 +157,17 @@ }) -{#key componentId} - {#each visibleIndicators as indicator, idx} - - {/each} -{/key} +{#each visibleIndicators as indicator, idx} + +{/each} diff --git a/packages/client/src/components/preview/SelectionIndicator.svelte b/packages/client/src/components/preview/SelectionIndicator.svelte index bca0341628..a271389cbd 100644 --- a/packages/client/src/components/preview/SelectionIndicator.svelte +++ b/packages/client/src/components/preview/SelectionIndicator.svelte @@ -10,7 +10,6 @@ diff --git a/packages/client/src/index.js b/packages/client/src/index.js index 2c8d310619..de6d1bdc12 100644 --- a/packages/client/src/index.js +++ b/packages/client/src/index.js @@ -42,6 +42,7 @@ const loadBudibase = async () => { hiddenComponentIds: window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"], usedPlugins: window["##BUDIBASE_USED_PLUGINS##"], location: window["##BUDIBASE_LOCATION##"], + snippets: window["##BUDIBASE_SNIPPETS##"], }) // Set app ID - this window flag is set by both the preview and the real @@ -84,8 +85,20 @@ const loadBudibase = async () => { } else { dndStore.actions.reset() } + } else if (type === "request-context") { + const { selectedComponentInstance } = get(componentStore) + const context = selectedComponentInstance?.getDataContext() + let stringifiedContext = null + try { + stringifiedContext = JSON.stringify(context) + } catch (error) { + // Ignore - invalid context + } + eventStore.actions.dispatchEvent("provide-context", { + context: stringifiedContext, + }) } else if (type === "hover-component") { - hoverStore.actions.hoverComponent(data) + hoverStore.actions.hoverComponent(data, false) } else if (type === "builder-meta") { builderStore.actions.setMetadata(data) } diff --git a/packages/client/src/sdk.js b/packages/client/src/sdk.js index 557d5ca8da..1f996bf656 100644 --- a/packages/client/src/sdk.js +++ b/packages/client/src/sdk.js @@ -29,7 +29,14 @@ import { fetchDatasourceSchema } from "./utils/schema.js" import { getAPIKey } from "./utils/api.js" import { enrichButtonActions } from "./utils/buttonActions.js" import { processStringSync, makePropSafe } from "@budibase/string-templates" -import { fetchData, LuceneUtils, Constants } from "@budibase/frontend-core" +import { + fetchData, + LuceneUtils, + Constants, + RowUtils, + memo, + derivedMemo, +} from "@budibase/frontend-core" export default { API, @@ -65,6 +72,9 @@ export default { processStringSync, makePropSafe, createContextStore, + generateGoldenSample: RowUtils.generateGoldenSample, + memo, + derivedMemo, // Components Provider, diff --git a/packages/client/src/stores/builder.js b/packages/client/src/stores/builder.js index 2e745885b5..5440fc3a79 100644 --- a/packages/client/src/stores/builder.js +++ b/packages/client/src/stores/builder.js @@ -18,6 +18,7 @@ const createBuilderStore = () => { usedPlugins: null, eventResolvers: {}, metadata: null, + snippets: null, // Legacy - allow the builder to specify a layout layout: null, diff --git a/packages/client/src/stores/derived/index.js b/packages/client/src/stores/derived/index.js index d9a7743be6..337c73831f 100644 --- a/packages/client/src/stores/derived/index.js +++ b/packages/client/src/stores/derived/index.js @@ -4,3 +4,4 @@ export { currentRole } from "./currentRole.js" export { dndComponentPath } from "./dndComponentPath.js" export { devToolsEnabled } from "./devToolsEnabled.js" +export { snippets } from "./snippets.js" diff --git a/packages/client/src/stores/derived/snippets.js b/packages/client/src/stores/derived/snippets.js new file mode 100644 index 0000000000..74b2797643 --- /dev/null +++ b/packages/client/src/stores/derived/snippets.js @@ -0,0 +1,10 @@ +import { appStore } from "../app.js" +import { builderStore } from "../builder.js" +import { derivedMemo } from "@budibase/frontend-core" + +export const snippets = derivedMemo( + [appStore, builderStore], + ([$appStore, $builderStore]) => { + return $builderStore?.snippets || $appStore?.application?.snippets || [] + } +) diff --git a/packages/client/src/stores/hover.js b/packages/client/src/stores/hover.js index 24f315a126..014a9f1aa0 100644 --- a/packages/client/src/stores/hover.js +++ b/packages/client/src/stores/hover.js @@ -5,13 +5,27 @@ const createHoverStore = () => { const store = writable({ hoveredComponentId: null, }) + let hoverTimeout - const hoverComponent = id => { + const hoverComponent = (id, notifyBuilder = true) => { + clearTimeout(hoverTimeout) + if (id) { + processHover(id, notifyBuilder) + } else { + hoverTimeout = setTimeout(() => { + processHover(id, notifyBuilder) + }, 10) + } + } + + const processHover = (id, notifyBuilder = true) => { if (id === get(store).hoveredComponentId) { return } store.set({ hoveredComponentId: id }) - eventStore.actions.dispatchEvent("hover-component", { id }) + if (notifyBuilder) { + eventStore.actions.dispatchEvent("hover-component", { id }) + } } return { diff --git a/packages/client/src/utils/enrichDataBinding.js b/packages/client/src/utils/enrichDataBinding.js index 0f142ab297..3756d8789a 100644 --- a/packages/client/src/utils/enrichDataBinding.js +++ b/packages/client/src/utils/enrichDataBinding.js @@ -1,23 +1,5 @@ import { Helpers } from "@budibase/bbui" -import { processString, processObjectSync } from "@budibase/string-templates" - -// Regex to test inputs with to see if they are likely candidates for template strings -const looksLikeTemplate = /{{.*}}/ - -/** - * Enriches a given input with a row from the database. - */ -export const enrichDataBinding = async (input, context) => { - // Only accept string inputs - if (!input || typeof input !== "string") { - return input - } - // Do a fast regex check if this looks like a template string - if (!looksLikeTemplate.test(input)) { - return input - } - return processString(input, context) -} +import { processObjectSync } from "@budibase/string-templates" /** * Recursively enriches all props in a props object and returns the new props. diff --git a/packages/frontend-core/src/api/app.js b/packages/frontend-core/src/api/app.js index 49137cbecd..fff2e99fe5 100644 --- a/packages/frontend-core/src/api/app.js +++ b/packages/frontend-core/src/api/app.js @@ -83,6 +83,18 @@ export const buildAppEndpoints = API => ({ }) }, + /** + * Duplicate an existing app + * @param app the app to dupe + */ + duplicateApp: async (app, appId) => { + return await API.post({ + url: `/api/applications/${appId}/duplicate`, + body: app, + json: false, + }) + }, + /** * Update an application using an export - the body * should be of type FormData, with a "file" and a "password" if encrypted. diff --git a/packages/frontend-core/src/components/grid/cells/AttachmentCell.svelte b/packages/frontend-core/src/components/grid/cells/AttachmentCell.svelte index e6c9e53c75..a1f5c4f2aa 100644 --- a/packages/frontend-core/src/components/grid/cells/AttachmentCell.svelte +++ b/packages/frontend-core/src/components/grid/cells/AttachmentCell.svelte @@ -9,6 +9,7 @@ export let api export let invertX = false export let invertY = false + export let schema const { API, notifications } = getContext("grid") const imageExtensions = ["png", "tiff", "gif", "raw", "jpg", "jpeg"] @@ -97,6 +98,7 @@ {value} compact on:change={e => onChange(e.detail)} + maximum={schema.constraints?.length?.maximum} {processFiles} {deleteAttachments} {handleFileTooLarge} diff --git a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte index 097544439c..657f618759 100644 --- a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte +++ b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte @@ -317,7 +317,7 @@ align="right" offset={0} popoverTarget={document.getElementById(`grid-${rand}`)} - customZindex={100} + customZindex={50} > {#if editIsOpen}
{ diff --git a/packages/frontend-core/src/components/grid/overlays/KeyboardManager.svelte b/packages/frontend-core/src/components/grid/overlays/KeyboardManager.svelte index 5e3a035d89..ed09301bb9 100644 --- a/packages/frontend-core/src/components/grid/overlays/KeyboardManager.svelte +++ b/packages/frontend-core/src/components/grid/overlays/KeyboardManager.svelte @@ -40,16 +40,18 @@ } } + // Handle certain key presses regardless of selection state + if (e.key === "Enter" && (e.ctrlKey || e.metaKey) && $config.canAddRows) { + e.preventDefault() + dispatch("add-row-inline") + return + } + // If nothing selected avoid processing further key presses if (!$focusedCellId) { if (e.key === "Tab" || e.key?.startsWith("Arrow")) { e.preventDefault() focusFirstCell() - } else if (e.key === "Enter" && (e.ctrlKey || e.metaKey)) { - if ($config.canAddRows) { - e.preventDefault() - dispatch("add-row-inline") - } } else if (e.key === "Delete" || e.key === "Backspace") { if (Object.keys($selectedRows).length && $config.canDeleteRows) { dispatch("request-bulk-delete") diff --git a/packages/frontend-core/src/utils/index.js b/packages/frontend-core/src/utils/index.js index 3f00c00e47..98998b7f0e 100644 --- a/packages/frontend-core/src/utils/index.js +++ b/packages/frontend-core/src/utils/index.js @@ -3,6 +3,7 @@ export * as JSONUtils from "./json" export * as CookieUtils from "./cookies" export * as RoleUtils from "./roles" export * as Utils from "./utils" +export * as RowUtils from "./rows" export { memo, derivedMemo } from "./memo" export { createWebsocket } from "./websocket" export * from "./download" diff --git a/packages/frontend-core/src/utils/rows.js b/packages/frontend-core/src/utils/rows.js new file mode 100644 index 0000000000..ea43d63734 --- /dev/null +++ b/packages/frontend-core/src/utils/rows.js @@ -0,0 +1,48 @@ +/** + * Util to check is a given value is "better" than another. "Betterness" is + * defined as presence and length. + */ +const isBetterSample = (newValue, oldValue) => { + // Prefer non-null values + if (oldValue == null && newValue != null) { + return true + } + + // Don't change type + const oldType = typeof oldValue + const newType = typeof newValue + if (oldType !== newType) { + return false + } + + // Prefer longer values + if (newType === "string" && newValue.length > oldValue.length) { + return true + } + if ( + newType === "object" && + Object.keys(newValue).length > Object.keys(oldValue).length + ) { + return true + } + + return false +} + +/** + * Generates a best-case example object of the provided samples. + * The generated sample does not necessarily exist - it simply is a sample that + * contains "good" examples for every property of all the samples. + * The generate sample will have a value for all keys across all samples. + */ +export const generateGoldenSample = samples => { + let goldenSample = {} + samples?.slice(0, 100).forEach(sample => { + Object.keys(sample).forEach(key => { + if (isBetterSample(sample[key], goldenSample[key])) { + goldenSample[key] = sample[key] + } + }) + }) + return goldenSample +} diff --git a/packages/pro b/packages/pro index 22a278da72..dd748e045f 160000 --- a/packages/pro +++ b/packages/pro @@ -1 +1 @@ -Subproject commit 22a278da720d92991dabdcd4cb6c96e7abe29781 +Subproject commit dd748e045ffdbc6662c5d2b76075f01d65a96a2f diff --git a/packages/server/Dockerfile b/packages/server/Dockerfile index 3aae395bc5..7c0e6e59bc 100644 --- a/packages/server/Dockerfile +++ b/packages/server/Dockerfile @@ -41,17 +41,9 @@ COPY scripts/removeWorkspaceDependencies.sh scripts/removeWorkspaceDependencies. RUN chmod +x ./scripts/removeWorkspaceDependencies.sh -WORKDIR /string-templates -COPY packages/string-templates/package.json package.json -RUN ../scripts/removeWorkspaceDependencies.sh package.json -RUN --mount=type=cache,target=/root/.yarn YARN_CACHE_FOLDER=/root/.yarn yarn install --production=true --network-timeout 1000000 -COPY packages/string-templates . - - WORKDIR /app COPY packages/server/package.json . COPY packages/server/dist/yarn.lock . -RUN cd ../string-templates && yarn link && cd - && yarn link @budibase/string-templates COPY scripts/removeWorkspaceDependencies.sh scripts/removeWorkspaceDependencies.sh RUN chmod +x ./scripts/removeWorkspaceDependencies.sh diff --git a/packages/server/__mocks__/@google-cloud/firestore.ts b/packages/server/__mocks__/@google-cloud/firestore.ts index a438d6a7c5..a5bccb1fa8 100644 --- a/packages/server/__mocks__/@google-cloud/firestore.ts +++ b/packages/server/__mocks__/@google-cloud/firestore.ts @@ -1,3 +1,4 @@ +// eslint-disable-next-line @typescript-eslint/no-unused-vars module FirebaseMock { const firebase: any = {} diff --git a/packages/server/__mocks__/@sendgrid/mail.ts b/packages/server/__mocks__/@sendgrid/mail.ts index 030a2dbd4c..8613ae4b16 100644 --- a/packages/server/__mocks__/@sendgrid/mail.ts +++ b/packages/server/__mocks__/@sendgrid/mail.ts @@ -1,3 +1,4 @@ +// eslint-disable-next-line @typescript-eslint/no-unused-vars module SendgridMock { class Email { constructor() { diff --git a/packages/server/__mocks__/airtable.ts b/packages/server/__mocks__/airtable.ts index ee4b38ffcd..fed30ca069 100644 --- a/packages/server/__mocks__/airtable.ts +++ b/packages/server/__mocks__/airtable.ts @@ -1,8 +1,5 @@ -module AirtableMock { - function Airtable() { - // @ts-ignore - this.base = jest.fn() - } - - module.exports = Airtable +class Airtable { + base = jest.fn() } + +module.exports = Airtable diff --git a/packages/server/__mocks__/arangojs.ts b/packages/server/__mocks__/arangojs.ts index 5f980a7f97..77ec7a9d42 100644 --- a/packages/server/__mocks__/arangojs.ts +++ b/packages/server/__mocks__/arangojs.ts @@ -1,3 +1,4 @@ +// eslint-disable-next-line @typescript-eslint/no-unused-vars module ArangoMock { const arangodb: any = {} diff --git a/packages/server/__mocks__/aws-sdk.ts b/packages/server/__mocks__/aws-sdk.ts index 3cf4bba007..d6d33f6c46 100644 --- a/packages/server/__mocks__/aws-sdk.ts +++ b/packages/server/__mocks__/aws-sdk.ts @@ -1,102 +1,81 @@ import fs from "fs" import { join } from "path" -module AwsMock { - const aws: any = {} +const response = (body: any, extra?: any) => () => ({ + promise: () => body, + ...extra, +}) - const response = (body: any, extra?: any) => () => ({ - promise: () => body, - ...extra, - }) - - function DocumentClient() { - // @ts-ignore - this.put = jest.fn(response({})) - // @ts-ignore - this.query = jest.fn( - response({ - Items: [], - }) - ) - // @ts-ignore - this.scan = jest.fn( - response({ - Items: [ - { - Name: "test", - }, - ], - }) - ) - // @ts-ignore - this.get = jest.fn(response({})) - // @ts-ignore - this.update = jest.fn(response({})) - // @ts-ignore - this.delete = jest.fn(response({})) - } - - function S3() { - // @ts-ignore - this.listObjects = jest.fn( - response({ - Contents: [], - }) - ) - - // @ts-ignore - this.createBucket = jest.fn( - response({ - Contents: {}, - }) - ) - - // @ts-ignore - this.deleteObjects = jest.fn( - response({ - Contents: {}, - }) - ) - - // @ts-ignore - this.getSignedUrl = (operation, params) => { - return `http://example.com/${params.Bucket}/${params.Key}` - } - - // @ts-ignore - this.headBucket = jest.fn( - response({ - Contents: {}, - }) - ) - - // @ts-ignore - this.upload = jest.fn( - response({ - Contents: {}, - }) - ) - - // @ts-ignore - this.getObject = jest.fn( - response( +class DocumentClient { + put = jest.fn(response({})) + query = jest.fn( + response({ + Items: [], + }) + ) + scan = jest.fn( + response({ + Items: [ { - Body: "", + Name: "test", }, - { - createReadStream: jest - .fn() - .mockReturnValue( - fs.createReadStream(join(__dirname, "aws-sdk.ts")) - ), - } - ) - ) - } - - aws.DynamoDB = { DocumentClient } - aws.S3 = S3 - aws.config = { update: jest.fn() } - - module.exports = aws + ], + }) + ) + get = jest.fn(response({})) + update = jest.fn(response({})) + delete = jest.fn(response({})) +} + +class S3 { + listObjects = jest.fn( + response({ + Contents: [], + }) + ) + createBucket = jest.fn( + response({ + Contents: {}, + }) + ) + deleteObjects = jest.fn( + response({ + Contents: {}, + }) + ) + getSignedUrl = jest.fn((operation, params) => { + return `http://example.com/${params.Bucket}/${params.Key}` + }) + headBucket = jest.fn( + response({ + Contents: {}, + }) + ) + upload = jest.fn( + response({ + Contents: {}, + }) + ) + getObject = jest.fn( + response( + { + Body: "", + }, + { + createReadStream: jest + .fn() + .mockReturnValue(fs.createReadStream(join(__dirname, "aws-sdk.ts"))), + } + ) + ) +} + +module.exports = { + DynamoDB: { + DocumentClient, + }, + S3, + config: { + update: jest.fn(), + }, } diff --git a/packages/server/__mocks__/mongodb.ts b/packages/server/__mocks__/mongodb.ts deleted file mode 100644 index 01b6e76fc4..0000000000 --- a/packages/server/__mocks__/mongodb.ts +++ /dev/null @@ -1,39 +0,0 @@ -module MongoMock { - const mongodb: any = {} - - mongodb.MongoClient = function () { - this.connect = jest.fn() - this.close = jest.fn() - this.insertOne = jest.fn() - this.insertMany = jest.fn(() => ({ toArray: () => [] })) - this.find = jest.fn(() => ({ toArray: () => [] })) - this.findOne = jest.fn() - this.findOneAndUpdate = jest.fn() - this.count = jest.fn() - this.deleteOne = jest.fn() - this.deleteMany = jest.fn(() => ({ toArray: () => [] })) - this.updateOne = jest.fn() - this.updateMany = jest.fn(() => ({ toArray: () => [] })) - - this.collection = jest.fn(() => ({ - insertOne: this.insertOne, - find: this.find, - insertMany: this.insertMany, - findOne: this.findOne, - findOneAndUpdate: this.findOneAndUpdate, - count: this.count, - deleteOne: this.deleteOne, - deleteMany: this.deleteMany, - updateOne: this.updateOne, - updateMany: this.updateMany, - })) - - this.db = () => ({ - collection: this.collection, - }) - } - - mongodb.ObjectId = jest.requireActual("mongodb").ObjectId - - module.exports = mongodb -} diff --git a/packages/server/__mocks__/mssql.ts b/packages/server/__mocks__/mssql.ts deleted file mode 100644 index cdfb7d520e..0000000000 --- a/packages/server/__mocks__/mssql.ts +++ /dev/null @@ -1,24 +0,0 @@ -module MsSqlMock { - const mssql: any = {} - - mssql.query = jest.fn(() => ({ - recordset: [ - { - a: "string", - b: 1, - }, - ], - })) - - // mssql.connect = jest.fn(() => ({ recordset: [] })) - - mssql.ConnectionPool = jest.fn(() => ({ - connect: jest.fn(() => ({ - request: jest.fn(() => ({ - query: jest.fn(sql => ({ recordset: [sql] })), - })), - })), - })) - - module.exports = mssql -} diff --git a/packages/server/__mocks__/mysql2.ts b/packages/server/__mocks__/mysql2.ts deleted file mode 100644 index 9d42a35dd8..0000000000 --- a/packages/server/__mocks__/mysql2.ts +++ /dev/null @@ -1,14 +0,0 @@ -module MySQLMock { - const mysql: any = {} - - const client = { - connect: jest.fn(), - query: jest.fn((query, bindings, fn) => { - fn(null, []) - }), - } - - mysql.createConnection = jest.fn(() => client) - - module.exports = mysql -} diff --git a/packages/server/__mocks__/mysql2/promise.ts b/packages/server/__mocks__/mysql2/promise.ts deleted file mode 100644 index 8a8fb7fcf0..0000000000 --- a/packages/server/__mocks__/mysql2/promise.ts +++ /dev/null @@ -1,17 +0,0 @@ -module MySQLMock { - const mysql: any = {} - - const client = { - connect: jest.fn(), - end: jest.fn(), - query: jest.fn(async () => { - return [[]] - }), - } - - mysql.createConnection = jest.fn(async () => { - return client - }) - - module.exports = mysql -} diff --git a/packages/server/__mocks__/node-fetch.ts b/packages/server/__mocks__/node-fetch.ts index 265d6b1c36..c5073499a7 100644 --- a/packages/server/__mocks__/node-fetch.ts +++ b/packages/server/__mocks__/node-fetch.ts @@ -1,6 +1,7 @@ // @ts-ignore import fs from "fs" +// eslint-disable-next-line @typescript-eslint/no-unused-vars module FetchMock { // @ts-ignore const fetch = jest.requireActual("node-fetch") @@ -8,6 +9,7 @@ module FetchMock { let mockSearch = false const func = async (url: any, opts: any) => { + const { host, pathname } = new URL(url) function json(body: any, status = 200) { return { status, @@ -34,7 +36,7 @@ module FetchMock { } } - if (url.includes("/api/global")) { + if (pathname.includes("/api/global")) { const user = { email: "test@example.com", _id: "us_test@example.com", @@ -47,31 +49,31 @@ module FetchMock { global: false, }, } - return url.endsWith("/users") && opts.method === "GET" + return pathname.endsWith("/users") && opts.method === "GET" ? json([user]) : json(user) } // mocked data based on url - else if (url.includes("api/apps")) { + else if (pathname.includes("api/apps")) { return json({ app1: { url: "/app1", }, }) - } else if (url.includes("example.com")) { + } else if (host.includes("example.com")) { return json({ body: opts.body, url, method: opts.method, }) - } else if (url.includes("invalid.com")) { + } else if (host.includes("invalid.com")) { return json( { invalid: true, }, 404 ) - } else if (mockSearch && url.includes("_search")) { + } else if (mockSearch && pathname.includes("_search")) { const body = opts.body const parts = body.split("tableId:") let tableId @@ -90,7 +92,7 @@ module FetchMock { ], bookmark: "test", }) - } else if (url.includes("google.com")) { + } else if (host.includes("google.com")) { return json({ url, opts, @@ -177,7 +179,7 @@ module FetchMock { } else if (url === "https://www.googleapis.com/oauth2/v4/token") { // any valid response return json({}) - } else if (url.includes("failonce.com")) { + } else if (host.includes("failonce.com")) { failCount++ if (failCount === 1) { return json({ message: "error" }, 500) diff --git a/packages/server/__mocks__/oracledb.ts b/packages/server/__mocks__/oracledb.ts index fd19845eee..0172ace0e6 100644 --- a/packages/server/__mocks__/oracledb.ts +++ b/packages/server/__mocks__/oracledb.ts @@ -1,31 +1,21 @@ -module OracleDbMock { - // mock execute - const execute = jest.fn(() => ({ - rows: [ - { - a: "string", - b: 1, - }, - ], - })) +const executeMock = jest.fn(() => ({ + rows: [ + { + a: "string", + b: 1, + }, + ], +})) - const close = jest.fn() +const closeMock = jest.fn() - // mock connection - function Connection() {} - Connection.prototype.execute = execute - Connection.prototype.close = close - - // mock oracledb - const oracleDb: any = {} - oracleDb.getConnection = jest.fn(() => { - // @ts-ignore - return new Connection() - }) - - // expose mocks - oracleDb.executeMock = execute - oracleDb.closeMock = close - - module.exports = oracleDb +class Connection { + execute = executeMock + close = closeMock +} + +module.exports = { + getConnection: jest.fn(() => new Connection()), + executeMock, + closeMock, } diff --git a/packages/server/__mocks__/pg.ts b/packages/server/__mocks__/pg.ts index 110933ad52..50a7c7349e 100644 --- a/packages/server/__mocks__/pg.ts +++ b/packages/server/__mocks__/pg.ts @@ -1,30 +1,25 @@ -module PgMock { - const pg: any = {} +const query = jest.fn(() => ({ + rows: [ + { + a: "string", + b: 1, + }, + ], +})) - const query = jest.fn(() => ({ - rows: [ - { - a: "string", - b: 1, - }, - ], - })) - - // constructor - function Client() {} - - Client.prototype.query = query - Client.prototype.end = jest.fn(cb => { +class Client { + query = query + end = jest.fn(cb => { if (cb) cb() }) - Client.prototype.connect = jest.fn() - Client.prototype.release = jest.fn() - - const on = jest.fn() - - pg.Client = Client - pg.queryMock = query - pg.on = on - - module.exports = pg + connect = jest.fn() + release = jest.fn() +} + +const on = jest.fn() + +module.exports = { + Client, + queryMock: query, + on, } diff --git a/packages/server/jest.config.ts b/packages/server/jest.config.ts index 80b187966c..6c6d6a20d3 100644 --- a/packages/server/jest.config.ts +++ b/packages/server/jest.config.ts @@ -30,6 +30,8 @@ const baseConfig: Config.InitialProjectOptions = { "@budibase/backend-core": "/../backend-core/src", "@budibase/shared-core": "/../shared-core/src", "@budibase/types": "/../types/src", + "@budibase/string-templates/(.*)": ["/../string-templates/$1"], + "@budibase/string-templates": ["/../string-templates/src"], }, } diff --git a/packages/server/package.json b/packages/server/package.json index 45980a4be6..8e66f3d7e0 100644 --- a/packages/server/package.json +++ b/packages/server/package.json @@ -13,9 +13,10 @@ "build": "node ./scripts/build.js", "postbuild": "copyfiles -f ../client/dist/budibase-client.js ../client/manifest.json client && copyfiles -f ../../yarn.lock ./dist/", "check:types": "tsc -p tsconfig.json --noEmit --paths null", + "build:isolated-vm-lib:snippets": "esbuild --minify --bundle src/jsRunner/bundles/snippets.ts --outfile=src/jsRunner/bundles/snippets.ivm.bundle.js --platform=node --format=iife --global-name=snippets", "build:isolated-vm-lib:string-templates": "esbuild --minify --bundle src/jsRunner/bundles/index-helpers.ts --outfile=src/jsRunner/bundles/index-helpers.ivm.bundle.js --platform=node --format=iife --external:handlebars --global-name=helpers", "build:isolated-vm-lib:bson": "esbuild --minify --bundle src/jsRunner/bundles/bsonPackage.ts --outfile=src/jsRunner/bundles/bson.ivm.bundle.js --platform=node --format=iife --global-name=bson", - "build:isolated-vm-libs": "yarn build:isolated-vm-lib:string-templates && yarn build:isolated-vm-lib:bson", + "build:isolated-vm-libs": "yarn build:isolated-vm-lib:string-templates && yarn build:isolated-vm-lib:bson && yarn build:isolated-vm-lib:snippets", "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput", "debug": "yarn build && node --expose-gc --inspect=9222 dist/index.js", "jest": "NODE_OPTIONS=\"--no-node-snapshot $NODE_OPTIONS\" jest", @@ -149,7 +150,7 @@ "rimraf": "3.0.2", "supertest": "6.3.3", "swagger-jsdoc": "6.1.0", - "testcontainers": "10.6.0", + "testcontainers": "10.7.2", "timekeeper": "2.2.0", "ts-node": "10.8.1", "tsconfig-paths": "4.0.0", @@ -174,6 +175,10 @@ ] }, "build": { + "inputs": [ + "{projectRoot}/builder", + "{projectRoot}/client" + ], "outputs": [ "{projectRoot}/builder", "{projectRoot}/client", diff --git a/packages/server/src/api/controllers/application.ts b/packages/server/src/api/controllers/application.ts index 0bc93888ae..40db259289 100644 --- a/packages/server/src/api/controllers/application.ts +++ b/packages/server/src/api/controllers/application.ts @@ -50,6 +50,8 @@ import { CreateAppRequest, FetchAppDefinitionResponse, FetchAppPackageResponse, + DuplicateAppRequest, + DuplicateAppResponse, } from "@budibase/types" import { BASE_LAYOUT_PROP_IDS } from "../../constants/layouts" import sdk from "../../sdk" @@ -122,7 +124,7 @@ interface AppTemplate { templateString?: string useTemplate?: string file?: { - type: string + type?: string path: string password?: string } @@ -263,6 +265,10 @@ async function performAppCreate(ctx: UserCtx) { ...(ctx.request.files.templateFile as any), password: encryptionPassword, } + } else if (typeof ctx.request.body.file?.path === "string") { + instanceConfig.file = { + path: ctx.request.body.file?.path, + } } const tenantId = tenancy.isMultiTenant() ? tenancy.getTenantId() : null const appId = generateDevAppID(generateAppID(tenantId)) @@ -372,12 +378,20 @@ async function creationEvents(request: any, app: App) { else if (request.files?.templateFile) { creationFns.push(a => events.app.fileImported(a)) } + // from server file path + else if (request.body.file) { + // explicitly pass in the newly created app id + creationFns.push(a => events.app.duplicated(a, app.appId)) + } // unknown else { console.error("Could not determine template creation event") } } - creationFns.push(a => events.app.created(a)) + + if (!request.duplicate) { + creationFns.push(a => events.app.created(a)) + } for (let fn of creationFns) { await fn(app) @@ -391,8 +405,10 @@ async function appPostCreate(ctx: UserCtx, app: App) { tenantId, appId: app.appId, }) + await creationEvents(ctx.request, app) - // app import & template creation + + // app import, template creation and duplication if (ctx.request.body.useTemplate === "true") { const { rows } = await getUniqueRows([app.appId]) const rowCount = rows ? rows.length : 0 @@ -421,7 +437,7 @@ async function appPostCreate(ctx: UserCtx, app: App) { } } -export async function create(ctx: UserCtx) { +export async function create(ctx: UserCtx) { const newApplication = await quotas.addApp(() => performAppCreate(ctx)) await appPostCreate(ctx, newApplication) await cache.bustCache(cache.CacheKey.CHECKLIST) @@ -626,6 +642,69 @@ export async function importToApp(ctx: UserCtx) { ctx.body = { message: "app updated" } } +/** + * Create a copy of the latest dev application. + * Performs an export of the app, then imports from the export dir path + */ +export async function duplicateApp( + ctx: UserCtx +) { + const { name: appName, url: possibleUrl } = ctx.request.body + const { appId: sourceAppId } = ctx.params + const [app] = await dbCore.getAppsByIDs([sourceAppId]) + + if (!app) { + ctx.throw(404, "Source app not found") + } + + const apps = (await dbCore.getAllApps({ dev: true })) as App[] + + checkAppName(ctx, apps, appName) + const url = sdk.applications.getAppUrl({ name: appName, url: possibleUrl }) + checkAppUrl(ctx, apps, url) + + const tmpPath = await sdk.backups.exportApp(sourceAppId, { + excludeRows: false, + tar: false, + }) + + const createRequestBody: CreateAppRequest = { + name: appName, + url: possibleUrl, + useTemplate: "true", + // The app export path + file: { + path: tmpPath, + }, + } + + // Build a new request + const createRequest = { + roleId: ctx.roleId, + user: { + ...ctx.user, + _id: dbCore.getGlobalIDFromUserMetadataID(ctx.user._id || ""), + }, + request: { + body: createRequestBody, + }, + } as UserCtx + + // Build the new application + await create(createRequest) + const { body: newApplication } = createRequest + + if (!newApplication) { + ctx.throw(500, "There was a problem duplicating the application") + } + + ctx.body = { + duplicateAppId: newApplication?.appId, + sourceAppId, + } + ctx.status = 200 +} + export async function updateAppPackage( appPackage: Partial, appId: string diff --git a/packages/server/src/api/controllers/plugin/index.ts b/packages/server/src/api/controllers/plugin/index.ts index a8a451c98c..c7d4912db3 100644 --- a/packages/server/src/api/controllers/plugin/index.ts +++ b/packages/server/src/api/controllers/plugin/index.ts @@ -39,25 +39,28 @@ export async function create(ctx: any) { let name = "PLUGIN_" + Math.floor(100000 + Math.random() * 900000) switch (source) { - case PluginSource.NPM: + case PluginSource.NPM: { const { metadata: metadataNpm, directory: directoryNpm } = await npmUpload(url, name) metadata = metadataNpm directory = directoryNpm break - case PluginSource.GITHUB: + } + case PluginSource.GITHUB: { const { metadata: metadataGithub, directory: directoryGithub } = await githubUpload(url, name, githubToken) metadata = metadataGithub directory = directoryGithub break - case PluginSource.URL: + } + case PluginSource.URL: { const headersObj = headers || {} const { metadata: metadataUrl, directory: directoryUrl } = await urlUpload(url, name, headersObj) metadata = metadataUrl directory = directoryUrl break + } } pluginCore.validate(metadata?.schema) diff --git a/packages/server/src/api/controllers/public/utils.ts b/packages/server/src/api/controllers/public/utils.ts index 1d67b49e0d..ec1d7cfa47 100644 --- a/packages/server/src/api/controllers/public/utils.ts +++ b/packages/server/src/api/controllers/public/utils.ts @@ -1,11 +1,12 @@ import { context } from "@budibase/backend-core" import { isExternalTableID } from "../../../integrations/utils" import { APP_PREFIX, DocumentType } from "../../../db/utils" +import { Row } from "@budibase/types" export async function addRev( body: { _id?: string; _rev?: string }, tableId?: string -) { +): Promise { if (!body._id || (tableId && isExternalTableID(tableId))) { return body } diff --git a/packages/server/src/api/controllers/query/import/sources/openapi2.ts b/packages/server/src/api/controllers/query/import/sources/openapi2.ts index 230647475e..6eb4766c70 100644 --- a/packages/server/src/api/controllers/query/import/sources/openapi2.ts +++ b/packages/server/src/api/controllers/query/import/sources/openapi2.ts @@ -109,13 +109,14 @@ export class OpenAPI2 extends OpenAPISource { for (let param of allParams) { if (parameterNotRef(param)) { switch (param.in) { - case "query": + case "query": { let prefix = "" if (queryString) { prefix = "&" } queryString = `${queryString}${prefix}${param.name}={{${param.name}}}` break + } case "header": headers[param.name] = `{{${param.name}}}` break @@ -125,7 +126,7 @@ export class OpenAPI2 extends OpenAPISource { case "formData": // future enhancement break - case "body": + case "body": { // set the request body to the example provided // future enhancement: generate an example from the schema let bodyParam: OpenAPIV2.InBodyParameterObject = @@ -135,6 +136,7 @@ export class OpenAPI2 extends OpenAPISource { requestBody = schema.example } break + } } // add the parameter if it can be bound in our config diff --git a/packages/server/src/api/controllers/query/import/sources/openapi3.ts b/packages/server/src/api/controllers/query/import/sources/openapi3.ts index f86f684c32..f6755c69ad 100644 --- a/packages/server/src/api/controllers/query/import/sources/openapi3.ts +++ b/packages/server/src/api/controllers/query/import/sources/openapi3.ts @@ -161,13 +161,14 @@ export class OpenAPI3 extends OpenAPISource { for (let param of allParams) { if (parameterNotRef(param)) { switch (param.in) { - case "query": + case "query": { let prefix = "" if (queryString) { prefix = "&" } queryString = `${queryString}${prefix}${param.name}={{${param.name}}}` break + } case "header": headers[param.name] = `{{${param.name}}}` break diff --git a/packages/server/src/api/controllers/query/index.ts b/packages/server/src/api/controllers/query/index.ts index 3c21537484..0dba20dacd 100644 --- a/packages/server/src/api/controllers/query/index.ts +++ b/packages/server/src/api/controllers/query/index.ts @@ -14,22 +14,35 @@ import { SessionCookie, JsonFieldSubType, QueryResponse, - QueryPreview, QuerySchema, FieldType, ExecuteQueryRequest, ExecuteQueryResponse, - Row, QueryParameter, PreviewQueryRequest, PreviewQueryResponse, } from "@budibase/types" import { ValidQueryNameRegex, utils as JsonUtils } from "@budibase/shared-core" +import { findHBSBlocks } from "@budibase/string-templates" const Runner = new Thread(ThreadType.QUERY, { timeoutMs: env.QUERY_THREAD_TIMEOUT, }) +function validateQueryInputs(parameters: Record) { + for (let entry of Object.entries(parameters)) { + const [key, value] = entry + if (typeof value !== "string") { + continue + } + if (findHBSBlocks(value).length !== 0) { + throw new Error( + `Parameter '${key}' input contains a handlebars binding - this is not allowed.` + ) + } + } +} + export async function fetch(ctx: UserCtx) { ctx.body = await sdk.queries.fetch() } @@ -123,10 +136,10 @@ function getAuthConfig(ctx: UserCtx) { function enrichParameters( queryParameters: QueryParameter[], - requestParameters: { [key: string]: string } = {} -): { - [key: string]: string -} { + requestParameters: Record = {} +): Record { + // first check parameters are all valid + validateQueryInputs(requestParameters) // make sure parameters are fully enriched with defaults for (let parameter of queryParameters) { if (!requestParameters[parameter.name]) { diff --git a/packages/server/src/api/controllers/role.ts b/packages/server/src/api/controllers/role.ts index b3eb61a255..3398c8102c 100644 --- a/packages/server/src/api/controllers/role.ts +++ b/packages/server/src/api/controllers/role.ts @@ -106,6 +106,21 @@ export async function save(ctx: UserCtx) { ) role._rev = result.rev ctx.body = role + + const devDb = context.getDevAppDB() + const prodDb = context.getProdAppDB() + + if (await prodDb.exists()) { + const replication = new dbCore.Replication({ + source: devDb.name, + target: prodDb.name, + }) + await replication.replicate({ + filter: (doc: any) => { + return doc._id && doc._id.startsWith("role_") + }, + }) + } } export async function destroy(ctx: UserCtx) { diff --git a/packages/server/src/api/controllers/row/ExternalRequest.ts b/packages/server/src/api/controllers/row/ExternalRequest.ts index 685af4e98e..f89c9dc51a 100644 --- a/packages/server/src/api/controllers/row/ExternalRequest.ts +++ b/packages/server/src/api/controllers/row/ExternalRequest.ts @@ -7,13 +7,11 @@ import { FilterType, IncludeRelationship, ManyToManyRelationshipFieldMetadata, - ManyToOneRelationshipFieldMetadata, OneToManyRelationshipFieldMetadata, Operation, PaginationJson, RelationshipFieldMetadata, RelationshipsJson, - RelationshipType, Row, SearchFilters, SortJson, @@ -437,11 +435,11 @@ export class ExternalRequest { return { row: newRow, manyRelationships } } - processRelationshipFields( + async processRelationshipFields( table: Table, row: Row, relationships: RelationshipsJson[] - ): Row { + ): Promise { for (let relationship of relationships) { const linkedTable = this.tables[relationship.tableName] if (!linkedTable || !row[relationship.column]) { @@ -457,7 +455,7 @@ export class ExternalRequest { } // process additional types relatedRow = processDates(table, relatedRow) - relatedRow = processFormulas(linkedTable, relatedRow) + relatedRow = await processFormulas(linkedTable, relatedRow) row[relationship.column][key] = relatedRow } } @@ -521,7 +519,7 @@ export class ExternalRequest { return rows } - outputProcessing( + async outputProcessing( rows: Row[] = [], table: Table, relationships: RelationshipsJson[] @@ -561,9 +559,12 @@ export class ExternalRequest { } // make sure all related rows are correct - let finalRowArray = Object.values(finalRows).map(row => - this.processRelationshipFields(table, row, relationships) - ) + let finalRowArray = [] + for (let row of Object.values(finalRows)) { + finalRowArray.push( + await this.processRelationshipFields(table, row, relationships) + ) + } // process some additional types finalRowArray = processDates(table, finalRowArray) @@ -714,7 +715,7 @@ export class ExternalRequest { const rows = related[key]?.rows || [] - function relationshipMatchPredicate({ + const relationshipMatchPredicate = ({ row, linkPrimary, linkSecondary, @@ -722,7 +723,7 @@ export class ExternalRequest { row: Row linkPrimary: string linkSecondary?: string - }) { + }) => { const matchesPrimaryLink = row[linkPrimary] === relationship.id || row[linkPrimary] === body?.[linkPrimary] @@ -934,7 +935,11 @@ export class ExternalRequest { processed.manyRelationships ) } - const output = this.outputProcessing(responseRows, table, relationships) + const output = await this.outputProcessing( + responseRows, + table, + relationships + ) // if reading it'll just be an array of rows, return whole thing if (operation === Operation.READ) { return ( diff --git a/packages/server/src/api/controllers/row/alias.ts b/packages/server/src/api/controllers/row/alias.ts index 1d586c54fd..60c207c8ce 100644 --- a/packages/server/src/api/controllers/row/alias.ts +++ b/packages/server/src/api/controllers/row/alias.ts @@ -23,6 +23,12 @@ const DISABLED_WRITE_CLIENTS: SqlClient[] = [ SqlClient.ORACLE, ] +const DISABLED_OPERATIONS: Operation[] = [ + Operation.CREATE_TABLE, + Operation.UPDATE_TABLE, + Operation.DELETE_TABLE, +] + class CharSequence { static alphabet = "abcdefghijklmnopqrstuvwxyz" counters: number[] @@ -59,13 +65,18 @@ export default class AliasTables { } isAliasingEnabled(json: QueryJson, datasource: Datasource) { + const operation = json.endpoint.operation const fieldLength = json.resource?.fields?.length - if (!fieldLength || fieldLength <= 0) { + if ( + !fieldLength || + fieldLength <= 0 || + DISABLED_OPERATIONS.includes(operation) + ) { return false } try { const sqlClient = getSQLClient(datasource) - const isWrite = WRITE_OPERATIONS.includes(json.endpoint.operation) + const isWrite = WRITE_OPERATIONS.includes(operation) const isDisabledClient = DISABLED_WRITE_CLIENTS.includes(sqlClient) if (isWrite && isDisabledClient) { return false diff --git a/packages/server/src/api/controllers/row/external.ts b/packages/server/src/api/controllers/row/external.ts index dc3b556c54..8ce9ff0f9d 100644 --- a/packages/server/src/api/controllers/row/external.ts +++ b/packages/server/src/api/controllers/row/external.ts @@ -128,7 +128,10 @@ export async function bulkDestroy(ctx: UserCtx) { ) } const responses = await Promise.all(promises) - return { response: { ok: true }, rows: responses.map(resp => resp.row) } + const finalRows = responses + .map(resp => resp.row) + .filter(row => row && row._id) + return { response: { ok: true }, rows: finalRows } } export async function fetchEnrichedRow(ctx: UserCtx) { diff --git a/packages/server/src/api/controllers/row/index.ts b/packages/server/src/api/controllers/row/index.ts index 54c294c42b..3466a4491d 100644 --- a/packages/server/src/api/controllers/row/index.ts +++ b/packages/server/src/api/controllers/row/index.ts @@ -131,7 +131,10 @@ async function processDeleteRowsRequest(ctx: UserCtx) { : fixRow(processedRow, ctx.params) }) - return await Promise.all(processedRows) + const responses = await Promise.allSettled(processedRows) + return responses + .filter(resp => resp.status === "fulfilled") + .map(resp => (resp as PromiseFulfilledResult).value) } async function deleteRows(ctx: UserCtx) { diff --git a/packages/server/src/api/controllers/row/staticFormula.ts b/packages/server/src/api/controllers/row/staticFormula.ts index 0ea8b3560e..a75a6cd2cc 100644 --- a/packages/server/src/api/controllers/row/staticFormula.ts +++ b/packages/server/src/api/controllers/row/staticFormula.ts @@ -110,7 +110,7 @@ export async function updateAllFormulasInTable(table: Table) { (enriched: Row) => enriched._id === row._id ) if (enrichedRow) { - const processed = processFormulas(table, cloneDeep(row), { + const processed = await processFormulas(table, cloneDeep(row), { dynamic: false, contextRows: [enrichedRow], }) @@ -143,7 +143,7 @@ export async function finaliseRow( squash: false, })) as Row // use enriched row to generate formulas for saving, specifically only use as context - row = processFormulas(table, row, { + row = await processFormulas(table, row, { dynamic: false, contextRows: [enrichedRow], }) @@ -179,7 +179,7 @@ export async function finaliseRow( const response = await db.put(row) // for response, calculate the formulas for the enriched row enrichedRow._rev = response.rev - enrichedRow = processFormulas(table, enrichedRow, { + enrichedRow = await processFormulas(table, enrichedRow, { dynamic: false, }) // this updates the related formulas in other rows based on the relations to this row diff --git a/packages/server/src/api/controllers/row/views.ts b/packages/server/src/api/controllers/row/views.ts index 188fe86f17..2c6cb4b17a 100644 --- a/packages/server/src/api/controllers/row/views.ts +++ b/packages/server/src/api/controllers/row/views.ts @@ -1,4 +1,3 @@ -import { quotas } from "@budibase/pro" import { UserCtx, ViewV2, diff --git a/packages/server/src/api/controllers/script.ts b/packages/server/src/api/controllers/script.ts index b69fc430a6..4317f5fcde 100644 --- a/packages/server/src/api/controllers/script.ts +++ b/packages/server/src/api/controllers/script.ts @@ -1,6 +1,6 @@ import { Ctx } from "@budibase/types" import { IsolatedVM } from "../../jsRunner/vm" -import { iifeWrapper } from "../../jsRunner/utilities" +import { iifeWrapper } from "@budibase/string-templates" export async function execute(ctx: Ctx) { const { script, context } = ctx.request.body diff --git a/packages/server/src/api/controllers/static/templates/preview.hbs b/packages/server/src/api/controllers/static/templates/preview.hbs index 63c61baa9f..54b5b1a4e4 100644 --- a/packages/server/src/api/controllers/static/templates/preview.hbs +++ b/packages/server/src/api/controllers/static/templates/preview.hbs @@ -72,7 +72,8 @@ navigation, hiddenComponentIds, usedPlugins, - location + location, + snippets } = parsed // Set some flags so the app knows we're in the builder @@ -89,6 +90,7 @@ window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"] = hiddenComponentIds window["##BUDIBASE_USED_PLUGINS##"] = usedPlugins window["##BUDIBASE_LOCATION##"] = location + window["##BUDIBASE_SNIPPETS##"] = snippets // Initialise app try { diff --git a/packages/server/src/api/controllers/table/external.ts b/packages/server/src/api/controllers/table/external.ts index c85b46a95c..7c036bec9d 100644 --- a/packages/server/src/api/controllers/table/external.ts +++ b/packages/server/src/api/controllers/table/external.ts @@ -61,9 +61,6 @@ export async function destroy(ctx: UserCtx) { const tableToDelete: TableRequest = await sdk.tables.getTable( ctx.params.tableId ) - if (!tableToDelete || !tableToDelete.created) { - ctx.throw(400, "Cannot delete tables which weren't created in Budibase.") - } const datasourceId = getDatasourceId(tableToDelete) try { const { datasource, table } = await sdk.tables.external.destroy( diff --git a/packages/server/src/api/controllers/table/utils.ts b/packages/server/src/api/controllers/table/utils.ts index 9e1bb59e9d..0c9933a4cf 100644 --- a/packages/server/src/api/controllers/table/utils.ts +++ b/packages/server/src/api/controllers/table/utils.ts @@ -30,6 +30,8 @@ import { View, RelationshipFieldMetadata, FieldType, + FieldTypeSubtypes, + AttachmentFieldMetadata, } from "@budibase/types" export async function clearColumns(table: Table, columnNames: string[]) { @@ -88,6 +90,27 @@ export async function checkForColumnUpdates( // Update views await checkForViewUpdates(updatedTable, deletedColumns, columnRename) } + + const changedAttachmentSubtypeColumns = Object.values( + updatedTable.schema + ).filter( + (column): column is AttachmentFieldMetadata => + column.type === FieldType.ATTACHMENT && + column.subtype !== oldTable?.schema[column.name]?.subtype + ) + for (const attachmentColumn of changedAttachmentSubtypeColumns) { + if (attachmentColumn.subtype === FieldTypeSubtypes.ATTACHMENT.SINGLE) { + attachmentColumn.constraints ??= { length: {} } + attachmentColumn.constraints.length ??= {} + attachmentColumn.constraints.length.maximum = 1 + attachmentColumn.constraints.length.message = + "cannot contain multiple files" + } else { + delete attachmentColumn.constraints?.length?.maximum + delete attachmentColumn.constraints?.length?.message + } + } + return { rows: updatedRows, table: updatedTable } } diff --git a/packages/server/src/api/controllers/view/viewsV2.ts b/packages/server/src/api/controllers/view/viewsV2.ts index f4f969622a..a386ac303f 100644 --- a/packages/server/src/api/controllers/view/viewsV2.ts +++ b/packages/server/src/api/controllers/view/viewsV2.ts @@ -24,7 +24,7 @@ async function parseSchema(view: CreateViewRequest) { icon: schemaValue.icon, } Object.entries(fieldSchema) - .filter(([_, val]) => val === undefined) + .filter(([, val]) => val === undefined) .forEach(([key]) => { delete fieldSchema[key as keyof UIFieldMetadata] }) diff --git a/packages/server/src/api/index.ts b/packages/server/src/api/index.ts index ad3d8307da..92cee95ea6 100644 --- a/packages/server/src/api/index.ts +++ b/packages/server/src/api/index.ts @@ -1,6 +1,7 @@ import Router from "@koa/router" import { auth, middleware, env as envCore } from "@budibase/backend-core" import currentApp from "../middleware/currentapp" +import cleanup from "../middleware/cleanup" import zlib from "zlib" import { mainRoutes, staticRoutes, publicRoutes } from "./routes" import { middleware as pro } from "@budibase/pro" @@ -62,6 +63,8 @@ if (apiEnabled()) { .use(auth.auditLog) // @ts-ignore .use(migrations) + // @ts-ignore + .use(cleanup) // authenticated routes for (let route of mainRoutes) { diff --git a/packages/server/src/api/routes/application.ts b/packages/server/src/api/routes/application.ts index 7e01a3c2ef..07db85451a 100644 --- a/packages/server/src/api/routes/application.ts +++ b/packages/server/src/api/routes/application.ts @@ -55,9 +55,14 @@ router ) .delete( "/api/applications/:appId", - authorized(permissions.GLOBAL_BUILDER), + authorized(permissions.BUILDER), controller.destroy ) + .post( + "/api/applications/:appId/duplicate", + authorized(permissions.BUILDER), + controller.duplicateApp + ) .post( "/api/applications/:appId/import", authorized(permissions.BUILDER), diff --git a/packages/server/src/api/routes/index.ts b/packages/server/src/api/routes/index.ts index 22d0a20c9b..5a42c258cf 100644 --- a/packages/server/src/api/routes/index.ts +++ b/packages/server/src/api/routes/index.ts @@ -33,7 +33,6 @@ export { default as staticRoutes } from "./static" export { default as publicRoutes } from "./public" const appBackupRoutes = pro.appBackups -const scheduleRoutes = pro.schedules const environmentVariableRoutes = pro.environmentVariables export const mainRoutes: Router[] = [ @@ -65,7 +64,6 @@ export const mainRoutes: Router[] = [ pluginRoutes, opsRoutes, debugRoutes, - scheduleRoutes, environmentVariableRoutes, // these need to be handled last as they still use /api/:tableId // this could be breaking as koa may recognise other routes as this diff --git a/packages/server/src/api/routes/tests/__snapshots__/datasource.spec.ts.snap b/packages/server/src/api/routes/tests/__snapshots__/datasource.spec.ts.snap index 8dc472173c..57d79db24b 100644 --- a/packages/server/src/api/routes/tests/__snapshots__/datasource.spec.ts.snap +++ b/packages/server/src/api/routes/tests/__snapshots__/datasource.spec.ts.snap @@ -81,6 +81,7 @@ exports[`/datasources fetch returns all the datasources from the server 1`] = ` { "config": {}, "createdAt": "2020-01-01T00:00:00.000Z", + "isSQL": true, "name": "Test", "source": "POSTGRES", "type": "datasource", diff --git a/packages/server/src/api/routes/tests/__snapshots__/view.spec.js.snap b/packages/server/src/api/routes/tests/__snapshots__/view.spec.js.snap deleted file mode 100644 index 357285a69a..0000000000 --- a/packages/server/src/api/routes/tests/__snapshots__/view.spec.js.snap +++ /dev/null @@ -1,38 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`/views query returns data for the created view 1`] = ` -[ - { - "avg": 2333.3333333333335, - "count": 3, - "group": null, - "max": 4000, - "min": 1000, - "sum": 7000, - "sumsqr": 21000000, - }, -] -`; - -exports[`/views query returns data for the created view using a group by 1`] = ` -[ - { - "avg": 1500, - "count": 2, - "group": "One", - "max": 2000, - "min": 1000, - "sum": 3000, - "sumsqr": 5000000, - }, - { - "avg": 4000, - "count": 1, - "group": "Two", - "max": 4000, - "min": 4000, - "sum": 4000, - "sumsqr": 16000000, - }, -] -`; diff --git a/packages/server/src/api/routes/tests/appImport.spec.ts b/packages/server/src/api/routes/tests/appImport.spec.ts index 51331323de..75e9f91d63 100644 --- a/packages/server/src/api/routes/tests/appImport.spec.ts +++ b/packages/server/src/api/routes/tests/appImport.spec.ts @@ -16,7 +16,7 @@ describe("/applications/:appId/import", () => { it("should be able to perform import", async () => { const appId = config.getAppId() - const res = await request + await request .post(`/api/applications/${appId}/import`) .field("encryptionPassword", PASSWORD) .attach("appExport", path.join(__dirname, "assets", "export.tar.gz")) @@ -25,8 +25,8 @@ describe("/applications/:appId/import", () => { .expect(200) const appPackage = await config.api.application.get(appId!) expect(appPackage.navigation?.links?.length).toBe(2) - expect(expect(appPackage.navigation?.links?.[0].url).toBe("/blank")) - expect(expect(appPackage.navigation?.links?.[1].url).toBe("/derp")) + expect(appPackage.navigation?.links?.[0].url).toBe("/blank") + expect(appPackage.navigation?.links?.[1].url).toBe("/derp") const screens = await config.api.screen.list() expect(screens.length).toBe(2) expect(screens[0].routing.route).toBe("/derp") diff --git a/packages/server/src/api/routes/tests/appSync.spec.ts b/packages/server/src/api/routes/tests/appSync.spec.ts index 0773b2b008..93b8175c48 100644 --- a/packages/server/src/api/routes/tests/appSync.spec.ts +++ b/packages/server/src/api/routes/tests/appSync.spec.ts @@ -2,7 +2,6 @@ import * as setup from "./utilities" import { roles, db as dbCore } from "@budibase/backend-core" describe("/api/applications/:appId/sync", () => { - let request = setup.getRequest() let config = setup.getConfig() let app diff --git a/packages/server/src/api/routes/tests/application.spec.ts b/packages/server/src/api/routes/tests/application.spec.ts index 5a3be462e8..7f89a5cac2 100644 --- a/packages/server/src/api/routes/tests/application.spec.ts +++ b/packages/server/src/api/routes/tests/application.spec.ts @@ -16,8 +16,10 @@ import * as setup from "./utilities" import { AppStatus } from "../../../db/utils" import { events, utils, context } from "@budibase/backend-core" import env from "../../../environment" -import type { App } from "@budibase/types" +import { type App } from "@budibase/types" import tk from "timekeeper" +import * as uuid from "uuid" +import { structures } from "@budibase/backend-core/tests" describe("/applications", () => { let config = setup.getConfig() @@ -29,15 +31,107 @@ describe("/applications", () => { beforeEach(async () => { app = await config.api.application.create({ name: utils.newid() }) const deployment = await config.api.application.publish(app.appId) - expect(deployment.status).toBe("SUCCESS") + if (deployment.status !== "SUCCESS") { + throw new Error("Failed to publish app") + } jest.clearAllMocks() }) + // These need to go first for the app totals to make sense + describe("permissions", () => { + it("should only return apps a user has access to", async () => { + let user = await config.createUser({ + builder: { global: false }, + admin: { global: false }, + }) + + await config.withUser(user, async () => { + const apps = await config.api.application.fetch() + expect(apps).toHaveLength(0) + }) + + user = await config.globalUser({ + ...user, + builder: { + apps: [config.getProdAppId()], + }, + }) + + await config.withUser(user, async () => { + const apps = await config.api.application.fetch() + expect(apps).toHaveLength(1) + }) + }) + + it("should only return apps a user has access to through a custom role", async () => { + let user = await config.createUser({ + builder: { global: false }, + admin: { global: false }, + }) + + await config.withUser(user, async () => { + const apps = await config.api.application.fetch() + expect(apps).toHaveLength(0) + }) + + const role = await config.api.roles.save({ + name: "Test", + inherits: "PUBLIC", + permissionId: "read_only", + version: "name", + }) + + user = await config.globalUser({ + ...user, + roles: { + [config.getProdAppId()]: role.name, + }, + }) + + await config.withUser(user, async () => { + const apps = await config.api.application.fetch() + expect(apps).toHaveLength(1) + }) + }) + + it("should only return apps a user has access to through a custom role on a group", async () => { + let user = await config.createUser({ + builder: { global: false }, + admin: { global: false }, + }) + + await config.withUser(user, async () => { + const apps = await config.api.application.fetch() + expect(apps).toHaveLength(0) + }) + + const roleName = uuid.v4().replace(/-/g, "") + const role = await config.api.roles.save({ + name: roleName, + inherits: "PUBLIC", + permissionId: "read_only", + version: "name", + }) + + const group = await config.createGroup(role._id!) + + user = await config.globalUser({ + ...user, + userGroups: [group._id!], + }) + + await config.withUser(user, async () => { + const apps = await config.api.application.fetch() + expect(apps).toHaveLength(1) + }) + }) + }) + describe("create", () => { it("creates empty app", async () => { const app = await config.api.application.create({ name: utils.newid() }) expect(app._id).toBeDefined() - expect(events.app.created).toBeCalledTimes(1) + expect(events.app.created).toHaveBeenCalledTimes(1) }) it("creates app from template", async () => { @@ -48,8 +142,8 @@ describe("/applications", () => { templateString: "{}", }) expect(app._id).toBeDefined() - expect(events.app.created).toBeCalledTimes(1) - expect(events.app.templateImported).toBeCalledTimes(1) + expect(events.app.created).toHaveBeenCalledTimes(1) + expect(events.app.templateImported).toHaveBeenCalledTimes(1) }) it("creates app from file", async () => { @@ -59,8 +153,8 @@ describe("/applications", () => { templateFile: "src/api/routes/tests/data/export.txt", }) expect(app._id).toBeDefined() - expect(events.app.created).toBeCalledTimes(1) - expect(events.app.fileImported).toBeCalledTimes(1) + expect(events.app.created).toHaveBeenCalledTimes(1) + expect(events.app.fileImported).toHaveBeenCalledTimes(1) }) it("should apply authorization to endpoint", async () => { @@ -90,8 +184,22 @@ describe("/applications", () => { expect(app.navigation!.navTextColor).toBe( "var(--spectrum-global-color-gray-50)" ) - expect(events.app.created).toBeCalledTimes(1) - expect(events.app.fileImported).toBeCalledTimes(1) + expect(events.app.created).toHaveBeenCalledTimes(1) + expect(events.app.fileImported).toHaveBeenCalledTimes(1) + }) + + it("should reject with a known name", async () => { + await config.api.application.create( + { name: app.name }, + { body: { message: "App name is already in use." }, status: 400 } + ) + }) + + it("should reject with a known url", async () => { + await config.api.application.create( + { name: "made up", url: app?.url! }, + { body: { message: "App URL is already in use." }, status: 400 } + ) }) }) @@ -123,32 +231,32 @@ describe("/applications", () => { name: "TEST_APP", }) expect(updatedApp._rev).toBeDefined() - expect(events.app.updated).toBeCalledTimes(1) + expect(events.app.updated).toHaveBeenCalledTimes(1) }) }) describe("publish", () => { it("should publish app with dev app ID", async () => { await config.api.application.publish(app.appId) - expect(events.app.published).toBeCalledTimes(1) + expect(events.app.published).toHaveBeenCalledTimes(1) }) it("should publish app with prod app ID", async () => { await config.api.application.publish(app.appId.replace("_dev", "")) - expect(events.app.published).toBeCalledTimes(1) + expect(events.app.published).toHaveBeenCalledTimes(1) }) }) describe("manage client library version", () => { it("should be able to update the app client library version", async () => { await config.api.application.updateClient(app.appId) - expect(events.app.versionUpdated).toBeCalledTimes(1) + expect(events.app.versionUpdated).toHaveBeenCalledTimes(1) }) it("should be able to revert the app client library version", async () => { await config.api.application.updateClient(app.appId) await config.api.application.revertClient(app.appId) - expect(events.app.versionReverted).toBeCalledTimes(1) + expect(events.app.versionReverted).toHaveBeenCalledTimes(1) }) }) @@ -205,26 +313,83 @@ describe("/applications", () => { describe("unpublish", () => { it("should unpublish app with dev app ID", async () => { await config.api.application.unpublish(app.appId) - expect(events.app.unpublished).toBeCalledTimes(1) + expect(events.app.unpublished).toHaveBeenCalledTimes(1) }) it("should unpublish app with prod app ID", async () => { await config.api.application.unpublish(app.appId.replace("_dev", "")) - expect(events.app.unpublished).toBeCalledTimes(1) + expect(events.app.unpublished).toHaveBeenCalledTimes(1) }) }) describe("delete", () => { it("should delete published app and dev apps with dev app ID", async () => { await config.api.application.delete(app.appId) - expect(events.app.deleted).toBeCalledTimes(1) - expect(events.app.unpublished).toBeCalledTimes(1) + expect(events.app.deleted).toHaveBeenCalledTimes(1) + expect(events.app.unpublished).toHaveBeenCalledTimes(1) }) it("should delete published app and dev app with prod app ID", async () => { await config.api.application.delete(app.appId.replace("_dev", "")) - expect(events.app.deleted).toBeCalledTimes(1) - expect(events.app.unpublished).toBeCalledTimes(1) + expect(events.app.deleted).toHaveBeenCalledTimes(1) + expect(events.app.unpublished).toHaveBeenCalledTimes(1) + }) + }) + + describe("POST /api/applications/:appId/duplicate", () => { + it("should duplicate an existing app", async () => { + const resp = await config.api.application.duplicateApp( + app.appId, + { + name: "to-dupe copy", + url: "/to-dupe-copy", + }, + { + status: 200, + } + ) + + expect(events.app.duplicated).toHaveBeenCalled() + expect(resp.duplicateAppId).toBeDefined() + expect(resp.sourceAppId).toEqual(app.appId) + expect(resp.duplicateAppId).not.toEqual(app.appId) + }) + + it("should reject an unknown app id with a 404", async () => { + await config.api.application.duplicateApp( + structures.db.id(), + { + name: "to-dupe 123", + url: "/to-dupe-123", + }, + { + status: 404, + } + ) + }) + + it("should reject with a known name", async () => { + await config.api.application.duplicateApp( + app.appId, + { + name: app.name, + url: "/known-name", + }, + { body: { message: "App name is already in use." }, status: 400 } + ) + expect(events.app.duplicated).not.toHaveBeenCalled() + }) + + it("should reject with a known url", async () => { + await config.api.application.duplicateApp( + app.appId, + { + name: "this is fine", + url: app.url, + }, + { body: { message: "App URL is already in use." }, status: 400 } + ) + expect(events.app.duplicated).not.toHaveBeenCalled() }) }) @@ -248,18 +413,4 @@ describe("/applications", () => { expect(devLogs.data.length).toBe(0) }) }) - - describe("permissions", () => { - it("should only return apps a user has access to", async () => { - const user = await config.createUser({ - builder: { global: false }, - admin: { global: false }, - }) - - await config.withUser(user, async () => { - const apps = await config.api.application.fetch() - expect(apps).toHaveLength(0) - }) - }) - }) }) diff --git a/packages/server/src/api/routes/tests/automation.spec.ts b/packages/server/src/api/routes/tests/automation.spec.ts index ee8fc7d544..322694df75 100644 --- a/packages/server/src/api/routes/tests/automation.spec.ts +++ b/packages/server/src/api/routes/tests/automation.spec.ts @@ -95,8 +95,8 @@ describe("/automations", () => { expect(res.body.message).toEqual("Automation created successfully") expect(res.body.automation.name).toEqual("My Automation") expect(res.body.automation._id).not.toEqual(null) - expect(events.automation.created).toBeCalledTimes(1) - expect(events.automation.stepCreated).not.toBeCalled() + expect(events.automation.created).toHaveBeenCalledTimes(1) + expect(events.automation.stepCreated).not.toHaveBeenCalled() }) it("creates an automation with steps", async () => { @@ -114,8 +114,8 @@ describe("/automations", () => { expect(res.body.message).toEqual("Automation created successfully") expect(res.body.automation.name).toEqual("My Automation") expect(res.body.automation._id).not.toEqual(null) - expect(events.automation.created).toBeCalledTimes(1) - expect(events.automation.stepCreated).toBeCalledTimes(2) + expect(events.automation.created).toHaveBeenCalledTimes(1) + expect(events.automation.stepCreated).toHaveBeenCalledTimes(2) }) it("should apply authorization to endpoint", async () => { @@ -158,7 +158,7 @@ describe("/automations", () => { automation = await config.createAutomation(automation) await setup.delay(500) const res = await testAutomation(config, automation) - expect(events.automation.tested).toBeCalledTimes(1) + expect(events.automation.tested).toHaveBeenCalledTimes(1) // this looks a bit mad but we don't actually have a way to wait for a response from the automation to // know that it has finished all of its actions - this is currently the best way // also when this runs in CI it is very temper-mental so for now trying to make run stable by repeating until it works @@ -265,10 +265,10 @@ describe("/automations", () => { `Automation ${automation._id} updated successfully.` ) // events - expect(events.automation.created).not.toBeCalled() - expect(events.automation.stepCreated).not.toBeCalled() - expect(events.automation.stepDeleted).not.toBeCalled() - expect(events.automation.triggerUpdated).not.toBeCalled() + expect(events.automation.created).not.toHaveBeenCalled() + expect(events.automation.stepCreated).not.toHaveBeenCalled() + expect(events.automation.stepDeleted).not.toHaveBeenCalled() + expect(events.automation.triggerUpdated).not.toHaveBeenCalled() }) it("updates a automations name using POST request", async () => { @@ -293,10 +293,10 @@ describe("/automations", () => { `Automation ${automation._id} updated successfully.` ) // events - expect(events.automation.created).not.toBeCalled() - expect(events.automation.stepCreated).not.toBeCalled() - expect(events.automation.stepDeleted).not.toBeCalled() - expect(events.automation.triggerUpdated).not.toBeCalled() + expect(events.automation.created).not.toHaveBeenCalled() + expect(events.automation.stepCreated).not.toHaveBeenCalled() + expect(events.automation.stepDeleted).not.toHaveBeenCalled() + expect(events.automation.triggerUpdated).not.toHaveBeenCalled() }) it("updates an automation trigger", async () => { @@ -310,10 +310,10 @@ describe("/automations", () => { await update(automation) // events - expect(events.automation.created).not.toBeCalled() - expect(events.automation.stepCreated).not.toBeCalled() - expect(events.automation.stepDeleted).not.toBeCalled() - expect(events.automation.triggerUpdated).toBeCalledTimes(1) + expect(events.automation.created).not.toHaveBeenCalled() + expect(events.automation.stepCreated).not.toHaveBeenCalled() + expect(events.automation.stepDeleted).not.toHaveBeenCalled() + expect(events.automation.triggerUpdated).toHaveBeenCalledTimes(1) }) it("adds automation steps", async () => { @@ -327,10 +327,10 @@ describe("/automations", () => { await update(automation) // events - expect(events.automation.stepCreated).toBeCalledTimes(2) - expect(events.automation.created).not.toBeCalled() - expect(events.automation.stepDeleted).not.toBeCalled() - expect(events.automation.triggerUpdated).not.toBeCalled() + expect(events.automation.stepCreated).toHaveBeenCalledTimes(2) + expect(events.automation.created).not.toHaveBeenCalled() + expect(events.automation.stepDeleted).not.toHaveBeenCalled() + expect(events.automation.triggerUpdated).not.toHaveBeenCalled() }) it("removes automation steps", async () => { @@ -344,10 +344,10 @@ describe("/automations", () => { await update(automation) // events - expect(events.automation.stepDeleted).toBeCalledTimes(2) - expect(events.automation.stepCreated).not.toBeCalled() - expect(events.automation.created).not.toBeCalled() - expect(events.automation.triggerUpdated).not.toBeCalled() + expect(events.automation.stepDeleted).toHaveBeenCalledTimes(2) + expect(events.automation.stepCreated).not.toHaveBeenCalled() + expect(events.automation.created).not.toHaveBeenCalled() + expect(events.automation.triggerUpdated).not.toHaveBeenCalled() }) it("adds and removes automation steps", async () => { @@ -360,10 +360,10 @@ describe("/automations", () => { await update(automation) // events - expect(events.automation.stepCreated).toBeCalledTimes(2) - expect(events.automation.stepDeleted).toBeCalledTimes(1) - expect(events.automation.created).not.toBeCalled() - expect(events.automation.triggerUpdated).not.toBeCalled() + expect(events.automation.stepCreated).toHaveBeenCalledTimes(2) + expect(events.automation.stepDeleted).toHaveBeenCalledTimes(1) + expect(events.automation.created).not.toHaveBeenCalled() + expect(events.automation.triggerUpdated).not.toHaveBeenCalled() }) }) @@ -400,7 +400,7 @@ describe("/automations", () => { .expect(200) expect(res.body.id).toEqual(automation._id) - expect(events.automation.deleted).toBeCalledTimes(1) + expect(events.automation.deleted).toHaveBeenCalledTimes(1) }) it("should apply authorization to endpoint", async () => { diff --git a/packages/server/src/api/routes/tests/backup.spec.ts b/packages/server/src/api/routes/tests/backup.spec.ts index c862106d58..7b56145f8e 100644 --- a/packages/server/src/api/routes/tests/backup.spec.ts +++ b/packages/server/src/api/routes/tests/backup.spec.ts @@ -21,7 +21,7 @@ describe("/backups", () => { it("should be able to export app", async () => { const body = await config.api.backup.exportBasicBackup(config.getAppId()!) expect(body instanceof Buffer).toBe(true) - expect(events.app.exported).toBeCalledTimes(1) + expect(events.app.exported).toHaveBeenCalledTimes(1) }) it("should apply authorization to endpoint", async () => { diff --git a/packages/server/src/api/routes/tests/datasource.spec.ts b/packages/server/src/api/routes/tests/datasource.spec.ts index 032da71b80..cbd830aee5 100644 --- a/packages/server/src/api/routes/tests/datasource.spec.ts +++ b/packages/server/src/api/routes/tests/datasource.spec.ts @@ -40,7 +40,7 @@ describe("/datasources", () => { expect(res.body.datasource.name).toEqual("Test") expect(res.body.errors).toEqual({}) - expect(events.datasource.created).toBeCalledTimes(1) + expect(events.datasource.created).toHaveBeenCalledTimes(1) }) }) @@ -56,7 +56,7 @@ describe("/datasources", () => { expect(res.body.datasource.name).toEqual("Updated Test") expect(res.body.errors).toBeUndefined() - expect(events.datasource.updated).toBeCalledTimes(1) + expect(events.datasource.updated).toHaveBeenCalledTimes(1) }) describe("dynamic variables", () => { @@ -196,7 +196,7 @@ describe("/datasources", () => { .expect(200) expect(res.body.length).toEqual(1) - expect(events.datasource.deleted).toBeCalledTimes(1) + expect(events.datasource.deleted).toHaveBeenCalledTimes(1) }) it("should apply authorization to endpoint", async () => { diff --git a/packages/server/src/api/routes/tests/debug.spec.ts b/packages/server/src/api/routes/tests/debug.spec.ts index 53e1f67823..546344a646 100644 --- a/packages/server/src/api/routes/tests/debug.spec.ts +++ b/packages/server/src/api/routes/tests/debug.spec.ts @@ -1,13 +1,5 @@ -const { checkBuilderEndpoint } = require("./utilities/TestFunctions") -const setup = require("./utilities") - -import os from "os" - -jest.mock("process", () => ({ - arch: "arm64", - version: "v14.20.1", - platform: "darwin", -})) +import * as setup from "./utilities" +import { checkBuilderEndpoint } from "./utilities/TestFunctions" describe("/component", () => { let request = setup.getRequest() @@ -17,21 +9,6 @@ describe("/component", () => { beforeAll(async () => { await config.init() - os.cpus = () => [ - { - model: "test", - speed: 12323, - times: { - user: 0, - nice: 0, - sys: 0, - idle: 0, - irq: 0, - }, - }, - ] - os.uptime = () => 123123123123 - os.totalmem = () => 10000000000 }) describe("/api/debug", () => { @@ -43,14 +20,16 @@ describe("/component", () => { .expect(200) expect(res.body).toEqual({ budibaseVersion: "0.0.0+jest", - cpuArch: "arm64", - cpuCores: 1, - cpuInfo: "test", + cpuArch: expect.any(String), + cpuCores: expect.any(Number), + cpuInfo: expect.any(String), hosting: "docker-compose", - nodeVersion: "v14.20.1", - platform: "darwin", - totalMemory: "9.313225746154785GB", - uptime: "1425036 day(s), 3 hour(s), 32 minute(s)", + nodeVersion: expect.stringMatching(/^v\d+\.\d+\.\d+$/), + platform: expect.any(String), + totalMemory: expect.stringMatching(/^[0-9\\.]+GB$/), + uptime: expect.stringMatching( + /^\d+ day\(s\), \d+ hour\(s\), \d+ minute\(s\)$/ + ), }) }) diff --git a/packages/server/src/api/routes/tests/environmentVariables.spec.ts b/packages/server/src/api/routes/tests/environmentVariables.spec.ts index 22114a1da3..9104dedf4f 100644 --- a/packages/server/src/api/routes/tests/environmentVariables.spec.ts +++ b/packages/server/src/api/routes/tests/environmentVariables.spec.ts @@ -138,10 +138,10 @@ describe("/api/env/variables", () => { .expect("Content-Type", /json/) .expect(200) expect(res.body.rows.length).toEqual(0) - expect(events.query.previewed).toBeCalledTimes(1) + expect(events.query.previewed).toHaveBeenCalledTimes(1) // API doesn't include config in response delete response.body.datasource.config - expect(events.query.previewed).toBeCalledWith( + expect(events.query.previewed).toHaveBeenCalledWith( response.body.datasource, queryPreview ) diff --git a/packages/server/src/api/routes/tests/permissions.spec.ts b/packages/server/src/api/routes/tests/permissions.spec.ts index 1eabf6edbb..bee794da47 100644 --- a/packages/server/src/api/routes/tests/permissions.spec.ts +++ b/packages/server/src/api/routes/tests/permissions.spec.ts @@ -16,7 +16,7 @@ import { ViewV2, } from "@budibase/types" import * as setup from "./utilities" -import { mocks } from "@budibase/backend-core/tests" +import { generator, mocks } from "@budibase/backend-core/tests" const { basicRow } = setup.structures const { BUILTIN_ROLE_IDS } = roles @@ -44,7 +44,10 @@ describe("/permission", () => { table = (await config.createTable()) as typeof table row = await config.createRow() - view = await config.api.viewV2.create({ tableId: table._id }) + view = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + }) perms = await config.api.permission.add({ roleId: STD_ROLE_ID, resourceId: table._id, @@ -153,7 +156,7 @@ describe("/permission", () => { level: PermissionLevel.READ, }) - const response = await config.api.permission.revoke( + await config.api.permission.revoke( { roleId: STD_ROLE_ID, resourceId: table._id, diff --git a/packages/server/src/api/routes/tests/queries/generic-sql.spec.ts b/packages/server/src/api/routes/tests/queries/generic-sql.spec.ts new file mode 100644 index 0000000000..1fc0ecb382 --- /dev/null +++ b/packages/server/src/api/routes/tests/queries/generic-sql.spec.ts @@ -0,0 +1,401 @@ +import { Datasource, Query, SourceName } from "@budibase/types" +import * as setup from "../utilities" +import { databaseTestProviders } from "../../../../integrations/tests/utils" +import pg from "pg" +import mysql from "mysql2/promise" +import mssql from "mssql" + +jest.unmock("pg") + +const createTableSQL: Record = { + [SourceName.POSTGRES]: ` + CREATE TABLE test_table ( + id serial PRIMARY KEY, + name VARCHAR ( 50 ) NOT NULL, + birthday TIMESTAMP + );`, + [SourceName.MYSQL]: ` + CREATE TABLE test_table ( + id INT AUTO_INCREMENT PRIMARY KEY, + name VARCHAR(50) NOT NULL, + birthday TIMESTAMP + );`, + [SourceName.SQL_SERVER]: ` + CREATE TABLE test_table ( + id INT IDENTITY(1,1) PRIMARY KEY, + name NVARCHAR(50) NOT NULL, + birthday DATETIME + );`, +} + +const insertSQL = `INSERT INTO test_table (name) VALUES ('one'), ('two'), ('three'), ('four'), ('five')` +const dropTableSQL = `DROP TABLE test_table;` + +describe.each([ + ["postgres", databaseTestProviders.postgres], + ["mysql", databaseTestProviders.mysql], + ["mssql", databaseTestProviders.mssql], + ["mariadb", databaseTestProviders.mariadb], +])("queries (%s)", (__, dsProvider) => { + const config = setup.getConfig() + let datasource: Datasource + + async function createQuery(query: Partial): Promise { + const defaultQuery: Query = { + datasourceId: datasource._id!, + name: "New Query", + parameters: [], + fields: {}, + schema: {}, + queryVerb: "read", + transformer: "return data", + readable: true, + } + return await config.api.query.create({ ...defaultQuery, ...query }) + } + + async function rawQuery(sql: string): Promise { + // We re-fetch the datasource here because the one returned by + // config.api.datasource.create has the password field blanked out, and we + // need the password to connect to the database. + const ds = await dsProvider.datasource() + switch (ds.source) { + case SourceName.POSTGRES: { + const client = new pg.Client(ds.config!) + await client.connect() + try { + const { rows } = await client.query(sql) + return rows + } finally { + await client.end() + } + } + case SourceName.MYSQL: { + const con = await mysql.createConnection(ds.config!) + try { + const [rows] = await con.query(sql) + return rows + } finally { + con.end() + } + } + case SourceName.SQL_SERVER: { + const pool = new mssql.ConnectionPool(ds.config! as mssql.config) + const client = await pool.connect() + try { + const { recordset } = await client.query(sql) + return recordset + } finally { + await pool.close() + } + } + } + } + + beforeAll(async () => { + await config.init() + datasource = await config.api.datasource.create( + await dsProvider.datasource() + ) + }) + + beforeEach(async () => { + await rawQuery(createTableSQL[datasource.source]) + await rawQuery(insertSQL) + }) + + afterEach(async () => { + await rawQuery(dropTableSQL) + }) + + afterAll(async () => { + await dsProvider.stop() + setup.afterAll() + }) + + describe("create", () => { + it("should be able to insert with bindings", async () => { + const query = await createQuery({ + fields: { + sql: "INSERT INTO test_table (name) VALUES ({{ foo }})", + }, + parameters: [ + { + name: "foo", + default: "bar", + }, + ], + queryVerb: "create", + }) + + const result = await config.api.query.execute(query._id!, { + parameters: { + foo: "baz", + }, + }) + + expect(result.data).toEqual([ + { + created: true, + }, + ]) + + const rows = await rawQuery("SELECT * FROM test_table WHERE name = 'baz'") + expect(rows).toHaveLength(1) + }) + + it.each(["2021-02-05T12:01:00.000Z", "2021-02-05"])( + "should coerce %s into a date", + async datetimeStr => { + const date = new Date(datetimeStr) + const query = await createQuery({ + fields: { + sql: `INSERT INTO test_table (name, birthday) VALUES ('foo', {{ birthday }})`, + }, + parameters: [ + { + name: "birthday", + default: "", + }, + ], + queryVerb: "create", + }) + + const result = await config.api.query.execute(query._id!, { + parameters: { birthday: datetimeStr }, + }) + + expect(result.data).toEqual([{ created: true }]) + + const rows = await rawQuery( + `SELECT * FROM test_table WHERE birthday = '${date.toISOString()}'` + ) + expect(rows).toHaveLength(1) + } + ) + + it.each(["2021,02,05", "202205-1500"])( + "should not coerce %s as a date", + async notDateStr => { + const query = await createQuery({ + fields: { + sql: "INSERT INTO test_table (name) VALUES ({{ name }})", + }, + parameters: [ + { + name: "name", + default: "", + }, + ], + queryVerb: "create", + }) + + const result = await config.api.query.execute(query._id!, { + parameters: { + name: notDateStr, + }, + }) + + expect(result.data).toEqual([{ created: true }]) + + const rows = await rawQuery( + `SELECT * FROM test_table WHERE name = '${notDateStr}'` + ) + expect(rows).toHaveLength(1) + } + ) + }) + + describe("read", () => { + it("should execute a query", async () => { + const query = await createQuery({ + fields: { + sql: "SELECT * FROM test_table ORDER BY id", + }, + }) + + const result = await config.api.query.execute(query._id!) + + expect(result.data).toEqual([ + { + id: 1, + name: "one", + birthday: null, + }, + { + id: 2, + name: "two", + birthday: null, + }, + { + id: 3, + name: "three", + birthday: null, + }, + { + id: 4, + name: "four", + birthday: null, + }, + { + id: 5, + name: "five", + birthday: null, + }, + ]) + }) + + it("should be able to transform a query", async () => { + const query = await createQuery({ + fields: { + sql: "SELECT * FROM test_table WHERE id = 1", + }, + transformer: ` + data[0].id = data[0].id + 1; + return data; + `, + }) + + const result = await config.api.query.execute(query._id!) + + expect(result.data).toEqual([ + { + id: 2, + name: "one", + birthday: null, + }, + ]) + }) + + it("should coerce numeric bindings", async () => { + const query = await createQuery({ + fields: { + sql: "SELECT * FROM test_table WHERE id = {{ id }}", + }, + parameters: [ + { + name: "id", + default: "", + }, + ], + }) + + const result = await config.api.query.execute(query._id!, { + parameters: { + id: "1", + }, + }) + + expect(result.data).toEqual([ + { + id: 1, + name: "one", + birthday: null, + }, + ]) + }) + }) + + describe("update", () => { + it("should be able to update rows", async () => { + const query = await createQuery({ + fields: { + sql: "UPDATE test_table SET name = {{ name }} WHERE id = {{ id }}", + }, + parameters: [ + { + name: "id", + default: "", + }, + { + name: "name", + default: "updated", + }, + ], + queryVerb: "update", + }) + + const result = await config.api.query.execute(query._id!, { + parameters: { + id: "1", + name: "foo", + }, + }) + + expect(result.data).toEqual([ + { + updated: true, + }, + ]) + + const rows = await rawQuery("SELECT * FROM test_table WHERE id = 1") + expect(rows).toEqual([{ id: 1, name: "foo", birthday: null }]) + }) + + it("should be able to execute an update that updates no rows", async () => { + const query = await createQuery({ + fields: { + sql: "UPDATE test_table SET name = 'updated' WHERE id = 100", + }, + queryVerb: "update", + }) + + const result = await config.api.query.execute(query._id!) + + expect(result.data).toEqual([ + { + updated: true, + }, + ]) + }) + + it("should be able to execute a delete that deletes no rows", async () => { + const query = await createQuery({ + fields: { + sql: "DELETE FROM test_table WHERE id = 100", + }, + queryVerb: "delete", + }) + + const result = await config.api.query.execute(query._id!) + + expect(result.data).toEqual([ + { + deleted: true, + }, + ]) + }) + }) + + describe("delete", () => { + it("should be able to delete rows", async () => { + const query = await createQuery({ + fields: { + sql: "DELETE FROM test_table WHERE id = {{ id }}", + }, + parameters: [ + { + name: "id", + default: "", + }, + ], + queryVerb: "delete", + }) + + const result = await config.api.query.execute(query._id!, { + parameters: { + id: "1", + }, + }) + + expect(result.data).toEqual([ + { + deleted: true, + }, + ]) + + const rows = await rawQuery("SELECT * FROM test_table WHERE id = 1") + expect(rows).toHaveLength(0) + }) + }) +}) diff --git a/packages/server/src/api/routes/tests/queries/mongodb.spec.ts b/packages/server/src/api/routes/tests/queries/mongodb.spec.ts index b61f905bef..e0351e0ce3 100644 --- a/packages/server/src/api/routes/tests/queries/mongodb.spec.ts +++ b/packages/server/src/api/routes/tests/queries/mongodb.spec.ts @@ -3,8 +3,6 @@ import * as setup from "../utilities" import { databaseTestProviders } from "../../../../integrations/tests/utils" import { MongoClient, type Collection, BSON } from "mongodb" -jest.unmock("mongodb") - const collection = "test_collection" const expectValidId = expect.stringMatching(/^\w{24}$/) @@ -36,27 +34,27 @@ describe("/queries", () => { return await config.api.query.create(combinedQuery) } - async function withClient( - callback: (client: MongoClient) => Promise - ): Promise { + async function withClient( + callback: (client: MongoClient) => Promise + ): Promise { const ds = await databaseTestProviders.mongodb.datasource() const client = new MongoClient(ds.config!.connectionString) await client.connect() try { - await callback(client) + return await callback(client) } finally { await client.close() } } - async function withCollection( - callback: (collection: Collection) => Promise - ): Promise { - await withClient(async client => { + async function withCollection( + callback: (collection: Collection) => Promise + ): Promise { + return await withClient(async client => { const db = client.db( (await databaseTestProviders.mongodb.datasource()).config!.db ) - await callback(db.collection(collection)) + return await callback(db.collection(collection)) }) } @@ -327,6 +325,42 @@ describe("/queries", () => { }) }) + it("should be able to updateOne by ObjectId", async () => { + const insertResult = await withCollection(c => c.insertOne({ name: "one" })) + const query = await createQuery({ + fields: { + json: { + filter: { _id: { $eq: `ObjectId("${insertResult.insertedId}")` } }, + update: { $set: { name: "newName" } }, + }, + extra: { + actionType: "updateOne", + }, + }, + queryVerb: "update", + }) + + const result = await config.api.query.execute(query._id!) + + expect(result.data).toEqual([ + { + acknowledged: true, + matchedCount: 1, + modifiedCount: 1, + upsertedCount: 0, + upsertedId: null, + }, + ]) + + await withCollection(async collection => { + const doc = await collection.findOne({ name: { $eq: "newName" } }) + expect(doc).toEqual({ + _id: insertResult.insertedId, + name: "newName", + }) + }) + }) + it("should be able to delete all records", async () => { const query = await createQuery({ fields: { @@ -390,4 +424,85 @@ describe("/queries", () => { } }) }) + + it("should throw an error if the incorrect actionType is specified", async () => { + const verbs = ["read", "create", "update", "delete"] + for (const verb of verbs) { + const query = await createQuery({ + fields: { json: {}, extra: { actionType: "invalid" } }, + queryVerb: verb, + }) + await config.api.query.execute(query._id!, undefined, { status: 400 }) + } + }) + + it("should ignore extra brackets in query", async () => { + const query = await createQuery({ + fields: { + json: { foo: "te}st" }, + extra: { + actionType: "insertOne", + }, + }, + queryVerb: "create", + }) + + const result = await config.api.query.execute(query._id!) + expect(result.data).toEqual([ + { + acknowledged: true, + insertedId: expectValidId, + }, + ]) + + await withCollection(async collection => { + const doc = await collection.findOne({ foo: { $eq: "te}st" } }) + expect(doc).toEqual({ + _id: expectValidBsonObjectId, + foo: "te}st", + }) + }) + }) + + it("should ignore be able to save deeply nested data", async () => { + const data = { + foo: "bar", + data: [ + { cid: 1 }, + { cid: 2 }, + { + nested: { + name: "test", + ary: [1, 2, 3], + aryOfObjects: [{ a: 1 }, { b: 2 }], + }, + }, + ], + } + const query = await createQuery({ + fields: { + json: data, + extra: { + actionType: "insertOne", + }, + }, + queryVerb: "create", + }) + + const result = await config.api.query.execute(query._id!) + expect(result.data).toEqual([ + { + acknowledged: true, + insertedId: expectValidId, + }, + ]) + + await withCollection(async collection => { + const doc = await collection.findOne({ foo: { $eq: "bar" } }) + expect(doc).toEqual({ + _id: expectValidBsonObjectId, + ...data, + }) + }) + }) }) diff --git a/packages/server/src/api/routes/tests/queries/mysql.spec.ts b/packages/server/src/api/routes/tests/queries/mysql.spec.ts deleted file mode 100644 index 1c9c1d3865..0000000000 --- a/packages/server/src/api/routes/tests/queries/mysql.spec.ts +++ /dev/null @@ -1,239 +0,0 @@ -import { Datasource, Query } from "@budibase/types" -import * as setup from "../utilities" -import { databaseTestProviders } from "../../../../integrations/tests/utils" -import mysql from "mysql2/promise" - -jest.unmock("mysql2") -jest.unmock("mysql2/promise") - -const createTableSQL = ` -CREATE TABLE test_table ( - id INT AUTO_INCREMENT PRIMARY KEY, - name VARCHAR(50) NOT NULL -) -` - -const insertSQL = ` -INSERT INTO test_table (name) VALUES ('one'), ('two'), ('three'), ('four'), ('five') -` - -const dropTableSQL = ` -DROP TABLE test_table -` - -describe("/queries", () => { - let config = setup.getConfig() - let datasource: Datasource - - async function createQuery(query: Partial): Promise { - const defaultQuery: Query = { - datasourceId: datasource._id!, - name: "New Query", - parameters: [], - fields: {}, - schema: {}, - queryVerb: "read", - transformer: "return data", - readable: true, - } - return await config.api.query.create({ ...defaultQuery, ...query }) - } - - async function withConnection( - callback: (client: mysql.Connection) => Promise - ): Promise { - const ds = await databaseTestProviders.mysql.datasource() - const con = await mysql.createConnection(ds.config!) - try { - await callback(con) - } finally { - con.end() - } - } - - afterAll(async () => { - await databaseTestProviders.mysql.stop() - setup.afterAll() - }) - - beforeAll(async () => { - await config.init() - datasource = await config.api.datasource.create( - await databaseTestProviders.mysql.datasource() - ) - }) - - beforeEach(async () => { - await withConnection(async connection => { - const resp = await connection.query(createTableSQL) - await connection.query(insertSQL) - }) - }) - - afterEach(async () => { - await withConnection(async connection => { - await connection.query(dropTableSQL) - }) - }) - - it("should execute a query", async () => { - const query = await createQuery({ - fields: { - sql: "SELECT * FROM test_table ORDER BY id", - }, - }) - - const result = await config.api.query.execute(query._id!) - - expect(result.data).toEqual([ - { - id: 1, - name: "one", - }, - { - id: 2, - name: "two", - }, - { - id: 3, - name: "three", - }, - { - id: 4, - name: "four", - }, - { - id: 5, - name: "five", - }, - ]) - }) - - it("should be able to transform a query", async () => { - const query = await createQuery({ - fields: { - sql: "SELECT * FROM test_table WHERE id = 1", - }, - transformer: ` - data[0].id = data[0].id + 1; - return data; - `, - }) - - const result = await config.api.query.execute(query._id!) - - expect(result.data).toEqual([ - { - id: 2, - name: "one", - }, - ]) - }) - - it("should be able to insert with bindings", async () => { - const query = await createQuery({ - fields: { - sql: "INSERT INTO test_table (name) VALUES ({{ foo }})", - }, - parameters: [ - { - name: "foo", - default: "bar", - }, - ], - queryVerb: "create", - }) - - const result = await config.api.query.execute(query._id!, { - parameters: { - foo: "baz", - }, - }) - - expect(result.data).toEqual([ - { - created: true, - }, - ]) - - await withConnection(async connection => { - const [rows] = await connection.query( - "SELECT * FROM test_table WHERE name = 'baz'" - ) - expect(rows).toHaveLength(1) - }) - }) - - it("should be able to update rows", async () => { - const query = await createQuery({ - fields: { - sql: "UPDATE test_table SET name = {{ name }} WHERE id = {{ id }}", - }, - parameters: [ - { - name: "id", - default: "", - }, - { - name: "name", - default: "updated", - }, - ], - queryVerb: "update", - }) - - const result = await config.api.query.execute(query._id!, { - parameters: { - id: "1", - name: "foo", - }, - }) - - expect(result.data).toEqual([ - { - updated: true, - }, - ]) - - await withConnection(async connection => { - const [rows] = await connection.query( - "SELECT * FROM test_table WHERE id = 1" - ) - expect(rows).toEqual([{ id: 1, name: "foo" }]) - }) - }) - - it("should be able to delete rows", async () => { - const query = await createQuery({ - fields: { - sql: "DELETE FROM test_table WHERE id = {{ id }}", - }, - parameters: [ - { - name: "id", - default: "", - }, - ], - queryVerb: "delete", - }) - - const result = await config.api.query.execute(query._id!, { - parameters: { - id: "1", - }, - }) - - expect(result.data).toEqual([ - { - deleted: true, - }, - ]) - - await withConnection(async connection => { - const [rows] = await connection.query( - "SELECT * FROM test_table WHERE id = 1" - ) - expect(rows).toHaveLength(0) - }) - }) -}) diff --git a/packages/server/src/api/routes/tests/queries/postgres.spec.ts b/packages/server/src/api/routes/tests/queries/postgres.spec.ts deleted file mode 100644 index fd6a2b7d3c..0000000000 --- a/packages/server/src/api/routes/tests/queries/postgres.spec.ts +++ /dev/null @@ -1,243 +0,0 @@ -import { Datasource, Query } from "@budibase/types" -import * as setup from "../utilities" -import { databaseTestProviders } from "../../../../integrations/tests/utils" -import { Client } from "pg" - -jest.unmock("pg") - -const createTableSQL = ` -CREATE TABLE test_table ( - id serial PRIMARY KEY, - name VARCHAR ( 50 ) NOT NULL -); -` - -const insertSQL = ` -INSERT INTO test_table (name) VALUES ('one'); -INSERT INTO test_table (name) VALUES ('two'); -INSERT INTO test_table (name) VALUES ('three'); -INSERT INTO test_table (name) VALUES ('four'); -INSERT INTO test_table (name) VALUES ('five'); -` - -const dropTableSQL = ` -DROP TABLE test_table; -` - -describe("/queries", () => { - let config = setup.getConfig() - let datasource: Datasource - - async function createQuery(query: Partial): Promise { - const defaultQuery: Query = { - datasourceId: datasource._id!, - name: "New Query", - parameters: [], - fields: {}, - schema: {}, - queryVerb: "read", - transformer: "return data", - readable: true, - } - return await config.api.query.create({ ...defaultQuery, ...query }) - } - - async function withClient( - callback: (client: Client) => Promise - ): Promise { - const ds = await databaseTestProviders.postgres.datasource() - const client = new Client(ds.config!) - await client.connect() - try { - await callback(client) - } finally { - await client.end() - } - } - - afterAll(async () => { - await databaseTestProviders.postgres.stop() - setup.afterAll() - }) - - beforeAll(async () => { - await config.init() - datasource = await config.api.datasource.create( - await databaseTestProviders.postgres.datasource() - ) - }) - - beforeEach(async () => { - await withClient(async client => { - await client.query(createTableSQL) - await client.query(insertSQL) - }) - }) - - afterEach(async () => { - await withClient(async client => { - await client.query(dropTableSQL) - }) - }) - - it("should execute a query", async () => { - const query = await createQuery({ - fields: { - sql: "SELECT * FROM test_table ORDER BY id", - }, - }) - - const result = await config.api.query.execute(query._id!) - - expect(result.data).toEqual([ - { - id: 1, - name: "one", - }, - { - id: 2, - name: "two", - }, - { - id: 3, - name: "three", - }, - { - id: 4, - name: "four", - }, - { - id: 5, - name: "five", - }, - ]) - }) - - it("should be able to transform a query", async () => { - const query = await createQuery({ - fields: { - sql: "SELECT * FROM test_table WHERE id = 1", - }, - transformer: ` - data[0].id = data[0].id + 1; - return data; - `, - }) - - const result = await config.api.query.execute(query._id!) - - expect(result.data).toEqual([ - { - id: 2, - name: "one", - }, - ]) - }) - - it("should be able to insert with bindings", async () => { - const query = await createQuery({ - fields: { - sql: "INSERT INTO test_table (name) VALUES ({{ foo }})", - }, - parameters: [ - { - name: "foo", - default: "bar", - }, - ], - queryVerb: "create", - }) - - const result = await config.api.query.execute(query._id!, { - parameters: { - foo: "baz", - }, - }) - - expect(result.data).toEqual([ - { - created: true, - }, - ]) - - await withClient(async client => { - const { rows } = await client.query( - "SELECT * FROM test_table WHERE name = 'baz'" - ) - expect(rows).toHaveLength(1) - }) - }) - - it("should be able to update rows", async () => { - const query = await createQuery({ - fields: { - sql: "UPDATE test_table SET name = {{ name }} WHERE id = {{ id }}", - }, - parameters: [ - { - name: "id", - default: "", - }, - { - name: "name", - default: "updated", - }, - ], - queryVerb: "update", - }) - - const result = await config.api.query.execute(query._id!, { - parameters: { - id: "1", - name: "foo", - }, - }) - - expect(result.data).toEqual([ - { - updated: true, - }, - ]) - - await withClient(async client => { - const { rows } = await client.query( - "SELECT * FROM test_table WHERE id = 1" - ) - expect(rows).toEqual([{ id: 1, name: "foo" }]) - }) - }) - - it("should be able to delete rows", async () => { - const query = await createQuery({ - fields: { - sql: "DELETE FROM test_table WHERE id = {{ id }}", - }, - parameters: [ - { - name: "id", - default: "", - }, - ], - queryVerb: "delete", - }) - - const result = await config.api.query.execute(query._id!, { - parameters: { - id: "1", - }, - }) - - expect(result.data).toEqual([ - { - deleted: true, - }, - ]) - - await withClient(async client => { - const { rows } = await client.query( - "SELECT * FROM test_table WHERE id = 1" - ) - expect(rows).toHaveLength(0) - }) - }) -}) diff --git a/packages/server/src/api/routes/tests/queries/query.seq.spec.ts b/packages/server/src/api/routes/tests/queries/query.seq.spec.ts index 4347ed9044..10b90eafb1 100644 --- a/packages/server/src/api/routes/tests/queries/query.seq.spec.ts +++ b/packages/server/src/api/routes/tests/queries/query.seq.spec.ts @@ -81,8 +81,8 @@ describe("/queries", () => { createdAt: new Date().toISOString(), updatedAt: new Date().toISOString(), }) - expect(events.query.created).toBeCalledTimes(1) - expect(events.query.updated).not.toBeCalled() + expect(events.query.created).toHaveBeenCalledTimes(1) + expect(events.query.updated).not.toHaveBeenCalled() }) }) @@ -106,8 +106,8 @@ describe("/queries", () => { createdAt: new Date().toISOString(), updatedAt: new Date().toISOString(), }) - expect(events.query.created).not.toBeCalled() - expect(events.query.updated).toBeCalledTimes(1) + expect(events.query.created).not.toHaveBeenCalled() + expect(events.query.updated).toHaveBeenCalledTimes(1) }) }) @@ -210,8 +210,8 @@ describe("/queries", () => { .expect(200) expect(res.body).toEqual([]) - expect(events.query.deleted).toBeCalledTimes(1) - expect(events.query.deleted).toBeCalledWith(datasource, query) + expect(events.query.deleted).toHaveBeenCalledTimes(1) + expect(events.query.deleted).toHaveBeenCalledWith(datasource, query) }) it("should apply authorization to endpoint", async () => { @@ -243,9 +243,12 @@ describe("/queries", () => { b: { type: "number", name: "b" }, }) expect(responseBody.rows.length).toEqual(1) - expect(events.query.previewed).toBeCalledTimes(1) + expect(events.query.previewed).toHaveBeenCalledTimes(1) delete datasource.config - expect(events.query.previewed).toBeCalledWith(datasource, queryPreview) + expect(events.query.previewed).toHaveBeenCalledWith( + datasource, + queryPreview + ) }) it("should apply authorization to endpoint", async () => { @@ -327,6 +330,7 @@ describe("/queries", () => { ], }, ] + pg.queryMock.mockImplementation(() => ({ rows, })) @@ -408,6 +412,21 @@ describe("/queries", () => { }, }) }) + + it("shouldn't allow handlebars to be passed as parameters", async () => { + const res = await request + .post(`/api/queries/${query._id}`) + .send({ + parameters: { + a: "{{ 'test' }}", + }, + }) + .set(config.defaultHeaders()) + .expect(400) + expect(res.body.message).toEqual( + "Parameter 'a' input contains a handlebars binding - this is not allowed." + ) + }) }) describe("variables", () => { diff --git a/packages/server/src/api/routes/tests/row.spec.ts b/packages/server/src/api/routes/tests/row.spec.ts index de411f5397..f638f2c4bf 100644 --- a/packages/server/src/api/routes/tests/row.spec.ts +++ b/packages/server/src/api/routes/tests/row.spec.ts @@ -3,53 +3,56 @@ import { databaseTestProviders } from "../../../integrations/tests/utils" import tk from "timekeeper" import { outputProcessing } from "../../../utilities/rowProcessor" import * as setup from "./utilities" -import { context, InternalTable, roles, tenancy } from "@budibase/backend-core" +import { context, InternalTable, tenancy } from "@budibase/backend-core" import { quotas } from "@budibase/pro" import { AutoFieldSubType, + Datasource, DeleteRow, FieldSchema, FieldType, FieldTypeSubtypes, FormulaType, INTERNAL_TABLE_SOURCE_ID, - PermissionLevel, QuotaUsageType, RelationshipType, Row, SaveTableRequest, - SearchQueryOperators, - SortOrder, - SortType, StaticQuotaName, Table, TableSourceType, } from "@budibase/types" -import { - expectAnyExternalColsAttributes, - expectAnyInternalColsAttributes, - generator, - mocks, - structures, -} from "@budibase/backend-core/tests" -import _ from "lodash" +import { generator, mocks } from "@budibase/backend-core/tests" +import _, { merge } from "lodash" import * as uuid from "uuid" const timestamp = new Date("2023-01-26T11:48:57.597Z").toISOString() tk.freeze(timestamp) -const { basicRow } = setup.structures +jest.unmock("mssql") +jest.unmock("pg") describe.each([ ["internal", undefined], ["postgres", databaseTestProviders.postgres], + ["mysql", databaseTestProviders.mysql], + ["mssql", databaseTestProviders.mssql], + ["mariadb", databaseTestProviders.mariadb], ])("/rows (%s)", (__, dsProvider) => { - const isInternal = !dsProvider - - const request = setup.getRequest() + const isInternal = dsProvider === undefined const config = setup.getConfig() + let table: Table - let tableId: string + let datasource: Datasource | undefined + + beforeAll(async () => { + await config.init() + if (dsProvider) { + datasource = await config.createDatasource({ + datasource: await dsProvider.datasource(), + }) + } + }) afterAll(async () => { if (dsProvider) { @@ -58,24 +61,17 @@ describe.each([ setup.afterAll() }) - beforeAll(async () => { - await config.init() - - if (dsProvider) { - await config.createDatasource({ - datasource: await dsProvider.datasource(), - }) - } - }) - - const generateTableConfig: () => SaveTableRequest = () => { - return { - name: uuid.v4(), + function saveTableRequest( + ...overrides: Partial[] + ): SaveTableRequest { + const req: SaveTableRequest = { + name: uuid.v4().substring(0, 16), type: "table", + sourceType: datasource + ? TableSourceType.EXTERNAL + : TableSourceType.INTERNAL, + sourceId: datasource ? datasource._id! : INTERNAL_TABLE_SOURCE_ID, primary: ["id"], - primaryDisplay: "name", - sourceType: TableSourceType.INTERNAL, - sourceId: INTERNAL_TABLE_SOURCE_ID, schema: { id: { type: FieldType.AUTO, @@ -85,22 +81,36 @@ describe.each([ presence: true, }, }, - name: { - type: FieldType.STRING, - name: "name", - constraints: { - type: "string", + }, + } + return merge(req, ...overrides) + } + + function defaultTable( + ...overrides: Partial[] + ): SaveTableRequest { + return saveTableRequest( + { + primaryDisplay: "name", + schema: { + name: { + type: FieldType.STRING, + name: "name", + constraints: { + type: "string", + }, }, - }, - description: { - type: FieldType.STRING, - name: "description", - constraints: { - type: "string", + description: { + type: FieldType.STRING, + name: "description", + constraints: { + type: "string", + }, }, }, }, - } + ...overrides + ) } beforeEach(async () => { @@ -127,53 +137,65 @@ describe.each([ } : undefined - async function createTable( - cfg: Omit, - opts?: { skipReassigning: boolean } - ) { - let table - if (dsProvider) { - table = await config.createExternalTable(cfg, opts) - } else { - table = await config.createTable(cfg, opts) - } - return table - } - beforeAll(async () => { - const tableConfig = generateTableConfig() - let table = await createTable(tableConfig) - tableId = table._id! + table = await config.api.table.save(defaultTable()) }) - describe("save, load, update", () => { - it("returns a success message when the row is created", async () => { + describe("create", () => { + it("creates a new row successfully", async () => { const rowUsage = await getRowUsage() - - const res = await request - .post(`/api/${tableId}/rows`) - .send(basicRow(tableId)) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - expect((res as any).res.statusMessage).toEqual( - `${config.table!.name} saved successfully` - ) - expect(res.body.name).toEqual("Test Contact") - expect(res.body._rev).toBeDefined() + const row = await config.api.row.save(table._id!, { + name: "Test Contact", + }) + expect(row.name).toEqual("Test Contact") + expect(row._rev).toBeDefined() await assertRowUsage(rowUsage + 1) }) - it("Increment row autoId per create row request", async () => { + it("fails to create a row for a table that does not exist", async () => { + const rowUsage = await getRowUsage() + await config.api.row.save("1234567", {}, { status: 404 }) + await assertRowUsage(rowUsage) + }) + + it("fails to create a row if required fields are missing", async () => { + const rowUsage = await getRowUsage() + const table = await config.api.table.save( + saveTableRequest({ + schema: { + required: { + type: FieldType.STRING, + name: "required", + constraints: { + type: "string", + presence: true, + }, + }, + }, + }) + ) + await config.api.row.save( + table._id!, + {}, + { + status: 500, + body: { + validationErrors: { + required: ["can't be blank"], + }, + }, + } + ) + await assertRowUsage(rowUsage) + }) + + it("increment row autoId per create row request", async () => { const rowUsage = await getRowUsage() - const tableConfig = generateTableConfig() - const newTable = await createTable( - { - ...tableConfig, + const newTable = await config.api.table.save( + saveTableRequest({ name: "TestTableAuto", schema: { - ...tableConfig.schema, "Row ID": { name: "Row ID", type: FieldType.NUMBER, @@ -190,81 +212,16 @@ describe.each([ }, }, }, - }, - { skipReassigning: true } + }) ) - const ids = [1, 2, 3] - - // Performing several create row requests should increment the autoID fields accordingly - const createRow = async (id: number) => { - const res = await config.api.row.save(newTable._id!, { - name: "row_" + id, - }) - expect(res.name).toEqual("row_" + id) - expect(res._rev).toBeDefined() - expect(res["Row ID"]).toEqual(id) + let previousId = 0 + for (let i = 0; i < 10; i++) { + const row = await config.api.row.save(newTable._id!, {}) + expect(row["Row ID"]).toBeGreaterThan(previousId) + previousId = row["Row ID"] } - - for (let i = 0; i < ids.length; i++) { - await createRow(ids[i]) - } - - await assertRowUsage(rowUsage + ids.length) - }) - - it("updates a row successfully", async () => { - const existing = await config.createRow() - const rowUsage = await getRowUsage() - - const res = await config.api.row.save(tableId, { - _id: existing._id, - _rev: existing._rev, - tableId, - name: "Updated Name", - }) - - expect(res.name).toEqual("Updated Name") - await assertRowUsage(rowUsage) - }) - - it("should load a row", async () => { - const existing = await config.createRow() - - const res = await config.api.row.get(tableId, existing._id!) - - expect(res).toEqual({ - ...existing, - ...defaultRowFields, - }) - }) - - it("should list all rows for given tableId", async () => { - const table = await createTable(generateTableConfig(), { - skipReassigning: true, - }) - const tableId = table._id! - const newRow = { - tableId, - name: "Second Contact", - description: "new", - } - const firstRow = await config.createRow({ tableId }) - await config.createRow(newRow) - - const res = await config.api.row.fetch(tableId) - - expect(res.length).toBe(2) - expect(res.find((r: Row) => r.name === newRow.name)).toBeDefined() - expect(res.find((r: Row) => r.name === firstRow.name)).toBeDefined() - }) - - it("load should return 404 when row does not exist", async () => { - await config.createRow() - - await config.api.row.get(tableId, "1234567", { - status: 404, - }) + await assertRowUsage(rowUsage + 10) }) isInternal && @@ -317,45 +274,47 @@ describe.each([ inclusion: ["Alpha", "Beta", "Gamma"], }, } - const table = await createTable({ - name: "TestTable2", - type: "table", - schema: { - name: str, - stringUndefined: str, - stringNull: str, - stringString: str, - numberEmptyString: number, - numberNull: number, - numberUndefined: number, - numberString: number, - numberNumber: number, - datetimeEmptyString: datetime, - datetimeNull: datetime, - datetimeUndefined: datetime, - datetimeString: datetime, - datetimeDate: datetime, - boolNull: bool, - boolEmpty: bool, - boolUndefined: bool, - boolString: bool, - boolBool: bool, - attachmentNull: attachment, - attachmentUndefined: attachment, - attachmentEmpty: attachment, - attachmentEmptyArrayStr: attachment, - arrayFieldEmptyArrayStr: arrayField, - arrayFieldArrayStrKnown: arrayField, - arrayFieldNull: arrayField, - arrayFieldUndefined: arrayField, - optsFieldEmptyStr: optsField, - optsFieldUndefined: optsField, - optsFieldNull: optsField, - optsFieldStrKnown: optsField, - }, - }) + const table = await config.api.table.save( + saveTableRequest({ + schema: { + name: str, + stringUndefined: str, + stringNull: str, + stringString: str, + numberEmptyString: number, + numberNull: number, + numberUndefined: number, + numberString: number, + numberNumber: number, + datetimeEmptyString: datetime, + datetimeNull: datetime, + datetimeUndefined: datetime, + datetimeString: datetime, + datetimeDate: datetime, + boolNull: bool, + boolEmpty: bool, + boolUndefined: bool, + boolString: bool, + boolBool: bool, + attachmentNull: attachment, + attachmentUndefined: attachment, + attachmentEmpty: attachment, + attachmentEmptyArrayStr: attachment, + arrayFieldEmptyArrayStr: arrayField, + arrayFieldArrayStrKnown: arrayField, + arrayFieldNull: arrayField, + arrayFieldUndefined: arrayField, + optsFieldEmptyStr: optsField, + optsFieldUndefined: optsField, + optsFieldNull: optsField, + optsFieldStrKnown: optsField, + }, + }) + ) - const row = { + const datetimeStr = "1984-04-20T00:00:00.000Z" + + const row = await config.api.row.save(table._id!, { name: "Test Row", stringUndefined: undefined, stringNull: null, @@ -368,8 +327,8 @@ describe.each([ datetimeEmptyString: "", datetimeNull: null, datetimeUndefined: undefined, - datetimeString: "1984-04-20T00:00:00.000Z", - datetimeDate: new Date("1984-04-20"), + datetimeString: datetimeStr, + datetimeDate: new Date(datetimeStr), boolNull: null, boolEmpty: "", boolUndefined: undefined, @@ -388,127 +347,137 @@ describe.each([ optsFieldUndefined: undefined, optsFieldNull: null, optsFieldStrKnown: "Alpha", - } + }) - const createdRow = await config.createRow(row) - const id = createdRow._id! + expect(row.stringUndefined).toBe(undefined) + expect(row.stringNull).toBe(null) + expect(row.stringString).toBe("i am a string") + expect(row.numberEmptyString).toBe(null) + expect(row.numberNull).toBe(null) + expect(row.numberUndefined).toBe(undefined) + expect(row.numberString).toBe(123) + expect(row.numberNumber).toBe(123) + expect(row.datetimeEmptyString).toBe(null) + expect(row.datetimeNull).toBe(null) + expect(row.datetimeUndefined).toBe(undefined) + expect(row.datetimeString).toBe(new Date(datetimeStr).toISOString()) + expect(row.datetimeDate).toBe(new Date(datetimeStr).toISOString()) + expect(row.boolNull).toBe(null) + expect(row.boolEmpty).toBe(null) + expect(row.boolUndefined).toBe(undefined) + expect(row.boolString).toBe(true) + expect(row.boolBool).toBe(true) + expect(row.attachmentNull).toEqual([]) + expect(row.attachmentUndefined).toBe(undefined) + expect(row.attachmentEmpty).toEqual([]) + expect(row.attachmentEmptyArrayStr).toEqual([]) + expect(row.arrayFieldEmptyArrayStr).toEqual([]) + expect(row.arrayFieldNull).toEqual([]) + expect(row.arrayFieldUndefined).toEqual(undefined) + expect(row.optsFieldEmptyStr).toEqual(null) + expect(row.optsFieldUndefined).toEqual(undefined) + expect(row.optsFieldNull).toEqual(null) + expect(row.arrayFieldArrayStrKnown).toEqual(["One"]) + expect(row.optsFieldStrKnown).toEqual("Alpha") + }) - const saved = await config.api.row.get(table._id!, id) - - expect(saved.stringUndefined).toBe(undefined) - expect(saved.stringNull).toBe(null) - expect(saved.stringString).toBe("i am a string") - expect(saved.numberEmptyString).toBe(null) - expect(saved.numberNull).toBe(null) - expect(saved.numberUndefined).toBe(undefined) - expect(saved.numberString).toBe(123) - expect(saved.numberNumber).toBe(123) - expect(saved.datetimeEmptyString).toBe(null) - expect(saved.datetimeNull).toBe(null) - expect(saved.datetimeUndefined).toBe(undefined) - expect(saved.datetimeString).toBe( - new Date(row.datetimeString).toISOString() + isInternal && + it("doesn't allow creating in user table", async () => { + const userTableId = InternalTable.USER_METADATA + const response = await config.api.row.save( + userTableId, + { + tableId: userTableId, + firstName: "Joe", + lastName: "Joe", + email: "joe@joe.com", + roles: {}, + }, + { status: 400 } ) - expect(saved.datetimeDate).toBe(row.datetimeDate.toISOString()) - expect(saved.boolNull).toBe(null) - expect(saved.boolEmpty).toBe(null) - expect(saved.boolUndefined).toBe(undefined) - expect(saved.boolString).toBe(true) - expect(saved.boolBool).toBe(true) - expect(saved.attachmentNull).toEqual([]) - expect(saved.attachmentUndefined).toBe(undefined) - expect(saved.attachmentEmpty).toEqual([]) - expect(saved.attachmentEmptyArrayStr).toEqual([]) - expect(saved.arrayFieldEmptyArrayStr).toEqual([]) - expect(saved.arrayFieldNull).toEqual([]) - expect(saved.arrayFieldUndefined).toEqual(undefined) - expect(saved.optsFieldEmptyStr).toEqual(null) - expect(saved.optsFieldUndefined).toEqual(undefined) - expect(saved.optsFieldNull).toEqual(null) - expect(saved.arrayFieldArrayStrKnown).toEqual(["One"]) - expect(saved.optsFieldStrKnown).toEqual("Alpha") + expect(response.message).toBe("Cannot create new user entry.") }) }) - describe("view save", () => { - it("views have extra data trimmed", async () => { - const table = await createTable({ - type: "table", - name: "orders", - primary: ["OrderID"], - schema: { - Country: { - type: FieldType.STRING, - name: "Country", - }, - OrderID: { - type: FieldType.NUMBER, - name: "OrderID", - }, - Story: { - type: FieldType.STRING, - name: "Story", - }, - }, - }) + describe("get", () => { + it("reads an existing row successfully", async () => { + const existing = await config.api.row.save(table._id!, {}) - const createViewResponse = await config.createView({ - name: uuid.v4(), - schema: { - Country: { - visible: true, - }, - OrderID: { - visible: true, - }, - }, - }) + const res = await config.api.row.get(table._id!, existing._id!) - const createRowResponse = await config.api.row.save( - createViewResponse.id, - { - OrderID: "1111", - Country: "Aussy", - Story: "aaaaa", - } - ) - - const row = await config.api.row.get(table._id!, createRowResponse._id!) - expect(row.Story).toBeUndefined() - expect(row).toEqual({ + expect(res).toEqual({ + ...existing, ...defaultRowFields, - OrderID: 1111, - Country: "Aussy", - _id: createRowResponse._id, - _rev: createRowResponse._rev, - tableId: table._id, }) }) + + it("returns 404 when row does not exist", async () => { + const table = await config.api.table.save(defaultTable()) + await config.api.row.save(table._id!, {}) + await config.api.row.get(table._id!, "1234567", { + status: 404, + }) + }) + }) + + describe("fetch", () => { + it("fetches all rows for given tableId", async () => { + const table = await config.api.table.save(defaultTable()) + const rows = await Promise.all([ + config.api.row.save(table._id!, {}), + config.api.row.save(table._id!, {}), + ]) + + const res = await config.api.row.fetch(table._id!) + expect(res.map(r => r._id)).toEqual( + expect.arrayContaining(rows.map(r => r._id)) + ) + }) + + it("returns 404 when table does not exist", async () => { + await config.api.row.fetch("1234567", { status: 404 }) + }) + }) + + describe("update", () => { + it("updates an existing row successfully", async () => { + const existing = await config.api.row.save(table._id!, {}) + const rowUsage = await getRowUsage() + + const res = await config.api.row.save(table._id!, { + _id: existing._id, + _rev: existing._rev, + name: "Updated Name", + }) + + expect(res.name).toEqual("Updated Name") + await assertRowUsage(rowUsage) + }) }) describe("patch", () => { let otherTable: Table beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) - const otherTableConfig = generateTableConfig() - // need a short name of table here - for relationship tests - otherTableConfig.name = "a" - otherTableConfig.schema.relationship = { - name: "relationship", - relationshipType: RelationshipType.ONE_TO_MANY, - type: FieldType.LINK, - tableId: table._id!, - fieldName: "relationship", - } - otherTable = await createTable(otherTableConfig) - // need to set the config back to the original table - config.table = table + table = await config.api.table.save(defaultTable()) + otherTable = await config.api.table.save( + defaultTable({ + name: "a", + schema: { + relationship: { + name: "relationship", + relationshipType: RelationshipType.ONE_TO_MANY, + type: FieldType.LINK, + tableId: table._id!, + fieldName: "relationship", + }, + }, + }) + ) }) it("should update only the fields that are supplied", async () => { - const existing = await config.createRow() + const existing = await config.api.row.save(table._id!, {}) const rowUsage = await getRowUsage() @@ -530,7 +499,7 @@ describe.each([ }) it("should throw an error when given improper types", async () => { - const existing = await config.createRow() + const existing = await config.api.row.save(table._id!, {}) const rowUsage = await getRowUsage() await config.api.row.patch( @@ -622,12 +591,11 @@ describe.each([ describe("destroy", () => { beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) + table = await config.api.table.save(defaultTable()) }) it("should be able to delete a row", async () => { - const createdRow = await config.createRow() + const createdRow = await config.api.row.save(table._id!, {}) const rowUsage = await getRowUsage() const res = await config.api.row.bulkDelete(table._id!, { @@ -636,12 +604,22 @@ describe.each([ expect(res[0]._id).toEqual(createdRow._id) await assertRowUsage(rowUsage - 1) }) + + it("should be able to bulk delete rows, including a row that doesn't exist", async () => { + const createdRow = await config.api.row.save(table._id!, {}) + + const res = await config.api.row.bulkDelete(table._id!, { + rows: [createdRow, { _id: "9999999" }], + }) + + expect(res[0]._id).toEqual(createdRow._id) + expect(res.length).toEqual(1) + }) }) describe("validate", () => { beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) + table = await config.api.table.save(defaultTable()) }) it("should return no errors on valid row", async () => { @@ -673,13 +651,12 @@ describe.each([ describe("bulkDelete", () => { beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) + table = await config.api.table.save(defaultTable()) }) it("should be able to delete a bulk set of rows", async () => { - const row1 = await config.createRow() - const row2 = await config.createRow() + const row1 = await config.api.row.save(table._id!, {}) + const row2 = await config.api.row.save(table._id!, {}) const rowUsage = await getRowUsage() const res = await config.api.row.bulkDelete(table._id!, { @@ -693,9 +670,9 @@ describe.each([ it("should be able to delete a variety of row set types", async () => { const [row1, row2, row3] = await Promise.all([ - config.createRow(), - config.createRow(), - config.createRow(), + config.api.row.save(table._id!, {}), + config.api.row.save(table._id!, {}), + config.api.row.save(table._id!, {}), ]) const rowUsage = await getRowUsage() @@ -709,7 +686,7 @@ describe.each([ }) it("should accept a valid row object and delete the row", async () => { - const row1 = await config.createRow() + const row1 = await config.api.row.save(table._id!, {}) const rowUsage = await getRowUsage() const res = await config.api.row.delete(table._id!, row1 as DeleteRow) @@ -747,91 +724,36 @@ describe.each([ }) }) - // Legacy views are not available for external - isInternal && - describe("fetchView", () => { - beforeEach(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) - }) - - it("should be able to fetch tables contents via 'view'", async () => { - const row = await config.createRow() - const rowUsage = await getRowUsage() - - const rows = await config.api.legacyView.get(table._id!) - expect(rows.length).toEqual(1) - expect(rows[0]._id).toEqual(row._id) - await assertRowUsage(rowUsage) - }) - - it("should throw an error if view doesn't exist", async () => { - const rowUsage = await getRowUsage() - - await config.api.legacyView.get("derp", { status: 404 }) - - await assertRowUsage(rowUsage) - }) - - it("should be able to run on a view", async () => { - const view = await config.createLegacyView({ - tableId: table._id!, - name: "ViewTest", - filters: [], - schema: {}, - }) - const row = await config.createRow() - const rowUsage = await getRowUsage() - - const rows = await config.api.legacyView.get(view.name) - expect(rows.length).toEqual(1) - expect(rows[0]._id).toEqual(row._id) - - await assertRowUsage(rowUsage) - }) - }) - - describe("fetchEnrichedRows", () => { + describe("enrich", () => { beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) + table = await config.api.table.save(defaultTable()) }) it("should allow enriching some linked rows", async () => { const { linkedTable, firstRow, secondRow } = await tenancy.doInTenant( config.getTenantId(), async () => { - const linkedTable = await config.createLinkedTable( - RelationshipType.ONE_TO_MANY, - ["link"], - { - // Making sure that the combined table name + column name is within postgres limits - name: uuid.v4().replace(/-/g, "").substring(0, 16), - type: "table", - primary: ["id"], - primaryDisplay: "id", + const linkedTable = await config.api.table.save( + defaultTable({ schema: { - id: { - type: FieldType.AUTO, - name: "id", - autocolumn: true, - constraints: { - presence: true, - }, + link: { + name: "link", + fieldName: "link", + type: FieldType.LINK, + relationshipType: RelationshipType.ONE_TO_MANY, + tableId: table._id!, }, }, - } + }) ) - const firstRow = await config.createRow({ + const firstRow = await config.api.row.save(table._id!, { name: "Test Contact", description: "original description", - tableId: table._id, }) - const secondRow = await config.createRow({ + const secondRow = await config.api.row.save(linkedTable._id!, { name: "Test 2", description: "og desc", link: [{ _id: firstRow._id }], - tableId: linkedTable._id, }) return { linkedTable, firstRow, secondRow } } @@ -864,15 +786,20 @@ describe.each([ isInternal && describe("attachments", () => { - beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) - }) - it("should allow enriching attachment rows", async () => { - const table = await config.createAttachmentTable() - const attachmentId = `${structures.uuid()}.csv` - const row = await config.createRow({ + const table = await config.api.table.save( + defaultTable({ + schema: { + attachment: { + type: FieldType.ATTACHMENT, + name: "attachment", + constraints: { type: "array", presence: false }, + }, + }, + }) + ) + const attachmentId = `${uuid.v4()}.csv` + const row = await config.api.row.save(table._id!, { name: "test", description: "test", attachment: [ @@ -893,14 +820,13 @@ describe.each([ }) }) - describe("exportData", () => { + describe("exportRows", () => { beforeAll(async () => { - const tableConfig = generateTableConfig() - table = await createTable(tableConfig) + table = await config.api.table.save(defaultTable()) }) it("should allow exporting all columns", async () => { - const existing = await config.createRow() + const existing = await config.api.row.save(table._id!, {}) const res = await config.api.row.exportRows(table._id!, { rows: [existing._id!], }) @@ -918,7 +844,7 @@ describe.each([ }) it("should allow exporting only certain columns", async () => { - const existing = await config.createRow() + const existing = await config.api.row.save(table._id!, {}) const res = await config.api.row.exportRows(table._id!, { rows: [existing._id!], columns: ["_id"], @@ -931,659 +857,49 @@ describe.each([ expect(Object.keys(row).length).toEqual(1) expect(row._id).toEqual(existing._id) }) - }) - describe("view 2.0", () => { - async function userTable(): Promise
{ - return { - name: `users_${uuid.v4()}`, - sourceId: INTERNAL_TABLE_SOURCE_ID, - sourceType: TableSourceType.INTERNAL, - type: "table", - primary: ["id"], - schema: { - id: { - type: FieldType.AUTO, - name: "id", - autocolumn: true, - constraints: { - presence: true, - }, - }, - name: { - type: FieldType.STRING, - name: "name", - }, - surname: { - type: FieldType.STRING, - name: "surname", - }, - age: { - type: FieldType.NUMBER, - name: "age", - }, - address: { - type: FieldType.STRING, - name: "address", - }, - jobTitle: { - type: FieldType.STRING, - name: "jobTitle", - }, + it("should handle single quotes in row filtering", async () => { + const existing = await config.api.row.save(table._id!, {}) + const res = await config.api.row.exportRows(table._id!, { + rows: [`['${existing._id!}']`], + }) + const results = JSON.parse(res) + expect(results.length).toEqual(1) + const row = results[0] + expect(row._id).toEqual(existing._id) + }) + + it("should return an error on composite keys", async () => { + const existing = await config.api.row.save(table._id!, {}) + await config.api.row.exportRows( + table._id!, + { + rows: [`['${existing._id!}']`, "['d001', '10111']"], }, - } - } - - const randomRowData = () => ({ - name: generator.first(), - surname: generator.last(), - age: generator.age(), - address: generator.address(), - jobTitle: generator.word(), - }) - - describe("create", () => { - it("should persist a new row with only the provided view fields", async () => { - const table = await createTable(await userTable()) - const view = await config.createView({ - schema: { - name: { visible: true }, - surname: { visible: true }, - address: { visible: true }, - }, - }) - - const data = randomRowData() - const newRow = await config.api.row.save(view.id, { - tableId: table!._id, - _viewId: view.id, - ...data, - }) - - const row = await config.api.row.get(table._id!, newRow._id!) - expect(row).toEqual({ - name: data.name, - surname: data.surname, - address: data.address, - tableId: table!._id, - _id: newRow._id, - _rev: newRow._rev, - id: newRow.id, - ...defaultRowFields, - }) - expect(row._viewId).toBeUndefined() - expect(row.age).toBeUndefined() - expect(row.jobTitle).toBeUndefined() - }) - }) - - describe("patch", () => { - it("should update only the view fields for a row", async () => { - const table = await createTable(await userTable()) - const tableId = table._id! - const view = await config.createView({ - schema: { - name: { visible: true }, - address: { visible: true }, - }, - }) - - const newRow = await config.api.row.save(view.id, { - tableId, - _viewId: view.id, - ...randomRowData(), - }) - const newData = randomRowData() - await config.api.row.patch(view.id, { - tableId, - _viewId: view.id, - _id: newRow._id!, - _rev: newRow._rev!, - ...newData, - }) - - const row = await config.api.row.get(tableId, newRow._id!) - expect(row).toEqual({ - ...newRow, - name: newData.name, - address: newData.address, - _id: newRow._id, - _rev: expect.any(String), - id: newRow.id, - ...defaultRowFields, - }) - expect(row._viewId).toBeUndefined() - expect(row.age).toBeUndefined() - expect(row.jobTitle).toBeUndefined() - }) - }) - - describe("destroy", () => { - it("should be able to delete a row", async () => { - const table = await createTable(await userTable()) - const tableId = table._id! - const view = await config.createView({ - schema: { - name: { visible: true }, - address: { visible: true }, - }, - }) - - const createdRow = await config.createRow() - const rowUsage = await getRowUsage() - - await config.api.row.bulkDelete(view.id, { rows: [createdRow] }) - - await assertRowUsage(rowUsage - 1) - - await config.api.row.get(tableId, createdRow._id!, { - status: 404, - }) - }) - - it("should be able to delete multiple rows", async () => { - const table = await createTable(await userTable()) - const tableId = table._id! - const view = await config.createView({ - schema: { - name: { visible: true }, - address: { visible: true }, - }, - }) - - const rows = await Promise.all([ - config.createRow(), - config.createRow(), - config.createRow(), - ]) - const rowUsage = await getRowUsage() - - await config.api.row.bulkDelete(view.id, { rows: [rows[0], rows[2]] }) - - await assertRowUsage(rowUsage - 2) - - await config.api.row.get(tableId, rows[0]._id!, { - status: 404, - }) - await config.api.row.get(tableId, rows[2]._id!, { - status: 404, - }) - await config.api.row.get(tableId, rows[1]._id!, { status: 200 }) - }) - }) - - describe("view search", () => { - const viewSchema = { age: { visible: true }, name: { visible: true } } - async function userTable(): Promise
{ - return { - name: `users_${uuid.v4()}`, - sourceId: INTERNAL_TABLE_SOURCE_ID, - sourceType: TableSourceType.INTERNAL, - type: "table", - primary: ["id"], - schema: { - id: { - type: FieldType.AUTO, - name: "id", - autocolumn: true, - constraints: { - presence: true, - }, - }, - name: { - type: FieldType.STRING, - name: "name", - constraints: { type: "string" }, - }, - age: { - type: FieldType.NUMBER, - name: "age", - constraints: {}, - }, + { + status: 400, + body: { + message: "Export data does not support composite keys.", }, } - } + ) + }) - it("returns empty rows from view when no schema is passed", async () => { - const table = await createTable(await userTable()) - const rows = await Promise.all( - Array.from({ length: 10 }, () => - config.api.row.save(table._id!, { tableId: table._id }) - ) - ) - - const createViewResponse = await config.createView() - const response = await config.api.viewV2.search(createViewResponse.id) - - expect(response.rows).toHaveLength(10) - expect(response).toEqual({ - rows: expect.arrayContaining( - rows.map(r => ({ - _viewId: createViewResponse.id, - tableId: table._id, - _id: r._id, - _rev: r._rev, - ...defaultRowFields, - })) - ), - ...(isInternal - ? {} - : { - hasNextPage: false, - bookmark: null, - }), - }) - }) - - it("searching respects the view filters", async () => { - const table = await createTable(await userTable()) - - await Promise.all( - Array.from({ length: 10 }, () => - config.api.row.save(table._id!, { - tableId: table._id, - name: generator.name(), - age: generator.integer({ min: 10, max: 30 }), - }) - ) - ) - - const expectedRows = await Promise.all( - Array.from({ length: 5 }, () => - config.api.row.save(table._id!, { - tableId: table._id, - name: generator.name(), - age: 40, - }) - ) - ) - - const createViewResponse = await config.createView({ - query: [ - { operator: SearchQueryOperators.EQUAL, field: "age", value: 40 }, - ], - schema: viewSchema, - }) - - const response = await config.api.viewV2.search(createViewResponse.id) - - expect(response.rows).toHaveLength(5) - expect(response).toEqual({ - rows: expect.arrayContaining( - expectedRows.map(r => ({ - _viewId: createViewResponse.id, - tableId: table._id, - name: r.name, - age: r.age, - _id: r._id, - _rev: r._rev, - ...defaultRowFields, - })) - ), - ...(isInternal - ? {} - : { - hasNextPage: false, - bookmark: null, - }), - }) - }) - - const sortTestOptions: [ - { - field: string - order?: SortOrder - type?: SortType - }, - string[] - ][] = [ - [ - { - field: "name", - order: SortOrder.ASCENDING, - type: SortType.STRING, - }, - ["Alice", "Bob", "Charly", "Danny"], - ], - [ - { - field: "name", - }, - ["Alice", "Bob", "Charly", "Danny"], - ], - [ - { - field: "name", - order: SortOrder.DESCENDING, - }, - ["Danny", "Charly", "Bob", "Alice"], - ], - [ - { - field: "name", - order: SortOrder.DESCENDING, - type: SortType.STRING, - }, - ["Danny", "Charly", "Bob", "Alice"], - ], - [ - { - field: "age", - order: SortOrder.ASCENDING, - type: SortType.number, - }, - ["Danny", "Alice", "Charly", "Bob"], - ], - [ - { - field: "age", - order: SortOrder.ASCENDING, - }, - ["Danny", "Alice", "Charly", "Bob"], - ], - [ - { - field: "age", - order: SortOrder.DESCENDING, - }, - ["Bob", "Charly", "Alice", "Danny"], - ], - [ - { - field: "age", - order: SortOrder.DESCENDING, - type: SortType.number, - }, - ["Bob", "Charly", "Alice", "Danny"], - ], - ] - - describe("sorting", () => { - beforeAll(async () => { - const table = await createTable(await userTable()) - const users = [ - { name: "Alice", age: 25 }, - { name: "Bob", age: 30 }, - { name: "Charly", age: 27 }, - { name: "Danny", age: 15 }, - ] - await Promise.all( - users.map(u => - config.api.row.save(table._id!, { - tableId: table._id, - ...u, - }) - ) - ) - }) - - it.each(sortTestOptions)( - "allow sorting (%s)", - async (sortParams, expected) => { - const createViewResponse = await config.createView({ - sort: sortParams, - schema: viewSchema, - }) - - const response = await config.api.viewV2.search( - createViewResponse.id - ) - - expect(response.rows).toHaveLength(4) - expect(response.rows).toEqual( - expected.map(name => expect.objectContaining({ name })) - ) - } - ) - - it.each(sortTestOptions)( - "allow override the default view sorting (%s)", - async (sortParams, expected) => { - const createViewResponse = await config.createView({ - sort: { - field: "name", - order: SortOrder.ASCENDING, - type: SortType.STRING, - }, - schema: viewSchema, - }) - - const response = await config.api.viewV2.search( - createViewResponse.id, - { - sort: sortParams.field, - sortOrder: sortParams.order, - sortType: sortParams.type, - query: {}, - } - ) - - expect(response.rows).toHaveLength(4) - expect(response.rows).toEqual( - expected.map(name => expect.objectContaining({ name })) - ) - } - ) - }) - - it("when schema is defined, defined columns and row attributes are returned", async () => { - const table = await createTable(await userTable()) - const rows = await Promise.all( - Array.from({ length: 10 }, () => - config.api.row.save(table._id!, { - tableId: table._id, - name: generator.name(), - age: generator.age(), - }) - ) - ) - - const view = await config.createView({ - schema: { name: { visible: true } }, - }) - const response = await config.api.viewV2.search(view.id) - - expect(response.rows).toHaveLength(10) - expect(response.rows).toEqual( - expect.arrayContaining( - rows.map(r => ({ - ...(isInternal - ? expectAnyInternalColsAttributes - : expectAnyExternalColsAttributes), - _viewId: view.id, - name: r.name, - })) - ) - ) - }) - - it("views without data can be returned", async () => { - const table = await createTable(await userTable()) - - const createViewResponse = await config.createView() - const response = await config.api.viewV2.search(createViewResponse.id) - - expect(response.rows).toHaveLength(0) - }) - - it("respects the limit parameter", async () => { - await createTable(await userTable()) - await Promise.all(Array.from({ length: 10 }, () => config.createRow())) - - const limit = generator.integer({ min: 1, max: 8 }) - - const createViewResponse = await config.createView() - const response = await config.api.viewV2.search(createViewResponse.id, { - limit, - query: {}, - }) - - expect(response.rows).toHaveLength(limit) - }) - - it("can handle pagination", async () => { - await createTable(await userTable()) - await Promise.all(Array.from({ length: 10 }, () => config.createRow())) - - const createViewResponse = await config.createView() - const allRows = (await config.api.viewV2.search(createViewResponse.id)) - .rows - - const firstPageResponse = await config.api.viewV2.search( - createViewResponse.id, - { - paginate: true, - limit: 4, - query: {}, - } - ) - expect(firstPageResponse).toEqual({ - rows: expect.arrayContaining(allRows.slice(0, 4)), - totalRows: isInternal ? 10 : undefined, - hasNextPage: true, - bookmark: expect.anything(), - }) - - const secondPageResponse = await config.api.viewV2.search( - createViewResponse.id, - { - paginate: true, - limit: 4, - bookmark: firstPageResponse.bookmark, - - query: {}, - } - ) - expect(secondPageResponse).toEqual({ - rows: expect.arrayContaining(allRows.slice(4, 8)), - totalRows: isInternal ? 10 : undefined, - hasNextPage: true, - bookmark: expect.anything(), - }) - - const lastPageResponse = await config.api.viewV2.search( - createViewResponse.id, - { - paginate: true, - limit: 4, - bookmark: secondPageResponse.bookmark, - query: {}, - } - ) - expect(lastPageResponse).toEqual({ - rows: expect.arrayContaining(allRows.slice(8)), - totalRows: isInternal ? 10 : undefined, - hasNextPage: false, - bookmark: expect.anything(), - }) - }) - - isInternal && - it("doesn't allow creating in user table", async () => { - const userTableId = InternalTable.USER_METADATA - const response = await config.api.row.save( - userTableId, - { - tableId: userTableId, - firstName: "Joe", - lastName: "Joe", - email: "joe@joe.com", - roles: {}, - }, - { status: 400 } - ) - expect(response.message).toBe("Cannot create new user entry.") - }) - - describe("permissions", () => { - let viewId: string - let tableId: string - - beforeAll(async () => { - await createTable(await userTable()) - await Promise.all( - Array.from({ length: 10 }, () => config.createRow()) - ) - - const createViewResponse = await config.createView() - - tableId = table._id! - viewId = createViewResponse.id - }) - - beforeEach(() => { - mocks.licenses.useViewPermissions() - }) - - it("does not allow public users to fetch by default", async () => { - await config.publish() - await config.api.viewV2.publicSearch(viewId, undefined, { - status: 403, - }) - }) - - it("allow public users to fetch when permissions are explicit", async () => { - await config.api.permission.add({ - roleId: roles.BUILTIN_ROLE_IDS.PUBLIC, - level: PermissionLevel.READ, - resourceId: viewId, - }) - await config.publish() - - const response = await config.api.viewV2.publicSearch(viewId) - - expect(response.rows).toHaveLength(10) - }) - - it("allow public users to fetch when permissions are inherited", async () => { - await config.api.permission.add({ - roleId: roles.BUILTIN_ROLE_IDS.PUBLIC, - level: PermissionLevel.READ, - resourceId: tableId, - }) - await config.publish() - - const response = await config.api.viewV2.publicSearch(viewId) - - expect(response.rows).toHaveLength(10) - }) - - it("respects inherited permissions, not allowing not public views from public tables", async () => { - await config.api.permission.add({ - roleId: roles.BUILTIN_ROLE_IDS.PUBLIC, - level: PermissionLevel.READ, - resourceId: tableId, - }) - await config.api.permission.add({ - roleId: roles.BUILTIN_ROLE_IDS.POWER, - level: PermissionLevel.READ, - resourceId: viewId, - }) - await config.publish() - - await config.api.viewV2.publicSearch(viewId, undefined, { - status: 403, - }) - }) - }) + it("should return an error if no table is found", async () => { + const existing = await config.api.row.save(table._id!, {}) + await config.api.row.exportRows( + "1234567", + { rows: [existing._id!] }, + { status: 404 } + ) }) }) let o2mTable: Table let m2mTable: Table beforeAll(async () => { - o2mTable = await createTable( - { ...generateTableConfig(), name: "o2m" }, - { - skipReassigning: true, - } - ) - m2mTable = await createTable( - { ...generateTableConfig(), name: "m2m" }, - { - skipReassigning: true, - } - ) + o2mTable = await config.api.table.save(defaultTable({ name: "o2m" })) + m2mTable = await config.api.table.save(defaultTable({ name: "m2m" })) }) describe.each([ @@ -1645,21 +961,9 @@ describe.each([ let m2mData: Row[] beforeAll(async () => { - const tableConfig = generateTableConfig() - - if (config.datasource) { - tableConfig.sourceId = config.datasource._id! - if (config.datasource.plus) { - tableConfig.sourceType = TableSourceType.EXTERNAL - } - } - const table = await config.api.table.save({ - ...tableConfig, - schema: { - ...tableConfig.schema, - ...relSchema(), - }, - }) + const table = await config.api.table.save( + defaultTable({ schema: relSchema() }) + ) tableId = table._id! o2mData = [ @@ -1678,37 +982,33 @@ describe.each([ }) it("can save a row when relationship fields are empty", async () => { - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), - } - const row = await config.api.row.save(tableId, rowData) + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", + }) expect(row).toEqual({ - name: rowData.name, - description: rowData.description, - tableId, _id: expect.any(String), _rev: expect.any(String), id: isInternal ? undefined : expect.any(Number), type: isInternal ? "row" : undefined, + name: "foo", + description: "bar", + tableId, }) }) it("can save a row with a single relationship field", async () => { const user = _.sample(o2mData)! - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", user: [user], - } - const row = await config.api.row.save(tableId, rowData) + }) expect(row).toEqual({ - name: rowData.name, - description: rowData.description, + name: "foo", + description: "bar", tableId, user: [user].map(u => resultMapper(u)), _id: expect.any(String), @@ -1721,17 +1021,15 @@ describe.each([ it("can save a row with a multiple relationship field", async () => { const selectedUsers = _.sampleSize(m2mData, 2) - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", users: selectedUsers, - } - const row = await config.api.row.save(tableId, rowData) + }) expect(row).toEqual({ - name: rowData.name, - description: rowData.description, + name: "foo", + description: "bar", tableId, users: expect.arrayContaining(selectedUsers.map(u => resultMapper(u))), _id: expect.any(String), @@ -1742,17 +1040,15 @@ describe.each([ }) it("can retrieve rows with no populated relationships", async () => { - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), - } - const row = await config.api.row.save(tableId, rowData) + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", + }) const retrieved = await config.api.row.get(tableId, row._id!) expect(retrieved).toEqual({ - name: rowData.name, - description: rowData.description, + name: "foo", + description: "bar", tableId, user: undefined, users: undefined, @@ -1767,19 +1063,17 @@ describe.each([ const user1 = _.sample(o2mData)! const [user2, user3] = _.sampleSize(m2mData, 2) - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", users: [user2, user3], user: [user1], - } - const row = await config.api.row.save(tableId, rowData) + }) const retrieved = await config.api.row.get(tableId, row._id!) expect(retrieved).toEqual({ - name: rowData.name, - description: rowData.description, + name: "foo", + description: "bar", tableId, user: expect.arrayContaining([user1].map(u => resultMapper(u))), users: expect.arrayContaining([user2, user3].map(u => resultMapper(u))), @@ -1795,13 +1089,11 @@ describe.each([ const user = _.sample(o2mData)! const [users1, users2, users3] = _.sampleSize(m2mData, 3) - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", users: [users1, users2], - } - const row = await config.api.row.save(tableId, rowData) + }) const updatedRow = await config.api.row.save(tableId, { ...row, @@ -1809,8 +1101,8 @@ describe.each([ users: [users3, users1], }) expect(updatedRow).toEqual({ - name: rowData.name, - description: rowData.description, + name: "foo", + description: "bar", tableId, user: expect.arrayContaining([user].map(u => resultMapper(u))), users: expect.arrayContaining( @@ -1826,14 +1118,11 @@ describe.each([ it("can wipe an existing populated relationships in row", async () => { const [user1, user2] = _.sampleSize(m2mData, 2) - - const rowData = { - ...basicRow(tableId), - name: generator.name(), - description: generator.name(), + const row = await config.api.row.save(tableId, { + name: "foo", + description: "bar", users: [user1, user2], - } - const row = await config.api.row.save(tableId, rowData) + }) const updatedRow = await config.api.row.save(tableId, { ...row, @@ -1841,8 +1130,8 @@ describe.each([ users: null, }) expect(updatedRow).toEqual({ - name: rowData.name, - description: rowData.description, + name: "foo", + description: "bar", tableId, _id: row._id, _rev: expect.any(String), @@ -1855,28 +1144,19 @@ describe.each([ const [user1] = _.sampleSize(o2mData, 1) const [users1, users2, users3] = _.sampleSize(m2mData, 3) - const rows: { - name: string - description: string - user?: Row[] - users?: Row[] - tableId: string - }[] = [ + const rows = [ { - ...basicRow(tableId), name: generator.name(), description: generator.name(), users: [users1, users2], }, { - ...basicRow(tableId), name: generator.name(), description: generator.name(), user: [user1], users: [users1, users3], }, { - ...basicRow(tableId), name: generator.name(), description: generator.name(), users: [users3], @@ -1914,28 +1194,19 @@ describe.each([ const [user1] = _.sampleSize(o2mData, 1) const [users1, users2, users3] = _.sampleSize(m2mData, 3) - const rows: { - name: string - description: string - user?: Row[] - users?: Row[] - tableId: string - }[] = [ + const rows = [ { - ...basicRow(tableId), name: generator.name(), description: generator.name(), users: [users1, users2], }, { - ...basicRow(tableId), name: generator.name(), description: generator.name(), user: [user1], users: [users1, users3], }, { - ...basicRow(tableId), name: generator.name(), description: generator.name(), users: [users3], @@ -1977,20 +1248,23 @@ describe.each([ }) describe("Formula fields", () => { - let relationshipTable: Table, tableId: string, relatedRow: Row + let table: Table + let otherTable: Table + let relatedRow: Row beforeAll(async () => { - const otherTableId = config.table!._id! - const cfg = generateTableConfig() - relationshipTable = await config.createLinkedTable( - RelationshipType.ONE_TO_MANY, - ["links"], - { - ...cfg, - // needs to be a short name + otherTable = await config.api.table.save(defaultTable()) + table = await config.api.table.save( + saveTableRequest({ name: "b", schema: { - ...cfg.schema, + links: { + name: "links", + fieldName: "links", + type: FieldType.LINK, + tableId: otherTable._id!, + relationshipType: RelationshipType.ONE_TO_MANY, + }, formula: { name: "formula", type: FieldType.FORMULA, @@ -1998,25 +1272,23 @@ describe.each([ formulaType: FormulaType.DYNAMIC, }, }, - } + }) ) - tableId = relationshipTable._id! - - relatedRow = await config.api.row.save(otherTableId, { + relatedRow = await config.api.row.save(otherTable._id!, { name: generator.word(), description: generator.paragraph(), }) - await config.api.row.save(tableId, { + await config.api.row.save(table._id!, { name: generator.word(), description: generator.paragraph(), - tableId, + tableId: table._id!, links: [relatedRow._id], }) }) it("should be able to search for rows containing formulas", async () => { - const { rows } = await config.api.row.search(tableId) + const { rows } = await config.api.row.search(table._id!) expect(rows.length).toBe(1) expect(rows[0].links.length).toBe(1) const row = rows[0] @@ -2037,22 +1309,22 @@ describe.each([ ` ).toString("base64") - const table = await config.createTable({ - name: "table", - type: "table", - schema: { - text: { - name: "text", - type: FieldType.STRING, + const table = await config.api.table.save( + saveTableRequest({ + schema: { + text: { + name: "text", + type: FieldType.STRING, + }, + formula: { + name: "formula", + type: FieldType.FORMULA, + formula: `{{ js "${js}"}}`, + formulaType: FormulaType.DYNAMIC, + }, }, - formula: { - name: "formula", - type: FieldType.FORMULA, - formula: `{{ js "${js}"}}`, - formulaType: FormulaType.DYNAMIC, - }, - }, - }) + }) + ) await config.api.row.save(table._id!, { text: "foo" }) const { rows } = await config.api.row.search(table._id!) @@ -2080,22 +1352,23 @@ describe.each([ ` ).toString("base64") - const table = await config.createTable({ - name: "table", - type: "table", - schema: { - text: { - name: "text", - type: FieldType.STRING, + const table = await config.api.table.save( + saveTableRequest({ + name: "table", + schema: { + text: { + name: "text", + type: FieldType.STRING, + }, + formula: { + name: "formula", + type: FieldType.FORMULA, + formula: `{{ js "${js}"}}`, + formulaType: FormulaType.DYNAMIC, + }, }, - formula: { - name: "formula", - type: FieldType.FORMULA, - formula: `{{ js "${js}"}}`, - formulaType: FormulaType.DYNAMIC, - }, - }, - }) + }) + ) for (let i = 0; i < 10; i++) { await config.api.row.save(table._id!, { text: "foo" }) @@ -2133,22 +1406,22 @@ describe.each([ it("should not carry over context between formulas", async () => { const js = Buffer.from(`return $("[text]");`).toString("base64") - const table = await config.createTable({ - name: "table", - type: "table", - schema: { - text: { - name: "text", - type: FieldType.STRING, + const table = await config.api.table.save( + saveTableRequest({ + schema: { + text: { + name: "text", + type: FieldType.STRING, + }, + formula: { + name: "formula", + type: FieldType.FORMULA, + formula: `{{ js "${js}"}}`, + formulaType: FormulaType.DYNAMIC, + }, }, - formula: { - name: "formula", - type: FieldType.FORMULA, - formula: `{{ js "${js}"}}`, - formulaType: FormulaType.DYNAMIC, - }, - }, - }) + }) + ) for (let i = 0; i < 10; i++) { await config.api.row.save(table._id!, { text: `foo${i}` }) diff --git a/packages/server/src/api/routes/tests/table.spec.ts b/packages/server/src/api/routes/tests/table.spec.ts index 77704a0408..1038808fe1 100644 --- a/packages/server/src/api/routes/tests/table.spec.ts +++ b/packages/server/src/api/routes/tests/table.spec.ts @@ -20,7 +20,7 @@ import sdk from "../../../sdk" import * as uuid from "uuid" import tk from "timekeeper" -import { mocks } from "@budibase/backend-core/tests" +import { generator, mocks } from "@budibase/backend-core/tests" import { TableToBuild } from "../../../tests/utilities/TestConfiguration" tk.freeze(mocks.date.MOCK_DATE) @@ -64,8 +64,8 @@ describe("/tables", () => { "Table TestTable saved successfully." ) expect(res.body.name).toEqual("TestTable") - expect(events.table.created).toBeCalledTimes(1) - expect(events.table.created).toBeCalledWith(res.body) + expect(events.table.created).toHaveBeenCalledTimes(1) + expect(events.table.created).toHaveBeenCalledWith(res.body) }) it("creates all the passed fields", async () => { @@ -135,12 +135,12 @@ describe("/tables", () => { const res = await createTable(table) - expect(events.table.created).toBeCalledTimes(1) - expect(events.table.created).toBeCalledWith(res.body) - expect(events.table.imported).toBeCalledTimes(1) - expect(events.table.imported).toBeCalledWith(res.body) - expect(events.rows.imported).toBeCalledTimes(1) - expect(events.rows.imported).toBeCalledWith(res.body, 1) + expect(events.table.created).toHaveBeenCalledTimes(1) + expect(events.table.created).toHaveBeenCalledWith(res.body) + expect(events.table.imported).toHaveBeenCalledTimes(1) + expect(events.table.imported).toHaveBeenCalledWith(res.body) + expect(events.rows.imported).toHaveBeenCalledTimes(1) + expect(events.rows.imported).toHaveBeenCalledWith(res.body, 1) }) it("should apply authorization to endpoint", async () => { @@ -164,8 +164,8 @@ describe("/tables", () => { .expect("Content-Type", /json/) .expect(200) - expect(events.table.updated).toBeCalledTimes(1) - expect(events.table.updated).toBeCalledWith(res.body) + expect(events.table.updated).toHaveBeenCalledTimes(1) + expect(events.table.updated).toHaveBeenCalledWith(res.body) }) it("updates all the row fields for a table when a schema key is renamed", async () => { @@ -335,8 +335,8 @@ describe("/tables", () => { .expect(200) expect(events.table.created).not.toHaveBeenCalled() - expect(events.rows.imported).toBeCalledTimes(1) - expect(events.rows.imported).toBeCalledWith( + expect(events.rows.imported).toHaveBeenCalledTimes(1) + expect(events.rows.imported).toHaveBeenCalledWith( expect.objectContaining({ name: "TestTable", _id: table._id, @@ -417,8 +417,8 @@ describe("/tables", () => { it("should fetch views", async () => { const tableId = config.table!._id! const views = [ - await config.api.viewV2.create({ tableId }), - await config.api.viewV2.create({ tableId }), + await config.api.viewV2.create({ tableId, name: generator.guid() }), + await config.api.viewV2.create({ tableId, name: generator.guid() }), ] const res = await request @@ -455,7 +455,7 @@ describe("/tables", () => { }, })) - await config.api.viewV2.create({ tableId }) + await config.api.viewV2.create({ tableId, name: generator.guid() }) await config.createLegacyView() const res = await config.api.table.fetch() @@ -527,8 +527,8 @@ describe("/tables", () => { .expect("Content-Type", /json/) .expect(200) expect(res.body.message).toEqual(`Table ${testTable._id} deleted.`) - expect(events.table.deleted).toBeCalledTimes(1) - expect(events.table.deleted).toBeCalledWith({ + expect(events.table.deleted).toHaveBeenCalledTimes(1) + expect(events.table.deleted).toHaveBeenCalledWith({ ...testTable, tableId: testTable._id, }) diff --git a/packages/server/src/api/routes/tests/view.spec.js b/packages/server/src/api/routes/tests/view.spec.js deleted file mode 100644 index 92ff097899..0000000000 --- a/packages/server/src/api/routes/tests/view.spec.js +++ /dev/null @@ -1,432 +0,0 @@ -const setup = require("./utilities") -const { events } = require("@budibase/backend-core") - -function priceTable() { - return { - name: "table", - type: "table", - key: "name", - schema: { - Price: { - type: "number", - constraints: {}, - }, - Category: { - type: "string", - constraints: { - type: "string", - }, - }, - }, - } -} - -describe("/views", () => { - let request = setup.getRequest() - let config = setup.getConfig() - let table - - afterAll(setup.afterAll) - - beforeAll(async () => { - await config.init() - }) - - beforeEach(async () => { - table = await config.createTable(priceTable()) - }) - - const saveView = async view => { - const viewToSave = { - name: "TestView", - field: "Price", - calculation: "stats", - tableId: table._id, - ...view, - } - return request - .post(`/api/views`) - .send(viewToSave) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - } - - describe("create", () => { - it("returns a success message when the view is successfully created", async () => { - const res = await saveView() - expect(res.body.tableId).toBe(table._id) - expect(events.view.created).toBeCalledTimes(1) - }) - - it("creates a view with a calculation", async () => { - jest.clearAllMocks() - - const res = await saveView({ calculation: "count" }) - - expect(res.body.tableId).toBe(table._id) - expect(events.view.created).toBeCalledTimes(1) - expect(events.view.updated).not.toBeCalled() - expect(events.view.calculationCreated).toBeCalledTimes(1) - expect(events.view.calculationUpdated).not.toBeCalled() - expect(events.view.calculationDeleted).not.toBeCalled() - expect(events.view.filterCreated).not.toBeCalled() - expect(events.view.filterUpdated).not.toBeCalled() - expect(events.view.filterDeleted).not.toBeCalled() - }) - - it("creates a view with a filter", async () => { - jest.clearAllMocks() - - const res = await saveView({ - calculation: null, - filters: [ - { - value: "1", - condition: "EQUALS", - key: "price", - }, - ], - }) - - expect(res.body.tableId).toBe(table._id) - expect(events.view.created).toBeCalledTimes(1) - expect(events.view.updated).not.toBeCalled() - expect(events.view.calculationCreated).not.toBeCalled() - expect(events.view.calculationUpdated).not.toBeCalled() - expect(events.view.calculationDeleted).not.toBeCalled() - expect(events.view.filterCreated).toBeCalledTimes(1) - expect(events.view.filterUpdated).not.toBeCalled() - expect(events.view.filterDeleted).not.toBeCalled() - }) - - it("updates the table row with the new view metadata", async () => { - const res = await request - .post(`/api/views`) - .send({ - name: "TestView", - field: "Price", - calculation: "stats", - tableId: table._id, - }) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - expect(res.body.tableId).toBe(table._id) - - const updatedTable = await config.getTable(table._id) - const expectedObj = expect.objectContaining({ - TestView: expect.objectContaining({ - field: "Price", - calculation: "stats", - tableId: table._id, - filters: [], - schema: { - sum: { - type: "number", - }, - min: { - type: "number", - }, - max: { - type: "number", - }, - count: { - type: "number", - }, - sumsqr: { - type: "number", - }, - avg: { - type: "number", - }, - field: { - type: "string", - }, - }, - }), - }) - expect(updatedTable.views).toEqual(expectedObj) - }) - }) - - describe("update", () => { - it("updates a view with no calculation or filter changed", async () => { - await saveView() - jest.clearAllMocks() - - await saveView() - - expect(events.view.created).not.toBeCalled() - expect(events.view.updated).toBeCalledTimes(1) - expect(events.view.calculationCreated).not.toBeCalled() - expect(events.view.calculationUpdated).not.toBeCalled() - expect(events.view.calculationDeleted).not.toBeCalled() - expect(events.view.filterCreated).not.toBeCalled() - expect(events.view.filterUpdated).not.toBeCalled() - expect(events.view.filterDeleted).not.toBeCalled() - }) - - it("updates a view calculation", async () => { - await saveView({ calculation: "sum" }) - jest.clearAllMocks() - - await saveView({ calculation: "count" }) - - expect(events.view.created).not.toBeCalled() - expect(events.view.updated).toBeCalledTimes(1) - expect(events.view.calculationCreated).not.toBeCalled() - expect(events.view.calculationUpdated).toBeCalledTimes(1) - expect(events.view.calculationDeleted).not.toBeCalled() - expect(events.view.filterCreated).not.toBeCalled() - expect(events.view.filterUpdated).not.toBeCalled() - expect(events.view.filterDeleted).not.toBeCalled() - }) - - it("deletes a view calculation", async () => { - await saveView({ calculation: "sum" }) - jest.clearAllMocks() - - await saveView({ calculation: null }) - - expect(events.view.created).not.toBeCalled() - expect(events.view.updated).toBeCalledTimes(1) - expect(events.view.calculationCreated).not.toBeCalled() - expect(events.view.calculationUpdated).not.toBeCalled() - expect(events.view.calculationDeleted).toBeCalledTimes(1) - expect(events.view.filterCreated).not.toBeCalled() - expect(events.view.filterUpdated).not.toBeCalled() - expect(events.view.filterDeleted).not.toBeCalled() - }) - - it("updates a view filter", async () => { - await saveView({ - filters: [ - { - value: "1", - condition: "EQUALS", - key: "price", - }, - ], - }) - jest.clearAllMocks() - - await saveView({ - filters: [ - { - value: "2", - condition: "EQUALS", - key: "price", - }, - ], - }) - - expect(events.view.created).not.toBeCalled() - expect(events.view.updated).toBeCalledTimes(1) - expect(events.view.calculationCreated).not.toBeCalled() - expect(events.view.calculationUpdated).not.toBeCalled() - expect(events.view.calculationDeleted).not.toBeCalled() - expect(events.view.filterCreated).not.toBeCalled() - expect(events.view.filterUpdated).toBeCalledTimes(1) - expect(events.view.filterDeleted).not.toBeCalled() - }) - - it("deletes a view filter", async () => { - await saveView({ - filters: [ - { - value: "1", - condition: "EQUALS", - key: "price", - }, - ], - }) - jest.clearAllMocks() - - await saveView({ filters: [] }) - - expect(events.view.created).not.toBeCalled() - expect(events.view.updated).toBeCalledTimes(1) - expect(events.view.calculationCreated).not.toBeCalled() - expect(events.view.calculationUpdated).not.toBeCalled() - expect(events.view.calculationDeleted).not.toBeCalled() - expect(events.view.filterCreated).not.toBeCalled() - expect(events.view.filterUpdated).not.toBeCalled() - expect(events.view.filterDeleted).toBeCalledTimes(1) - }) - }) - - describe("fetch", () => { - beforeEach(async () => { - table = await config.createTable(priceTable()) - }) - - it("returns only custom views", async () => { - await config.createLegacyView({ - name: "TestView", - field: "Price", - calculation: "stats", - tableId: table._id, - }) - const res = await request - .get(`/api/views`) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - expect(res.body.length).toBe(1) - expect(res.body.find(({ name }) => name === "TestView")).toBeDefined() - }) - }) - - describe("query", () => { - it("returns data for the created view", async () => { - await config.createLegacyView({ - name: "TestView", - field: "Price", - calculation: "stats", - tableId: table._id, - }) - await config.createRow({ - tableId: table._id, - Price: 1000, - }) - await config.createRow({ - tableId: table._id, - Price: 2000, - }) - await config.createRow({ - tableId: table._id, - Price: 4000, - }) - const res = await request - .get(`/api/views/TestView?calculation=stats`) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - expect(res.body.length).toBe(1) - expect(res.body).toMatchSnapshot() - }) - - it("returns data for the created view using a group by", async () => { - await config.createLegacyView({ - calculation: "stats", - name: "TestView", - field: "Price", - groupBy: "Category", - tableId: table._id, - }) - await config.createRow({ - tableId: table._id, - Price: 1000, - Category: "One", - }) - await config.createRow({ - tableId: table._id, - Price: 2000, - Category: "One", - }) - await config.createRow({ - tableId: table._id, - Price: 4000, - Category: "Two", - }) - const res = await request - .get(`/api/views/TestView?calculation=stats&group=Category`) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - - expect(res.body.length).toBe(2) - expect(res.body).toMatchSnapshot() - }) - }) - - describe("destroy", () => { - it("should be able to delete a view", async () => { - const table = await config.createTable(priceTable()) - const view = await config.createLegacyView() - const res = await request - .delete(`/api/views/${view.name}`) - .set(config.defaultHeaders()) - .expect("Content-Type", /json/) - .expect(200) - expect(res.body.map).toBeDefined() - expect(res.body.meta.tableId).toEqual(table._id) - expect(events.view.deleted).toBeCalledTimes(1) - }) - }) - - describe("exportView", () => { - beforeEach(() => { - jest.clearAllMocks() - }) - - const setupExport = async () => { - const table = await config.createTable() - await config.createRow({ name: "test-name", description: "ùúûü" }) - return table - } - - const exportView = async (viewName, format) => { - return request - .get(`/api/views/export?view=${viewName}&format=${format}`) - .set(config.defaultHeaders()) - .expect(200) - } - - const assertJsonExport = res => { - const rows = JSON.parse(res.text) - expect(rows.length).toBe(1) - expect(rows[0].name).toBe("test-name") - expect(rows[0].description).toBe("ùúûü") - } - - const assertCSVExport = res => { - expect(res.text).toBe(`"name","description"\n"test-name","ùúûü"`) - } - - it("should be able to export a table as JSON", async () => { - const table = await setupExport() - - const res = await exportView(table._id, "json") - - assertJsonExport(res) - expect(events.table.exported).toBeCalledTimes(1) - expect(events.table.exported).toBeCalledWith(table, "json") - }) - - it("should be able to export a table as CSV", async () => { - const table = await setupExport() - - const res = await exportView(table._id, "csv") - - assertCSVExport(res) - expect(events.table.exported).toBeCalledTimes(1) - expect(events.table.exported).toBeCalledWith(table, "csv") - }) - - it("should be able to export a view as JSON", async () => { - let table = await setupExport() - const view = await config.createLegacyView() - table = await config.getTable(table._id) - - let res = await exportView(view.name, "json") - - assertJsonExport(res) - expect(events.view.exported).toBeCalledTimes(1) - expect(events.view.exported).toBeCalledWith(table, "json") - }) - - it("should be able to export a view as CSV", async () => { - let table = await setupExport() - const view = await config.createLegacyView() - table = await config.getTable(table._id) - - let res = await exportView(view.name, "csv") - - assertCSVExport(res) - expect(events.view.exported).toBeCalledTimes(1) - expect(events.view.exported).toBeCalledWith(table, "csv") - }) - }) -}) diff --git a/packages/server/src/api/routes/tests/view.spec.ts b/packages/server/src/api/routes/tests/view.spec.ts new file mode 100644 index 0000000000..4f38603691 --- /dev/null +++ b/packages/server/src/api/routes/tests/view.spec.ts @@ -0,0 +1,494 @@ +import { events } from "@budibase/backend-core" +import * as setup from "./utilities" +import { + FieldType, + INTERNAL_TABLE_SOURCE_ID, + QuotaUsageType, + SaveTableRequest, + StaticQuotaName, + Table, + TableSourceType, + View, + ViewCalculation, +} from "@budibase/types" +import { quotas } from "@budibase/pro" + +const priceTable: SaveTableRequest = { + name: "table", + type: "table", + sourceId: INTERNAL_TABLE_SOURCE_ID, + sourceType: TableSourceType.INTERNAL, + schema: { + Price: { + name: "Price", + type: FieldType.NUMBER, + }, + Category: { + name: "Category", + type: FieldType.STRING, + constraints: { + type: "string", + }, + }, + }, +} + +describe("/views", () => { + let config = setup.getConfig() + let table: Table + + afterAll(setup.afterAll) + + beforeAll(async () => { + await config.init() + }) + + beforeEach(async () => { + table = await config.api.table.save(priceTable) + }) + + const saveView = async (view?: Partial) => { + const viewToSave: View = { + name: "TestView", + field: "Price", + calculation: ViewCalculation.STATISTICS, + tableId: table._id!, + filters: [], + schema: {}, + ...view, + } + return config.api.legacyView.save(viewToSave) + } + + const getRowUsage = async () => { + const { total } = await config.doInContext(undefined, () => + quotas.getCurrentUsageValues(QuotaUsageType.STATIC, StaticQuotaName.ROWS) + ) + return total + } + + const assertRowUsage = async (expected: number) => { + const usage = await getRowUsage() + expect(usage).toBe(expected) + } + + describe("create", () => { + it("returns a success message when the view is successfully created", async () => { + await saveView() + expect(events.view.created).toHaveBeenCalledTimes(1) + }) + + it("creates a view with a calculation", async () => { + jest.clearAllMocks() + + const view = await saveView({ calculation: ViewCalculation.COUNT }) + + expect(view.tableId).toBe(table._id) + expect(events.view.created).toHaveBeenCalledTimes(1) + expect(events.view.updated).not.toHaveBeenCalled() + expect(events.view.calculationCreated).toHaveBeenCalledTimes(1) + expect(events.view.calculationUpdated).not.toHaveBeenCalled() + expect(events.view.calculationDeleted).not.toHaveBeenCalled() + expect(events.view.filterCreated).not.toHaveBeenCalled() + expect(events.view.filterUpdated).not.toHaveBeenCalled() + expect(events.view.filterDeleted).not.toHaveBeenCalled() + }) + + it("creates a view with a filter", async () => { + jest.clearAllMocks() + + const view = await saveView({ + calculation: undefined, + filters: [ + { + value: "1", + condition: "EQUALS", + key: "price", + }, + ], + }) + + expect(view.tableId).toBe(table._id) + expect(events.view.created).toHaveBeenCalledTimes(1) + expect(events.view.updated).not.toHaveBeenCalled() + expect(events.view.calculationCreated).not.toHaveBeenCalled() + expect(events.view.calculationUpdated).not.toHaveBeenCalled() + expect(events.view.calculationDeleted).not.toHaveBeenCalled() + expect(events.view.filterCreated).toHaveBeenCalledTimes(1) + expect(events.view.filterUpdated).not.toHaveBeenCalled() + expect(events.view.filterDeleted).not.toHaveBeenCalled() + }) + + it("updates the table row with the new view metadata", async () => { + await saveView() + const updatedTable = await config.api.table.get(table._id!) + expect(updatedTable.views).toEqual( + expect.objectContaining({ + TestView: expect.objectContaining({ + field: "Price", + calculation: "stats", + tableId: table._id, + filters: [], + schema: { + sum: { + type: "number", + }, + min: { + type: "number", + }, + max: { + type: "number", + }, + count: { + type: "number", + }, + sumsqr: { + type: "number", + }, + avg: { + type: "number", + }, + field: { + type: "string", + }, + }, + }), + }) + ) + }) + }) + + describe("update", () => { + it("updates a view with no calculation or filter changed", async () => { + await saveView() + jest.clearAllMocks() + + await saveView() + + expect(events.view.created).not.toHaveBeenCalled() + expect(events.view.updated).toHaveBeenCalledTimes(1) + expect(events.view.calculationCreated).not.toHaveBeenCalled() + expect(events.view.calculationUpdated).not.toHaveBeenCalled() + expect(events.view.calculationDeleted).not.toHaveBeenCalled() + expect(events.view.filterCreated).not.toHaveBeenCalled() + expect(events.view.filterUpdated).not.toHaveBeenCalled() + expect(events.view.filterDeleted).not.toHaveBeenCalled() + }) + + it("updates a view calculation", async () => { + await saveView({ calculation: ViewCalculation.SUM }) + jest.clearAllMocks() + + await saveView({ calculation: ViewCalculation.COUNT }) + + expect(events.view.created).not.toHaveBeenCalled() + expect(events.view.updated).toHaveBeenCalledTimes(1) + expect(events.view.calculationCreated).not.toHaveBeenCalled() + expect(events.view.calculationUpdated).toHaveBeenCalledTimes(1) + expect(events.view.calculationDeleted).not.toHaveBeenCalled() + expect(events.view.filterCreated).not.toHaveBeenCalled() + expect(events.view.filterUpdated).not.toHaveBeenCalled() + expect(events.view.filterDeleted).not.toHaveBeenCalled() + }) + + it("deletes a view calculation", async () => { + await saveView({ calculation: ViewCalculation.SUM }) + jest.clearAllMocks() + + await saveView({ calculation: undefined }) + + expect(events.view.created).not.toHaveBeenCalled() + expect(events.view.updated).toHaveBeenCalledTimes(1) + expect(events.view.calculationCreated).not.toHaveBeenCalled() + expect(events.view.calculationUpdated).not.toHaveBeenCalled() + expect(events.view.calculationDeleted).toHaveBeenCalledTimes(1) + expect(events.view.filterCreated).not.toHaveBeenCalled() + expect(events.view.filterUpdated).not.toHaveBeenCalled() + expect(events.view.filterDeleted).not.toHaveBeenCalled() + }) + + it("updates a view filter", async () => { + await saveView({ + filters: [ + { + value: "1", + condition: "EQUALS", + key: "price", + }, + ], + }) + jest.clearAllMocks() + + await saveView({ + filters: [ + { + value: "2", + condition: "EQUALS", + key: "price", + }, + ], + }) + + expect(events.view.created).not.toHaveBeenCalled() + expect(events.view.updated).toHaveBeenCalledTimes(1) + expect(events.view.calculationCreated).not.toHaveBeenCalled() + expect(events.view.calculationUpdated).not.toHaveBeenCalled() + expect(events.view.calculationDeleted).not.toHaveBeenCalled() + expect(events.view.filterCreated).not.toHaveBeenCalled() + expect(events.view.filterUpdated).toHaveBeenCalledTimes(1) + expect(events.view.filterDeleted).not.toHaveBeenCalled() + }) + + it("deletes a view filter", async () => { + await saveView({ + filters: [ + { + value: "1", + condition: "EQUALS", + key: "price", + }, + ], + }) + jest.clearAllMocks() + + await saveView({ filters: [] }) + + expect(events.view.created).not.toHaveBeenCalled() + expect(events.view.updated).toHaveBeenCalledTimes(1) + expect(events.view.calculationCreated).not.toHaveBeenCalled() + expect(events.view.calculationUpdated).not.toHaveBeenCalled() + expect(events.view.calculationDeleted).not.toHaveBeenCalled() + expect(events.view.filterCreated).not.toHaveBeenCalled() + expect(events.view.filterUpdated).not.toHaveBeenCalled() + expect(events.view.filterDeleted).toHaveBeenCalledTimes(1) + }) + }) + + describe("fetch", () => { + beforeEach(async () => { + table = await config.api.table.save(priceTable) + }) + + it("returns only custom views", async () => { + await saveView({ + name: "TestView", + field: "Price", + calculation: ViewCalculation.STATISTICS, + tableId: table._id, + }) + const views = await config.api.legacyView.fetch() + expect(views.length).toBe(1) + expect(views.find(({ name }) => name === "TestView")).toBeDefined() + }) + + it("should be able to fetch tables contents via 'view'", async () => { + const row = await config.api.row.save(table._id!, {}) + const rowUsage = await getRowUsage() + + const rows = await config.api.legacyView.get(table._id!) + expect(rows.length).toEqual(1) + expect(rows[0]._id).toEqual(row._id) + await assertRowUsage(rowUsage) + }) + + it("should throw an error if view doesn't exist", async () => { + const rowUsage = await getRowUsage() + + await config.api.legacyView.get("derp", undefined, { status: 404 }) + + await assertRowUsage(rowUsage) + }) + + it("should be able to run on a view", async () => { + const view = await config.api.legacyView.save({ + tableId: table._id!, + name: "ViewTest", + filters: [], + schema: {}, + }) + const row = await config.api.row.save(table._id!, {}) + const rowUsage = await getRowUsage() + + const rows = await config.api.legacyView.get(view.name!) + expect(rows.length).toEqual(1) + expect(rows[0]._id).toEqual(row._id) + + await assertRowUsage(rowUsage) + }) + }) + + describe("query", () => { + it("returns data for the created view", async () => { + await saveView({ + name: "TestView", + field: "Price", + calculation: ViewCalculation.STATISTICS, + tableId: table._id!, + }) + await config.api.row.save(table._id!, { + Price: 1000, + }) + await config.api.row.save(table._id!, { + Price: 2000, + }) + await config.api.row.save(table._id!, { + Price: 4000, + }) + const rows = await config.api.legacyView.get("TestView", { + calculation: ViewCalculation.STATISTICS, + }) + expect(rows.length).toBe(1) + expect(rows[0]).toEqual({ + avg: 2333.3333333333335, + count: 3, + group: null, + max: 4000, + min: 1000, + sum: 7000, + sumsqr: 21000000, + }) + }) + + it("returns data for the created view using a group by", async () => { + await saveView({ + calculation: ViewCalculation.STATISTICS, + name: "TestView", + field: "Price", + groupBy: "Category", + tableId: table._id, + }) + await config.api.row.save(table._id!, { + Price: 1000, + Category: "One", + }) + await config.api.row.save(table._id!, { + Price: 2000, + Category: "One", + }) + await config.api.row.save(table._id!, { + Price: 4000, + Category: "Two", + }) + const rows = await config.api.legacyView.get("TestView", { + calculation: ViewCalculation.STATISTICS, + group: "Category", + }) + expect(rows.length).toBe(2) + expect(rows[0]).toEqual({ + avg: 1500, + count: 2, + group: "One", + max: 2000, + min: 1000, + sum: 3000, + sumsqr: 5000000, + }) + }) + }) + + describe("destroy", () => { + it("should be able to delete a view", async () => { + const table = await config.api.table.save(priceTable) + const view = await saveView({ tableId: table._id }) + const deletedView = await config.api.legacyView.destroy(view.name!) + expect(deletedView.map).toBeDefined() + expect(deletedView.meta?.tableId).toEqual(table._id) + expect(events.view.deleted).toHaveBeenCalledTimes(1) + }) + }) + + describe("exportView", () => { + beforeEach(() => { + jest.clearAllMocks() + }) + + const setupExport = async () => { + const table = await config.api.table.save({ + name: "test-table", + type: "table", + sourceId: INTERNAL_TABLE_SOURCE_ID, + sourceType: TableSourceType.INTERNAL, + schema: { + name: { + name: "name", + type: FieldType.STRING, + }, + description: { + name: "description", + type: FieldType.STRING, + }, + }, + }) + await config.api.row.save(table._id!, { + name: "test-name", + description: "ùúûü", + }) + return table + } + + const assertJsonExport = (res: string) => { + const rows = JSON.parse(res) + expect(rows.length).toBe(1) + expect(rows[0].name).toBe("test-name") + expect(rows[0].description).toBe("ùúûü") + } + + const assertCSVExport = (res: string) => { + expect(res).toBe(`"name","description"\n"test-name","ùúûü"`) + } + + it("should be able to export a table as JSON", async () => { + const table = await setupExport() + + const res = await config.api.legacyView.export(table._id!, "json") + + assertJsonExport(res) + expect(events.table.exported).toHaveBeenCalledTimes(1) + expect(events.table.exported).toHaveBeenCalledWith(table, "json") + }) + + it("should be able to export a table as CSV", async () => { + const table = await setupExport() + + const res = await config.api.legacyView.export(table._id!, "csv") + + assertCSVExport(res) + expect(events.table.exported).toHaveBeenCalledTimes(1) + expect(events.table.exported).toHaveBeenCalledWith(table, "csv") + }) + + it("should be able to export a view as JSON", async () => { + let table = await setupExport() + const view = await config.api.legacyView.save({ + name: "test-view", + tableId: table._id!, + filters: [], + schema: {}, + }) + table = await config.api.table.get(table._id!) + + let res = await config.api.legacyView.export(view.name!, "json") + + assertJsonExport(res) + expect(events.view.exported).toHaveBeenCalledTimes(1) + expect(events.view.exported).toHaveBeenCalledWith(table, "json") + }) + + it("should be able to export a view as CSV", async () => { + let table = await setupExport() + const view = await config.api.legacyView.save({ + name: "test-view", + tableId: table._id!, + filters: [], + schema: {}, + }) + table = await config.api.table.get(table._id!) + + let res = await config.api.legacyView.export(view.name!, "csv") + + assertCSVExport(res) + expect(events.view.exported).toHaveBeenCalledTimes(1) + expect(events.view.exported).toHaveBeenCalledWith(table, "csv") + }) + }) +}) diff --git a/packages/server/src/api/routes/tests/viewV2.spec.ts b/packages/server/src/api/routes/tests/viewV2.spec.ts index 5198e63338..f9d213a26b 100644 --- a/packages/server/src/api/routes/tests/viewV2.spec.ts +++ b/packages/server/src/api/routes/tests/viewV2.spec.ts @@ -1,78 +1,119 @@ import * as setup from "./utilities" import { CreateViewRequest, + Datasource, FieldSchema, FieldType, INTERNAL_TABLE_SOURCE_ID, + PermissionLevel, + QuotaUsageType, + SaveTableRequest, SearchQueryOperators, SortOrder, SortType, + StaticQuotaName, Table, TableSourceType, UIFieldMetadata, UpdateViewRequest, ViewV2, } from "@budibase/types" -import { generator } from "@budibase/backend-core/tests" -import { generateDatasourceID } from "../../../db/utils" +import { generator, mocks } from "@budibase/backend-core/tests" +import * as uuid from "uuid" +import { databaseTestProviders } from "../../../integrations/tests/utils" +import merge from "lodash/merge" +import { quotas } from "@budibase/pro" +import { roles } from "@budibase/backend-core" -function priceTable(): Table { - return { - name: "table", - type: "table", - sourceId: INTERNAL_TABLE_SOURCE_ID, - sourceType: TableSourceType.INTERNAL, - schema: { - Price: { - type: FieldType.NUMBER, - name: "Price", - constraints: {}, - }, - Category: { - type: FieldType.STRING, - name: "Category", - constraints: { - type: "string", - }, - }, - }, - } -} - -const config = setup.getConfig() - -beforeAll(async () => { - await config.init() -}) +jest.unmock("mssql") +jest.unmock("pg") describe.each([ - ["internal ds", () => config.createTable(priceTable())], - [ - "external ds", - async () => { - const datasource = await config.createDatasource({ - datasource: { - ...setup.structures.basicDatasource().datasource, - plus: true, - _id: generateDatasourceID({ plus: true }), - }, - }) + ["internal", undefined], + ["postgres", databaseTestProviders.postgres], + ["mysql", databaseTestProviders.mysql], + ["mssql", databaseTestProviders.mssql], + ["mariadb", databaseTestProviders.mariadb], +])("/v2/views (%s)", (_, dsProvider) => { + const config = setup.getConfig() + const isInternal = !dsProvider - return config.createExternalTable({ - ...priceTable(), - sourceId: datasource._id, - sourceType: TableSourceType.EXTERNAL, - }) - }, - ], -])("/v2/views (%s)", (_, tableBuilder) => { let table: Table + let datasource: Datasource + + function saveTableRequest( + ...overrides: Partial[] + ): SaveTableRequest { + const req: SaveTableRequest = { + name: uuid.v4().substring(0, 16), + type: "table", + sourceType: datasource + ? TableSourceType.EXTERNAL + : TableSourceType.INTERNAL, + sourceId: datasource ? datasource._id! : INTERNAL_TABLE_SOURCE_ID, + primary: ["id"], + schema: { + id: { + type: FieldType.AUTO, + name: "id", + autocolumn: true, + constraints: { + presence: true, + }, + }, + }, + } + return merge(req, ...overrides) + } + + function priceTable(): SaveTableRequest { + return saveTableRequest({ + schema: { + Price: { + type: FieldType.NUMBER, + name: "Price", + constraints: {}, + }, + Category: { + type: FieldType.STRING, + name: "Category", + constraints: { + type: "string", + }, + }, + }, + }) + } beforeAll(async () => { - table = await tableBuilder() + await config.init() + + if (dsProvider) { + datasource = await config.createDatasource({ + datasource: await dsProvider.datasource(), + }) + } + table = await config.api.table.save(priceTable()) }) - afterAll(setup.afterAll) + afterAll(async () => { + if (dsProvider) { + await dsProvider.stop() + } + setup.afterAll() + }) + + const getRowUsage = async () => { + const { total } = await config.doInContext(undefined, () => + quotas.getCurrentUsageValues(QuotaUsageType.STATIC, StaticQuotaName.ROWS) + ) + return total + } + + const assertRowUsage = async (expected: number) => { + const usage = await getRowUsage() + expect(usage).toBe(expected) + } describe("create", () => { it("persist the view when the view is successfully created", async () => { @@ -186,9 +227,12 @@ describe.each([ let view: ViewV2 beforeEach(async () => { - table = await tableBuilder() + table = await config.api.table.save(priceTable()) - view = await config.api.viewV2.create({ name: "View A" }) + view = await config.api.viewV2.create({ + tableId: table._id!, + name: "View A", + }) }) it("can update an existing view data", async () => { @@ -247,6 +291,9 @@ describe.each([ ...updatedData, schema: { ...table.schema, + id: expect.objectContaining({ + visible: false, + }), Category: expect.objectContaining({ visible: false, }), @@ -320,23 +367,27 @@ describe.each([ }) it("cannot update views v1", async () => { - const viewV1 = await config.createLegacyView() - await config.api.viewV2.update( - { - ...viewV1, - }, - { + const viewV1 = await config.api.legacyView.save({ + tableId: table._id!, + name: generator.guid(), + filters: [], + schema: {}, + }) + + await config.api.viewV2.update(viewV1 as unknown as ViewV2, { + status: 400, + body: { + message: "Only views V2 can be updated", status: 400, - body: { - message: "Only views V2 can be updated", - status: 400, - }, - } - ) + }, + }) }) it("cannot update the a view with unmatching ids between url and body", async () => { - const anotherView = await config.api.viewV2.create() + const anotherView = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + }) const result = await config .request!.put(`/api/v2/views/${anotherView.id}`) .send(view) @@ -411,7 +462,10 @@ describe.each([ let view: ViewV2 beforeAll(async () => { - view = await config.api.viewV2.create() + view = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + }) }) it("can delete an existing view", async () => { @@ -448,4 +502,507 @@ describe.each([ expect(viewSchema.Price?.visible).toEqual(false) }) }) + + describe("read", () => { + it("views have extra data trimmed", async () => { + const table = await config.api.table.save( + saveTableRequest({ + name: "orders", + schema: { + Country: { + type: FieldType.STRING, + name: "Country", + }, + Story: { + type: FieldType.STRING, + name: "Story", + }, + }, + }) + ) + + const view = await config.api.viewV2.create({ + tableId: table._id!, + name: uuid.v4(), + schema: { + Country: { + visible: true, + }, + }, + }) + + let row = await config.api.row.save(view.id, { + Country: "Aussy", + Story: "aaaaa", + }) + + row = await config.api.row.get(table._id!, row._id!) + expect(row.Story).toBeUndefined() + expect(row.Country).toEqual("Aussy") + }) + }) + + describe("row operations", () => { + let table: Table, view: ViewV2 + beforeEach(async () => { + table = await config.api.table.save( + saveTableRequest({ + schema: { + one: { type: FieldType.STRING, name: "one" }, + two: { type: FieldType.STRING, name: "two" }, + }, + }) + ) + view = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + schema: { + two: { visible: true }, + }, + }) + }) + + describe("create", () => { + it("should persist a new row with only the provided view fields", async () => { + const newRow = await config.api.row.save(view.id, { + tableId: table!._id, + _viewId: view.id, + one: "foo", + two: "bar", + }) + + const row = await config.api.row.get(table._id!, newRow._id!) + expect(row.one).toBeUndefined() + expect(row.two).toEqual("bar") + }) + }) + + describe("patch", () => { + it("should update only the view fields for a row", async () => { + const newRow = await config.api.row.save(table._id!, { + one: "foo", + two: "bar", + }) + await config.api.row.patch(view.id, { + tableId: table._id!, + _id: newRow._id!, + _rev: newRow._rev!, + one: "newFoo", + two: "newBar", + }) + + const row = await config.api.row.get(table._id!, newRow._id!) + expect(row.one).toEqual("foo") + expect(row.two).toEqual("newBar") + }) + }) + + describe("destroy", () => { + it("should be able to delete a row", async () => { + const createdRow = await config.api.row.save(table._id!, {}) + const rowUsage = await getRowUsage() + await config.api.row.bulkDelete(view.id, { rows: [createdRow] }) + await assertRowUsage(rowUsage - 1) + await config.api.row.get(table._id!, createdRow._id!, { + status: 404, + }) + }) + + it("should be able to delete multiple rows", async () => { + const rows = await Promise.all([ + config.api.row.save(table._id!, {}), + config.api.row.save(table._id!, {}), + config.api.row.save(table._id!, {}), + ]) + const rowUsage = await getRowUsage() + + await config.api.row.bulkDelete(view.id, { rows: [rows[0], rows[2]] }) + + await assertRowUsage(rowUsage - 2) + + await config.api.row.get(table._id!, rows[0]._id!, { + status: 404, + }) + await config.api.row.get(table._id!, rows[2]._id!, { + status: 404, + }) + await config.api.row.get(table._id!, rows[1]._id!, { status: 200 }) + }) + }) + + describe("search", () => { + it("returns empty rows from view when no schema is passed", async () => { + const rows = await Promise.all( + Array.from({ length: 10 }, () => config.api.row.save(table._id!, {})) + ) + const response = await config.api.viewV2.search(view.id) + expect(response.rows).toHaveLength(10) + expect(response).toEqual({ + rows: expect.arrayContaining( + rows.map(r => ({ + _viewId: view.id, + tableId: table._id, + _id: r._id, + _rev: r._rev, + ...(isInternal + ? { + type: "row", + updatedAt: expect.any(String), + createdAt: expect.any(String), + } + : {}), + })) + ), + ...(isInternal + ? {} + : { + hasNextPage: false, + bookmark: null, + }), + }) + }) + + it("searching respects the view filters", async () => { + await config.api.row.save(table._id!, { + one: "foo", + two: "bar", + }) + const two = await config.api.row.save(table._id!, { + one: "foo2", + two: "bar2", + }) + + const view = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + query: [ + { + operator: SearchQueryOperators.EQUAL, + field: "two", + value: "bar2", + }, + ], + schema: { + two: { visible: true }, + }, + }) + + const response = await config.api.viewV2.search(view.id) + expect(response.rows).toHaveLength(1) + expect(response).toEqual({ + rows: expect.arrayContaining([ + { + _viewId: view.id, + tableId: table._id, + two: two.two, + _id: two._id, + _rev: two._rev, + ...(isInternal + ? { + type: "row", + createdAt: expect.any(String), + updatedAt: expect.any(String), + } + : {}), + }, + ]), + ...(isInternal + ? {} + : { + hasNextPage: false, + bookmark: null, + }), + }) + }) + + it("views without data can be returned", async () => { + const response = await config.api.viewV2.search(view.id) + expect(response.rows).toHaveLength(0) + }) + + it("respects the limit parameter", async () => { + await Promise.all( + Array.from({ length: 10 }, () => config.api.row.save(table._id!, {})) + ) + const limit = generator.integer({ min: 1, max: 8 }) + const response = await config.api.viewV2.search(view.id, { + limit, + query: {}, + }) + expect(response.rows).toHaveLength(limit) + }) + + it("can handle pagination", async () => { + await Promise.all( + Array.from({ length: 10 }, () => config.api.row.save(table._id!, {})) + ) + const rows = (await config.api.viewV2.search(view.id)).rows + + const page1 = await config.api.viewV2.search(view.id, { + paginate: true, + limit: 4, + query: {}, + }) + expect(page1).toEqual({ + rows: expect.arrayContaining(rows.slice(0, 4)), + totalRows: isInternal ? 10 : undefined, + hasNextPage: true, + bookmark: expect.anything(), + }) + + const page2 = await config.api.viewV2.search(view.id, { + paginate: true, + limit: 4, + bookmark: page1.bookmark, + query: {}, + }) + expect(page2).toEqual({ + rows: expect.arrayContaining(rows.slice(4, 8)), + totalRows: isInternal ? 10 : undefined, + hasNextPage: true, + bookmark: expect.anything(), + }) + + const page3 = await config.api.viewV2.search(view.id, { + paginate: true, + limit: 4, + bookmark: page2.bookmark, + query: {}, + }) + expect(page3).toEqual({ + rows: expect.arrayContaining(rows.slice(8)), + totalRows: isInternal ? 10 : undefined, + hasNextPage: false, + bookmark: expect.anything(), + }) + }) + + const sortTestOptions: [ + { + field: string + order?: SortOrder + type?: SortType + }, + string[] + ][] = [ + [ + { + field: "name", + order: SortOrder.ASCENDING, + type: SortType.STRING, + }, + ["Alice", "Bob", "Charly", "Danny"], + ], + [ + { + field: "name", + }, + ["Alice", "Bob", "Charly", "Danny"], + ], + [ + { + field: "name", + order: SortOrder.DESCENDING, + }, + ["Danny", "Charly", "Bob", "Alice"], + ], + [ + { + field: "name", + order: SortOrder.DESCENDING, + type: SortType.STRING, + }, + ["Danny", "Charly", "Bob", "Alice"], + ], + [ + { + field: "age", + order: SortOrder.ASCENDING, + type: SortType.number, + }, + ["Danny", "Alice", "Charly", "Bob"], + ], + [ + { + field: "age", + order: SortOrder.ASCENDING, + }, + ["Danny", "Alice", "Charly", "Bob"], + ], + [ + { + field: "age", + order: SortOrder.DESCENDING, + }, + ["Bob", "Charly", "Alice", "Danny"], + ], + [ + { + field: "age", + order: SortOrder.DESCENDING, + type: SortType.number, + }, + ["Bob", "Charly", "Alice", "Danny"], + ], + ] + + describe("sorting", () => { + let table: Table + const viewSchema = { age: { visible: true }, name: { visible: true } } + + beforeAll(async () => { + table = await config.api.table.save( + saveTableRequest({ + name: `users_${uuid.v4()}`, + type: "table", + schema: { + name: { + type: FieldType.STRING, + name: "name", + }, + surname: { + type: FieldType.STRING, + name: "surname", + }, + age: { + type: FieldType.NUMBER, + name: "age", + }, + address: { + type: FieldType.STRING, + name: "address", + }, + jobTitle: { + type: FieldType.STRING, + name: "jobTitle", + }, + }, + }) + ) + + const users = [ + { name: "Alice", age: 25 }, + { name: "Bob", age: 30 }, + { name: "Charly", age: 27 }, + { name: "Danny", age: 15 }, + ] + await Promise.all( + users.map(u => + config.api.row.save(table._id!, { + tableId: table._id, + ...u, + }) + ) + ) + }) + + it.each(sortTestOptions)( + "allow sorting (%s)", + async (sortParams, expected) => { + const view = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + sort: sortParams, + schema: viewSchema, + }) + + const response = await config.api.viewV2.search(view.id) + + expect(response.rows).toHaveLength(4) + expect(response.rows).toEqual( + expected.map(name => expect.objectContaining({ name })) + ) + } + ) + + it.each(sortTestOptions)( + "allow override the default view sorting (%s)", + async (sortParams, expected) => { + const view = await config.api.viewV2.create({ + tableId: table._id!, + name: generator.guid(), + sort: { + field: "name", + order: SortOrder.ASCENDING, + type: SortType.STRING, + }, + schema: viewSchema, + }) + + const response = await config.api.viewV2.search(view.id, { + sort: sortParams.field, + sortOrder: sortParams.order, + sortType: sortParams.type, + query: {}, + }) + + expect(response.rows).toHaveLength(4) + expect(response.rows).toEqual( + expected.map(name => expect.objectContaining({ name })) + ) + } + ) + }) + }) + + describe("permissions", () => { + beforeEach(async () => { + mocks.licenses.useViewPermissions() + await Promise.all( + Array.from({ length: 10 }, () => config.api.row.save(table._id!, {})) + ) + }) + + it("does not allow public users to fetch by default", async () => { + await config.publish() + await config.api.viewV2.publicSearch(view.id, undefined, { + status: 403, + }) + }) + + it("allow public users to fetch when permissions are explicit", async () => { + await config.api.permission.add({ + roleId: roles.BUILTIN_ROLE_IDS.PUBLIC, + level: PermissionLevel.READ, + resourceId: view.id, + }) + await config.publish() + + const response = await config.api.viewV2.publicSearch(view.id) + + expect(response.rows).toHaveLength(10) + }) + + it("allow public users to fetch when permissions are inherited", async () => { + await config.api.permission.add({ + roleId: roles.BUILTIN_ROLE_IDS.PUBLIC, + level: PermissionLevel.READ, + resourceId: table._id!, + }) + await config.publish() + + const response = await config.api.viewV2.publicSearch(view.id) + + expect(response.rows).toHaveLength(10) + }) + + it("respects inherited permissions, not allowing not public views from public tables", async () => { + await config.api.permission.add({ + roleId: roles.BUILTIN_ROLE_IDS.PUBLIC, + level: PermissionLevel.READ, + resourceId: table._id!, + }) + await config.api.permission.add({ + roleId: roles.BUILTIN_ROLE_IDS.POWER, + level: PermissionLevel.READ, + resourceId: view.id, + }) + await config.publish() + + await config.api.viewV2.publicSearch(view.id, undefined, { + status: 403, + }) + }) + }) + }) }) diff --git a/packages/server/src/api/routes/tests/webhook.spec.ts b/packages/server/src/api/routes/tests/webhook.spec.ts index 48a6da38bf..b741ce0820 100644 --- a/packages/server/src/api/routes/tests/webhook.spec.ts +++ b/packages/server/src/api/routes/tests/webhook.spec.ts @@ -140,7 +140,7 @@ describe("/webhooks", () => { }) }) - it("should trigger a synchronous webhook call ", async () => { + it("should trigger a synchronous webhook call", async () => { mocks.licenses.useSyncAutomations() let automation = collectAutomation() let newAutomation = await config.createAutomation(automation) diff --git a/packages/server/src/api/routes/utils/validators.ts b/packages/server/src/api/routes/utils/validators.ts index 55766cd120..424d0d6c79 100644 --- a/packages/server/src/api/routes/utils/validators.ts +++ b/packages/server/src/api/routes/utils/validators.ts @@ -2,6 +2,7 @@ import { auth, permissions } from "@budibase/backend-core" import { DataSourceOperation } from "../../../constants" import { WebhookActionType } from "@budibase/types" import Joi from "joi" +import { ValidSnippetNameRegex } from "@budibase/shared-core" const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("") const OPTIONAL_NUMBER = Joi.number().optional().allow(null) @@ -226,6 +227,21 @@ export function applicationValidator(opts = { isCreate: true }) { base.name = appNameValidator.optional() } + const snippetValidator = Joi.array() + .optional() + .items( + Joi.object({ + name: Joi.string() + .pattern(new RegExp(ValidSnippetNameRegex)) + .error( + new Error( + "Snippet name cannot include spaces or special characters, and cannot start with a number" + ) + ), + code: OPTIONAL_STRING, + }) + ) + return auth.joiValidator.body( Joi.object({ _id: OPTIONAL_STRING, @@ -235,6 +251,7 @@ export function applicationValidator(opts = { isCreate: true }) { template: Joi.object({ templateString: OPTIONAL_STRING, }).unknown(true), + snippets: snippetValidator, }).unknown(true) ) } diff --git a/packages/server/src/appMigrations/tests/migrationsProcessor.spec.ts b/packages/server/src/appMigrations/tests/migrationsProcessor.spec.ts index 3b8e90b526..a2d1dc05c3 100644 --- a/packages/server/src/appMigrations/tests/migrationsProcessor.spec.ts +++ b/packages/server/src/appMigrations/tests/migrationsProcessor.spec.ts @@ -45,7 +45,7 @@ describe("migrationsProcessor", () => { await expect( config.doInContext(appId, () => processMigrations(appId, testMigrations)) - ).rejects.toThrowError( + ).rejects.toThrow( "The context cannot be changed, a migration is currently running" ) }) diff --git a/packages/server/src/automations/automationUtils.ts b/packages/server/src/automations/automationUtils.ts index 8a298a49a3..6730e04494 100644 --- a/packages/server/src/automations/automationUtils.ts +++ b/packages/server/src/automations/automationUtils.ts @@ -5,7 +5,7 @@ import { } from "@budibase/string-templates" import sdk from "../sdk" import { Row } from "@budibase/types" -import { LoopInput, LoopStep, LoopStepType } from "../definitions/automations" +import { LoopInput, LoopStepType } from "../definitions/automations" /** * When values are input to the system generally they will be of type string as this is required for template strings. diff --git a/packages/server/src/automations/steps/collect.ts b/packages/server/src/automations/steps/collect.ts index ef1fe64772..035bd36a46 100644 --- a/packages/server/src/automations/steps/collect.ts +++ b/packages/server/src/automations/steps/collect.ts @@ -4,7 +4,6 @@ import { AutomationStepInput, AutomationStepType, AutomationIOType, - AutomationFeature, } from "@budibase/types" export const definition: AutomationStepSchema = { diff --git a/packages/server/src/automations/steps/executeQuery.ts b/packages/server/src/automations/steps/executeQuery.ts index ea0737c86a..a9517b01a0 100644 --- a/packages/server/src/automations/steps/executeQuery.ts +++ b/packages/server/src/automations/steps/executeQuery.ts @@ -10,8 +10,6 @@ import { AutomationStepSchema, AutomationStepType, } from "@budibase/types" -import { utils } from "@budibase/backend-core" -import env from "../../environment" export const definition: AutomationStepSchema = { name: "External Data Connector", diff --git a/packages/server/src/automations/steps/openai.ts b/packages/server/src/automations/steps/openai.ts index 8ae211579e..bc926de7b7 100644 --- a/packages/server/src/automations/steps/openai.ts +++ b/packages/server/src/automations/steps/openai.ts @@ -58,7 +58,7 @@ export const definition: AutomationStepSchema = { }, } -export async function run({ inputs, context }: AutomationStepInput) { +export async function run({ inputs }: AutomationStepInput) { if (!environment.OPENAI_API_KEY) { return { success: false, diff --git a/packages/server/src/automations/steps/triggerAutomationRun.ts b/packages/server/src/automations/steps/triggerAutomationRun.ts index 83e1722877..f45a60600f 100644 --- a/packages/server/src/automations/steps/triggerAutomationRun.ts +++ b/packages/server/src/automations/steps/triggerAutomationRun.ts @@ -62,6 +62,7 @@ export const definition: AutomationStepSchema = { } export async function run({ inputs }: AutomationStepInput) { + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { automationId, ...fieldParams } = inputs.automation if (await features.isTriggerAutomationRunEnabled()) { diff --git a/packages/server/src/automations/tests/loop.spec.ts b/packages/server/src/automations/tests/loop.spec.ts index 68ab694c5d..2c6ae9749d 100644 --- a/packages/server/src/automations/tests/loop.spec.ts +++ b/packages/server/src/automations/tests/loop.spec.ts @@ -3,19 +3,18 @@ import * as triggers from "../triggers" import { loopAutomation } from "../../tests/utilities/structures" import { context } from "@budibase/backend-core" import * as setup from "./utilities" -import { Row, Table } from "@budibase/types" +import { Table } from "@budibase/types" import { LoopInput, LoopStepType } from "../../definitions/automations" describe("Attempt to run a basic loop automation", () => { let config = setup.getConfig(), - table: Table, - row: Row + table: Table beforeEach(async () => { await automation.init() await config.init() table = await config.createTable() - row = await config.createRow() + await config.createRow() }) afterAll(setup.afterAll) diff --git a/packages/server/src/automations/unitTests/automationUtils.spec.ts b/packages/server/src/automations/unitTests/automationUtils.spec.ts index 7de4a2e35b..afb6219ef2 100644 --- a/packages/server/src/automations/unitTests/automationUtils.spec.ts +++ b/packages/server/src/automations/unitTests/automationUtils.spec.ts @@ -1,4 +1,4 @@ -import { LoopStep, LoopStepType } from "../../definitions/automations" +import { LoopStepType } from "../../definitions/automations" import { typecastForLooping, cleanInputValues, diff --git a/packages/server/src/constants/index.ts b/packages/server/src/constants/index.ts index 49f1d01afb..d2bc3c44e3 100644 --- a/packages/server/src/constants/index.ts +++ b/packages/server/src/constants/index.ts @@ -6,6 +6,10 @@ import { TableSourceType, } from "@budibase/types" +import env from "../environment" + +export const AWS_REGION = env.AWS_REGION ? env.AWS_REGION : "eu-west-1" + export enum FilterTypes { STRING = "string", FUZZY = "fuzzy", diff --git a/packages/server/src/db/dynamoClient.ts b/packages/server/src/db/dynamoClient.ts deleted file mode 100644 index 148c433c41..0000000000 --- a/packages/server/src/db/dynamoClient.ts +++ /dev/null @@ -1,147 +0,0 @@ -import merge from "lodash/merge" -import env from "../environment" - -export const AWS_REGION = env.AWS_REGION ? env.AWS_REGION : "eu-west-1" - -const TableInfo = { - API_KEYS: { - name: "beta-api-key-table", - primary: "pk", - }, - USERS: { - name: "prod-budi-table", - primary: "pk", - sort: "sk", - }, -} - -let docClient: any = null - -type GetOpts = { - primary: string - sort?: string - otherProps?: any -} - -type UpdateOpts = { - primary: string - sort?: string - expression?: string - condition?: string - names?: string[] - values?: any[] - exists?: boolean - otherProps?: any -} - -type PutOpts = { - item: any - otherProps?: any -} - -class Table { - _name: string - _primary: string - _sort?: string - - constructor(tableInfo: { name: string; primary: string; sort?: string }) { - if (!tableInfo.name || !tableInfo.primary) { - throw "Table info must specify a name and a primary key" - } - this._name = tableInfo.name - this._primary = tableInfo.primary - this._sort = tableInfo.sort - } - - async get({ primary, sort, otherProps }: GetOpts) { - let params = { - TableName: this._name, - Key: { - [this._primary]: primary, - }, - } - if (this._sort && sort) { - params.Key[this._sort] = sort - } - if (otherProps) { - params = merge(params, otherProps) - } - let response = await docClient.get(params).promise() - return response.Item - } - - async update({ - primary, - sort, - expression, - condition, - names, - values, - exists, - otherProps, - }: UpdateOpts) { - let params: any = { - TableName: this._name, - Key: { - [this._primary]: primary, - }, - ExpressionAttributeNames: names, - ExpressionAttributeValues: values, - UpdateExpression: expression, - } - if (condition) { - params.ConditionExpression = condition - } - if (this._sort && sort) { - params.Key[this._sort] = sort - } - if (exists) { - params.ExpressionAttributeNames["#PRIMARY"] = this._primary - if (params.ConditionExpression) { - params.ConditionExpression += " AND " - } - params.ConditionExpression += "attribute_exists(#PRIMARY)" - } - if (otherProps) { - params = merge(params, otherProps) - } - return docClient.update(params).promise() - } - - async put({ item, otherProps }: PutOpts) { - if ( - item[this._primary] == null || - (this._sort && item[this._sort] == null) - ) { - throw "Cannot put item without primary and sort key (if required)" - } - let params = { - TableName: this._name, - Item: item, - } - if (otherProps) { - params = merge(params, otherProps) - } - return docClient.put(params).promise() - } -} - -export function init(endpoint: string) { - let AWS = require("aws-sdk") - let docClientParams: any = { - correctClockSkew: true, - region: AWS_REGION, - } - if (endpoint) { - docClientParams.endpoint = endpoint - } else if (env.DYNAMO_ENDPOINT) { - docClientParams.endpoint = env.DYNAMO_ENDPOINT - } - docClient = new AWS.DynamoDB.DocumentClient(docClientParams) -} - -if (!env.isProd() && !env.isJest()) { - env._set("AWS_ACCESS_KEY_ID", "KEY_ID") - env._set("AWS_SECRET_ACCESS_KEY", "SECRET_KEY") - init("http://localhost:8333") -} diff --git a/packages/server/src/db/linkedRows/index.ts b/packages/server/src/db/linkedRows/index.ts index 7af3f9392f..1eb534a7f8 100644 --- a/packages/server/src/db/linkedRows/index.ts +++ b/packages/server/src/db/linkedRows/index.ts @@ -18,7 +18,6 @@ import { Row, LinkDocumentValue, FieldType, - LinkDocument, ContextUser, } from "@budibase/types" import sdk from "../../sdk" @@ -202,7 +201,8 @@ export async function attachFullLinkedDocs( table => table._id === linkedTableId ) if (linkedTable) { - row[link.fieldName].push(processFormulas(linkedTable, linkedRow)) + const processed = await processFormulas(linkedTable, linkedRow) + row[link.fieldName].push(processed) } } } diff --git a/packages/server/src/db/views/staticViews.ts b/packages/server/src/db/views/staticViews.ts index 5b1b66d8e3..700bd2568a 100644 --- a/packages/server/src/db/views/staticViews.ts +++ b/packages/server/src/db/views/staticViews.ts @@ -30,8 +30,8 @@ export async function createLinkView() { if (doc.type === "link") { let doc1 = doc.doc1 let doc2 = doc.doc2 + // @ts-expect-error emit is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore emit([doc1.tableId, doc1.rowId], { id: doc2.rowId, thisId: doc1.rowId, @@ -39,8 +39,8 @@ export async function createLinkView() { }) // if linking to same table can't emit twice if (doc1.tableId !== doc2.tableId) { + // @ts-expect-error emit is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore emit([doc2.tableId, doc2.rowId], { id: doc1.rowId, thisId: doc2.rowId, @@ -101,8 +101,8 @@ export async function createAllSearchIndex() { if (Array.isArray(input[key])) { for (let val of input[key]) { if (typeof val !== "object") { + // @ts-expect-error index is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore index(idxKey, val, { store: true }) } } @@ -110,12 +110,12 @@ export async function createAllSearchIndex() { continue } if (typeof input[key] === "string") { + // @ts-expect-error index is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore index(idxKey, input[key].toLowerCase(), { store: true }) } else if (typeof input[key] !== "object") { + // @ts-expect-error index is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore index(idxKey, input[key], { store: true }) } else { idx(input[key], idxKey) @@ -123,8 +123,8 @@ export async function createAllSearchIndex() { } } if (doc._id!.startsWith("ro_")) { + // @ts-expect-error index is available in a CouchDB map function // eslint-disable-next-line no-undef - // @ts-ignore index("default", doc._id) idx(doc) } diff --git a/packages/server/src/features.ts b/packages/server/src/features.ts index f040cf82a2..3ab9410f53 100644 --- a/packages/server/src/features.ts +++ b/packages/server/src/features.ts @@ -1,8 +1,11 @@ import { features } from "@budibase/backend-core" import env from "./environment" +// eslint-disable-next-line no-unused-vars enum AppFeature { + // eslint-disable-next-line no-unused-vars API = "api", + // eslint-disable-next-line no-unused-vars AUTOMATIONS = "automations", } diff --git a/packages/server/src/integration-test/mysql.spec.ts b/packages/server/src/integration-test/mysql.spec.ts index fac2bfcfeb..92420fb336 100644 --- a/packages/server/src/integration-test/mysql.spec.ts +++ b/packages/server/src/integration-test/mysql.spec.ts @@ -12,7 +12,6 @@ import { TableRequest, TableSourceType, } from "@budibase/types" -import _ from "lodash" import { databaseTestProviders } from "../integrations/tests/utils" import mysql from "mysql2/promise" import { builderSocket } from "../websockets" @@ -21,7 +20,6 @@ fetch.mockSearch() const config = setup.getConfig()! -jest.unmock("mysql2/promise") jest.mock("../websockets", () => ({ clientAppSocket: jest.fn(), gridAppSocket: jest.fn(), @@ -106,6 +104,7 @@ describe("mysql integrations", () => { plus: true, source: "MYSQL", type: "datasource_plus", + isSQL: true, _id: expect.any(String), _rev: expect.any(String), createdAt: expect.any(String), @@ -306,7 +305,7 @@ describe("mysql integrations", () => { } delete expectedTable._add - expect(emitDatasourceUpdateMock).toBeCalledTimes(1) + expect(emitDatasourceUpdateMock).toHaveBeenCalledTimes(1) const emittedDatasource: Datasource = emitDatasourceUpdateMock.mock.calls[0][1] expect(emittedDatasource.entities!["table"]).toEqual(expectedTable) diff --git a/packages/server/src/integration-test/postgres.spec.ts b/packages/server/src/integration-test/postgres.spec.ts index 7c14bc2b69..107c4ade1e 100644 --- a/packages/server/src/integration-test/postgres.spec.ts +++ b/packages/server/src/integration-test/postgres.spec.ts @@ -319,6 +319,7 @@ describe("postgres integrations", () => { }, plus: true, source: "POSTGRES", + isSQL: true, type: "datasource_plus", _id: expect.any(String), _rev: expect.any(String), diff --git a/packages/server/src/integrations/base/sql.ts b/packages/server/src/integrations/base/sql.ts index be1883c8ec..2093d455b9 100644 --- a/packages/server/src/integrations/base/sql.ts +++ b/packages/server/src/integrations/base/sql.ts @@ -4,11 +4,17 @@ import { QueryOptions } from "../../definitions/datasource" import { isIsoDateString, SqlClient, isValidFilter } from "../utils" import SqlTableQueryBuilder from "./sqlTable" import { + BBReferenceFieldMetadata, + FieldSchema, + FieldSubtype, + FieldType, + JsonFieldMetadata, Operation, QueryJson, RelationshipsJson, SearchFilters, SortDirection, + Table, } from "@budibase/types" import environment from "../../environment" @@ -691,6 +697,39 @@ class SqlQueryBuilder extends SqlTableQueryBuilder { return results.length ? results : [{ [operation.toLowerCase()]: true }] } + convertJsonStringColumns( + table: Table, + results: Record[], + aliases?: Record + ): Record[] { + for (const [name, field] of Object.entries(table.schema)) { + if (!this._isJsonColumn(field)) { + continue + } + const tableName = aliases?.[table.name] || table.name + const fullName = `${tableName}.${name}` + for (let row of results) { + if (typeof row[fullName] === "string") { + row[fullName] = JSON.parse(row[fullName]) + } + if (typeof row[name] === "string") { + row[name] = JSON.parse(row[name]) + } + } + } + return results + } + + _isJsonColumn( + field: FieldSchema + ): field is JsonFieldMetadata | BBReferenceFieldMetadata { + return ( + field.type === FieldType.JSON || + (field.type === FieldType.BB_REFERENCE && + field.subtype === FieldSubtype.USERS) + ) + } + log(query: string, values?: any[]) { if (!environment.SQL_LOGGING_ENABLE) { return diff --git a/packages/server/src/integrations/base/sqlTable.ts b/packages/server/src/integrations/base/sqlTable.ts index f3560791e6..0feecefb89 100644 --- a/packages/server/src/integrations/base/sqlTable.ts +++ b/packages/server/src/integrations/base/sqlTable.ts @@ -59,8 +59,8 @@ function generateSchema( case FieldType.BARCODEQR: schema.text(key) break - case FieldType.BB_REFERENCE: - const subtype = column.subtype as FieldSubtype + case FieldType.BB_REFERENCE: { + const subtype = column.subtype switch (subtype) { case FieldSubtype.USER: schema.text(key) @@ -72,6 +72,7 @@ function generateSchema( throw utils.unreachable(subtype) } break + } case FieldType.NUMBER: // if meta is specified then this is a junction table entry if (column.meta && column.meta.toKey && column.meta.toTable) { diff --git a/packages/server/src/integrations/dynamodb.ts b/packages/server/src/integrations/dynamodb.ts index bede4a7f7c..424a3dfce0 100644 --- a/packages/server/src/integrations/dynamodb.ts +++ b/packages/server/src/integrations/dynamodb.ts @@ -8,7 +8,7 @@ import { } from "@budibase/types" import AWS from "aws-sdk" -import { AWS_REGION } from "../db/dynamoClient" +import { AWS_REGION } from "../constants" import { DocumentClient } from "aws-sdk/clients/dynamodb" interface DynamoDBConfig { diff --git a/packages/server/src/integrations/googlesheets.ts b/packages/server/src/integrations/googlesheets.ts index 32398bde41..bc0e25e267 100644 --- a/packages/server/src/integrations/googlesheets.ts +++ b/packages/server/src/integrations/googlesheets.ts @@ -168,6 +168,7 @@ class GoogleSheetsIntegration implements DatasourcePlus { return "" } + // eslint-disable-next-line @typescript-eslint/no-unused-vars getStringConcat(parts: string[]) { return "" } diff --git a/packages/server/src/integrations/microsoftSqlServer.ts b/packages/server/src/integrations/microsoftSqlServer.ts index f87e248ac0..831fcd3d20 100644 --- a/packages/server/src/integrations/microsoftSqlServer.ts +++ b/packages/server/src/integrations/microsoftSqlServer.ts @@ -252,7 +252,7 @@ class SqlServerIntegration extends Sql implements DatasourcePlus { } switch (this.config.authType) { - case MSSQLConfigAuthType.AZURE_ACTIVE_DIRECTORY: + case MSSQLConfigAuthType.AZURE_ACTIVE_DIRECTORY: { const { clientId, tenantId, clientSecret } = this.config.adConfig || {} const clientApp = new ConfidentialClientApplication({ @@ -274,7 +274,8 @@ class SqlServerIntegration extends Sql implements DatasourcePlus { }, } break - case MSSQLConfigAuthType.NTLM: + } + case MSSQLConfigAuthType.NTLM: { const { domain, trustServerCertificate } = this.config.ntlmConfig || {} clientCfg.authentication = { @@ -286,6 +287,7 @@ class SqlServerIntegration extends Sql implements DatasourcePlus { clientCfg.options ??= {} clientCfg.options.trustServerCertificate = !!trustServerCertificate break + } case null: case undefined: break @@ -502,8 +504,18 @@ class SqlServerIntegration extends Sql implements DatasourcePlus { } const operation = this._operation(json) const queryFn = (query: any, op: string) => this.internalQuery(query, op) - const processFn = (result: any) => - result.recordset ? result.recordset : [{ [operation]: true }] + const processFn = (result: any) => { + if (json?.meta?.table && result.recordset) { + return this.convertJsonStringColumns( + json.meta.table, + result.recordset, + json.tableAliases + ) + } else if (result.recordset) { + return result.recordset + } + return [{ [operation]: true }] + } return this.queryWithReturning(json, queryFn, processFn) } diff --git a/packages/server/src/integrations/mongodb.ts b/packages/server/src/integrations/mongodb.ts index 272810b052..c9852e4c7a 100644 --- a/packages/server/src/integrations/mongodb.ts +++ b/packages/server/src/integrations/mongodb.ts @@ -23,7 +23,7 @@ import { } from "mongodb" import environment from "../environment" -interface MongoDBConfig { +export interface MongoDBConfig { connectionString: string db: string tlsCertificateKeyFile: string @@ -348,7 +348,7 @@ const getSchema = () => { const SCHEMA: Integration = getSchema() -class MongoIntegration implements IntegrationBase { +export class MongoIntegration implements IntegrationBase { private config: MongoDBConfig private client: MongoClient diff --git a/packages/server/src/integrations/mysql.ts b/packages/server/src/integrations/mysql.ts index f629381807..db3819f468 100644 --- a/packages/server/src/integrations/mysql.ts +++ b/packages/server/src/integrations/mysql.ts @@ -386,7 +386,17 @@ class MySQLIntegration extends Sql implements DatasourcePlus { try { const queryFn = (query: any) => this.internalQuery(query, { connect: false, disableCoercion: true }) - return await this.queryWithReturning(json, queryFn) + const processFn = (result: any) => { + if (json?.meta?.table && Array.isArray(result)) { + return this.convertJsonStringColumns( + json.meta.table, + result, + json.tableAliases + ) + } + return result + } + return await this.queryWithReturning(json, queryFn, processFn) } finally { await this.disconnect() } diff --git a/packages/server/src/integrations/oracle.ts b/packages/server/src/integrations/oracle.ts index 08f3058d63..83803906be 100644 --- a/packages/server/src/integrations/oracle.ts +++ b/packages/server/src/integrations/oracle.ts @@ -455,7 +455,7 @@ class OracleIntegration extends Sql implements DatasourcePlus { operation !== Operation.DELETE ) { const lastRow = await this.internalQuery({ - sql: `SELECT * FROM \"${json.endpoint.entityId}\" WHERE ROWID = '${response.lastRowid}'`, + sql: `SELECT * FROM "${json.endpoint.entityId}" WHERE ROWID = '${response.lastRowid}'`, }) return lastRow.rows as Row[] } else { diff --git a/packages/server/src/integrations/rest.ts b/packages/server/src/integrations/rest.ts index 44c62f60b7..5fa35cc667 100644 --- a/packages/server/src/integrations/rest.ts +++ b/packages/server/src/integrations/rest.ts @@ -283,7 +283,7 @@ class RestIntegration implements IntegrationBase { // content type defaults to plaintext input.body = string break - case BodyTypes.ENCODED: + case BodyTypes.ENCODED: { const params = new URLSearchParams() for (let [key, value] of Object.entries(object)) { params.append(key, value as string) @@ -293,7 +293,8 @@ class RestIntegration implements IntegrationBase { }) input.body = params break - case BodyTypes.FORM_DATA: + } + case BodyTypes.FORM_DATA: { const form = new FormData() for (let [key, value] of Object.entries(object)) { form.append(key, value) @@ -303,6 +304,7 @@ class RestIntegration implements IntegrationBase { }) input.body = form break + } case BodyTypes.XML: if (object != null && Object.keys(object).length) { string = new XmlBuilder().buildObject(object) diff --git a/packages/server/src/integrations/tests/airtable.spec.ts b/packages/server/src/integrations/tests/airtable.spec.ts index eeb3d65046..367e31e8a0 100644 --- a/packages/server/src/integrations/tests/airtable.spec.ts +++ b/packages/server/src/integrations/tests/airtable.spec.ts @@ -28,7 +28,7 @@ describe("Airtable Integration", () => { }) it("calls the create method with the correct params", async () => { - const response = await config.integration.create({ + await config.integration.create({ table: "test", json: {}, }) @@ -40,7 +40,7 @@ describe("Airtable Integration", () => { }) it("calls the read method with the correct params", async () => { - const response = await config.integration.read({ + await config.integration.read({ table: "test", view: "Grid view", }) @@ -51,7 +51,7 @@ describe("Airtable Integration", () => { }) it("calls the update method with the correct params", async () => { - const response = await config.integration.update({ + await config.integration.update({ table: "table", id: "123", json: { @@ -68,7 +68,7 @@ describe("Airtable Integration", () => { it("calls the delete method with the correct params", async () => { const ids = [1, 2, 3, 4] - const response = await config.integration.delete({ + await config.integration.delete({ ids, }) expect(config.client.destroy).toHaveBeenCalledWith(ids) diff --git a/packages/server/src/integrations/tests/arangodb.spec.ts b/packages/server/src/integrations/tests/arangodb.spec.ts index c7339299dd..6ac242d8db 100644 --- a/packages/server/src/integrations/tests/arangodb.spec.ts +++ b/packages/server/src/integrations/tests/arangodb.spec.ts @@ -12,7 +12,6 @@ class TestConfiguration { describe("ArangoDB Integration", () => { let config: any - let indexName = "Users" beforeEach(() => { config = new TestConfiguration() @@ -23,7 +22,7 @@ describe("ArangoDB Integration", () => { json: "Hello", } - const response = await config.integration.create(body) + await config.integration.create(body) expect(config.integration.client.query).toHaveBeenCalledWith( `INSERT Hello INTO collection RETURN NEW` ) @@ -33,7 +32,7 @@ describe("ArangoDB Integration", () => { const query = { sql: `test`, } - const response = await config.integration.read(query) + await config.integration.read(query) expect(config.integration.client.query).toHaveBeenCalledWith(query.sql) }) }) diff --git a/packages/server/src/integrations/tests/couchdb.spec.ts b/packages/server/src/integrations/tests/couchdb.spec.ts index 66735d7b74..f27713a81f 100644 --- a/packages/server/src/integrations/tests/couchdb.spec.ts +++ b/packages/server/src/integrations/tests/couchdb.spec.ts @@ -79,7 +79,7 @@ describe("CouchDB Integration", () => { it("calls the delete method with the correct params", async () => { const id = "1234" - const response = await config.integration.delete({ id }) + await config.integration.delete({ id }) expect(config.integration.client.get).toHaveBeenCalledWith(id) expect(config.integration.client.remove).toHaveBeenCalled() }) diff --git a/packages/server/src/integrations/tests/dynamodb.spec.ts b/packages/server/src/integrations/tests/dynamodb.spec.ts index a7a2767469..0215817907 100644 --- a/packages/server/src/integrations/tests/dynamodb.spec.ts +++ b/packages/server/src/integrations/tests/dynamodb.spec.ts @@ -19,7 +19,7 @@ describe("DynamoDB Integration", () => { }) it("calls the create method with the correct params", async () => { - const response = await config.integration.create({ + await config.integration.create({ table: tableName, json: { Name: "John", @@ -66,7 +66,7 @@ describe("DynamoDB Integration", () => { }) it("calls the get method with the correct params", async () => { - const response = await config.integration.get({ + await config.integration.get({ table: tableName, json: { Id: 123, @@ -80,7 +80,7 @@ describe("DynamoDB Integration", () => { }) it("calls the update method with the correct params", async () => { - const response = await config.integration.update({ + await config.integration.update({ table: tableName, json: { Name: "John", @@ -93,7 +93,7 @@ describe("DynamoDB Integration", () => { }) it("calls the delete method with the correct params", async () => { - const response = await config.integration.delete({ + await config.integration.delete({ table: tableName, json: { Name: "John", diff --git a/packages/server/src/integrations/tests/elasticsearch.spec.ts b/packages/server/src/integrations/tests/elasticsearch.spec.ts index e21e8dec69..f8a1dd8013 100644 --- a/packages/server/src/integrations/tests/elasticsearch.spec.ts +++ b/packages/server/src/integrations/tests/elasticsearch.spec.ts @@ -22,7 +22,7 @@ describe("Elasticsearch Integration", () => { const body = { name: "Hello", } - const response = await config.integration.create({ + await config.integration.create({ index: indexName, json: body, }) diff --git a/packages/server/src/integrations/tests/firebase.spec.ts b/packages/server/src/integrations/tests/firebase.spec.ts index f2cea8898f..c5c214d232 100644 --- a/packages/server/src/integrations/tests/firebase.spec.ts +++ b/packages/server/src/integrations/tests/firebase.spec.ts @@ -81,7 +81,7 @@ describe("Firebase Integration", () => { }) it("calls the delete method with the correct params", async () => { - const response = await config.integration.delete({ + await config.integration.delete({ table: tableName, json: { id: "test", diff --git a/packages/server/src/integrations/tests/googlesheets.spec.ts b/packages/server/src/integrations/tests/googlesheets.spec.ts index 7007693086..c6e073d602 100644 --- a/packages/server/src/integrations/tests/googlesheets.spec.ts +++ b/packages/server/src/integrations/tests/googlesheets.spec.ts @@ -109,9 +109,9 @@ describe("Google Sheets Integration", () => { sheetsByTitle[table.name] = sheet await integration.updateTable(table) - expect(sheet.loadHeaderRow).toBeCalledTimes(1) - expect(sheet.setHeaderRow).toBeCalledTimes(1) - expect(sheet.setHeaderRow).toBeCalledWith(tableColumns) + expect(sheet.loadHeaderRow).toHaveBeenCalledTimes(1) + expect(sheet.setHeaderRow).toHaveBeenCalledTimes(1) + expect(sheet.setHeaderRow).toHaveBeenCalledWith(tableColumns) }) }) @@ -127,9 +127,9 @@ describe("Google Sheets Integration", () => { await integration.updateTable(table) return sheet }) - expect(sheet.loadHeaderRow).toBeCalledTimes(1) - expect(sheet.setHeaderRow).toBeCalledTimes(1) - expect(sheet.setHeaderRow).toBeCalledWith(["name"]) + expect(sheet.loadHeaderRow).toHaveBeenCalledTimes(1) + expect(sheet.setHeaderRow).toHaveBeenCalledTimes(1) + expect(sheet.setHeaderRow).toHaveBeenCalledWith(["name"]) // No undefined are sent expect((sheet.setHeaderRow as any).mock.calls[0][0]).toHaveLength(1) @@ -148,7 +148,7 @@ describe("Google Sheets Integration", () => { const res = await integration.getTableNames() - expect(mockGoogleIntegration.loadInfo).toBeCalledTimes(1) + expect(mockGoogleIntegration.loadInfo).toHaveBeenCalledTimes(1) expect(res).toEqual(sheetNames) }) }) @@ -159,7 +159,7 @@ describe("Google Sheets Integration", () => { await config.doInContext(structures.uuid(), async () => { const res = await integration.testConnection() - expect(mockGoogleIntegration.loadInfo).toBeCalledTimes(1) + expect(mockGoogleIntegration.loadInfo).toHaveBeenCalledTimes(1) expect(res).toEqual({ connected: true }) }) }) diff --git a/packages/server/src/integrations/tests/microsoftSqlServer.spec.ts b/packages/server/src/integrations/tests/microsoftSqlServer.spec.ts deleted file mode 100644 index eaaa79f7c9..0000000000 --- a/packages/server/src/integrations/tests/microsoftSqlServer.spec.ts +++ /dev/null @@ -1,57 +0,0 @@ -import { default as MSSQLIntegration } from "../microsoftSqlServer" - -jest.mock("mssql") - -class TestConfiguration { - integration: any - - constructor(config: any = {}) { - this.integration = new MSSQLIntegration.integration(config) - } -} - -describe("MS SQL Server Integration", () => { - let config: any - - beforeEach(async () => { - config = new TestConfiguration() - }) - - describe("check sql used", () => { - beforeEach(async () => { - await config.integration.connect() - }) - - it("calls the create method with the correct params", async () => { - const sql = "insert into users (name, age) values ('Joe', 123);" - const response = await config.integration.create({ - sql, - }) - expect(config.integration.client.request).toHaveBeenCalledWith() - expect(response[0]).toEqual(sql) - }) - - it("calls the read method with the correct params", async () => { - const sql = "select * from users;" - const response = await config.integration.read({ - sql, - }) - expect(config.integration.client.request).toHaveBeenCalledWith() - expect(response[0]).toEqual(sql) - }) - }) - - describe("no rows returned", () => { - beforeEach(async () => { - await config.integration.connect() - }) - - it("returns the correct response when the create response has no rows", async () => { - const sql = "insert into users (name, age) values ('Joe', 123);" - const response = await config.integration.create({ - sql, - }) - expect(response[0]).toEqual(sql) - }) - }) -}) diff --git a/packages/server/src/integrations/tests/mongo.spec.ts b/packages/server/src/integrations/tests/mongo.spec.ts deleted file mode 100644 index 93e54c7bc7..0000000000 --- a/packages/server/src/integrations/tests/mongo.spec.ts +++ /dev/null @@ -1,337 +0,0 @@ -const mongo = require("mongodb") - -import { default as MongoDBIntegration } from "../mongodb" - -jest.mock("mongodb") - -class TestConfiguration { - integration: any - - constructor(config: any = {}) { - this.integration = new MongoDBIntegration.integration(config) - } -} - -function disableConsole() { - jest.spyOn(console, "error") - // @ts-ignore - console.error.mockImplementation(() => {}) - - // @ts-ignore - return console.error.mockRestore -} - -describe("MongoDB Integration", () => { - let config: any - let indexName = "Users" - - beforeEach(() => { - config = new TestConfiguration() - }) - - it("calls the create method with the correct params", async () => { - const body = { - name: "Hello", - } - await config.integration.create({ - index: indexName, - json: body, - extra: { collection: "testCollection", actionType: "insertOne" }, - }) - expect(config.integration.client.insertOne).toHaveBeenCalledWith(body) - }) - - it("calls the read method with the correct params", async () => { - const query = { - json: { - address: "test", - }, - extra: { collection: "testCollection", actionType: "find" }, - } - const response = await config.integration.read(query) - expect(config.integration.client.find).toHaveBeenCalledWith(query.json) - expect(response).toEqual(expect.any(Array)) - }) - - it("calls the delete method with the correct params", async () => { - const query = { - json: { - filter: { - id: "test", - }, - options: { - opt: "option", - }, - }, - extra: { collection: "testCollection", actionType: "deleteOne" }, - } - await config.integration.delete(query) - expect(config.integration.client.deleteOne).toHaveBeenCalledWith( - query.json.filter, - query.json.options - ) - }) - - it("calls the update method with the correct params", async () => { - const query = { - json: { - filter: { - id: "test", - }, - update: { - name: "TestName", - }, - options: { - upsert: false, - }, - }, - extra: { collection: "testCollection", actionType: "updateOne" }, - } - await config.integration.update(query) - expect(config.integration.client.updateOne).toHaveBeenCalledWith( - query.json.filter, - query.json.update, - query.json.options - ) - }) - - it("throws an error when an invalid query.extra.actionType is passed for each method", async () => { - const restore = disableConsole() - - const query = { - extra: { collection: "testCollection", actionType: "deleteOne" }, - } - - let error = null - try { - await config.integration.read(query) - } catch (err) { - error = err - } - expect(error).toBeDefined() - restore() - }) - - it("creates ObjectIds if the field contains a match on ObjectId", async () => { - const query = { - json: { - filter: { - _id: "ObjectId('ACBD12345678ABCD12345678')", - name: "ObjectId('BBBB12345678ABCD12345678')", - }, - update: { - _id: "ObjectId('FFFF12345678ABCD12345678')", - name: "ObjectId('CCCC12345678ABCD12345678')", - }, - options: { - upsert: false, - }, - }, - extra: { collection: "testCollection", actionType: "updateOne" }, - } - await config.integration.update(query) - expect(config.integration.client.updateOne).toHaveBeenCalled() - - const args = config.integration.client.updateOne.mock.calls[0] - expect(args[0]).toEqual({ - _id: mongo.ObjectId.createFromHexString("ACBD12345678ABCD12345678"), - name: mongo.ObjectId.createFromHexString("BBBB12345678ABCD12345678"), - }) - expect(args[1]).toEqual({ - _id: mongo.ObjectId.createFromHexString("FFFF12345678ABCD12345678"), - name: mongo.ObjectId.createFromHexString("CCCC12345678ABCD12345678"), - }) - expect(args[2]).toEqual({ - upsert: false, - }) - }) - - it("creates ObjectIds if the $ operator fields contains a match on ObjectId", async () => { - const query = { - json: { - filter: { - _id: { - $eq: "ObjectId('ACBD12345678ABCD12345678')", - }, - }, - update: { - $set: { - _id: "ObjectId('FFFF12345678ABCD12345678')", - }, - }, - options: { - upsert: true, - }, - }, - extra: { collection: "testCollection", actionType: "updateOne" }, - } - await config.integration.update(query) - expect(config.integration.client.updateOne).toHaveBeenCalled() - - const args = config.integration.client.updateOne.mock.calls[0] - expect(args[0]).toEqual({ - _id: { - $eq: mongo.ObjectId.createFromHexString("ACBD12345678ABCD12345678"), - }, - }) - expect(args[1]).toEqual({ - $set: { - _id: mongo.ObjectId.createFromHexString("FFFF12345678ABCD12345678"), - }, - }) - expect(args[2]).toEqual({ - upsert: true, - }) - }) - - it("supports findOneAndUpdate", async () => { - const query = { - json: { - filter: { - _id: { - $eq: "ObjectId('ACBD12345678ABCD12345678')", - }, - }, - update: { - $set: { - name: "UPDATED", - age: 99, - }, - }, - options: { - upsert: false, - }, - }, - extra: { collection: "testCollection", actionType: "findOneAndUpdate" }, - } - await config.integration.read(query) - expect(config.integration.client.findOneAndUpdate).toHaveBeenCalled() - - const args = config.integration.client.findOneAndUpdate.mock.calls[0] - expect(args[0]).toEqual({ - _id: { - $eq: mongo.ObjectId.createFromHexString("ACBD12345678ABCD12345678"), - }, - }) - expect(args[1]).toEqual({ - $set: { - name: "UPDATED", - age: 99, - }, - }) - expect(args[2]).toEqual({ - upsert: false, - includeResultMetadata: true, - }) - }) - - it("can parse nested objects with arrays", async () => { - const query = { - json: `{ - "_id": { - "$eq": "ObjectId('ACBD12345678ABCD12345678')" - } - }, - { - "$set": { - "value": { - "data": [ - { "cid": 1 }, - { "cid": 2 }, - { "nested": { - "name": "test" - }} - ] - } - } - }, - { - "upsert": true - }`, - extra: { collection: "testCollection", actionType: "updateOne" }, - } - await config.integration.update(query) - expect(config.integration.client.updateOne).toHaveBeenCalled() - - const args = config.integration.client.updateOne.mock.calls[0] - expect(args[0]).toEqual({ - _id: { - $eq: mongo.ObjectId.createFromHexString("ACBD12345678ABCD12345678"), - }, - }) - expect(args[1]).toEqual({ - $set: { - value: { - data: [ - { cid: 1 }, - { cid: 2 }, - { - nested: { - name: "test", - }, - }, - ], - }, - }, - }) - expect(args[2]).toEqual({ - upsert: true, - }) - }) - - it("ignores braces within strings when parsing nested objects", async () => { - const query = { - json: `{ - "_id": { - "$eq": "ObjectId('ACBD12345678ABCD12345678')" - } - }, - { - "$set": { - "value": { - "data": [ - { "cid": 1 }, - { "cid": 2 }, - { "nested": { - "name": "te}st" - }} - ] - } - } - }, - { - "upsert": true, - "extra": "ad\\"{\\"d" - }`, - extra: { collection: "testCollection", actionType: "updateOne" }, - } - await config.integration.update(query) - expect(config.integration.client.updateOne).toHaveBeenCalled() - - const args = config.integration.client.updateOne.mock.calls[0] - expect(args[0]).toEqual({ - _id: { - $eq: mongo.ObjectId.createFromHexString("ACBD12345678ABCD12345678"), - }, - }) - expect(args[1]).toEqual({ - $set: { - value: { - data: [ - { cid: 1 }, - { cid: 2 }, - { - nested: { - name: "te}st", - }, - }, - ], - }, - }, - }) - expect(args[2]).toEqual({ - upsert: true, - extra: 'ad"{"d', - }) - }) -}) diff --git a/packages/server/src/integrations/tests/mysql.spec.ts b/packages/server/src/integrations/tests/mysql.spec.ts deleted file mode 100644 index 7d45a06735..0000000000 --- a/packages/server/src/integrations/tests/mysql.spec.ts +++ /dev/null @@ -1,152 +0,0 @@ -import { default as MySQLIntegration, bindingTypeCoerce } from "../mysql" - -jest.mock("mysql2") - -class TestConfiguration { - integration: any - - constructor(config: any = { ssl: {} }) { - this.integration = new MySQLIntegration.integration(config) - } -} - -describe("MySQL Integration", () => { - let config: any - - beforeEach(() => { - config = new TestConfiguration() - }) - - it("calls the create method with the correct params", async () => { - const sql = "insert into users (name, age) values ('Joe', 123);" - await config.integration.create({ - sql, - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, []) - }) - - it("calls the read method with the correct params", async () => { - const sql = "select * from users;" - await config.integration.read({ - sql, - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, []) - }) - - it("calls the update method with the correct params", async () => { - const sql = "update table users set name = 'test';" - await config.integration.update({ - sql, - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, []) - }) - - it("calls the delete method with the correct params", async () => { - const sql = "delete from users where name = 'todelete';" - await config.integration.delete({ - sql, - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, []) - }) - - describe("no rows returned", () => { - it("returns the correct response when the create response has no rows", async () => { - const sql = "insert into users (name, age) values ('Joe', 123);" - const response = await config.integration.create({ - sql, - }) - expect(response).toEqual([{ created: true }]) - }) - - it("returns the correct response when the update response has no rows", async () => { - const sql = "update table users set name = 'test';" - const response = await config.integration.update({ - sql, - }) - expect(response).toEqual([{ updated: true }]) - }) - - it("returns the correct response when the delete response has no rows", async () => { - const sql = "delete from users where name = 'todelete';" - const response = await config.integration.delete({ - sql, - }) - expect(response).toEqual([{ deleted: true }]) - }) - }) - - describe("binding type coerce", () => { - it("ignores non-string types ", async () => { - const sql = "select * from users;" - const date = new Date() - await config.integration.read({ - sql, - bindings: [11, date, ["a", "b", "c"], { id: 1 }], - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, [ - 11, - date, - ["a", "b", "c"], - { id: 1 }, - ]) - }) - - it("parses strings matching a number regex", async () => { - const sql = "select * from users;" - await config.integration.read({ - sql, - bindings: ["101", "3.14"], - }) - expect(config.integration.client.query).toHaveBeenCalledWith( - sql, - [101, 3.14] - ) - }) - - it.skip("parses strings matching a valid date format", async () => { - const sql = "select * from users;" - await config.integration.read({ - sql, - bindings: [ - "2001-10-30", - "2010-09-01T13:30:59.123Z", - "2021-02-05 12:01 PM", - ], - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, [ - new Date("2001-10-30T00:00:00.000Z"), - new Date("2010-09-01T13:30:59.123Z"), - new Date("2021-02-05T12:01:00.000Z"), - ]) - }) - - it("does not parse string matching a valid array of numbers as date", async () => { - const sql = "select * from users;" - await config.integration.read({ - sql, - bindings: ["1,2,2017"], - }) - expect(config.integration.client.query).toHaveBeenCalledWith(sql, [ - "1,2,2017", - ]) - }) - }) -}) - -describe("bindingTypeCoercion", () => { - it("shouldn't coerce something that looks like a date", () => { - const response = bindingTypeCoerce(["202205-1500"]) - expect(response[0]).toBe("202205-1500") - }) - - it("should coerce an actual date", () => { - const date = new Date("2023-06-13T14:24:22.620Z") - const response = bindingTypeCoerce(["2023-06-13T14:24:22.620Z"]) - expect(response[0]).toEqual(date) - }) - - it("should coerce numbers", () => { - const response = bindingTypeCoerce(["0"]) - expect(response[0]).toEqual(0) - }) -}) diff --git a/packages/server/src/integrations/tests/oracle.spec.ts b/packages/server/src/integrations/tests/oracle.spec.ts index 8c05a881d4..7b620d68ad 100644 --- a/packages/server/src/integrations/tests/oracle.spec.ts +++ b/packages/server/src/integrations/tests/oracle.spec.ts @@ -22,11 +22,6 @@ describe("Oracle Integration", () => { config = new TestConfiguration() }) - afterEach(() => { - expect(oracledb.closeMock).toHaveBeenCalled() - expect(oracledb.closeMock).toHaveBeenCalledTimes(1) - }) - it("calls the create method with the correct params", async () => { const sql = "insert into users (name, age) values ('Joe', 123);" await config.integration.create({ @@ -34,6 +29,7 @@ describe("Oracle Integration", () => { }) expect(oracledb.executeMock).toHaveBeenCalledWith(sql, [], options) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) it("calls the read method with the correct params", async () => { @@ -43,15 +39,17 @@ describe("Oracle Integration", () => { }) expect(oracledb.executeMock).toHaveBeenCalledWith(sql, [], options) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) it("calls the update method with the correct params", async () => { const sql = "update table users set name = 'test';" - const response = await config.integration.update({ + await config.integration.update({ sql, }) expect(oracledb.executeMock).toHaveBeenCalledWith(sql, [], options) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) it("calls the delete method with the correct params", async () => { @@ -61,6 +59,7 @@ describe("Oracle Integration", () => { }) expect(oracledb.executeMock).toHaveBeenCalledWith(sql, [], options) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) describe("no rows returned", () => { @@ -75,6 +74,7 @@ describe("Oracle Integration", () => { }) expect(response).toEqual([{ created: true }]) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) it("returns the correct response when the update response has no rows", async () => { @@ -84,6 +84,7 @@ describe("Oracle Integration", () => { }) expect(response).toEqual([{ updated: true }]) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) it("returns the correct response when the delete response has no rows", async () => { @@ -93,6 +94,7 @@ describe("Oracle Integration", () => { }) expect(response).toEqual([{ deleted: true }]) expect(oracledb.executeMock).toHaveBeenCalledTimes(1) + expect(oracledb.closeMock).toHaveBeenCalledTimes(1) }) }) }) diff --git a/packages/server/src/integrations/tests/postgres.spec.ts b/packages/server/src/integrations/tests/postgres.spec.ts deleted file mode 100644 index 1acdff6bcf..0000000000 --- a/packages/server/src/integrations/tests/postgres.spec.ts +++ /dev/null @@ -1,83 +0,0 @@ -const pg = require("pg") - -import { default as PostgresIntegration } from "../postgres" - -jest.mock("pg") - -class TestConfiguration { - integration: any - - constructor(config: any = {}) { - this.integration = new PostgresIntegration.integration(config) - } -} - -describe("Postgres Integration", () => { - let config: any - - beforeEach(() => { - config = new TestConfiguration() - }) - - it("calls the create method with the correct params", async () => { - const sql = "insert into users (name, age) values ('Joe', 123);" - await config.integration.create({ - sql, - }) - expect(pg.queryMock).toHaveBeenCalledWith(sql, []) - }) - - it("calls the read method with the correct params", async () => { - const sql = "select * from users;" - await config.integration.read({ - sql, - }) - expect(pg.queryMock).toHaveBeenCalledWith(sql, []) - }) - - it("calls the update method with the correct params", async () => { - const sql = "update table users set name = 'test';" - const response = await config.integration.update({ - sql, - }) - expect(pg.queryMock).toHaveBeenCalledWith(sql, []) - }) - - it("calls the delete method with the correct params", async () => { - const sql = "delete from users where name = 'todelete';" - await config.integration.delete({ - sql, - }) - expect(pg.queryMock).toHaveBeenCalledWith(sql, []) - }) - - describe("no rows returned", () => { - beforeEach(() => { - pg.queryMock.mockImplementation(() => ({ rows: [] })) - }) - - it("returns the correct response when the create response has no rows", async () => { - const sql = "insert into users (name, age) values ('Joe', 123);" - const response = await config.integration.create({ - sql, - }) - expect(response).toEqual([{ created: true }]) - }) - - it("returns the correct response when the update response has no rows", async () => { - const sql = "update table users set name = 'test';" - const response = await config.integration.update({ - sql, - }) - expect(response).toEqual([{ updated: true }]) - }) - - it("returns the correct response when the delete response has no rows", async () => { - const sql = "delete from users where name = 'todelete';" - const response = await config.integration.delete({ - sql, - }) - expect(response).toEqual([{ deleted: true }]) - }) - }) -}) diff --git a/packages/server/src/integrations/tests/rest.spec.ts b/packages/server/src/integrations/tests/rest.spec.ts index bc0c0cac2f..3335f44a7b 100644 --- a/packages/server/src/integrations/tests/rest.spec.ts +++ b/packages/server/src/integrations/tests/rest.spec.ts @@ -70,7 +70,7 @@ describe("REST Integration", () => { Accept: "text/html", }, } - const response = await config.integration.read(query) + await config.integration.read(query) expect(fetch).toHaveBeenCalledWith(`${BASE_URL}/api?test=1`, { headers: { Accept: "text/html", @@ -91,7 +91,7 @@ describe("REST Integration", () => { name: "test", }), } - const response = await config.integration.update(query) + await config.integration.update(query) expect(fetch).toHaveBeenCalledWith(`${BASE_URL}/api?test=1`, { method: "PUT", body: '{"name":"test"}', @@ -111,7 +111,7 @@ describe("REST Integration", () => { name: "test", }), } - const response = await config.integration.delete(query) + await config.integration.delete(query) expect(fetch).toHaveBeenCalledWith(`${BASE_URL}/api?test=1`, { method: "DELETE", headers: HEADERS, @@ -418,9 +418,9 @@ describe("REST Integration", () => { }) // @ts-ignore const sentData = fetch.mock.calls[0][1].body - expect(sentData.has(pageParam)) + expect(sentData.has(pageParam)).toEqual(true) expect(sentData.get(pageParam)).toEqual(pageValue.toString()) - expect(sentData.has(sizeParam)) + expect(sentData.has(pageParam)).toEqual(true) expect(sentData.get(sizeParam)).toEqual(sizeValue.toString()) }) }) @@ -551,9 +551,9 @@ describe("REST Integration", () => { }) // @ts-ignore const sentData = fetch.mock.calls[0][1].body - expect(sentData.has(pageParam)) + expect(sentData.has(pageParam)).toEqual(true) expect(sentData.get(pageParam)).toEqual(pageValue.toString()) - expect(sentData.has(sizeParam)) + expect(sentData.has(pageParam)).toEqual(true) expect(sentData.get(sizeParam)).toEqual(sizeValue.toString()) expect(res.pagination.cursor).toEqual(123) }) diff --git a/packages/server/src/integrations/tests/s3.spec.ts b/packages/server/src/integrations/tests/s3.spec.ts index b4b2ad76e7..b75340ab20 100644 --- a/packages/server/src/integrations/tests/s3.spec.ts +++ b/packages/server/src/integrations/tests/s3.spec.ts @@ -1,5 +1,3 @@ -const AWS = require("aws-sdk") - import { default as S3Integration } from "../s3" jest.mock("aws-sdk") @@ -79,7 +77,7 @@ describe("S3 Integration", () => { }) }) - it("calls the delete method with the correct params ", async () => { + it("calls the delete method with the correct params", async () => { await config.integration.delete({ bucket: "test", delete: `{ diff --git a/packages/server/src/integrations/tests/sql.spec.ts b/packages/server/src/integrations/tests/sql.spec.ts index f4eaf2859c..c0b92b3849 100644 --- a/packages/server/src/integrations/tests/sql.spec.ts +++ b/packages/server/src/integrations/tests/sql.spec.ts @@ -342,25 +342,6 @@ describe("SQL query builder", () => { }) }) - it("should use greater than when only low range specified", () => { - const date = new Date() - const query = sql._query( - generateReadJson({ - filters: { - range: { - property: { - low: date, - }, - }, - }, - }) - ) - expect(query).toEqual({ - bindings: [date, limit], - sql: `select * from (select * from "${TABLE_NAME}" where "${TABLE_NAME}"."property" > $1 limit $2) as "${TABLE_NAME}"`, - }) - }) - it("should use AND like expression for MS-SQL when filter is contains", () => { const query = new Sql(SqlClient.MS_SQL, 10)._query( generateReadJson({ @@ -408,7 +389,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: [10], - sql: `select * from (select * from \"${TABLE_NAME}\" where \"${TABLE_NAME}\".\"age\"::jsonb @> '[20]' and \"${TABLE_NAME}\".\"name\"::jsonb @> '["John"]' limit $1) as \"${TABLE_NAME}\"`, + sql: `select * from (select * from "${TABLE_NAME}" where "${TABLE_NAME}"."age"::jsonb @> '[20]' and "${TABLE_NAME}"."name"::jsonb @> '["John"]' limit $1) as "${TABLE_NAME}"`, }) }) @@ -459,7 +440,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: [10], - sql: `select * from (select * from \"${TABLE_NAME}\" where NOT \"${TABLE_NAME}\".\"age\"::jsonb @> '[20]' and NOT \"${TABLE_NAME}\".\"name\"::jsonb @> '["John"]' limit $1) as \"${TABLE_NAME}\"`, + sql: `select * from (select * from "${TABLE_NAME}" where NOT "${TABLE_NAME}"."age"::jsonb @> '[20]' and NOT "${TABLE_NAME}"."name"::jsonb @> '["John"]' limit $1) as "${TABLE_NAME}"`, }) }) @@ -510,7 +491,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: [10], - sql: `select * from (select * from \"${TABLE_NAME}\" where \"${TABLE_NAME}\".\"age\"::jsonb ?| array [20,25] and \"${TABLE_NAME}\".\"name\"::jsonb ?| array ['John','Mary'] limit $1) as \"${TABLE_NAME}\"`, + sql: `select * from (select * from "${TABLE_NAME}" where "${TABLE_NAME}"."age"::jsonb ?| array [20,25] and "${TABLE_NAME}"."name"::jsonb ?| array ['John','Mary'] limit $1) as "${TABLE_NAME}"`, }) }) @@ -591,7 +572,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: ["2000-01-01 00:00:00", 500], - sql: `select * from (select * from \"${TABLE_NAME}\" where \"${TABLE_NAME}\".\"dob\" > $1 limit $2) as \"${TABLE_NAME}\"`, + sql: `select * from (select * from "${TABLE_NAME}" where "${TABLE_NAME}"."dob" > $1 limit $2) as "${TABLE_NAME}"`, }) }) @@ -610,7 +591,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: ["2010-01-01 00:00:00", 500], - sql: `select * from (select * from \"${TABLE_NAME}\" where \"${TABLE_NAME}\".\"dob\" < $1 limit $2) as \"${TABLE_NAME}\"`, + sql: `select * from (select * from "${TABLE_NAME}" where "${TABLE_NAME}"."dob" < $1 limit $2) as "${TABLE_NAME}"`, }) }) @@ -626,7 +607,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: ["john%", limit], - sql: `select * from (select * from (select * from \"test\" where LOWER(\"test\".\"name\") LIKE :1) where rownum <= :2) \"test\"`, + sql: `select * from (select * from (select * from "test" where LOWER("test"."name") LIKE :1) where rownum <= :2) "test"`, }) query = new Sql(SqlClient.ORACLE, limit)._query( @@ -641,7 +622,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: ["%20%", "%25%", `%"john"%`, `%"mary"%`, limit], - sql: `select * from (select * from (select * from \"test\" where (LOWER(\"test\".\"age\") LIKE :1 AND LOWER(\"test\".\"age\") LIKE :2) and (LOWER(\"test\".\"name\") LIKE :3 AND LOWER(\"test\".\"name\") LIKE :4)) where rownum <= :5) \"test\"`, + sql: `select * from (select * from (select * from "test" where (LOWER("test"."age") LIKE :1 AND LOWER("test"."age") LIKE :2) and (LOWER("test"."name") LIKE :3 AND LOWER("test"."name") LIKE :4)) where rownum <= :5) "test"`, }) query = new Sql(SqlClient.ORACLE, limit)._query( @@ -655,7 +636,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: [`%jo%`, limit], - sql: `select * from (select * from (select * from \"test\" where LOWER(\"test\".\"name\") LIKE :1) where rownum <= :2) \"test\"`, + sql: `select * from (select * from (select * from "test" where LOWER("test"."name") LIKE :1) where rownum <= :2) "test"`, }) }) @@ -682,7 +663,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: ['{ "created_at":"2023-09-09T03:21:06.024Z" }'], - sql: `insert into \"test\" (\"name\") values ($1) returning *`, + sql: `insert into "test" ("name") values ($1) returning *`, }) }) @@ -695,7 +676,7 @@ describe("SQL query builder", () => { ) expect(query).toEqual({ bindings: [dateObj], - sql: `insert into \"test\" (\"name\") values ($1) returning *`, + sql: `insert into "test" ("name") values ($1) returning *`, }) }) diff --git a/packages/server/src/integrations/tests/sqlAlias.spec.ts b/packages/server/src/integrations/tests/sqlAlias.spec.ts index dd82dadac0..ccb164bcfd 100644 --- a/packages/server/src/integrations/tests/sqlAlias.spec.ts +++ b/packages/server/src/integrations/tests/sqlAlias.spec.ts @@ -294,7 +294,7 @@ describe("Captures of real examples", () => { type: "datasource", isSQL: false, }) - ) + ).toEqual(false) }) it("should disable when no fields", () => { diff --git a/packages/server/src/integrations/tests/utils/index.ts b/packages/server/src/integrations/tests/utils/index.ts index b6e4e43e7a..b2be3df4e0 100644 --- a/packages/server/src/integrations/tests/utils/index.ts +++ b/packages/server/src/integrations/tests/utils/index.ts @@ -4,6 +4,8 @@ import { Datasource } from "@budibase/types" import * as postgres from "./postgres" import * as mongodb from "./mongodb" import * as mysql from "./mysql" +import * as mssql from "./mssql" +import * as mariadb from "./mariadb" import { StartedTestContainer } from "testcontainers" jest.setTimeout(30000) @@ -14,4 +16,10 @@ export interface DatabaseProvider { datasource(): Promise } -export const databaseTestProviders = { postgres, mongodb, mysql } +export const databaseTestProviders = { + postgres, + mongodb, + mysql, + mssql, + mariadb, +} diff --git a/packages/server/src/integrations/tests/utils/mariadb.ts b/packages/server/src/integrations/tests/utils/mariadb.ts new file mode 100644 index 0000000000..a097e0aaa1 --- /dev/null +++ b/packages/server/src/integrations/tests/utils/mariadb.ts @@ -0,0 +1,58 @@ +import { Datasource, SourceName } from "@budibase/types" +import { GenericContainer, Wait, StartedTestContainer } from "testcontainers" +import { AbstractWaitStrategy } from "testcontainers/build/wait-strategies/wait-strategy" + +let container: StartedTestContainer | undefined + +class MariaDBWaitStrategy extends AbstractWaitStrategy { + async waitUntilReady(container: any, boundPorts: any, startTime?: Date) { + // Because MariaDB first starts itself up, runs an init script, then restarts, + // it's possible for the mysqladmin ping to succeed early and then tests to + // run against a MariaDB that's mid-restart and fail. To get around this, we + // wait for logs and then do a ping check. + + const logs = Wait.forLogMessage("mariadbd: ready for connections", 2) + await logs.waitUntilReady(container, boundPorts, startTime) + + const command = Wait.forSuccessfulCommand( + `mysqladmin ping -h localhost -P 3306 -u root -ppassword` + ) + await command.waitUntilReady(container) + } +} + +export async function start(): Promise { + return await new GenericContainer("mariadb:lts") + .withExposedPorts(3306) + .withEnvironment({ MARIADB_ROOT_PASSWORD: "password" }) + .withWaitStrategy(new MariaDBWaitStrategy()) + .start() +} + +export async function datasource(): Promise { + if (!container) { + container = await start() + } + const host = container.getHost() + const port = container.getMappedPort(3306) + + return { + type: "datasource_plus", + source: SourceName.MYSQL, + plus: true, + config: { + host, + port, + user: "root", + password: "password", + database: "mysql", + }, + } +} + +export async function stop() { + if (container) { + await container.stop() + container = undefined + } +} diff --git a/packages/server/src/integrations/tests/utils/mssql.ts b/packages/server/src/integrations/tests/utils/mssql.ts new file mode 100644 index 0000000000..6bd4290a90 --- /dev/null +++ b/packages/server/src/integrations/tests/utils/mssql.ts @@ -0,0 +1,56 @@ +import { Datasource, SourceName } from "@budibase/types" +import { GenericContainer, Wait, StartedTestContainer } from "testcontainers" + +let container: StartedTestContainer | undefined + +export async function start(): Promise { + return await new GenericContainer( + "mcr.microsoft.com/mssql/server:2022-latest" + ) + .withExposedPorts(1433) + .withEnvironment({ + ACCEPT_EULA: "Y", + MSSQL_SA_PASSWORD: "Password_123", + // This is important, as Microsoft allow us to use the "Developer" edition + // of SQL Server for development and testing purposes. We can't use other + // versions without a valid license, and we cannot use the Developer + // version in production. + MSSQL_PID: "Developer", + }) + .withWaitStrategy( + Wait.forSuccessfulCommand( + "/opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P Password_123 -q 'SELECT 1'" + ) + ) + .start() +} + +export async function datasource(): Promise { + if (!container) { + container = await start() + } + const host = container.getHost() + const port = container.getMappedPort(1433) + + return { + type: "datasource_plus", + source: SourceName.SQL_SERVER, + plus: true, + config: { + server: host, + port, + user: "sa", + password: "Password_123", + options: { + encrypt: false, + }, + }, + } +} + +export async function stop() { + if (container) { + await container.stop() + container = undefined + } +} diff --git a/packages/server/src/integrations/utils.ts b/packages/server/src/integrations/utils.ts index 91966658a6..f73f522357 100644 --- a/packages/server/src/integrations/utils.ts +++ b/packages/server/src/integrations/utils.ts @@ -330,7 +330,7 @@ function copyExistingPropsOver( const existingTableSchema = entities[tableName].schema for (let key in existingTableSchema) { - if (!existingTableSchema.hasOwnProperty(key)) { + if (!Object.prototype.hasOwnProperty.call(existingTableSchema, key)) { continue } const column = existingTableSchema[key] diff --git a/packages/server/src/jsRunner/bundles/index-helpers.ivm.bundle.js b/packages/server/src/jsRunner/bundles/index-helpers.ivm.bundle.js index ff8d7265c6..55af2db6e2 100644 --- a/packages/server/src/jsRunner/bundles/index-helpers.ivm.bundle.js +++ b/packages/server/src/jsRunner/bundles/index-helpers.ivm.bundle.js @@ -1,4 +1,4 @@ -"use strict";var helpers=(()=>{var hn=Object.create;var Se=Object.defineProperty;var pn=Object.getOwnPropertyDescriptor;var mn=Object.getOwnPropertyNames;var gn=Object.getPrototypeOf,yn=Object.prototype.hasOwnProperty;var fe=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(t,r)=>(typeof require<"u"?require:t)[r]}):e)(function(e){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+e+'" is not supported')});var Z=(e,t)=>()=>(e&&(t=e(e=0)),t);var U=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),yt=(e,t)=>{for(var r in t)Se(e,r,{get:t[r],enumerable:!0})},vt=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of mn(t))!yn.call(e,i)&&i!==r&&Se(e,i,{get:()=>t[i],enumerable:!(n=pn(t,i))||n.enumerable});return e};var Ne=(e,t,r)=>(r=e!=null?hn(gn(e)):{},vt(t||!e||!e.__esModule?Se(r,"default",{value:e,enumerable:!0}):r,e)),$t=e=>vt(Se({},"__esModule",{value:!0}),e);var bt=U((qe,Ye)=>{(function(e,t){typeof qe=="object"&&typeof Ye<"u"?Ye.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs=t()})(qe,function(){"use strict";var e=1e3,t=6e4,r=36e5,n="millisecond",i="second",u="minute",s="hour",f="day",w="week",g="month",l="quarter",x="year",v="date",a="Invalid Date",T=/^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/,E=/\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g,I={name:"en",weekdays:"Sunday_Monday_Tuesday_Wednesday_Thursday_Friday_Saturday".split("_"),months:"January_February_March_April_May_June_July_August_September_October_November_December".split("_"),ordinal:function($){var h=["th","st","nd","rd"],c=$%100;return"["+$+(h[(c-20)%10]||h[c]||h[0])+"]"}},Y=function($,h,c){var b=String($);return!b||b.length>=h?$:""+Array(h+1-b.length).join(c)+$},F={s:Y,z:function($){var h=-$.utcOffset(),c=Math.abs(h),b=Math.floor(c/60),d=c%60;return(h<=0?"+":"-")+Y(b,2,"0")+":"+Y(d,2,"0")},m:function $(h,c){if(h.date()1)return $(j[0])}else{var _=h.name;S[_]=h,d=_}return!b&&d&&(q=d),d||!b&&q},N=function($,h){if(o($))return $.clone();var c=typeof h=="object"?h:{};return c.date=$,c.args=arguments,new B(c)},O=F;O.l=D,O.i=o,O.w=function($,h){return N($,{locale:h.$L,utc:h.$u,x:h.$x,$offset:h.$offset})};var B=function(){function $(c){this.$L=D(c.locale,null,!0),this.parse(c),this.$x=this.$x||c.x||{},this[p]=!0}var h=$.prototype;return h.parse=function(c){this.$d=function(b){var d=b.date,M=b.utc;if(d===null)return new Date(NaN);if(O.u(d))return new Date;if(d instanceof Date)return new Date(d);if(typeof d=="string"&&!/Z$/i.test(d)){var j=d.match(T);if(j){var _=j[2]-1||0,H=(j[7]||"0").substring(0,3);return M?new Date(Date.UTC(j[1],_,j[3]||1,j[4]||0,j[5]||0,j[6]||0,H)):new Date(j[1],_,j[3]||1,j[4]||0,j[5]||0,j[6]||0,H)}}return new Date(d)}(c),this.init()},h.init=function(){var c=this.$d;this.$y=c.getFullYear(),this.$M=c.getMonth(),this.$D=c.getDate(),this.$W=c.getDay(),this.$H=c.getHours(),this.$m=c.getMinutes(),this.$s=c.getSeconds(),this.$ms=c.getMilliseconds()},h.$utils=function(){return O},h.isValid=function(){return this.$d.toString()!==a},h.isSame=function(c,b){var d=N(c);return this.startOf(b)<=d&&d<=this.endOf(b)},h.isAfter=function(c,b){return N(c){(function(e,t){typeof Ce=="object"&&typeof Ee<"u"?Ee.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_duration=t()})(Ce,function(){"use strict";var e,t,r=1e3,n=6e4,i=36e5,u=864e5,s=/\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g,f=31536e6,w=2628e6,g=/^(-|\+)?P(?:([-+]?[0-9,.]*)Y)?(?:([-+]?[0-9,.]*)M)?(?:([-+]?[0-9,.]*)W)?(?:([-+]?[0-9,.]*)D)?(?:T(?:([-+]?[0-9,.]*)H)?(?:([-+]?[0-9,.]*)M)?(?:([-+]?[0-9,.]*)S)?)?$/,l={years:f,months:w,days:u,hours:i,minutes:n,seconds:r,milliseconds:1,weeks:6048e5},x=function(S){return S instanceof F},v=function(S,p,o){return new F(S,o,p.$l)},a=function(S){return t.p(S)+"s"},T=function(S){return S<0},E=function(S){return T(S)?Math.ceil(S):Math.floor(S)},I=function(S){return Math.abs(S)},Y=function(S,p){return S?T(S)?{negative:!0,format:""+I(S)+p}:{negative:!1,format:""+S+p}:{negative:!1,format:""}},F=function(){function S(o,D,N){var O=this;if(this.$d={},this.$l=N,o===void 0&&(this.$ms=0,this.parseFromMilliseconds()),D)return v(o*l[a(D)],this);if(typeof o=="number")return this.$ms=o,this.parseFromMilliseconds(),this;if(typeof o=="object")return Object.keys(o).forEach(function($){O.$d[a($)]=o[$]}),this.calMilliseconds(),this;if(typeof o=="string"){var B=o.match(g);if(B){var J=B.slice(2).map(function($){return $!=null?Number($):0});return this.$d.years=J[0],this.$d.months=J[1],this.$d.weeks=J[2],this.$d.days=J[3],this.$d.hours=J[4],this.$d.minutes=J[5],this.$d.seconds=J[6],this.calMilliseconds(),this}}return this}var p=S.prototype;return p.calMilliseconds=function(){var o=this;this.$ms=Object.keys(this.$d).reduce(function(D,N){return D+(o.$d[N]||0)*l[N]},0)},p.parseFromMilliseconds=function(){var o=this.$ms;this.$d.years=E(o/f),o%=f,this.$d.months=E(o/w),o%=w,this.$d.days=E(o/u),o%=u,this.$d.hours=E(o/i),o%=i,this.$d.minutes=E(o/n),o%=n,this.$d.seconds=E(o/r),o%=r,this.$d.milliseconds=o},p.toISOString=function(){var o=Y(this.$d.years,"Y"),D=Y(this.$d.months,"M"),N=+this.$d.days||0;this.$d.weeks&&(N+=7*this.$d.weeks);var O=Y(N,"D"),B=Y(this.$d.hours,"H"),J=Y(this.$d.minutes,"M"),$=this.$d.seconds||0;this.$d.milliseconds&&($+=this.$d.milliseconds/1e3,$=Math.round(1e3*$)/1e3);var h=Y($,"S"),c=o.negative||D.negative||O.negative||B.negative||J.negative||h.negative,b=B.format||J.format||h.format?"T":"",d=(c?"-":"")+"P"+o.format+D.format+O.format+b+B.format+J.format+h.format;return d==="P"||d==="-P"?"P0D":d},p.toJSON=function(){return this.toISOString()},p.format=function(o){var D=o||"YYYY-MM-DDTHH:mm:ss",N={Y:this.$d.years,YY:t.s(this.$d.years,2,"0"),YYYY:t.s(this.$d.years,4,"0"),M:this.$d.months,MM:t.s(this.$d.months,2,"0"),D:this.$d.days,DD:t.s(this.$d.days,2,"0"),H:this.$d.hours,HH:t.s(this.$d.hours,2,"0"),m:this.$d.minutes,mm:t.s(this.$d.minutes,2,"0"),s:this.$d.seconds,ss:t.s(this.$d.seconds,2,"0"),SSS:t.s(this.$d.milliseconds,3,"0")};return D.replace(s,function(O,B){return B||String(N[O])})},p.as=function(o){return this.$ms/l[a(o)]},p.get=function(o){var D=this.$ms,N=a(o);return N==="milliseconds"?D%=1e3:D=N==="weeks"?E(D/l[N]):this.$d[N],D||0},p.add=function(o,D,N){var O;return O=D?o*l[a(D)]:x(o)?o.$ms:v(o,this).$ms,v(this.$ms+O*(N?-1:1),this)},p.subtract=function(o,D){return this.add(o,D,!0)},p.locale=function(o){var D=this.clone();return D.$l=o,D},p.clone=function(){return v(this.$ms,this)},p.humanize=function(o){return e().add(this.$ms,"ms").locale(this.$l).fromNow(!o)},p.valueOf=function(){return this.asMilliseconds()},p.milliseconds=function(){return this.get("milliseconds")},p.asMilliseconds=function(){return this.as("milliseconds")},p.seconds=function(){return this.get("seconds")},p.asSeconds=function(){return this.as("seconds")},p.minutes=function(){return this.get("minutes")},p.asMinutes=function(){return this.as("minutes")},p.hours=function(){return this.get("hours")},p.asHours=function(){return this.as("hours")},p.days=function(){return this.get("days")},p.asDays=function(){return this.as("days")},p.weeks=function(){return this.get("weeks")},p.asWeeks=function(){return this.as("weeks")},p.months=function(){return this.get("months")},p.asMonths=function(){return this.as("months")},p.years=function(){return this.get("years")},p.asYears=function(){return this.as("years")},S}(),q=function(S,p,o){return S.add(p.years()*o,"y").add(p.months()*o,"M").add(p.days()*o,"d").add(p.hours()*o,"h").add(p.minutes()*o,"m").add(p.seconds()*o,"s").add(p.milliseconds()*o,"ms")};return function(S,p,o){e=o,t=o().$utils(),o.duration=function(O,B){var J=o.locale();return v(O,{$l:J},B)},o.isDuration=x;var D=p.prototype.add,N=p.prototype.subtract;p.prototype.add=function(O,B){return x(O)?q(this,O,1):D.bind(this)(O,B)},p.prototype.subtract=function(O,B){return x(O)?q(this,O,-1):N.bind(this)(O,B)}}})});var Ot=U((Ie,_e)=>{(function(e,t){typeof Ie=="object"&&typeof _e<"u"?_e.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_advancedFormat=t()})(Ie,function(){"use strict";return function(e,t){var r=t.prototype,n=r.format;r.format=function(i){var u=this,s=this.$locale();if(!this.isValid())return n.bind(this)(i);var f=this.$utils(),w=(i||"YYYY-MM-DDTHH:mm:ssZ").replace(/\[([^\]]+)]|Q|wo|ww|w|WW|W|zzz|z|gggg|GGGG|Do|X|x|k{1,2}|S/g,function(g){switch(g){case"Q":return Math.ceil((u.$M+1)/3);case"Do":return s.ordinal(u.$D);case"gggg":return u.weekYear();case"GGGG":return u.isoWeekYear();case"wo":return s.ordinal(u.week(),"W");case"w":case"ww":return f.s(u.week(),g==="w"?1:2,"0");case"W":case"WW":return f.s(u.isoWeek(),g==="W"?1:2,"0");case"k":case"kk":return f.s(String(u.$H===0?24:u.$H),g==="k"?1:2,"0");case"X":return Math.floor(u.$d.getTime()/1e3);case"x":return u.$d.getTime();case"z":return"["+u.offsetName()+"]";case"zzz":return"["+u.offsetName("long")+"]";default:return g}});return n.bind(this)(w)}}})});var xt=U((We,Fe)=>{(function(e,t){typeof We=="object"&&typeof Fe<"u"?Fe.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_isoWeek=t()})(We,function(){"use strict";var e="day";return function(t,r,n){var i=function(f){return f.add(4-f.isoWeekday(),e)},u=r.prototype;u.isoWeekYear=function(){return i(this).year()},u.isoWeek=function(f){if(!this.$utils().u(f))return this.add(7*(f-this.isoWeek()),e);var w,g,l,x,v=i(this),a=(w=this.isoWeekYear(),g=this.$u,l=(g?n.utc:n)().year(w).startOf("year"),x=4-l.isoWeekday(),l.isoWeekday()>4&&(x+=7),l.add(x,e));return v.diff(a,"week")+1},u.isoWeekday=function(f){return this.$utils().u(f)?this.day()||7:this.day(this.day()%7?f:f-7)};var s=u.startOf;u.startOf=function(f,w){var g=this.$utils(),l=!!g.u(w)||w;return g.p(f)==="isoweek"?l?this.date(this.date()-(this.isoWeekday()-1)).startOf("day"):this.date(this.date()-1-(this.isoWeekday()-1)+7).endOf("day"):s.bind(this)(f,w)}}})});var St=U((He,Be)=>{(function(e,t){typeof He=="object"&&typeof Be<"u"?Be.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_weekYear=t()})(He,function(){"use strict";return function(e,t){t.prototype.weekYear=function(){var r=this.month(),n=this.week(),i=this.year();return n===1&&r===11?i+1:r===0&&n>=52?i-1:i}}})});var Nt=U((Le,ze)=>{(function(e,t){typeof Le=="object"&&typeof ze<"u"?ze.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_weekOfYear=t()})(Le,function(){"use strict";var e="week",t="year";return function(r,n,i){var u=n.prototype;u.week=function(s){if(s===void 0&&(s=null),s!==null)return this.add(7*(s-this.week()),"day");var f=this.$locale().yearStart||1;if(this.month()===11&&this.date()>25){var w=i(this).startOf(t).add(1,t).date(f),g=i(this).endOf(e);if(w.isBefore(g))return 1}var l=i(this).startOf(t).date(f).startOf(e).subtract(1,"millisecond"),x=this.diff(l,e,!0);return x<0?i(this).startOf("week").week():Math.ceil(x)},u.weeks=function(s){return s===void 0&&(s=null),this.week(s)}}})});var Mt=U((Pe,Re)=>{(function(e,t){typeof Pe=="object"&&typeof Re<"u"?Re.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_relativeTime=t()})(Pe,function(){"use strict";return function(e,t,r){e=e||{};var n=t.prototype,i={future:"in %s",past:"%s ago",s:"a few seconds",m:"a minute",mm:"%d minutes",h:"an hour",hh:"%d hours",d:"a day",dd:"%d days",M:"a month",MM:"%d months",y:"a year",yy:"%d years"};function u(f,w,g,l){return n.fromToBase(f,w,g,l)}r.en.relativeTime=i,n.fromToBase=function(f,w,g,l,x){for(var v,a,T,E=g.$locale().relativeTime||i,I=e.thresholds||[{l:"s",r:44,d:"second"},{l:"m",r:89},{l:"mm",r:44,d:"minute"},{l:"h",r:89},{l:"hh",r:21,d:"hour"},{l:"d",r:35},{l:"dd",r:25,d:"day"},{l:"M",r:45},{l:"MM",r:10,d:"month"},{l:"y",r:17},{l:"yy",d:"year"}],Y=I.length,F=0;F0,S<=q.r||!q.r){S<=1&&F>0&&(q=I[F-1]);var p=E[q.l];x&&(S=x(""+S)),a=typeof p=="string"?p.replace("%d",S):p(S,w,q.l,T);break}}if(w)return a;var o=T?E.future:E.past;return typeof o=="function"?o(a):o.replace("%s",a)},n.to=function(f,w){return u(f,w,this,!0)},n.from=function(f,w){return u(f,w,this)};var s=function(f){return f.$u?r.utc():r()};n.toNow=function(f){return this.to(s(this),f)},n.fromNow=function(f){return this.from(s(this),f)}}})});var jt=U((Je,Ge)=>{(function(e,t){typeof Je=="object"&&typeof Ge<"u"?Ge.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_utc=t()})(Je,function(){"use strict";var e="minute",t=/[+-]\d\d(?::?\d\d)?/g,r=/([+-]|\d\d)/g;return function(n,i,u){var s=i.prototype;u.utc=function(a){var T={date:a,utc:!0,args:arguments};return new i(T)},s.utc=function(a){var T=u(this.toDate(),{locale:this.$L,utc:!0});return a?T.add(this.utcOffset(),e):T},s.local=function(){return u(this.toDate(),{locale:this.$L,utc:!1})};var f=s.parse;s.parse=function(a){a.utc&&(this.$u=!0),this.$utils().u(a.$offset)||(this.$offset=a.$offset),f.call(this,a)};var w=s.init;s.init=function(){if(this.$u){var a=this.$d;this.$y=a.getUTCFullYear(),this.$M=a.getUTCMonth(),this.$D=a.getUTCDate(),this.$W=a.getUTCDay(),this.$H=a.getUTCHours(),this.$m=a.getUTCMinutes(),this.$s=a.getUTCSeconds(),this.$ms=a.getUTCMilliseconds()}else w.call(this)};var g=s.utcOffset;s.utcOffset=function(a,T){var E=this.$utils().u;if(E(a))return this.$u?0:E(this.$offset)?g.call(this):this.$offset;if(typeof a=="string"&&(a=function(q){q===void 0&&(q="");var S=q.match(t);if(!S)return null;var p=(""+S[0]).match(r)||["-",0,0],o=p[0],D=60*+p[1]+ +p[2];return D===0?0:o==="+"?D:-D}(a),a===null))return this;var I=Math.abs(a)<=16?60*a:a,Y=this;if(T)return Y.$offset=I,Y.$u=a===0,Y;if(a!==0){var F=this.$u?this.toDate().getTimezoneOffset():-1*this.utcOffset();(Y=this.local().add(I+F,e)).$offset=I,Y.$x.$localOffset=F}else Y=this.utc();return Y};var l=s.format;s.format=function(a){var T=a||(this.$u?"YYYY-MM-DDTHH:mm:ss[Z]":"");return l.call(this,T)},s.valueOf=function(){var a=this.$utils().u(this.$offset)?0:this.$offset+(this.$x.$localOffset||this.$d.getTimezoneOffset());return this.$d.valueOf()-6e4*a},s.isUTC=function(){return!!this.$u},s.toISOString=function(){return this.toDate().toISOString()},s.toString=function(){return this.toDate().toUTCString()};var x=s.toDate;s.toDate=function(a){return a==="s"&&this.$offset?u(this.format("YYYY-MM-DD HH:mm:ss:SSS")).toDate():x.call(this)};var v=s.diff;s.diff=function(a,T,E){if(a&&this.$u===a.$u)return v.call(this,a,T,E);var I=this.local(),Y=u(a).local();return v.call(I,Y,T,E)}}})});var At=U((Ze,Ve)=>{(function(e,t){typeof Ze=="object"&&typeof Ve<"u"?Ve.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_timezone=t()})(Ze,function(){"use strict";var e={year:0,month:1,day:2,hour:3,minute:4,second:5},t={};return function(r,n,i){var u,s=function(l,x,v){v===void 0&&(v={});var a=new Date(l),T=function(E,I){I===void 0&&(I={});var Y=I.timeZoneName||"short",F=E+"|"+Y,q=t[F];return q||(q=new Intl.DateTimeFormat("en-US",{hour12:!1,timeZone:E,year:"numeric",month:"2-digit",day:"2-digit",hour:"2-digit",minute:"2-digit",second:"2-digit",timeZoneName:Y}),t[F]=q),q}(x,v);return T.formatToParts(a)},f=function(l,x){for(var v=s(l,x),a=[],T=0;T=0&&(a[F]=parseInt(Y,10))}var q=a[3],S=q===24?0:q,p=a[0]+"-"+a[1]+"-"+a[2]+" "+S+":"+a[4]+":"+a[5]+":000",o=+l;return(i.utc(p).valueOf()-(o-=o%1e3))/6e4},w=n.prototype;w.tz=function(l,x){l===void 0&&(l=u);var v=this.utcOffset(),a=this.toDate(),T=a.toLocaleString("en-US",{timeZone:l}),E=Math.round((a-new Date(T))/1e3/60),I=i(T,{locale:this.$L}).$set("millisecond",this.$ms).utcOffset(15*-Math.round(a.getTimezoneOffset()/15)-E,!0);if(x){var Y=I.utcOffset();I=I.add(v-Y,"minute")}return I.$x.$timezone=l,I},w.offsetName=function(l){var x=this.$x.$timezone||i.tz.guess(),v=s(this.valueOf(),x,{timeZoneName:l}).find(function(a){return a.type.toLowerCase()==="timezonename"});return v&&v.value};var g=w.startOf;w.startOf=function(l,x){if(!this.$x||!this.$x.$timezone)return g.call(this,l,x);var v=i(this.format("YYYY-MM-DD HH:mm:ss:SSS"),{locale:this.$L});return g.call(v,l,x).tz(this.$x.$timezone,!0)},i.tz=function(l,x,v){var a=v&&x,T=v||x||u,E=f(+i(),T);if(typeof l!="string")return i(l).tz(T);var I=function(S,p,o){var D=S-60*p*1e3,N=f(D,o);if(p===N)return[D,p];var O=f(D-=60*(N-p)*1e3,o);return N===O?[D,N]:[S-60*Math.min(N,O)*1e3,Math.max(N,O)]}(i.utc(l,a).valueOf(),E,T),Y=I[0],F=I[1],q=i(Y).utcOffset(F);return q.$x.$timezone=T,q},i.tz.guess=function(){return Intl.DateTimeFormat().resolvedOptions().timeZone},i.tz.setDefault=function(l){u=l}}})});var Dt=U((Ui,et)=>{var X=bt();X.extend(wt());X.extend(Ot());X.extend(xt());X.extend(St());X.extend(Nt());X.extend(Mt());X.extend(jt());X.extend(At());function oe(e){return typeof e=="object"&&typeof e.hash=="object"}function Qe(e){return typeof e=="object"&&typeof e.options=="object"&&typeof e.app=="object"}function Xe(e,t,r){if(oe(e))return Xe({},t,e);if(oe(t))return Xe(e,r,t);let n=Qe(e)?e.context:{};r=r||{},oe(r)||(t=Object.assign({},t,r)),oe(r)&&r.hash.root===!0&&(t=Object.assign({},r.data.root,t));let i=Object.assign({},n,t,r.hash);return Qe(e)||(i=Object.assign({},e,i)),Qe(e)&&e.view&&e.view.data&&(i=Object.assign({},i,e.view.data)),i}function Ke(e,t,r){return oe(t)&&(r=t,t=null),oe(e)&&(r=e,t=null,e=null),{str:e,pattern:t,options:r}}function kt(e,t,r){let n=Ke(e,t,r),i={lang:"en",date:new Date(n.str)},u=Xe(this,i,{});X.locale(u.lang||u.language)}et.exports.date=(e,t,r)=>{let n=Ke(e,t,r);if(n.str==null&&n.pattern==null)return X.locale("en"),X().format("MMMM DD, YYYY");kt(n.str,n.pattern,n.options);let i=X(new Date(n.str));return typeof n.options=="string"?i=n.options.toLowerCase()==="utc"?i.utc():i.tz(n.options):i=i.tz(X.tz.guess()),n.pattern===""?i.toISOString():i.format(n.pattern)};et.exports.duration=(e,t,r)=>{let n=Ke(e,t);kt(n.str,n.pattern);let i=X.duration(n.str,n.pattern);return r&&!oe(r)?i.format(r):i.humanize()}});var tt=U((Ti,Tt)=>{Tt.exports=function(e){return e!=null&&(Ut(e)||vn(e)||!!e._isBuffer)};function Ut(e){return!!e.constructor&&typeof e.constructor.isBuffer=="function"&&e.constructor.isBuffer(e)}function vn(e){return typeof e.readFloatLE=="function"&&typeof e.slice=="function"&&Ut(e.slice(0,0))}});var Yt=U((qi,qt)=>{var $n=tt(),bn=Object.prototype.toString;qt.exports=function(t){if(typeof t>"u")return"undefined";if(t===null)return"null";if(t===!0||t===!1||t instanceof Boolean)return"boolean";if(typeof t=="string"||t instanceof String)return"string";if(typeof t=="number"||t instanceof Number)return"number";if(typeof t=="function"||t instanceof Function)return"function";if(typeof Array.isArray<"u"&&Array.isArray(t))return"array";if(t instanceof RegExp)return"regexp";if(t instanceof Date)return"date";var r=bn.call(t);return r==="[object RegExp]"?"regexp":r==="[object Date]"?"date":r==="[object Arguments]"?"arguments":r==="[object Error]"?"error":$n(t)?"buffer":r==="[object Set]"?"set":r==="[object WeakSet]"?"weakset":r==="[object Map]"?"map":r==="[object WeakMap]"?"weakmap":r==="[object Symbol]"?"symbol":r==="[object Int8Array]"?"int8array":r==="[object Uint8Array]"?"uint8array":r==="[object Uint8ClampedArray]"?"uint8clampedarray":r==="[object Int16Array]"?"int16array":r==="[object Uint16Array]"?"uint16array":r==="[object Int32Array]"?"int32array":r==="[object Uint32Array]"?"uint32array":r==="[object Float32Array]"?"float32array":r==="[object Float64Array]"?"float64array":"object"}});var _t=U((Yi,It)=>{"use strict";var Ct=Yt(),Et={arguments:"an arguments object",array:"an array",boolean:"a boolean",buffer:"a buffer",date:"a date",error:"an error",float32array:"a float32array",float64array:"a float64array",function:"a function",int16array:"an int16array",int32array:"an int32array",int8array:"an int8array",map:"a Map",null:"null",number:"a number",object:"an object",regexp:"a regular expression",set:"a Set",string:"a string",symbol:"a symbol",uint16array:"an uint16array",uint32array:"an uint32array",uint8array:"an uint8array",uint8clampedarray:"an uint8clampedarray",undefined:"undefined",weakmap:"a WeakMap",weakset:"a WeakSet"};function rt(e){return Et[Ct(e)]}rt.types=Et;rt.typeOf=Ct;It.exports=rt});var Me=U((Ci,Ft)=>{var wn=Object.prototype.toString;Ft.exports=function(t){if(t===void 0)return"undefined";if(t===null)return"null";var r=typeof t;if(r==="boolean")return"boolean";if(r==="string")return"string";if(r==="number")return"number";if(r==="symbol")return"symbol";if(r==="function")return Mn(t)?"generatorfunction":"function";if(On(t))return"array";if(kn(t))return"buffer";if(An(t))return"arguments";if(Sn(t))return"date";if(xn(t))return"error";if(Nn(t))return"regexp";switch(Wt(t)){case"Symbol":return"symbol";case"Promise":return"promise";case"WeakMap":return"weakmap";case"WeakSet":return"weakset";case"Map":return"map";case"Set":return"set";case"Int8Array":return"int8array";case"Uint8Array":return"uint8array";case"Uint8ClampedArray":return"uint8clampedarray";case"Int16Array":return"int16array";case"Uint16Array":return"uint16array";case"Int32Array":return"int32array";case"Uint32Array":return"uint32array";case"Float32Array":return"float32array";case"Float64Array":return"float64array"}if(jn(t))return"generator";switch(r=wn.call(t),r){case"[object Object]":return"object";case"[object Map Iterator]":return"mapiterator";case"[object Set Iterator]":return"setiterator";case"[object String Iterator]":return"stringiterator";case"[object Array Iterator]":return"arrayiterator"}return r.slice(8,-1).toLowerCase().replace(/\s/g,"")};function Wt(e){return typeof e.constructor=="function"?e.constructor.name:null}function On(e){return Array.isArray?Array.isArray(e):e instanceof Array}function xn(e){return e instanceof Error||typeof e.message=="string"&&e.constructor&&typeof e.constructor.stackTraceLimit=="number"}function Sn(e){return e instanceof Date?!0:typeof e.toDateString=="function"&&typeof e.getDate=="function"&&typeof e.setDate=="function"}function Nn(e){return e instanceof RegExp?!0:typeof e.flags=="string"&&typeof e.ignoreCase=="boolean"&&typeof e.multiline=="boolean"&&typeof e.global=="boolean"}function Mn(e,t){return Wt(e)==="GeneratorFunction"}function jn(e){return typeof e.throw=="function"&&typeof e.return=="function"&&typeof e.next=="function"}function An(e){try{if(typeof e.length=="number"&&typeof e.callee=="function")return!0}catch(t){if(t.message.indexOf("callee")!==-1)return!0}return!1}function kn(e){return e.constructor&&typeof e.constructor.isBuffer=="function"?e.constructor.isBuffer(e):!1}});var ee=U((Lt,zt)=>{"use strict";var Dn=fe("util"),Ht=_t(),Un=Me(),m=Lt=zt.exports;m.extend=Bt;m.indexOf=In;m.escapeExpression=_n;m.isEmpty=Bn;m.createFrame=Wn;m.blockParams=Fn;m.appendContextPath=Hn;var Tn={"&":"&","<":"<",">":">",'"':""","'":"'","`":"`","=":"="},qn=/[&<>"'`=]/g,Yn=/[&<>"'`=]/;function Cn(e){return Tn[e]}function Bt(e){for(var t=1;t{"use strict";var Ln=ee();pe.contains=function(e,t,r){return e==null||t==null||isNaN(e.length)?!1:e.indexOf(t,r)!==-1};pe.chop=function(e){if(typeof e!="string")return"";var t=/^[-_.\W\s]+|[-_.\W\s]+$/g;return e.trim().replace(t,"")};pe.changecase=function(e,t){if(typeof e!="string")return"";if(e.length===1)return e.toLowerCase();e=pe.chop(e).toLowerCase(),typeof t!="function"&&(t=Ln.identity);var r=/[-_.\W\s]+(\w|$)/g;return e.replace(r,function(n,i){return t(i)})};pe.random=function(e,t){return e+Math.floor(Math.random()*(t-e+1))}});var Rt=U((Ii,Pt)=>{"use strict";var zn=je(),V=Pt.exports;V.abs=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.abs(e)};V.add=function(e,t){return!isNaN(e)&&!isNaN(t)?Number(e)+Number(t):typeof e=="string"&&typeof t=="string"?e+t:""};V.avg=function(){let e=[].concat.apply([],arguments);return e.pop(),V.sum(e)/e.length};V.ceil=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.ceil(e)};V.divide=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)/Number(t)};V.floor=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.floor(e)};V.minus=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)-Number(t)};V.modulo=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)%Number(t)};V.multiply=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)*Number(t)};V.plus=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)+Number(t)};V.random=function(e,t){if(isNaN(e))throw new TypeError("expected minimum to be a number");if(isNaN(t))throw new TypeError("expected maximum to be a number");return zn.random(e,t)};V.remainder=function(e,t){return e%t};V.round=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.round(e)};V.subtract=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)-Number(t)};V.sum=function(){for(var e=[].concat.apply([],arguments),t=e.length,r=0;t--;)isNaN(e[t])||(r+=Number(e[t]));return r}});var Gt=U((_i,Jt)=>{"use strict";Jt.exports=function(t){return t!=null&&typeof t=="object"&&Array.isArray(t)===!1}});var Ae=U((Wi,Xt)=>{var Qt=Gt();Xt.exports=function(e,t,r){if(Qt(r)||(r={default:r}),!Vt(e))return typeof r.default<"u"?r.default:e;typeof t=="number"&&(t=String(t));let n=Array.isArray(t),i=typeof t=="string",u=r.separator||".",s=r.joinChar||(typeof u=="string"?u:".");if(!i&&!n)return e;if(i&&t in e)return ut(t,e,r)?e[t]:r.default;let f=n?t:Pn(t,u,r),w=f.length,g=0;do{let l=f[g];for(typeof l=="number"&&(l=String(l));l&&l.slice(-1)==="\\";)l=Zt([l.slice(0,-1),f[++g]||""],s,r);if(l in e){if(!ut(l,e,r))return r.default;e=e[l]}else{let x=!1,v=g+1;for(;v{"use strict";Kt.exports=function(t){if(typeof t!="object")throw new TypeError("createFrame expects data to be an object");var r=Object.assign({},t);if(r._parent=t,r.extend=function(s){Object.assign(this,s)},arguments.length>1)for(var n=[].slice.call(arguments,1),i=n.length,u=-1;++u{"use strict";var y=ee(),C=er.exports,ae=Ae(),Rn=st();C.after=function(e,t){return y.isUndefined(e)?"":(e=y.result(e),Array.isArray(e)?e.slice(t):"")};C.arrayify=function(e){return y.isUndefined(e)?[]:e?Array.isArray(e)?e:[e]:[]};C.before=function(e,t){return y.isUndefined(e)?"":(e=y.result(e),Array.isArray(e)?e.slice(0,t-1):"")};C.eachIndex=function(e,t){var r="";if(y.isUndefined(e))return"";if(e=y.result(e),Array.isArray(e))for(var n=0;n0){for(var s=0;s-1,this,r):"")};C.isArray=function(e){return Array.isArray(e)};C.itemAt=function(e,t){if(y.isUndefined(e))return null;if(e=y.result(e),Array.isArray(e)){if(t=isNaN(t)?0:+t,t<0)return e[e.length+t];if(ti[t]>u[t]?1:-1)}return""};C.withAfter=function(e,t,r){if(y.isUndefined(e))return"";if(e=y.result(e),Array.isArray(e)){e=e.slice(t);for(var n="",i=0;i0){for(var i=[],u=0;u0&&u%t===0&&(n+=r.fn(i),i=[]),i.push(e[u]);n+=r.fn(i)}return n};C.withLast=function(e,t,r){if(y.isUndefined(e))return"";if(e=y.result(e),Array.isArray(e)){if(y.isUndefined(t)||(t=parseFloat(y.result(t))),y.isUndefined(t))return r=t,r.fn(e[e.length-1]);e=e.slice(-t);for(var n=e.length,i=-1,u="";++ig?1:w{"use strict";var tr=ee(),te=rr.exports;te.bytes=function(e,t,r){if(e==null||isNaN(e)&&(e=e.length,!e))return"0 B";isNaN(t)&&(t=2);var n=["B","kB","MB","GB","TB","PB","EB","ZB","YB"];t=Math.pow(10,t),e=Number(e);for(var i=n.length-1;i-->=0;){var u=Math.pow(10,i*3);if(u<=e+1){e=Math.round(e*t/u)/t,e+=" "+n[i];break}}return e};te.addCommas=function(e){return e.toString().replace(/(\d)(?=(\d\d\d)+(?!\d))/g,"$1,")};te.phoneNumber=function(e){return e=e.toString(),"("+e.substr(0,3)+") "+e.substr(3,3)+"-"+e.substr(6,4)};te.toAbbr=function(e,t){isNaN(e)&&(e=0),tr.isUndefined(t)&&(t=2),e=Number(e),t=Math.pow(10,t);for(var r=["k","m","b","t","q"],n=r.length-1;n>=0;){var i=Math.pow(10,(n+1)*3);if(i<=e+1){e=Math.round(e*t/i)/t,e+=r[n];break}n--}return e};te.toExponential=function(e,t){return isNaN(e)&&(e=0),tr.isUndefined(t)&&(t=0),Number(e).toExponential(t)};te.toFixed=function(e,t){return isNaN(e)&&(e=0),isNaN(t)&&(t=0),Number(e).toFixed(t)};te.toFloat=function(e){return parseFloat(e)};te.toInt=function(e){return parseInt(e,10)};te.toPrecision=function(e,t){return isNaN(e)&&(e=0),isNaN(t)&&(t=1),Number(e).toPrecision(t)}});var ur=U((Li,ir)=>{"use strict";var ft=fe("url"),ye=ee(),Jn=fe("querystring"),ce=ir.exports;ce.encodeURI=function(e){if(ye.isString(e))return encodeURIComponent(e)};ce.escape=function(e){if(ye.isString(e))return Jn.escape(e)};ce.decodeURI=function(e){if(ye.isString(e))return decodeURIComponent(e)};ce.urlResolve=function(e,t){return ft.resolve(e,t)};ce.urlParse=function(e){return ft.parse(e)};ce.stripQuerystring=function(e){if(ye.isString(e))return e.split("?")[0]};ce.stripProtocol=function(e){if(ye.isString(e)){var t=ft.parse(e);return t.protocol="",t.format()}}});var or=U((sr,fr)=>{"use strict";var z=ee(),le=je(),A=fr.exports;A.append=function(e,t){return typeof e=="string"&&typeof t=="string"?e+t:e};A.camelcase=function(e){return typeof e!="string"?"":le.changecase(e,function(t){return t.toUpperCase()})};A.capitalize=function(e){return typeof e!="string"?"":e.charAt(0).toUpperCase()+e.slice(1)};A.capitalizeAll=function(e){if(typeof e!="string")return"";if(z.isString(e))return e.replace(/\w\S*/g,function(t){return A.capitalize(t)})};A.center=function(e,t){if(typeof e!="string")return"";for(var r="",n=0;n-1;)i++,n+=r;return i};A.pascalcase=function(e){return typeof e!="string"?"":(e=le.changecase(e,function(t){return t.toUpperCase()}),e.charAt(0).toUpperCase()+e.slice(1))};A.pathcase=function(e){return typeof e!="string"?"":le.changecase(e,function(t){return"/"+t})};A.plusify=function(e,t){return typeof e!="string"?"":(z.isString(t)||(t=" "),e.split(t).join("+"))};A.prepend=function(e,t){return typeof e=="string"&&typeof t=="string"?t+e:e};A.raw=function(e){var t=e.fn(),r=z.options(this,e);if(r.escape!==!1)for(var n=0;(n=t.indexOf("{{",n))!==-1;)t[n-1]!=="\\"&&(t=t.slice(0,n)+"\\"+t.slice(n)),n+=3;return t};A.remove=function(e,t){return typeof e!="string"?"":z.isString(t)?e.split(t).join(""):e};A.removeFirst=function(e,t){return typeof e!="string"?"":z.isString(t)?e.replace(t,""):e};A.replace=function(e,t,r){return typeof e!="string"?"":z.isString(t)?(z.isString(r)||(r=""),e.split(t).join(r)):e};A.replaceFirst=function(e,t,r){return typeof e!="string"?"":z.isString(t)?(z.isString(r)||(r=""),e.replace(t,r)):e};A.reverse=ke().reverse;A.sentence=function(e){return typeof e!="string"?"":e.replace(/((?:\S[^\.\?\!]*)[\.\?\!]*)/g,function(t){return t.charAt(0).toUpperCase()+t.substr(1).toLowerCase()})};A.snakecase=function(e){return typeof e!="string"?"":le.changecase(e,function(t){return"_"+t})};A.split=function(e,t){return typeof e!="string"?"":(z.isString(t)||(t=","),e.split(t))};A.startsWith=function(e,t,r){var n=[].slice.call(arguments);return r=n.pop(),z.isString(t)&&t.indexOf(e)===0?r.fn(this):typeof r.inverse=="function"?r.inverse(this):""};A.titleize=function(e){if(typeof e!="string")return"";for(var t=e.replace(/[- _]+/g," "),r=t.split(" "),n=r.length,i=[],u=0;n--;){var s=r[u++];i.push(sr.capitalize(s))}return i.join(" ")};A.trim=function(e){return typeof e=="string"?e.trim():""};A.trimLeft=function(e){if(z.isString(e))return e.replace(/^\s+/,"")};A.trimRight=function(e){if(z.isString(e))return e.replace(/\s+$/,"")};A.truncate=function(e,t,r){if(z.isString(e))return typeof r!="string"&&(r=""),e.length>t?e.slice(0,t-r.length)+r:e};A.truncateWords=function(e,t,r){if(z.isString(e)&&!isNaN(t)){typeof r!="string"&&(r="\u2026");var n=Number(t),i=e.split(/[ \t]/);if(n>=i.length)return e;i=i.slice(0,n);var u=i.join(" ").trim();return u+r}};A.upcase=function(){return A.uppercase.apply(this,arguments)};A.uppercase=function(e){return z.isObject(e)&&e.fn?e.fn(this).toUpperCase():typeof e!="string"?"":e.toUpperCase()}});var cr=U((zi,ar)=>{"use strict";var Gn=Me();ar.exports=function e(t){switch(Gn(t)){case"boolean":case"date":case"function":case"null":case"number":return!0;case"undefined":return!1;case"regexp":return t.source!=="(?:)"&&t.source!=="";case"buffer":return t.toString()!=="";case"error":return t.message!=="";case"string":case"arguments":return t.length!==0;case"file":case"map":case"set":return t.size!==0;case"array":case"object":for(let r of Object.keys(t))if(e(t[r]))return!0;return!1;default:return!0}}});var dr=U((Pi,lr)=>{"use strict";var Zn=Ae(),Vn=cr();lr.exports=function(e,t,r){return Qn(e)&&(typeof t=="string"||Array.isArray(t))?Vn(Zn(e,t,r)):!1};function Qn(e){return e!=null&&(typeof e=="object"||typeof e=="function"||Array.isArray(e))}});var pr=U((Ri,hr)=>{"use strict";function ot(e,t){if(!e)return!0;let r=t||ot.keywords;Array.isArray(r)||(r=[r]);let n=typeof e=="string"?e.toLowerCase():null;for(let i of r)if(i===e||i===n)return!0;return!1}ot.keywords=["0","false","nada","nil","nay","nah","negative","no","none","nope","nul","null","nix","nyet","uh-uh","veto","zero"];hr.exports=ot});var gr=U((Ji,mr)=>{"use strict";mr.exports=function(t){let r=Math.abs(t);if(isNaN(r))throw new TypeError("expected a number");if(!Number.isInteger(r))throw new Error("expected an integer");if(!Number.isSafeInteger(r))throw new Error("value exceeds maximum safe integer");return r%2===1}});var br=U((Gi,$r)=>{"use strict";var Xn=dr(),k=ee(),Kn=je(),yr=pr(),vr=gr(),W=$r.exports;W.and=function(){for(var e=arguments.length-1,t=arguments[e],r=!0,n=0;n":i=e>r;break;case"<=":i=e<=r;break;case">=":i=e>=r;break;case"typeof":i=typeof e===r;break;default:throw new Error("helper {{compare}}: invalid operator: `"+t+"`")}return k.value(i,this,n)};W.contains=function(e,t,r,n){typeof r=="object"&&(n=r,r=void 0);var i=Kn.contains(e,t,r);return k.value(i,this,n)};W.default=function(){for(var e=0;et,this,r)};W.gte=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e>=t,this,r)};W.has=function(e,t,r){return k.isOptions(e)&&(r=e,t=null,e=null),k.isOptions(t)&&(r=t,t=null),e===null?k.value(!1,this,r):arguments.length===2?k.value(Xn(this,e),this,r):(Array.isArray(e)||k.isString(e))&&k.isString(t)&&e.indexOf(t)>-1?k.fn(!0,this,r):k.isObject(e)&&k.isString(t)&&t in e?k.fn(!0,this,r):k.inverse(!1,this,r)};W.isFalsey=function(e,t){return k.value(yr(e),this,t)};W.isTruthy=function(e,t){return k.value(!yr(e),this,t)};W.ifEven=function(e,t){return k.value(!vr(e),this,t)};W.ifNth=function(e,t,r){var n=!isNaN(e)&&!isNaN(t)&&t%e===0;return k.value(n,this,r)};W.ifOdd=function(e,t){return k.value(vr(e),this,t)};W.is=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e==t,this,r)};W.isnt=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e!=t,this,r)};W.lt=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e=t,this,r)};W.unlessGteq=function(e,t,r){return k.isOptions(t)&&(r=t,t=r.hash.compare),k.value(et,this,r)}});var Or=U((Zi,wr)=>{var ei=tt(),ti=Object.prototype.toString;wr.exports=function(t){if(typeof t>"u")return"undefined";if(t===null)return"null";if(t===!0||t===!1||t instanceof Boolean)return"boolean";if(typeof t=="string"||t instanceof String)return"string";if(typeof t=="number"||t instanceof Number)return"number";if(typeof t=="function"||t instanceof Function)return"function";if(typeof Array.isArray<"u"&&Array.isArray(t))return"array";if(t instanceof RegExp)return"regexp";if(t instanceof Date)return"date";var r=ti.call(t);return r==="[object RegExp]"?"regexp":r==="[object Date]"?"date":r==="[object Arguments]"?"arguments":r==="[object Error]"?"error":ei(t)?"buffer":r==="[object Set]"?"set":r==="[object WeakSet]"?"weakset":r==="[object Map]"?"map":r==="[object WeakMap]"?"weakmap":r==="[object Symbol]"?"symbol":r==="[object Int8Array]"?"int8array":r==="[object Uint8Array]"?"uint8array":r==="[object Uint8ClampedArray]"?"uint8clampedarray":r==="[object Int16Array]"?"int16array":r==="[object Uint16Array]"?"uint16array":r==="[object Int32Array]"?"int32array":r==="[object Uint32Array]"?"uint32array":r==="[object Float32Array]"?"float32array":r==="[object Float64Array]"?"float64array":"object"}});var Sr=U((Vi,xr)=>{"use strict";var ri=Or();xr.exports=function(t){var r=ri(t);if(r!=="number"&&r!=="string")return!1;var n=+t;return n-n+1>=0&&t!==""}});var Mr=U((Qi,Nr)=>{"use strict";var ni=Sr();Nr.exports=function(t,r){if(!r)return t;if(!t)return{};for(var n=String(r).split(/[[.\]]/).filter(Boolean),i=n[n.length-1],u={};r=n.shift();)if(t=t[r],!t)return{};return ni(i)?[t]:(u[i]=t,u)}});var Dr=U((Xi,kr)=>{"use strict";var ii=Object.hasOwnProperty,ve=ee(),ui=ke(),P=kr.exports,si=Ae(),jr=Mr(),Ar=st();P.extend=function(){var e=[].slice.call(arguments),t={};ve.isOptions(e[e.length-1])&&(t=e.pop().hash,e.push(t));for(var r={},n=0;n{"use strict";var fi=ee(),Ur=Tr.exports,oi=Me();Ur.toRegex=function(e,t,r){var n=fi.options({},t,r);return new RegExp(e,n.flags)};Ur.test=function(e,t){if(typeof e!="string")return!1;if(oi(t)!=="regexp")throw new TypeError("expected a regular expression");return t.test(e)}});function $e(){return De>Ue.length-16&&(Yr.default.randomFillSync(Ue),De=0),Ue.slice(De,De+=16)}var Yr,Ue,De,at=Z(()=>{Yr=Ne(fe("crypto")),Ue=new Uint8Array(256),De=Ue.length});var Cr,Er=Z(()=>{Cr=/^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i});function ai(e){return typeof e=="string"&&Cr.test(e)}var ne,be=Z(()=>{Er();ne=ai});function de(e,t=0){return R[e[t+0]]+R[e[t+1]]+R[e[t+2]]+R[e[t+3]]+"-"+R[e[t+4]]+R[e[t+5]]+"-"+R[e[t+6]]+R[e[t+7]]+"-"+R[e[t+8]]+R[e[t+9]]+"-"+R[e[t+10]]+R[e[t+11]]+R[e[t+12]]+R[e[t+13]]+R[e[t+14]]+R[e[t+15]]}function ci(e,t=0){let r=de(e,t);if(!ne(r))throw TypeError("Stringified UUID is invalid");return r}var R,Ir,we=Z(()=>{be();R=[];for(let e=0;e<256;++e)R.push((e+256).toString(16).slice(1));Ir=ci});function li(e,t,r){let n=t&&r||0,i=t||new Array(16);e=e||{};let u=e.node||_r,s=e.clockseq!==void 0?e.clockseq:ct;if(u==null||s==null){let v=e.random||(e.rng||$e)();u==null&&(u=_r=[v[0]|1,v[1],v[2],v[3],v[4],v[5]]),s==null&&(s=ct=(v[6]<<8|v[7])&16383)}let f=e.msecs!==void 0?e.msecs:Date.now(),w=e.nsecs!==void 0?e.nsecs:dt+1,g=f-lt+(w-dt)/1e4;if(g<0&&e.clockseq===void 0&&(s=s+1&16383),(g<0||f>lt)&&e.nsecs===void 0&&(w=0),w>=1e4)throw new Error("uuid.v1(): Can't create more than 10M uuids/sec");lt=f,dt=w,ct=s,f+=122192928e5;let l=((f&268435455)*1e4+w)%4294967296;i[n++]=l>>>24&255,i[n++]=l>>>16&255,i[n++]=l>>>8&255,i[n++]=l&255;let x=f/4294967296*1e4&268435455;i[n++]=x>>>8&255,i[n++]=x&255,i[n++]=x>>>24&15|16,i[n++]=x>>>16&255,i[n++]=s>>>8|128,i[n++]=s&255;for(let v=0;v<6;++v)i[n+v]=u[v];return t||de(i)}var _r,ct,lt,dt,Wr,Fr=Z(()=>{at();we();lt=0,dt=0;Wr=li});function di(e){if(!ne(e))throw TypeError("Invalid UUID");let t,r=new Uint8Array(16);return r[0]=(t=parseInt(e.slice(0,8),16))>>>24,r[1]=t>>>16&255,r[2]=t>>>8&255,r[3]=t&255,r[4]=(t=parseInt(e.slice(9,13),16))>>>8,r[5]=t&255,r[6]=(t=parseInt(e.slice(14,18),16))>>>8,r[7]=t&255,r[8]=(t=parseInt(e.slice(19,23),16))>>>8,r[9]=t&255,r[10]=(t=parseInt(e.slice(24,36),16))/1099511627776&255,r[11]=t/4294967296&255,r[12]=t>>>24&255,r[13]=t>>>16&255,r[14]=t>>>8&255,r[15]=t&255,r}var Te,ht=Z(()=>{be();Te=di});function hi(e){e=unescape(encodeURIComponent(e));let t=[];for(let r=0;r{we();ht();pi="6ba7b810-9dad-11d1-80b4-00c04fd430c8",mi="6ba7b811-9dad-11d1-80b4-00c04fd430c8"});function gi(e){return Array.isArray(e)?e=Buffer.from(e):typeof e=="string"&&(e=Buffer.from(e,"utf8")),Hr.default.createHash("md5").update(e).digest()}var Hr,Br,Lr=Z(()=>{Hr=Ne(fe("crypto"));Br=gi});var yi,zr,Pr=Z(()=>{pt();Lr();yi=Oe("v3",48,Br),zr=yi});var Rr,mt,Jr=Z(()=>{Rr=Ne(fe("crypto")),mt={randomUUID:Rr.default.randomUUID}});function vi(e,t,r){if(mt.randomUUID&&!t&&!e)return mt.randomUUID();e=e||{};let n=e.random||(e.rng||$e)();if(n[6]=n[6]&15|64,n[8]=n[8]&63|128,t){r=r||0;for(let i=0;i<16;++i)t[r+i]=n[i];return t}return de(n)}var Gr,Zr=Z(()=>{Jr();at();we();Gr=vi});function $i(e){return Array.isArray(e)?e=Buffer.from(e):typeof e=="string"&&(e=Buffer.from(e,"utf8")),Vr.default.createHash("sha1").update(e).digest()}var Vr,Qr,Xr=Z(()=>{Vr=Ne(fe("crypto"));Qr=$i});var bi,Kr,en=Z(()=>{pt();Xr();bi=Oe("v5",80,Qr),Kr=bi});var tn,rn=Z(()=>{tn="00000000-0000-0000-0000-000000000000"});function wi(e){if(!ne(e))throw TypeError("Invalid UUID");return parseInt(e.slice(14,15),16)}var nn,un=Z(()=>{be();nn=wi});var sn={};yt(sn,{NIL:()=>tn,parse:()=>Te,stringify:()=>Ir,v1:()=>Wr,v3:()=>zr,v4:()=>Gr,v5:()=>Kr,validate:()=>ne,version:()=>nn});var fn=Z(()=>{Fr();Pr();Zr();en();rn();un();be();we();ht()});var an=U((Wu,on)=>{var Oi=(fn(),$t(sn)),xi=on.exports;xi.uuid=function(){return Oi.v4()}});var dn=U((Fu,gt)=>{var{date:Si,duration:Ni}=Dt(),Mi={math:Rt(),array:ke(),number:nr(),url:ur(),string:or(),comparison:br(),object:Dr(),regex:qr(),uuid:an()},ln=["sortBy"];gt.exports.helpersToRemoveForJs=ln;var cn={date:Si,duration:Ni},ie;gt.exports.getJsHelperList=()=>{if(ie)return ie;ie={};for(let e of Object.values(Mi))for(let[t,r]of Object.entries(e))ie[t]=(...n)=>r(...n,{});for(let e of Object.keys(cn))ie[e]=cn[e];for(let e of ln)delete ie[e];return Object.freeze(ie),ie}});var ki={};yt(ki,{default:()=>Ai});var{getJsHelperList:ji}=dn(),Ai={...ji(),stripProtocol:helpersStripProtocol};return $t(ki);})(); +"use strict";var helpers=(()=>{var Mn=Object.create;var je=Object.defineProperty;var An=Object.getOwnPropertyDescriptor;var kn=Object.getOwnPropertyNames;var Dn=Object.getPrototypeOf,Un=Object.prototype.hasOwnProperty;var oe=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(t,r)=>(typeof require<"u"?require:t)[r]}):e)(function(e){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+e+'" is not supported')});var V=(e,t)=>()=>(e&&(t=e(e=0)),t);var T=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),mt=(e,t)=>{for(var r in t)je(e,r,{get:t[r],enumerable:!0})},yt=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of kn(t))!Un.call(e,i)&&i!==r&&je(e,i,{get:()=>t[i],enumerable:!(n=An(t,i))||n.enumerable});return e};var F=(e,t,r)=>(r=e!=null?Mn(Dn(e)):{},yt(t||!e||!e.__esModule?je(r,"default",{value:e,enumerable:!0}):r,e)),gt=e=>yt(je({},"__esModule",{value:!0}),e);var vt=T((Ye,Ce)=>{(function(e,t){typeof Ye=="object"&&typeof Ce<"u"?Ce.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs=t()})(Ye,function(){"use strict";var e=1e3,t=6e4,r=36e5,n="millisecond",i="second",u="minute",s="hour",f="day",w="week",y="month",l="quarter",x="year",v="date",a="Invalid Date",U=/^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/,q=/\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g,I={name:"en",weekdays:"Sunday_Monday_Tuesday_Wednesday_Thursday_Friday_Saturday".split("_"),months:"January_February_March_April_May_June_July_August_September_October_November_December".split("_"),ordinal:function($){var h=["th","st","nd","rd"],c=$%100;return"["+$+(h[(c-20)%10]||h[c]||h[0])+"]"}},C=function($,h,c){var b=String($);return!b||b.length>=h?$:""+Array(h+1-b.length).join(c)+$},H={s:C,z:function($){var h=-$.utcOffset(),c=Math.abs(h),b=Math.floor(c/60),d=c%60;return(h<=0?"+":"-")+C(b,2,"0")+":"+C(d,2,"0")},m:function $(h,c){if(h.date()1)return $(M[0])}else{var W=h.name;S[W]=h,d=W}return!b&&d&&(Y=d),d||!b&&Y},j=function($,h){if(o($))return $.clone();var c=typeof h=="object"?h:{};return c.date=$,c.args=arguments,new z(c)},O=H;O.l=D,O.i=o,O.w=function($,h){return j($,{locale:h.$L,utc:h.$u,x:h.$x,$offset:h.$offset})};var z=function(){function $(c){this.$L=D(c.locale,null,!0),this.parse(c),this.$x=this.$x||c.x||{},this[p]=!0}var h=$.prototype;return h.parse=function(c){this.$d=function(b){var d=b.date,N=b.utc;if(d===null)return new Date(NaN);if(O.u(d))return new Date;if(d instanceof Date)return new Date(d);if(typeof d=="string"&&!/Z$/i.test(d)){var M=d.match(U);if(M){var W=M[2]-1||0,B=(M[7]||"0").substring(0,3);return N?new Date(Date.UTC(M[1],W,M[3]||1,M[4]||0,M[5]||0,M[6]||0,B)):new Date(M[1],W,M[3]||1,M[4]||0,M[5]||0,M[6]||0,B)}}return new Date(d)}(c),this.init()},h.init=function(){var c=this.$d;this.$y=c.getFullYear(),this.$M=c.getMonth(),this.$D=c.getDate(),this.$W=c.getDay(),this.$H=c.getHours(),this.$m=c.getMinutes(),this.$s=c.getSeconds(),this.$ms=c.getMilliseconds()},h.$utils=function(){return O},h.isValid=function(){return this.$d.toString()!==a},h.isSame=function(c,b){var d=j(c);return this.startOf(b)<=d&&d<=this.endOf(b)},h.isAfter=function(c,b){return j(c){(function(e,t){typeof Ee=="object"&&typeof qe<"u"?qe.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_duration=t()})(Ee,function(){"use strict";var e,t,r=1e3,n=6e4,i=36e5,u=864e5,s=/\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g,f=31536e6,w=2628e6,y=/^(-|\+)?P(?:([-+]?[0-9,.]*)Y)?(?:([-+]?[0-9,.]*)M)?(?:([-+]?[0-9,.]*)W)?(?:([-+]?[0-9,.]*)D)?(?:T(?:([-+]?[0-9,.]*)H)?(?:([-+]?[0-9,.]*)M)?(?:([-+]?[0-9,.]*)S)?)?$/,l={years:f,months:w,days:u,hours:i,minutes:n,seconds:r,milliseconds:1,weeks:6048e5},x=function(S){return S instanceof H},v=function(S,p,o){return new H(S,o,p.$l)},a=function(S){return t.p(S)+"s"},U=function(S){return S<0},q=function(S){return U(S)?Math.ceil(S):Math.floor(S)},I=function(S){return Math.abs(S)},C=function(S,p){return S?U(S)?{negative:!0,format:""+I(S)+p}:{negative:!1,format:""+S+p}:{negative:!1,format:""}},H=function(){function S(o,D,j){var O=this;if(this.$d={},this.$l=j,o===void 0&&(this.$ms=0,this.parseFromMilliseconds()),D)return v(o*l[a(D)],this);if(typeof o=="number")return this.$ms=o,this.parseFromMilliseconds(),this;if(typeof o=="object")return Object.keys(o).forEach(function($){O.$d[a($)]=o[$]}),this.calMilliseconds(),this;if(typeof o=="string"){var z=o.match(y);if(z){var J=z.slice(2).map(function($){return $!=null?Number($):0});return this.$d.years=J[0],this.$d.months=J[1],this.$d.weeks=J[2],this.$d.days=J[3],this.$d.hours=J[4],this.$d.minutes=J[5],this.$d.seconds=J[6],this.calMilliseconds(),this}}return this}var p=S.prototype;return p.calMilliseconds=function(){var o=this;this.$ms=Object.keys(this.$d).reduce(function(D,j){return D+(o.$d[j]||0)*l[j]},0)},p.parseFromMilliseconds=function(){var o=this.$ms;this.$d.years=q(o/f),o%=f,this.$d.months=q(o/w),o%=w,this.$d.days=q(o/u),o%=u,this.$d.hours=q(o/i),o%=i,this.$d.minutes=q(o/n),o%=n,this.$d.seconds=q(o/r),o%=r,this.$d.milliseconds=o},p.toISOString=function(){var o=C(this.$d.years,"Y"),D=C(this.$d.months,"M"),j=+this.$d.days||0;this.$d.weeks&&(j+=7*this.$d.weeks);var O=C(j,"D"),z=C(this.$d.hours,"H"),J=C(this.$d.minutes,"M"),$=this.$d.seconds||0;this.$d.milliseconds&&($+=this.$d.milliseconds/1e3,$=Math.round(1e3*$)/1e3);var h=C($,"S"),c=o.negative||D.negative||O.negative||z.negative||J.negative||h.negative,b=z.format||J.format||h.format?"T":"",d=(c?"-":"")+"P"+o.format+D.format+O.format+b+z.format+J.format+h.format;return d==="P"||d==="-P"?"P0D":d},p.toJSON=function(){return this.toISOString()},p.format=function(o){var D=o||"YYYY-MM-DDTHH:mm:ss",j={Y:this.$d.years,YY:t.s(this.$d.years,2,"0"),YYYY:t.s(this.$d.years,4,"0"),M:this.$d.months,MM:t.s(this.$d.months,2,"0"),D:this.$d.days,DD:t.s(this.$d.days,2,"0"),H:this.$d.hours,HH:t.s(this.$d.hours,2,"0"),m:this.$d.minutes,mm:t.s(this.$d.minutes,2,"0"),s:this.$d.seconds,ss:t.s(this.$d.seconds,2,"0"),SSS:t.s(this.$d.milliseconds,3,"0")};return D.replace(s,function(O,z){return z||String(j[O])})},p.as=function(o){return this.$ms/l[a(o)]},p.get=function(o){var D=this.$ms,j=a(o);return j==="milliseconds"?D%=1e3:D=j==="weeks"?q(D/l[j]):this.$d[j],D||0},p.add=function(o,D,j){var O;return O=D?o*l[a(D)]:x(o)?o.$ms:v(o,this).$ms,v(this.$ms+O*(j?-1:1),this)},p.subtract=function(o,D){return this.add(o,D,!0)},p.locale=function(o){var D=this.clone();return D.$l=o,D},p.clone=function(){return v(this.$ms,this)},p.humanize=function(o){return e().add(this.$ms,"ms").locale(this.$l).fromNow(!o)},p.valueOf=function(){return this.asMilliseconds()},p.milliseconds=function(){return this.get("milliseconds")},p.asMilliseconds=function(){return this.as("milliseconds")},p.seconds=function(){return this.get("seconds")},p.asSeconds=function(){return this.as("seconds")},p.minutes=function(){return this.get("minutes")},p.asMinutes=function(){return this.as("minutes")},p.hours=function(){return this.get("hours")},p.asHours=function(){return this.as("hours")},p.days=function(){return this.get("days")},p.asDays=function(){return this.as("days")},p.weeks=function(){return this.get("weeks")},p.asWeeks=function(){return this.as("weeks")},p.months=function(){return this.get("months")},p.asMonths=function(){return this.as("months")},p.years=function(){return this.get("years")},p.asYears=function(){return this.as("years")},S}(),Y=function(S,p,o){return S.add(p.years()*o,"y").add(p.months()*o,"M").add(p.days()*o,"d").add(p.hours()*o,"h").add(p.minutes()*o,"m").add(p.seconds()*o,"s").add(p.milliseconds()*o,"ms")};return function(S,p,o){e=o,t=o().$utils(),o.duration=function(O,z){var J=o.locale();return v(O,{$l:J},z)},o.isDuration=x;var D=p.prototype.add,j=p.prototype.subtract;p.prototype.add=function(O,z){return x(O)?Y(this,O,1):D.bind(this)(O,z)},p.prototype.subtract=function(O,z){return x(O)?Y(this,O,-1):j.bind(this)(O,z)}}})});var bt=T((Ie,We)=>{(function(e,t){typeof Ie=="object"&&typeof We<"u"?We.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_advancedFormat=t()})(Ie,function(){"use strict";return function(e,t){var r=t.prototype,n=r.format;r.format=function(i){var u=this,s=this.$locale();if(!this.isValid())return n.bind(this)(i);var f=this.$utils(),w=(i||"YYYY-MM-DDTHH:mm:ssZ").replace(/\[([^\]]+)]|Q|wo|ww|w|WW|W|zzz|z|gggg|GGGG|Do|X|x|k{1,2}|S/g,function(y){switch(y){case"Q":return Math.ceil((u.$M+1)/3);case"Do":return s.ordinal(u.$D);case"gggg":return u.weekYear();case"GGGG":return u.isoWeekYear();case"wo":return s.ordinal(u.week(),"W");case"w":case"ww":return f.s(u.week(),y==="w"?1:2,"0");case"W":case"WW":return f.s(u.isoWeek(),y==="W"?1:2,"0");case"k":case"kk":return f.s(String(u.$H===0?24:u.$H),y==="k"?1:2,"0");case"X":return Math.floor(u.$d.getTime()/1e3);case"x":return u.$d.getTime();case"z":return"["+u.offsetName()+"]";case"zzz":return"["+u.offsetName("long")+"]";default:return y}});return n.bind(this)(w)}}})});var wt=T((_e,Fe)=>{(function(e,t){typeof _e=="object"&&typeof Fe<"u"?Fe.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_isoWeek=t()})(_e,function(){"use strict";var e="day";return function(t,r,n){var i=function(f){return f.add(4-f.isoWeekday(),e)},u=r.prototype;u.isoWeekYear=function(){return i(this).year()},u.isoWeek=function(f){if(!this.$utils().u(f))return this.add(7*(f-this.isoWeek()),e);var w,y,l,x,v=i(this),a=(w=this.isoWeekYear(),y=this.$u,l=(y?n.utc:n)().year(w).startOf("year"),x=4-l.isoWeekday(),l.isoWeekday()>4&&(x+=7),l.add(x,e));return v.diff(a,"week")+1},u.isoWeekday=function(f){return this.$utils().u(f)?this.day()||7:this.day(this.day()%7?f:f-7)};var s=u.startOf;u.startOf=function(f,w){var y=this.$utils(),l=!!y.u(w)||w;return y.p(f)==="isoweek"?l?this.date(this.date()-(this.isoWeekday()-1)).startOf("day"):this.date(this.date()-1-(this.isoWeekday()-1)+7).endOf("day"):s.bind(this)(f,w)}}})});var Ot=T((He,Be)=>{(function(e,t){typeof He=="object"&&typeof Be<"u"?Be.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_weekYear=t()})(He,function(){"use strict";return function(e,t){t.prototype.weekYear=function(){var r=this.month(),n=this.week(),i=this.year();return n===1&&r===11?i+1:r===0&&n>=52?i-1:i}}})});var xt=T((ze,Le)=>{(function(e,t){typeof ze=="object"&&typeof Le<"u"?Le.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_weekOfYear=t()})(ze,function(){"use strict";var e="week",t="year";return function(r,n,i){var u=n.prototype;u.week=function(s){if(s===void 0&&(s=null),s!==null)return this.add(7*(s-this.week()),"day");var f=this.$locale().yearStart||1;if(this.month()===11&&this.date()>25){var w=i(this).startOf(t).add(1,t).date(f),y=i(this).endOf(e);if(w.isBefore(y))return 1}var l=i(this).startOf(t).date(f).startOf(e).subtract(1,"millisecond"),x=this.diff(l,e,!0);return x<0?i(this).startOf("week").week():Math.ceil(x)},u.weeks=function(s){return s===void 0&&(s=null),this.week(s)}}})});var St=T((Pe,Re)=>{(function(e,t){typeof Pe=="object"&&typeof Re<"u"?Re.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_relativeTime=t()})(Pe,function(){"use strict";return function(e,t,r){e=e||{};var n=t.prototype,i={future:"in %s",past:"%s ago",s:"a few seconds",m:"a minute",mm:"%d minutes",h:"an hour",hh:"%d hours",d:"a day",dd:"%d days",M:"a month",MM:"%d months",y:"a year",yy:"%d years"};function u(f,w,y,l){return n.fromToBase(f,w,y,l)}r.en.relativeTime=i,n.fromToBase=function(f,w,y,l,x){for(var v,a,U,q=y.$locale().relativeTime||i,I=e.thresholds||[{l:"s",r:44,d:"second"},{l:"m",r:89},{l:"mm",r:44,d:"minute"},{l:"h",r:89},{l:"hh",r:21,d:"hour"},{l:"d",r:35},{l:"dd",r:25,d:"day"},{l:"M",r:45},{l:"MM",r:10,d:"month"},{l:"y",r:17},{l:"yy",d:"year"}],C=I.length,H=0;H0,S<=Y.r||!Y.r){S<=1&&H>0&&(Y=I[H-1]);var p=q[Y.l];x&&(S=x(""+S)),a=typeof p=="string"?p.replace("%d",S):p(S,w,Y.l,U);break}}if(w)return a;var o=U?q.future:q.past;return typeof o=="function"?o(a):o.replace("%s",a)},n.to=function(f,w){return u(f,w,this,!0)},n.from=function(f,w){return u(f,w,this)};var s=function(f){return f.$u?r.utc():r()};n.toNow=function(f){return this.to(s(this),f)},n.fromNow=function(f){return this.from(s(this),f)}}})});var jt=T((Ge,Je)=>{(function(e,t){typeof Ge=="object"&&typeof Je<"u"?Je.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_utc=t()})(Ge,function(){"use strict";var e="minute",t=/[+-]\d\d(?::?\d\d)?/g,r=/([+-]|\d\d)/g;return function(n,i,u){var s=i.prototype;u.utc=function(a){var U={date:a,utc:!0,args:arguments};return new i(U)},s.utc=function(a){var U=u(this.toDate(),{locale:this.$L,utc:!0});return a?U.add(this.utcOffset(),e):U},s.local=function(){return u(this.toDate(),{locale:this.$L,utc:!1})};var f=s.parse;s.parse=function(a){a.utc&&(this.$u=!0),this.$utils().u(a.$offset)||(this.$offset=a.$offset),f.call(this,a)};var w=s.init;s.init=function(){if(this.$u){var a=this.$d;this.$y=a.getUTCFullYear(),this.$M=a.getUTCMonth(),this.$D=a.getUTCDate(),this.$W=a.getUTCDay(),this.$H=a.getUTCHours(),this.$m=a.getUTCMinutes(),this.$s=a.getUTCSeconds(),this.$ms=a.getUTCMilliseconds()}else w.call(this)};var y=s.utcOffset;s.utcOffset=function(a,U){var q=this.$utils().u;if(q(a))return this.$u?0:q(this.$offset)?y.call(this):this.$offset;if(typeof a=="string"&&(a=function(Y){Y===void 0&&(Y="");var S=Y.match(t);if(!S)return null;var p=(""+S[0]).match(r)||["-",0,0],o=p[0],D=60*+p[1]+ +p[2];return D===0?0:o==="+"?D:-D}(a),a===null))return this;var I=Math.abs(a)<=16?60*a:a,C=this;if(U)return C.$offset=I,C.$u=a===0,C;if(a!==0){var H=this.$u?this.toDate().getTimezoneOffset():-1*this.utcOffset();(C=this.local().add(I+H,e)).$offset=I,C.$x.$localOffset=H}else C=this.utc();return C};var l=s.format;s.format=function(a){var U=a||(this.$u?"YYYY-MM-DDTHH:mm:ss[Z]":"");return l.call(this,U)},s.valueOf=function(){var a=this.$utils().u(this.$offset)?0:this.$offset+(this.$x.$localOffset||this.$d.getTimezoneOffset());return this.$d.valueOf()-6e4*a},s.isUTC=function(){return!!this.$u},s.toISOString=function(){return this.toDate().toISOString()},s.toString=function(){return this.toDate().toUTCString()};var x=s.toDate;s.toDate=function(a){return a==="s"&&this.$offset?u(this.format("YYYY-MM-DD HH:mm:ss:SSS")).toDate():x.call(this)};var v=s.diff;s.diff=function(a,U,q){if(a&&this.$u===a.$u)return v.call(this,a,U,q);var I=this.local(),C=u(a).local();return v.call(I,C,U,q)}}})});var Nt=T((Ze,Ve)=>{(function(e,t){typeof Ze=="object"&&typeof Ve<"u"?Ve.exports=t():typeof define=="function"&&define.amd?define(t):(e=typeof globalThis<"u"?globalThis:e||self).dayjs_plugin_timezone=t()})(Ze,function(){"use strict";var e={year:0,month:1,day:2,hour:3,minute:4,second:5},t={};return function(r,n,i){var u,s=function(l,x,v){v===void 0&&(v={});var a=new Date(l),U=function(q,I){I===void 0&&(I={});var C=I.timeZoneName||"short",H=q+"|"+C,Y=t[H];return Y||(Y=new Intl.DateTimeFormat("en-US",{hour12:!1,timeZone:q,year:"numeric",month:"2-digit",day:"2-digit",hour:"2-digit",minute:"2-digit",second:"2-digit",timeZoneName:C}),t[H]=Y),Y}(x,v);return U.formatToParts(a)},f=function(l,x){for(var v=s(l,x),a=[],U=0;U=0&&(a[H]=parseInt(C,10))}var Y=a[3],S=Y===24?0:Y,p=a[0]+"-"+a[1]+"-"+a[2]+" "+S+":"+a[4]+":"+a[5]+":000",o=+l;return(i.utc(p).valueOf()-(o-=o%1e3))/6e4},w=n.prototype;w.tz=function(l,x){l===void 0&&(l=u);var v=this.utcOffset(),a=this.toDate(),U=a.toLocaleString("en-US",{timeZone:l}),q=Math.round((a-new Date(U))/1e3/60),I=i(U,{locale:this.$L}).$set("millisecond",this.$ms).utcOffset(15*-Math.round(a.getTimezoneOffset()/15)-q,!0);if(x){var C=I.utcOffset();I=I.add(v-C,"minute")}return I.$x.$timezone=l,I},w.offsetName=function(l){var x=this.$x.$timezone||i.tz.guess(),v=s(this.valueOf(),x,{timeZoneName:l}).find(function(a){return a.type.toLowerCase()==="timezonename"});return v&&v.value};var y=w.startOf;w.startOf=function(l,x){if(!this.$x||!this.$x.$timezone)return y.call(this,l,x);var v=i(this.format("YYYY-MM-DD HH:mm:ss:SSS"),{locale:this.$L});return y.call(v,l,x).tz(this.$x.$timezone,!0)},i.tz=function(l,x,v){var a=v&&x,U=v||x||u,q=f(+i(),U);if(typeof l!="string")return i(l).tz(U);var I=function(S,p,o){var D=S-60*p*1e3,j=f(D,o);if(p===j)return[D,p];var O=f(D-=60*(j-p)*1e3,o);return j===O?[D,j]:[S-60*Math.min(j,O)*1e3,Math.max(j,O)]}(i.utc(l,a).valueOf(),q,U),C=I[0],H=I[1],Y=i(C).utcOffset(H);return Y.$x.$timezone=U,Y},i.tz.guess=function(){return Intl.DateTimeFormat().resolvedOptions().timeZone},i.tz.setDefault=function(l){u=l}}})});var et=T((Pi,_t)=>{_t.exports=function(e){return e!=null&&(Wt(e)||Tn(e)||!!e._isBuffer)};function Wt(e){return!!e.constructor&&typeof e.constructor.isBuffer=="function"&&e.constructor.isBuffer(e)}function Tn(e){return typeof e.readFloatLE=="function"&&typeof e.slice=="function"&&Wt(e.slice(0,0))}});var Ht=T((Ri,Ft)=>{var Yn=et(),Cn=Object.prototype.toString;Ft.exports=function(t){if(typeof t>"u")return"undefined";if(t===null)return"null";if(t===!0||t===!1||t instanceof Boolean)return"boolean";if(typeof t=="string"||t instanceof String)return"string";if(typeof t=="number"||t instanceof Number)return"number";if(typeof t=="function"||t instanceof Function)return"function";if(typeof Array.isArray<"u"&&Array.isArray(t))return"array";if(t instanceof RegExp)return"regexp";if(t instanceof Date)return"date";var r=Cn.call(t);return r==="[object RegExp]"?"regexp":r==="[object Date]"?"date":r==="[object Arguments]"?"arguments":r==="[object Error]"?"error":Yn(t)?"buffer":r==="[object Set]"?"set":r==="[object WeakSet]"?"weakset":r==="[object Map]"?"map":r==="[object WeakMap]"?"weakmap":r==="[object Symbol]"?"symbol":r==="[object Int8Array]"?"int8array":r==="[object Uint8Array]"?"uint8array":r==="[object Uint8ClampedArray]"?"uint8clampedarray":r==="[object Int16Array]"?"int16array":r==="[object Uint16Array]"?"uint16array":r==="[object Int32Array]"?"int32array":r==="[object Uint32Array]"?"uint32array":r==="[object Float32Array]"?"float32array":r==="[object Float64Array]"?"float64array":"object"}});var Pt=T((Gi,Lt)=>{"use strict";var Bt=Ht(),zt={arguments:"an arguments object",array:"an array",boolean:"a boolean",buffer:"a buffer",date:"a date",error:"an error",float32array:"a float32array",float64array:"a float64array",function:"a function",int16array:"an int16array",int32array:"an int32array",int8array:"an int8array",map:"a Map",null:"null",number:"a number",object:"an object",regexp:"a regular expression",set:"a Set",string:"a string",symbol:"a symbol",uint16array:"an uint16array",uint32array:"an uint32array",uint8array:"an uint8array",uint8clampedarray:"an uint8clampedarray",undefined:"undefined",weakmap:"a WeakMap",weakset:"a WeakSet"};function tt(e){return zt[Bt(e)]}tt.types=zt;tt.typeOf=Bt;Lt.exports=tt});var Ne=T((Ji,Gt)=>{var En=Object.prototype.toString;Gt.exports=function(t){if(t===void 0)return"undefined";if(t===null)return"null";var r=typeof t;if(r==="boolean")return"boolean";if(r==="string")return"string";if(r==="number")return"number";if(r==="symbol")return"symbol";if(r==="function")return Fn(t)?"generatorfunction":"function";if(qn(t))return"array";if(zn(t))return"buffer";if(Bn(t))return"arguments";if(Wn(t))return"date";if(In(t))return"error";if(_n(t))return"regexp";switch(Rt(t)){case"Symbol":return"symbol";case"Promise":return"promise";case"WeakMap":return"weakmap";case"WeakSet":return"weakset";case"Map":return"map";case"Set":return"set";case"Int8Array":return"int8array";case"Uint8Array":return"uint8array";case"Uint8ClampedArray":return"uint8clampedarray";case"Int16Array":return"int16array";case"Uint16Array":return"uint16array";case"Int32Array":return"int32array";case"Uint32Array":return"uint32array";case"Float32Array":return"float32array";case"Float64Array":return"float64array"}if(Hn(t))return"generator";switch(r=En.call(t),r){case"[object Object]":return"object";case"[object Map Iterator]":return"mapiterator";case"[object Set Iterator]":return"setiterator";case"[object String Iterator]":return"stringiterator";case"[object Array Iterator]":return"arrayiterator"}return r.slice(8,-1).toLowerCase().replace(/\s/g,"")};function Rt(e){return typeof e.constructor=="function"?e.constructor.name:null}function qn(e){return Array.isArray?Array.isArray(e):e instanceof Array}function In(e){return e instanceof Error||typeof e.message=="string"&&e.constructor&&typeof e.constructor.stackTraceLimit=="number"}function Wn(e){return e instanceof Date?!0:typeof e.toDateString=="function"&&typeof e.getDate=="function"&&typeof e.setDate=="function"}function _n(e){return e instanceof RegExp?!0:typeof e.flags=="string"&&typeof e.ignoreCase=="boolean"&&typeof e.multiline=="boolean"&&typeof e.global=="boolean"}function Fn(e,t){return Rt(e)==="GeneratorFunction"}function Hn(e){return typeof e.throw=="function"&&typeof e.return=="function"&&typeof e.next=="function"}function Bn(e){try{if(typeof e.length=="number"&&typeof e.callee=="function")return!0}catch(t){if(t.message.indexOf("callee")!==-1)return!0}return!1}function zn(e){return e.constructor&&typeof e.constructor.isBuffer=="function"?e.constructor.isBuffer(e):!1}});var te=T((Vt,Qt)=>{"use strict";var Ln=oe("util"),Jt=Pt(),Pn=Ne(),m=Vt=Qt.exports;m.extend=Zt;m.indexOf=Qn;m.escapeExpression=Xn;m.isEmpty=ri;m.createFrame=Kn;m.blockParams=ei;m.appendContextPath=ti;var Rn={"&":"&","<":"<",">":">",'"':""","'":"'","`":"`","=":"="},Gn=/[&<>"'`=]/g,Jn=/[&<>"'`=]/;function Zn(e){return Rn[e]}function Zt(e){for(var t=1;t{"use strict";var ni=te();me.contains=function(e,t,r){return e==null||t==null||isNaN(e.length)?!1:e.indexOf(t,r)!==-1};me.chop=function(e){if(typeof e!="string")return"";var t=/^[-_.\W\s]+|[-_.\W\s]+$/g;return e.trim().replace(t,"")};me.changecase=function(e,t){if(typeof e!="string")return"";if(e.length===1)return e.toLowerCase();e=me.chop(e).toLowerCase(),typeof t!="function"&&(t=ni.identity);var r=/[-_.\W\s]+(\w|$)/g;return e.replace(r,function(n,i){return t(i)})};me.random=function(e,t){return e+Math.floor(Math.random()*(t-e+1))}});var Kt=T((Vi,Xt)=>{"use strict";var ii=Me(),Q=Xt.exports;Q.abs=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.abs(e)};Q.add=function(e,t){return!isNaN(e)&&!isNaN(t)?Number(e)+Number(t):typeof e=="string"&&typeof t=="string"?e+t:""};Q.avg=function(){let e=[].concat.apply([],arguments);return e.pop(),Q.sum(e)/e.length};Q.ceil=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.ceil(e)};Q.divide=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)/Number(t)};Q.floor=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.floor(e)};Q.minus=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)-Number(t)};Q.modulo=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)%Number(t)};Q.multiply=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)*Number(t)};Q.plus=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)+Number(t)};Q.random=function(e,t){if(isNaN(e))throw new TypeError("expected minimum to be a number");if(isNaN(t))throw new TypeError("expected maximum to be a number");return ii.random(e,t)};Q.remainder=function(e,t){return e%t};Q.round=function(e){if(isNaN(e))throw new TypeError("expected a number");return Math.round(e)};Q.subtract=function(e,t){if(isNaN(e))throw new TypeError("expected the first argument to be a number");if(isNaN(t))throw new TypeError("expected the second argument to be a number");return Number(e)-Number(t)};Q.sum=function(){for(var e=[].concat.apply([],arguments),t=e.length,r=0;t--;)isNaN(e[t])||(r+=Number(e[t]));return r}});var tr=T((Qi,er)=>{"use strict";er.exports=function(t){return t!=null&&typeof t=="object"&&Array.isArray(t)===!1}});var Ae=T((Xi,ur)=>{var ir=tr();ur.exports=function(e,t,r){if(ir(r)||(r={default:r}),!nr(e))return typeof r.default<"u"?r.default:e;typeof t=="number"&&(t=String(t));let n=Array.isArray(t),i=typeof t=="string",u=r.separator||".",s=r.joinChar||(typeof u=="string"?u:".");if(!i&&!n)return e;if(i&&t in e)return it(t,e,r)?e[t]:r.default;let f=n?t:ui(t,u,r),w=f.length,y=0;do{let l=f[y];for(typeof l=="number"&&(l=String(l));l&&l.slice(-1)==="\\";)l=rr([l.slice(0,-1),f[++y]||""],s,r);if(l in e){if(!it(l,e,r))return r.default;e=e[l]}else{let x=!1,v=y+1;for(;v{"use strict";sr.exports=function(t){if(typeof t!="object")throw new TypeError("createFrame expects data to be an object");var r=Object.assign({},t);if(r._parent=t,r.extend=function(s){Object.assign(this,s)},arguments.length>1)for(var n=[].slice.call(arguments,1),i=n.length,u=-1;++u{"use strict";var g=te(),E=fr.exports,ce=Ae(),si=ut();E.after=function(e,t){return g.isUndefined(e)?"":(e=g.result(e),Array.isArray(e)?e.slice(t):"")};E.arrayify=function(e){return g.isUndefined(e)?[]:e?Array.isArray(e)?e:[e]:[]};E.before=function(e,t){return g.isUndefined(e)?"":(e=g.result(e),Array.isArray(e)?e.slice(0,t-1):"")};E.eachIndex=function(e,t){var r="";if(g.isUndefined(e))return"";if(e=g.result(e),Array.isArray(e))for(var n=0;n0){for(var s=0;s-1,this,r):"")};E.isArray=function(e){return Array.isArray(e)};E.itemAt=function(e,t){if(g.isUndefined(e))return null;if(e=g.result(e),Array.isArray(e)){if(t=isNaN(t)?0:+t,t<0)return e[e.length+t];if(ti[t]>u[t]?1:-1)}return""};E.withAfter=function(e,t,r){if(g.isUndefined(e))return"";if(e=g.result(e),Array.isArray(e)){e=e.slice(t);for(var n="",i=0;i0){for(var i=[],u=0;u0&&u%t===0&&(n+=r.fn(i),i=[]),i.push(e[u]);n+=r.fn(i)}return n};E.withLast=function(e,t,r){if(g.isUndefined(e))return"";if(e=g.result(e),Array.isArray(e)){if(g.isUndefined(t)||(t=parseFloat(g.result(t))),g.isUndefined(t))return r=t,r.fn(e[e.length-1]);e=e.slice(-t);for(var n=e.length,i=-1,u="";++iy?1:w{"use strict";var or=te(),re=ar.exports;re.bytes=function(e,t,r){if(e==null||isNaN(e)&&(e=e.length,!e))return"0 B";isNaN(t)&&(t=2);var n=["B","kB","MB","GB","TB","PB","EB","ZB","YB"];t=Math.pow(10,t),e=Number(e);for(var i=n.length-1;i-->=0;){var u=Math.pow(10,i*3);if(u<=e+1){e=Math.round(e*t/u)/t,e+=" "+n[i];break}}return e};re.addCommas=function(e){return e.toString().replace(/(\d)(?=(\d\d\d)+(?!\d))/g,"$1,")};re.phoneNumber=function(e){return e=e.toString(),"("+e.substr(0,3)+") "+e.substr(3,3)+"-"+e.substr(6,4)};re.toAbbr=function(e,t){isNaN(e)&&(e=0),or.isUndefined(t)&&(t=2),e=Number(e),t=Math.pow(10,t);for(var r=["k","m","b","t","q"],n=r.length-1;n>=0;){var i=Math.pow(10,(n+1)*3);if(i<=e+1){e=Math.round(e*t/i)/t,e+=r[n];break}n--}return e};re.toExponential=function(e,t){return isNaN(e)&&(e=0),or.isUndefined(t)&&(t=0),Number(e).toExponential(t)};re.toFixed=function(e,t){return isNaN(e)&&(e=0),isNaN(t)&&(t=0),Number(e).toFixed(t)};re.toFloat=function(e){return parseFloat(e)};re.toInt=function(e){return parseInt(e,10)};re.toPrecision=function(e,t){return isNaN(e)&&(e=0),isNaN(t)&&(t=1),Number(e).toPrecision(t)}});var dr=T((ru,lr)=>{"use strict";var st=oe("url"),ve=te(),fi=oe("querystring"),le=lr.exports;le.encodeURI=function(e){if(ve.isString(e))return encodeURIComponent(e)};le.escape=function(e){if(ve.isString(e))return fi.escape(e)};le.decodeURI=function(e){if(ve.isString(e))return decodeURIComponent(e)};le.urlResolve=function(e,t){return st.resolve(e,t)};le.urlParse=function(e){return st.parse(e)};le.stripQuerystring=function(e){if(ve.isString(e))return e.split("?")[0]};le.stripProtocol=function(e){if(ve.isString(e)){var t=st.parse(e);return t.protocol="",t.format()}}});var mr=T((hr,pr)=>{"use strict";var P=te(),de=Me(),A=pr.exports;A.append=function(e,t){return typeof e=="string"&&typeof t=="string"?e+t:e};A.camelcase=function(e){return typeof e!="string"?"":de.changecase(e,function(t){return t.toUpperCase()})};A.capitalize=function(e){return typeof e!="string"?"":e.charAt(0).toUpperCase()+e.slice(1)};A.capitalizeAll=function(e){if(typeof e!="string")return"";if(P.isString(e))return e.replace(/\w\S*/g,function(t){return A.capitalize(t)})};A.center=function(e,t){if(typeof e!="string")return"";for(var r="",n=0;n-1;)i++,n+=r;return i};A.pascalcase=function(e){return typeof e!="string"?"":(e=de.changecase(e,function(t){return t.toUpperCase()}),e.charAt(0).toUpperCase()+e.slice(1))};A.pathcase=function(e){return typeof e!="string"?"":de.changecase(e,function(t){return"/"+t})};A.plusify=function(e,t){return typeof e!="string"?"":(P.isString(t)||(t=" "),e.split(t).join("+"))};A.prepend=function(e,t){return typeof e=="string"&&typeof t=="string"?t+e:e};A.raw=function(e){var t=e.fn(),r=P.options(this,e);if(r.escape!==!1)for(var n=0;(n=t.indexOf("{{",n))!==-1;)t[n-1]!=="\\"&&(t=t.slice(0,n)+"\\"+t.slice(n)),n+=3;return t};A.remove=function(e,t){return typeof e!="string"?"":P.isString(t)?e.split(t).join(""):e};A.removeFirst=function(e,t){return typeof e!="string"?"":P.isString(t)?e.replace(t,""):e};A.replace=function(e,t,r){return typeof e!="string"?"":P.isString(t)?(P.isString(r)||(r=""),e.split(t).join(r)):e};A.replaceFirst=function(e,t,r){return typeof e!="string"?"":P.isString(t)?(P.isString(r)||(r=""),e.replace(t,r)):e};A.reverse=ke().reverse;A.sentence=function(e){return typeof e!="string"?"":e.replace(/((?:\S[^\.\?\!]*)[\.\?\!]*)/g,function(t){return t.charAt(0).toUpperCase()+t.substr(1).toLowerCase()})};A.snakecase=function(e){return typeof e!="string"?"":de.changecase(e,function(t){return"_"+t})};A.split=function(e,t){return typeof e!="string"?"":(P.isString(t)||(t=","),e.split(t))};A.startsWith=function(e,t,r){var n=[].slice.call(arguments);return r=n.pop(),P.isString(t)&&t.indexOf(e)===0?r.fn(this):typeof r.inverse=="function"?r.inverse(this):""};A.titleize=function(e){if(typeof e!="string")return"";for(var t=e.replace(/[- _]+/g," "),r=t.split(" "),n=r.length,i=[],u=0;n--;){var s=r[u++];i.push(hr.capitalize(s))}return i.join(" ")};A.trim=function(e){return typeof e=="string"?e.trim():""};A.trimLeft=function(e){if(P.isString(e))return e.replace(/^\s+/,"")};A.trimRight=function(e){if(P.isString(e))return e.replace(/\s+$/,"")};A.truncate=function(e,t,r){if(P.isString(e))return typeof r!="string"&&(r=""),e.length>t?e.slice(0,t-r.length)+r:e};A.truncateWords=function(e,t,r){if(P.isString(e)&&!isNaN(t)){typeof r!="string"&&(r="\u2026");var n=Number(t),i=e.split(/[ \t]/);if(n>=i.length)return e;i=i.slice(0,n);var u=i.join(" ").trim();return u+r}};A.upcase=function(){return A.uppercase.apply(this,arguments)};A.uppercase=function(e){return P.isObject(e)&&e.fn?e.fn(this).toUpperCase():typeof e!="string"?"":e.toUpperCase()}});var gr=T((nu,yr)=>{"use strict";var oi=Ne();yr.exports=function e(t){switch(oi(t)){case"boolean":case"date":case"function":case"null":case"number":return!0;case"undefined":return!1;case"regexp":return t.source!=="(?:)"&&t.source!=="";case"buffer":return t.toString()!=="";case"error":return t.message!=="";case"string":case"arguments":return t.length!==0;case"file":case"map":case"set":return t.size!==0;case"array":case"object":for(let r of Object.keys(t))if(e(t[r]))return!0;return!1;default:return!0}}});var $r=T((iu,vr)=>{"use strict";var ai=Ae(),ci=gr();vr.exports=function(e,t,r){return li(e)&&(typeof t=="string"||Array.isArray(t))?ci(ai(e,t,r)):!1};function li(e){return e!=null&&(typeof e=="object"||typeof e=="function"||Array.isArray(e))}});var wr=T((uu,br)=>{"use strict";function ft(e,t){if(!e)return!0;let r=t||ft.keywords;Array.isArray(r)||(r=[r]);let n=typeof e=="string"?e.toLowerCase():null;for(let i of r)if(i===e||i===n)return!0;return!1}ft.keywords=["0","false","nada","nil","nay","nah","negative","no","none","nope","nul","null","nix","nyet","uh-uh","veto","zero"];br.exports=ft});var xr=T((su,Or)=>{"use strict";Or.exports=function(t){let r=Math.abs(t);if(isNaN(r))throw new TypeError("expected a number");if(!Number.isInteger(r))throw new Error("expected an integer");if(!Number.isSafeInteger(r))throw new Error("value exceeds maximum safe integer");return r%2===1}});var Mr=T((fu,Nr)=>{"use strict";var di=$r(),k=te(),hi=Me(),Sr=wr(),jr=xr(),_=Nr.exports;_.and=function(){for(var e=arguments.length-1,t=arguments[e],r=!0,n=0;n":i=e>r;break;case"<=":i=e<=r;break;case">=":i=e>=r;break;case"typeof":i=typeof e===r;break;default:throw new Error("helper {{compare}}: invalid operator: `"+t+"`")}return k.value(i,this,n)};_.contains=function(e,t,r,n){typeof r=="object"&&(n=r,r=void 0);var i=hi.contains(e,t,r);return k.value(i,this,n)};_.default=function(){for(var e=0;et,this,r)};_.gte=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e>=t,this,r)};_.has=function(e,t,r){return k.isOptions(e)&&(r=e,t=null,e=null),k.isOptions(t)&&(r=t,t=null),e===null?k.value(!1,this,r):arguments.length===2?k.value(di(this,e),this,r):(Array.isArray(e)||k.isString(e))&&k.isString(t)&&e.indexOf(t)>-1?k.fn(!0,this,r):k.isObject(e)&&k.isString(t)&&t in e?k.fn(!0,this,r):k.inverse(!1,this,r)};_.isFalsey=function(e,t){return k.value(Sr(e),this,t)};_.isTruthy=function(e,t){return k.value(!Sr(e),this,t)};_.ifEven=function(e,t){return k.value(!jr(e),this,t)};_.ifNth=function(e,t,r){var n=!isNaN(e)&&!isNaN(t)&&t%e===0;return k.value(n,this,r)};_.ifOdd=function(e,t){return k.value(jr(e),this,t)};_.is=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e==t,this,r)};_.isnt=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e!=t,this,r)};_.lt=function(e,t,r){return arguments.length===2&&(r=t,t=r.hash.compare),k.value(e=t,this,r)};_.unlessGteq=function(e,t,r){return k.isOptions(t)&&(r=t,t=r.hash.compare),k.value(et,this,r)}});var kr=T((ou,Ar)=>{var pi=et(),mi=Object.prototype.toString;Ar.exports=function(t){if(typeof t>"u")return"undefined";if(t===null)return"null";if(t===!0||t===!1||t instanceof Boolean)return"boolean";if(typeof t=="string"||t instanceof String)return"string";if(typeof t=="number"||t instanceof Number)return"number";if(typeof t=="function"||t instanceof Function)return"function";if(typeof Array.isArray<"u"&&Array.isArray(t))return"array";if(t instanceof RegExp)return"regexp";if(t instanceof Date)return"date";var r=mi.call(t);return r==="[object RegExp]"?"regexp":r==="[object Date]"?"date":r==="[object Arguments]"?"arguments":r==="[object Error]"?"error":pi(t)?"buffer":r==="[object Set]"?"set":r==="[object WeakSet]"?"weakset":r==="[object Map]"?"map":r==="[object WeakMap]"?"weakmap":r==="[object Symbol]"?"symbol":r==="[object Int8Array]"?"int8array":r==="[object Uint8Array]"?"uint8array":r==="[object Uint8ClampedArray]"?"uint8clampedarray":r==="[object Int16Array]"?"int16array":r==="[object Uint16Array]"?"uint16array":r==="[object Int32Array]"?"int32array":r==="[object Uint32Array]"?"uint32array":r==="[object Float32Array]"?"float32array":r==="[object Float64Array]"?"float64array":"object"}});var Ur=T((au,Dr)=>{"use strict";var yi=kr();Dr.exports=function(t){var r=yi(t);if(r!=="number"&&r!=="string")return!1;var n=+t;return n-n+1>=0&&t!==""}});var Yr=T((cu,Tr)=>{"use strict";var gi=Ur();Tr.exports=function(t,r){if(!r)return t;if(!t)return{};for(var n=String(r).split(/[[.\]]/).filter(Boolean),i=n[n.length-1],u={};r=n.shift();)if(t=t[r],!t)return{};return gi(i)?[t]:(u[i]=t,u)}});var Ir=T((lu,qr)=>{"use strict";var vi=Object.hasOwnProperty,$e=te(),$i=ke(),R=qr.exports,bi=Ae(),Cr=Yr(),Er=ut();R.extend=function(){var e=[].slice.call(arguments),t={};$e.isOptions(e[e.length-1])&&(t=e.pop().hash,e.push(t));for(var r={},n=0;n{"use strict";var wi=te(),Wr=_r.exports,Oi=Ne();Wr.toRegex=function(e,t,r){var n=wi.options({},t,r);return new RegExp(e,n.flags)};Wr.test=function(e,t){if(typeof e!="string")return!1;if(Oi(t)!=="regexp")throw new TypeError("expected a regular expression");return t.test(e)}});function be(){return De>Ue.length-16&&(Hr.default.randomFillSync(Ue),De=0),Ue.slice(De,De+=16)}var Hr,Ue,De,ot=V(()=>{Hr=F(oe("crypto")),Ue=new Uint8Array(256),De=Ue.length});var Br,zr=V(()=>{Br=/^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i});function xi(e){return typeof e=="string"&&Br.test(e)}var ue,we=V(()=>{zr();ue=xi});function he(e,t=0){return G[e[t+0]]+G[e[t+1]]+G[e[t+2]]+G[e[t+3]]+"-"+G[e[t+4]]+G[e[t+5]]+"-"+G[e[t+6]]+G[e[t+7]]+"-"+G[e[t+8]]+G[e[t+9]]+"-"+G[e[t+10]]+G[e[t+11]]+G[e[t+12]]+G[e[t+13]]+G[e[t+14]]+G[e[t+15]]}function Si(e,t=0){let r=he(e,t);if(!ue(r))throw TypeError("Stringified UUID is invalid");return r}var G,Lr,Oe=V(()=>{we();G=[];for(let e=0;e<256;++e)G.push((e+256).toString(16).slice(1));Lr=Si});function ji(e,t,r){let n=t&&r||0,i=t||new Array(16);e=e||{};let u=e.node||Pr,s=e.clockseq!==void 0?e.clockseq:at;if(u==null||s==null){let v=e.random||(e.rng||be)();u==null&&(u=Pr=[v[0]|1,v[1],v[2],v[3],v[4],v[5]]),s==null&&(s=at=(v[6]<<8|v[7])&16383)}let f=e.msecs!==void 0?e.msecs:Date.now(),w=e.nsecs!==void 0?e.nsecs:lt+1,y=f-ct+(w-lt)/1e4;if(y<0&&e.clockseq===void 0&&(s=s+1&16383),(y<0||f>ct)&&e.nsecs===void 0&&(w=0),w>=1e4)throw new Error("uuid.v1(): Can't create more than 10M uuids/sec");ct=f,lt=w,at=s,f+=122192928e5;let l=((f&268435455)*1e4+w)%4294967296;i[n++]=l>>>24&255,i[n++]=l>>>16&255,i[n++]=l>>>8&255,i[n++]=l&255;let x=f/4294967296*1e4&268435455;i[n++]=x>>>8&255,i[n++]=x&255,i[n++]=x>>>24&15|16,i[n++]=x>>>16&255,i[n++]=s>>>8|128,i[n++]=s&255;for(let v=0;v<6;++v)i[n+v]=u[v];return t||he(i)}var Pr,at,ct,lt,Rr,Gr=V(()=>{ot();Oe();ct=0,lt=0;Rr=ji});function Ni(e){if(!ue(e))throw TypeError("Invalid UUID");let t,r=new Uint8Array(16);return r[0]=(t=parseInt(e.slice(0,8),16))>>>24,r[1]=t>>>16&255,r[2]=t>>>8&255,r[3]=t&255,r[4]=(t=parseInt(e.slice(9,13),16))>>>8,r[5]=t&255,r[6]=(t=parseInt(e.slice(14,18),16))>>>8,r[7]=t&255,r[8]=(t=parseInt(e.slice(19,23),16))>>>8,r[9]=t&255,r[10]=(t=parseInt(e.slice(24,36),16))/1099511627776&255,r[11]=t/4294967296&255,r[12]=t>>>24&255,r[13]=t>>>16&255,r[14]=t>>>8&255,r[15]=t&255,r}var Te,dt=V(()=>{we();Te=Ni});function Mi(e){e=unescape(encodeURIComponent(e));let t=[];for(let r=0;r{Oe();dt();Ai="6ba7b810-9dad-11d1-80b4-00c04fd430c8",ki="6ba7b811-9dad-11d1-80b4-00c04fd430c8"});function Di(e){return Array.isArray(e)?e=Buffer.from(e):typeof e=="string"&&(e=Buffer.from(e,"utf8")),Jr.default.createHash("md5").update(e).digest()}var Jr,Zr,Vr=V(()=>{Jr=F(oe("crypto"));Zr=Di});var Ui,Qr,Xr=V(()=>{ht();Vr();Ui=xe("v3",48,Zr),Qr=Ui});var Kr,pt,en=V(()=>{Kr=F(oe("crypto")),pt={randomUUID:Kr.default.randomUUID}});function Ti(e,t,r){if(pt.randomUUID&&!t&&!e)return pt.randomUUID();e=e||{};let n=e.random||(e.rng||be)();if(n[6]=n[6]&15|64,n[8]=n[8]&63|128,t){r=r||0;for(let i=0;i<16;++i)t[r+i]=n[i];return t}return he(n)}var tn,rn=V(()=>{en();ot();Oe();tn=Ti});function Yi(e){return Array.isArray(e)?e=Buffer.from(e):typeof e=="string"&&(e=Buffer.from(e,"utf8")),nn.default.createHash("sha1").update(e).digest()}var nn,un,sn=V(()=>{nn=F(oe("crypto"));un=Yi});var Ci,fn,on=V(()=>{ht();sn();Ci=xe("v5",80,un),fn=Ci});var an,cn=V(()=>{an="00000000-0000-0000-0000-000000000000"});function Ei(e){if(!ue(e))throw TypeError("Invalid UUID");return parseInt(e.slice(14,15),16)}var ln,dn=V(()=>{we();ln=Ei});var hn={};mt(hn,{NIL:()=>an,parse:()=>Te,stringify:()=>Lr,v1:()=>Rr,v3:()=>Qr,v4:()=>tn,v5:()=>fn,validate:()=>ue,version:()=>ln});var pn=V(()=>{Gr();Xr();rn();on();cn();dn();we();Oe();dt()});var yn=T((Xu,mn)=>{var qi=(pn(),gt(hn)),Ii=mn.exports;Ii.uuid=function(){return qi.v4()}});var Bi={};mt(Bi,{default:()=>Hi});var X=F(vt()),Mt=F($t()),At=F(bt()),kt=F(wt()),Dt=F(Ot()),Ut=F(xt()),Tt=F(St()),Yt=F(jt()),Ct=F(Nt());X.default.extend(Mt.default);X.default.extend(At.default);X.default.extend(kt.default);X.default.extend(Dt.default);X.default.extend(Ut.default);X.default.extend(Tt.default);X.default.extend(Yt.default);X.default.extend(Ct.default);function ae(e){return typeof e=="object"&&typeof e.hash=="object"}function Qe(e){return typeof e=="object"&&typeof e.options=="object"&&typeof e.app=="object"}function Xe(e,t,r){if(ae(e))return Xe({},t,e);if(ae(t))return Xe(e,r,t);let n=Qe(e)?e.context:{};r=r||{},ae(r)||(t=Object.assign({},t,r)),ae(r)&&r.hash.root===!0&&(t=Object.assign({},r.data.root,t));let i=Object.assign({},n,t,r.hash);return Qe(e)||(i=Object.assign({},e,i)),Qe(e)&&e.view&&e.view.data&&(i=Object.assign({},i,e.view.data)),i}function Ke(e,t,r){return ae(t)&&(r=t,t=null),ae(e)&&(r=e,t=null,e=null),{str:e,pattern:t,options:r}}function Et(e,t,r){let n=Ke(e,t,r),i={lang:"en",date:new Date(n.str)},u=Xe(this,i,{});X.default.locale(u.lang||u.language)}var qt=(e,t,r)=>{let n=Ke(e,t,r);if(n.str==null&&n.pattern==null)return X.default.locale("en"),(0,X.default)().format("MMMM DD, YYYY");Et(n.str,n.pattern,n.options);let i=(0,X.default)(new Date(n.str));return typeof n.options=="string"?i=n.options.toLowerCase()==="utc"?i.utc():i.tz(n.options):i=i.tz(X.default.tz.guess()),n.pattern===""?i.toISOString():i.format(n.pattern)},It=(e,t,r)=>{let n=Ke(e,t);Et(n.str,n.pattern);let i=X.default.duration(n.str,n.pattern);return r&&!ae(r)?i.format(r):i.humanize()};var gn=F(Kt()),vn=F(ke()),$n=F(cr()),bn=F(dr()),wn=F(mr()),On=F(Mr()),xn=F(Ir()),Sn=F(Fr()),jn=F(yn()),Wi={math:gn.default,array:vn.default,number:$n.default,url:bn.default,string:wn.default,comparison:On.default,object:xn.default,regex:Sn.default,uuid:jn.default},_i=["sortBy"],Fi={date:qt,duration:It},ne;function Nn(){if(ne)return ne;ne={};for(let e of Object.values(Wi))for(let[t,r]of Object.entries(e))ne[t]=(...n)=>r(...n,{});ne={...ne,...Fi};for(let e of _i)delete ne[e];return Object.freeze(ne),ne}var Hi={...Nn(),stripProtocol:helpersStripProtocol};return gt(Bi);})(); /*! Bundled license information: is-buffer/index.js: diff --git a/packages/server/src/jsRunner/bundles/index-helpers.ts b/packages/server/src/jsRunner/bundles/index-helpers.ts index a8992294a9..9e95dbf0a4 100644 --- a/packages/server/src/jsRunner/bundles/index-helpers.ts +++ b/packages/server/src/jsRunner/bundles/index-helpers.ts @@ -1,6 +1,5 @@ -const { - getJsHelperList, -} = require("../../../../string-templates/src/helpers/list.js") +// eslint-disable-next-line local-rules/no-budibase-imports +import { getJsHelperList } from "@budibase/string-templates/src/helpers/list" export default { ...getJsHelperList(), diff --git a/packages/server/src/jsRunner/bundles/index.ts b/packages/server/src/jsRunner/bundles/index.ts index 9e2960807a..94a40fea29 100644 --- a/packages/server/src/jsRunner/bundles/index.ts +++ b/packages/server/src/jsRunner/bundles/index.ts @@ -1,15 +1,15 @@ -import { utils } from "@budibase/shared-core" -import environment from "../../environment" import fs from "fs" export const enum BundleType { HELPERS = "helpers", BSON = "bson", + SNIPPETS = "snippets", } const bundleSourceFile: Record = { [BundleType.HELPERS]: "./index-helpers.ivm.bundle.js", [BundleType.BSON]: "./bson.ivm.bundle.js", + [BundleType.SNIPPETS]: "./snippets.ivm.bundle.js", } const bundleSourceCode: Partial> = {} diff --git a/packages/server/src/jsRunner/bundles/snippets.ivm.bundle.js b/packages/server/src/jsRunner/bundles/snippets.ivm.bundle.js new file mode 100644 index 0000000000..4dff030c0b --- /dev/null +++ b/packages/server/src/jsRunner/bundles/snippets.ivm.bundle.js @@ -0,0 +1,3 @@ +"use strict";var snippets=(()=>{var p=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var u=(i,e)=>{for(var n in e)p(i,n,{get:e[n],enumerable:!0})},a=(i,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of s(e))!c.call(i,t)&&t!==n&&p(i,t,{get:()=>e[t],enumerable:!(r=f(e,t))||r.enumerable});return i};var h=i=>a(p({},"__esModule",{value:!0}),i);var C={};u(C,{default:()=>x});var o=i=>`(function(){ +${i} +})();`;var x=new Proxy({},{get:function(i,e){return e in snippetCache||(snippetCache[e]=[eval][0](o(snippetDefinitions[e]))),snippetCache[e]}});return h(C);})(); diff --git a/packages/server/src/jsRunner/bundles/snippets.ts b/packages/server/src/jsRunner/bundles/snippets.ts new file mode 100644 index 0000000000..8244b2eef8 --- /dev/null +++ b/packages/server/src/jsRunner/bundles/snippets.ts @@ -0,0 +1,27 @@ +// @ts-ignore +// eslint-disable-next-line local-rules/no-budibase-imports +import { iifeWrapper } from "@budibase/string-templates/iife" + +export default new Proxy( + {}, + { + get: function (_, name) { + // Both snippetDefinitions and snippetCache are injected to the isolate + // global scope before this bundle is loaded, so we can access it from + // there. + // See https://esbuild.github.io/content-types/#direct-eval for info on + // why eval is being called this way. + // Snippets are cached and reused once they have been evaluated. + // @ts-expect-error snippetDefinitions and snippetCache are injected to the global scope + // eslint-disable-next-line no-undef + if (!(name in snippetCache)) { + // @ts-expect-error snippetDefinitions and snippetCache are injected to the global scope + // eslint-disable-next-line no-undef + snippetCache[name] = [eval][0](iifeWrapper(snippetDefinitions[name])) + } + // @ts-expect-error snippetDefinitions and snippetCache are injected to the global scope + // eslint-disable-next-line no-undef + return snippetCache[name] + }, + } +) diff --git a/packages/server/src/jsRunner/index.ts b/packages/server/src/jsRunner/index.ts index 0c9f5d9f01..7065febcb4 100644 --- a/packages/server/src/jsRunner/index.ts +++ b/packages/server/src/jsRunner/index.ts @@ -11,23 +11,32 @@ import { IsolatedVM } from "./vm" export function init() { setJSRunner((js: string, ctx: Record) => { - return tracer.trace("runJS", {}, span => { + return tracer.trace("runJS", {}, () => { try { + // Reuse an existing isolate from context, or make a new one const bbCtx = context.getCurrentContext() + const vm = + bbCtx?.vm || + new IsolatedVM({ + memoryLimit: env.JS_RUNNER_MEMORY_LIMIT, + invocationTimeout: env.JS_PER_INVOCATION_TIMEOUT_MS, + isolateAccumulatedTimeout: env.JS_PER_REQUEST_TIMEOUT_MS, + }) + .withHelpers() + .withSnippets(bbCtx?.snippets) - const vm = bbCtx?.vm - ? bbCtx.vm - : new IsolatedVM({ - memoryLimit: env.JS_RUNNER_MEMORY_LIMIT, - invocationTimeout: env.JS_PER_INVOCATION_TIMEOUT_MS, - isolateAccumulatedTimeout: env.JS_PER_REQUEST_TIMEOUT_MS, - }).withHelpers() - - if (bbCtx) { - // If we have a context, we want to persist it to reuse the isolate + // Persist isolate in context so we can reuse it + if (bbCtx && !bbCtx.vm) { bbCtx.vm = vm + bbCtx.cleanup = bbCtx.cleanup || [] + bbCtx.cleanup.push(() => vm.close()) } - const { helpers, ...rest } = ctx + + // Because we can't pass functions into an Isolate, we remove them from + // the passed context and rely on the withHelpers() method to add them + // back in. + // eslint-disable-next-line @typescript-eslint/no-unused-vars + const { helpers, snippets, ...rest } = ctx return vm.withContext(rest, () => vm.execute(js)) } catch (error: any) { if (error.message === "Script execution timed out.") { diff --git a/packages/server/src/jsRunner/tests/isolatedVM.spec.ts b/packages/server/src/jsRunner/tests/isolatedVM.spec.ts index 5296598ef1..5a9bc05d76 100644 --- a/packages/server/src/jsRunner/tests/isolatedVM.spec.ts +++ b/packages/server/src/jsRunner/tests/isolatedVM.spec.ts @@ -1,7 +1,7 @@ import fs from "fs" import path from "path" import { IsolatedVM } from "../vm" -import { iifeWrapper } from "../utilities" +import { iifeWrapper } from "@budibase/string-templates" function runJSWithIsolatedVM(script: string, context: Record) { const runner = new IsolatedVM() diff --git a/packages/server/src/jsRunner/tests/jsRunner.spec.ts b/packages/server/src/jsRunner/tests/jsRunner.spec.ts index 54983aa470..7448555aac 100644 --- a/packages/server/src/jsRunner/tests/jsRunner.spec.ts +++ b/packages/server/src/jsRunner/tests/jsRunner.spec.ts @@ -1,7 +1,7 @@ import { validate as isValidUUID } from "uuid" import { processStringSync, encodeJSBinding } from "@budibase/string-templates" -const { runJsHelpersTests } = require("@budibase/string-templates/test/utils") +import { runJsHelpersTests } from "@budibase/string-templates/test/utils" import tk from "timekeeper" import { init } from ".." @@ -30,12 +30,12 @@ describe("jsRunner (using isolated-vm)", () => { ) } - it("it can run a basic javascript", async () => { + it("can run a basic javascript", async () => { const output = await processJS(`return 1 + 2`) expect(output).toBe(3) }) - it("it can execute sloppy javascript", async () => { + it("can execute sloppy javascript", async () => { const output = await processJS(`a=2;b=3;return a + b`) expect(output).toBe(5) }) diff --git a/packages/server/src/jsRunner/utilities.ts b/packages/server/src/jsRunner/utilities.ts deleted file mode 100644 index fa398ec239..0000000000 --- a/packages/server/src/jsRunner/utilities.ts +++ /dev/null @@ -1,3 +0,0 @@ -export function iifeWrapper(script: string) { - return `(function(){\n${script}\n})();` -} diff --git a/packages/server/src/jsRunner/vm/isolated-vm.ts b/packages/server/src/jsRunner/vm/isolated-vm.ts index b0692f0fd1..833faa3ebd 100644 --- a/packages/server/src/jsRunner/vm/isolated-vm.ts +++ b/packages/server/src/jsRunner/vm/isolated-vm.ts @@ -6,8 +6,8 @@ import crypto from "crypto" import querystring from "querystring" import { BundleType, loadBundle } from "../bundles" -import { VM } from "@budibase/types" -import { iifeWrapper } from "../utilities" +import { Snippet, VM } from "@budibase/types" +import { iifeWrapper } from "@budibase/string-templates" import environment from "../../environment" class ExecutionTimeoutError extends Error { @@ -98,6 +98,26 @@ export class IsolatedVM implements VM { return this } + withSnippets(snippets?: Snippet[]) { + // Transform snippets into a map for faster access + let snippetMap: Record = {} + for (let snippet of snippets || []) { + snippetMap[snippet.name] = snippet.code + } + const snippetsSource = loadBundle(BundleType.SNIPPETS) + const script = this.isolate.compileScriptSync(` + const snippetDefinitions = ${JSON.stringify(snippetMap)}; + const snippetCache = {}; + ${snippetsSource}; + snippets = snippets.default; + `) + script.runSync(this.vm, { timeout: this.invocationTimeout, release: false }) + new Promise(() => { + script.release() + }) + return this + } + withContext(context: Record, executeWithContext: () => T) { this.addToContext(context) @@ -150,7 +170,8 @@ export class IsolatedVM implements VM { } decode(...input: any) { - // @ts-ignore + // @ts-expect-error - this is going to run in the isolate, where this function will be available + // eslint-disable-next-line no-undef return textDecoderCb({ constructorArgs: this.constructorArgs, functionArgs: input, @@ -195,6 +216,11 @@ export class IsolatedVM implements VM { return result[this.runResultKey] } + close(): void { + this.vm.release() + this.isolate.dispose() + } + private registerCallbacks(functions: Record) { const libId = crypto.randomUUID().replace(/-/g, "") diff --git a/packages/server/src/middleware/authorized.ts b/packages/server/src/middleware/authorized.ts index fe7f6bb6fe..ec8a3711cf 100644 --- a/packages/server/src/middleware/authorized.ts +++ b/packages/server/src/middleware/authorized.ts @@ -120,7 +120,7 @@ const authorized = !!subResourceId && (await sdk.permissions.getResourcePerms(subResourceId)) - function getPermLevel(permLevel: string) { + const getPermLevel = (permLevel: string) => { let result: string[] = [] if (permissions[permLevel]) { result.push(permissions[permLevel].role) diff --git a/packages/server/src/middleware/cleanup.ts b/packages/server/src/middleware/cleanup.ts new file mode 100644 index 0000000000..fa04743cee --- /dev/null +++ b/packages/server/src/middleware/cleanup.ts @@ -0,0 +1,33 @@ +import { Ctx } from "@budibase/types" +import { context } from "@budibase/backend-core" +import { tracer } from "dd-trace" + +export default async (ctx: Ctx, next: any) => { + const resp = await next() + + const current = context.getCurrentContext() + if (!current || !current.cleanup) { + return resp + } + + let errors = [] + for (let fn of current.cleanup) { + try { + await tracer.trace("cleanup", async () => { + await fn() + }) + } catch (e) { + // We catch errors here to ensure we at least attempt to run all cleanup + // functions. We'll throw the first error we encounter after all cleanup + // functions have been run. + errors.push(e) + } + } + delete current.cleanup + + if (errors.length > 0) { + throw errors[0] + } + + return resp +} diff --git a/packages/server/src/middleware/tests/authorized.spec.ts b/packages/server/src/middleware/tests/authorized.spec.ts index 0741f50e4d..79cfeca54e 100644 --- a/packages/server/src/middleware/tests/authorized.spec.ts +++ b/packages/server/src/middleware/tests/authorized.spec.ts @@ -11,7 +11,6 @@ import { import authorizedMiddleware from "../authorized" import env from "../../environment" -import { generateTableID, generateViewID } from "../../db/utils" import { generator, mocks } from "@budibase/backend-core/tests" import { initProMocks } from "../../tests/utilities/mocks/pro" import { getResourcePerms } from "../../sdk/app/permissions" @@ -213,11 +212,11 @@ describe("Authorization middleware", () => { it("will fetch resource permissions when resource is set", async () => { await config.executeMiddleware() - expect(config.throw).not.toBeCalled() + expect(config.throw).not.toHaveBeenCalled() expect(config.next).toHaveBeenCalled() - expect(mockedGetResourcePerms).toBeCalledTimes(1) - expect(mockedGetResourcePerms).toBeCalledWith(resourceId) + expect(mockedGetResourcePerms).toHaveBeenCalledTimes(1) + expect(mockedGetResourcePerms).toHaveBeenCalledWith(resourceId) }) }) }) diff --git a/packages/server/src/middleware/tests/trimViewRowInfo.spec.ts b/packages/server/src/middleware/tests/trimViewRowInfo.spec.ts index 40ff88c1e5..243f9a9329 100644 --- a/packages/server/src/middleware/tests/trimViewRowInfo.spec.ts +++ b/packages/server/src/middleware/tests/trimViewRowInfo.spec.ts @@ -133,8 +133,8 @@ describe("trimViewRowInfo middleware", () => { }) expect(config.params.sourceId).toEqual(table._id) - expect(config.next).toBeCalledTimes(1) - expect(config.throw).not.toBeCalled() + expect(config.next).toHaveBeenCalledTimes(1) + expect(config.throw).not.toHaveBeenCalled() }) it("when columns are defined, trimmed data is returned", async () => { @@ -162,7 +162,7 @@ describe("trimViewRowInfo middleware", () => { }) expect(config.params.sourceId).toEqual(table._id) - expect(config.next).toBeCalledTimes(1) - expect(config.throw).not.toBeCalled() + expect(config.next).toHaveBeenCalledTimes(1) + expect(config.throw).not.toHaveBeenCalled() }) }) diff --git a/packages/server/src/middleware/trimViewRowInfo.ts b/packages/server/src/middleware/trimViewRowInfo.ts index 95b085a08f..4c382e6123 100644 --- a/packages/server/src/middleware/trimViewRowInfo.ts +++ b/packages/server/src/middleware/trimViewRowInfo.ts @@ -32,10 +32,7 @@ export default async (ctx: Ctx, next: Next) => { } // have to mutate the koa context, can't return -export async function trimViewFields( - body: Row, - viewId: string -): Promise { +export async function trimViewFields(body: Row, viewId: string): Promise { const view = await sdk.views.get(viewId) const allowedKeys = sdk.views.allowedFields(view) // have to mutate the context, can't update reference diff --git a/packages/server/src/migrations/functions/backfill/global/users.ts b/packages/server/src/migrations/functions/backfill/global/users.ts index 9f536a97a5..b3dae822d7 100644 --- a/packages/server/src/migrations/functions/backfill/global/users.ts +++ b/packages/server/src/migrations/functions/backfill/global/users.ts @@ -43,7 +43,7 @@ export const backfill = async ( } if (user.roles) { - for (const [appId, role] of Object.entries(user.roles)) { + for (const [, role] of Object.entries(user.roles)) { await events.role.assigned(user, role, timestamp) } } diff --git a/packages/server/src/migrations/index.ts b/packages/server/src/migrations/index.ts index 61ae75adf1..a66d793142 100644 --- a/packages/server/src/migrations/index.ts +++ b/packages/server/src/migrations/index.ts @@ -11,7 +11,6 @@ import env from "../environment" // migration functions import * as userEmailViewCasing from "./functions/userEmailViewCasing" import * as syncQuotas from "./functions/syncQuotas" -import * as syncUsers from "./functions/usageQuotas/syncUsers" import * as appUrls from "./functions/appUrls" import * as tableSettings from "./functions/tableSettings" import * as backfill from "./functions/backfill" diff --git a/packages/server/src/migrations/tests/index.spec.ts b/packages/server/src/migrations/tests/index.spec.ts index 236776cd3f..8eb59b8a0e 100644 --- a/packages/server/src/migrations/tests/index.spec.ts +++ b/packages/server/src/migrations/tests/index.spec.ts @@ -66,28 +66,25 @@ describe("migrations", () => { )[0] await migrations.runMigration(migration) - expect(events.app.created).toBeCalledTimes(1) - expect(events.app.published).toBeCalledTimes(1) - expect(events.automation.created).toBeCalledTimes(2) - expect(events.automation.stepCreated).toBeCalledTimes(1) - expect(events.datasource.created).toBeCalledTimes(2) - expect(events.layout.created).toBeCalledTimes(1) - expect(events.query.created).toBeCalledTimes(2) - expect(events.role.created).toBeCalledTimes(2) - expect(events.table.created).toBeCalledTimes(3) - expect(events.view.created).toBeCalledTimes(2) - expect(events.view.calculationCreated).toBeCalledTimes(1) - expect(events.view.filterCreated).toBeCalledTimes(1) - expect(events.screen.created).toBeCalledTimes(2) - expect(events.backfill.appSucceeded).toBeCalledTimes(2) - - const processor = events.processors.analyticsProcessor.processEvent - console.log(processor) + expect(events.app.created).toHaveBeenCalledTimes(1) + expect(events.app.published).toHaveBeenCalledTimes(1) + expect(events.automation.created).toHaveBeenCalledTimes(2) + expect(events.automation.stepCreated).toHaveBeenCalledTimes(1) + expect(events.datasource.created).toHaveBeenCalledTimes(2) + expect(events.layout.created).toHaveBeenCalledTimes(1) + expect(events.query.created).toHaveBeenCalledTimes(2) + expect(events.role.created).toHaveBeenCalledTimes(2) + expect(events.table.created).toHaveBeenCalledTimes(3) + expect(events.view.created).toHaveBeenCalledTimes(2) + expect(events.view.calculationCreated).toHaveBeenCalledTimes(1) + expect(events.view.filterCreated).toHaveBeenCalledTimes(1) + expect(events.screen.created).toHaveBeenCalledTimes(2) + expect(events.backfill.appSucceeded).toHaveBeenCalledTimes(2) // to make sure caching is working as expected expect( events.processors.analyticsProcessor.processEvent - ).toBeCalledTimes(23) + ).toHaveBeenCalledTimes(23) }) }) }) @@ -123,24 +120,24 @@ describe("migrations", () => { )[0] await migrations.runMigration(migration) - expect(events.user.created).toBeCalledTimes(3) - expect(events.role.assigned).toBeCalledTimes(2) - expect(events.user.permissionBuilderAssigned).toBeCalledTimes(1) // default test user - expect(events.user.permissionAdminAssigned).toBeCalledTimes(1) // admin from above - expect(events.rows.created).toBeCalledTimes(1) - expect(events.rows.created).toBeCalledWith(2, timestamp) - expect(events.email.SMTPCreated).toBeCalledTimes(1) - expect(events.auth.SSOCreated).toBeCalledTimes(2) - expect(events.auth.SSOActivated).toBeCalledTimes(2) - expect(events.org.logoUpdated).toBeCalledTimes(1) - expect(events.org.nameUpdated).toBeCalledTimes(1) - expect(events.org.platformURLUpdated).toBeCalledTimes(1) - expect(events.backfill.tenantSucceeded).toBeCalledTimes(1) + expect(events.user.created).toHaveBeenCalledTimes(3) + expect(events.role.assigned).toHaveBeenCalledTimes(2) + expect(events.user.permissionBuilderAssigned).toHaveBeenCalledTimes(1) // default test user + expect(events.user.permissionAdminAssigned).toHaveBeenCalledTimes(1) // admin from above + expect(events.rows.created).toHaveBeenCalledTimes(1) + expect(events.rows.created).toHaveBeenCalledWith(2, timestamp) + expect(events.email.SMTPCreated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOCreated).toHaveBeenCalledTimes(2) + expect(events.auth.SSOActivated).toHaveBeenCalledTimes(2) + expect(events.org.logoUpdated).toHaveBeenCalledTimes(1) + expect(events.org.nameUpdated).toHaveBeenCalledTimes(1) + expect(events.org.platformURLUpdated).toHaveBeenCalledTimes(1) + expect(events.backfill.tenantSucceeded).toHaveBeenCalledTimes(1) // to make sure caching is working as expected - expect(events.processors.analyticsProcessor.processEvent).toBeCalledTimes( - 19 - ) + expect( + events.processors.analyticsProcessor.processEvent + ).toHaveBeenCalledTimes(19) }) }) }) diff --git a/packages/server/src/sdk/app/applications/sync.ts b/packages/server/src/sdk/app/applications/sync.ts index e73b3396d9..44e44a5aaa 100644 --- a/packages/server/src/sdk/app/applications/sync.ts +++ b/packages/server/src/sdk/app/applications/sync.ts @@ -3,11 +3,7 @@ import { db as dbCore, context, logging, roles } from "@budibase/backend-core" import { User, ContextUser, UserGroup } from "@budibase/types" import { sdk as proSdk } from "@budibase/pro" import sdk from "../../" -import { - getGlobalUsers, - getRawGlobalUsers, - processUser, -} from "../../../utilities/global" +import { getRawGlobalUsers, processUser } from "../../../utilities/global" import { generateUserMetadataID, InternalTables } from "../../../db/utils" type DeletedUser = { _id: string; deleted: boolean } diff --git a/packages/server/src/sdk/app/applications/tests/sync.spec.ts b/packages/server/src/sdk/app/applications/tests/sync.spec.ts index a53bdb0bd7..69ff2bfaf3 100644 --- a/packages/server/src/sdk/app/applications/tests/sync.spec.ts +++ b/packages/server/src/sdk/app/applications/tests/sync.spec.ts @@ -6,7 +6,7 @@ import EventEmitter from "events" import { UserGroup, UserMetadata, UserRoles, User } from "@budibase/types" const config = new TestConfiguration() -let app, group: UserGroup, groupUser: User +let group: UserGroup, groupUser: User const ROLE_ID = roles.BUILTIN_ROLE_IDS.BASIC const emitter = new EventEmitter() @@ -36,7 +36,7 @@ function waitForUpdate(opts: { group?: boolean }) { } beforeAll(async () => { - app = await config.init("syncApp") + await config.init("syncApp") }) async function createUser(email: string, roles: UserRoles, builder?: boolean) { diff --git a/packages/server/src/sdk/app/backups/imports.ts b/packages/server/src/sdk/app/backups/imports.ts index 75c17dfa95..977dea5b63 100644 --- a/packages/server/src/sdk/app/backups/imports.ts +++ b/packages/server/src/sdk/app/backups/imports.ts @@ -24,7 +24,7 @@ import tar from "tar" type TemplateType = { file?: { - type: string + type?: string path: string password?: string } diff --git a/packages/server/src/sdk/app/datasources/datasources.ts b/packages/server/src/sdk/app/datasources/datasources.ts index fd0d291d91..336a94636b 100644 --- a/packages/server/src/sdk/app/datasources/datasources.ts +++ b/packages/server/src/sdk/app/datasources/datasources.ts @@ -30,9 +30,15 @@ import { } from "../../../db/utils" import sdk from "../../index" import { setupCreationAuth as googleSetupCreationAuth } from "../../../integrations/googlesheets" +import { helpers } from "@budibase/shared-core" const ENV_VAR_PREFIX = "env." +function addDatasourceFlags(datasource: Datasource) { + datasource.isSQL = helpers.isSQL(datasource) + return datasource +} + export async function fetch(opts?: { enriched: boolean }): Promise { @@ -56,7 +62,7 @@ export async function fetch(opts?: { } as Datasource // Get external datasources - const datasources = ( + let datasources = ( await db.allDocs( getDatasourceParams(null, { include_docs: true, @@ -75,6 +81,7 @@ export async function fetch(opts?: { } } + datasources = datasources.map(datasource => addDatasourceFlags(datasource)) if (opts?.enriched) { const envVars = await getEnvironmentVariables() const promises = datasources.map(datasource => @@ -150,6 +157,7 @@ async function enrichDatasourceWithValues( } export async function enrich(datasource: Datasource) { + datasource = addDatasourceFlags(datasource) const { datasource: response } = await enrichDatasourceWithValues(datasource) return response } @@ -159,7 +167,8 @@ export async function get( opts?: { enriched: boolean } ): Promise { const appDb = context.getAppDB() - const datasource = await appDb.get(datasourceId) + let datasource = await appDb.get(datasourceId) + datasource = addDatasourceFlags(datasource) if (opts?.enriched) { return (await enrichDatasourceWithValues(datasource)).datasource } else { @@ -271,13 +280,14 @@ export function mergeConfigs(update: Datasource, old: Datasource) { export async function getExternalDatasources(): Promise { const db = context.getAppDB() - const externalDatasources = await db.allDocs( + let dsResponse = await db.allDocs( getDatasourcePlusParams(undefined, { include_docs: true, }) ) - return externalDatasources.rows.map(r => r.doc!) + const externalDatasources = dsResponse.rows.map(r => r.doc!) + return externalDatasources.map(datasource => addDatasourceFlags(datasource)) } export async function save( @@ -290,11 +300,11 @@ export async function save( const fetchSchema = opts?.fetchSchema || false const tablesFilter = opts?.tablesFilter || [] - datasource = { + datasource = addDatasourceFlags({ _id: generateDatasourceID({ plus }), ...datasource, type: plus ? DocumentType.DATASOURCE_PLUS : DocumentType.DATASOURCE, - } + }) let errors: Record = {} if (fetchSchema) { diff --git a/packages/server/src/sdk/app/permissions/index.ts b/packages/server/src/sdk/app/permissions/index.ts index a6d8f338a1..18a376aaf0 100644 --- a/packages/server/src/sdk/app/permissions/index.ts +++ b/packages/server/src/sdk/app/permissions/index.ts @@ -1,4 +1,4 @@ -import { db, env, roles } from "@budibase/backend-core" +import { db, roles } from "@budibase/backend-core" import { features } from "@budibase/pro" import { DocumentType, @@ -133,7 +133,7 @@ export async function getDependantResources( } const permissions = await getResourcePerms(view.id) - for (const [level, roleInfo] of Object.entries(permissions)) { + for (const [, roleInfo] of Object.entries(permissions)) { if (roleInfo.type === PermissionSource.INHERITED) { dependants[VirtualDocumentType.VIEW] ??= new Set() dependants[VirtualDocumentType.VIEW].add(view.id) diff --git a/packages/server/src/sdk/app/rows/search.ts b/packages/server/src/sdk/app/rows/search.ts index 8b24f9bc5f..63bbd699fa 100644 --- a/packages/server/src/sdk/app/rows/search.ts +++ b/packages/server/src/sdk/app/rows/search.ts @@ -1,10 +1,4 @@ -import { - Row, - SearchFilters, - SearchParams, - SortOrder, - SortType, -} from "@budibase/types" +import { Row, SearchFilters, SearchParams, SortOrder } from "@budibase/types" import { isExternalTableID } from "../../../integrations/utils" import * as internal from "./search/internal" import * as external from "./search/external" diff --git a/packages/server/src/sdk/app/rows/search/internal.ts b/packages/server/src/sdk/app/rows/search/internal.ts index 2d3c32e02e..8147ca46ad 100644 --- a/packages/server/src/sdk/app/rows/search/internal.ts +++ b/packages/server/src/sdk/app/rows/search/internal.ts @@ -1,6 +1,7 @@ import { context, db, + HTTPError, SearchParams as InternalSearchParams, } from "@budibase/backend-core" import env from "../../../../environment" @@ -31,6 +32,7 @@ import sdk from "../../../../sdk" import { ExportRowsParams, ExportRowsResult } from "../search" import { searchInputMapping } from "./utils" import pick from "lodash/pick" +import { breakRowIdField } from "../../../../integrations/utils" export async function search(options: SearchParams) { const { tableId } = options @@ -103,7 +105,16 @@ export async function exportRows( let response = ( await db.allDocs({ include_docs: true, - keys: rowIds, + keys: rowIds.map((row: string) => { + const ids = breakRowIdField(row) + if (ids.length > 1) { + throw new HTTPError( + "Export data does not support composite keys.", + 400 + ) + } + return ids[0] + }), }) ).rows.map(row => row.doc) diff --git a/packages/server/src/sdk/app/rows/search/tests/external.spec.ts b/packages/server/src/sdk/app/rows/search/tests/external.spec.ts index bae84592ca..8ecec784dd 100644 --- a/packages/server/src/sdk/app/rows/search/tests/external.spec.ts +++ b/packages/server/src/sdk/app/rows/search/tests/external.spec.ts @@ -17,8 +17,6 @@ import { generator, } from "@budibase/backend-core/tests" -jest.unmock("mysql2/promise") - jest.setTimeout(30000) describe("external search", () => { diff --git a/packages/server/src/sdk/app/rows/search/utils.ts b/packages/server/src/sdk/app/rows/search/utils.ts index 5d93dcaca2..086599665b 100644 --- a/packages/server/src/sdk/app/rows/search/utils.ts +++ b/packages/server/src/sdk/app/rows/search/utils.ts @@ -66,8 +66,8 @@ export function searchInputMapping(table: Table, options: SearchParams) { } for (let [key, column] of Object.entries(table.schema)) { switch (column.type) { - case FieldType.BB_REFERENCE: - const subtype = column.subtype as FieldSubtype + case FieldType.BB_REFERENCE: { + const subtype = column.subtype switch (subtype) { case FieldSubtype.USER: case FieldSubtype.USERS: @@ -77,6 +77,7 @@ export function searchInputMapping(table: Table, options: SearchParams) { utils.unreachable(subtype) } break + } } } return options diff --git a/packages/server/src/sdk/app/rows/utils.ts b/packages/server/src/sdk/app/rows/utils.ts index 6e3e25364e..8aa017d238 100644 --- a/packages/server/src/sdk/app/rows/utils.ts +++ b/packages/server/src/sdk/app/rows/utils.ts @@ -14,7 +14,7 @@ import { makeExternalQuery } from "../../../integrations/base/query" import { Format } from "../../../api/controllers/view/exporters" import sdk from "../.." import { isRelationshipColumn } from "../../../db/utils" -import { SqlClient } from "../../../integrations/utils" +import { SqlClient, isSQL } from "../../../integrations/utils" const SQL_CLIENT_SOURCE_MAP: Record = { [SourceName.POSTGRES]: SqlClient.POSTGRES, @@ -37,7 +37,7 @@ const SQL_CLIENT_SOURCE_MAP: Record = { } export function getSQLClient(datasource: Datasource): SqlClient { - if (!datasource.isSQL) { + if (!isSQL(datasource)) { throw new Error("Cannot get SQL Client for non-SQL datasource") } const lookup = SQL_CLIENT_SOURCE_MAP[datasource.source] diff --git a/packages/server/src/sdk/app/tables/tests/tables.spec.ts b/packages/server/src/sdk/app/tables/tests/tables.spec.ts index 457988c476..6e2cf9efa8 100644 --- a/packages/server/src/sdk/app/tables/tests/tables.spec.ts +++ b/packages/server/src/sdk/app/tables/tests/tables.spec.ts @@ -84,7 +84,7 @@ describe("table sdk", () => { }, }) - expect(sdk.views.enrichSchema).toBeCalledTimes(3) + expect(sdk.views.enrichSchema).toHaveBeenCalledTimes(3) expect(res).toEqual({ ...basicTable, diff --git a/packages/server/src/sdk/app/views/tests/views.spec.ts b/packages/server/src/sdk/app/views/tests/views.spec.ts index 508285651a..a610d34ec2 100644 --- a/packages/server/src/sdk/app/views/tests/views.spec.ts +++ b/packages/server/src/sdk/app/views/tests/views.spec.ts @@ -351,6 +351,7 @@ describe("table sdk", () => { const view: ViewV2 = { ...basicView, } + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { name, description, ...newTableSchema } = basicTable.schema const result = syncSchema(_.cloneDeep(view), newTableSchema, undefined) @@ -364,6 +365,7 @@ describe("table sdk", () => { const view: ViewV2 = { ...basicView, } + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { description, ...newTableSchema } = { ...basicTable.schema, updatedDescription: { @@ -448,6 +450,7 @@ describe("table sdk", () => { hiddenField: { visible: false }, }, } + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { name, description, ...newTableSchema } = basicTable.schema const result = syncSchema(_.cloneDeep(view), newTableSchema, undefined) @@ -471,6 +474,7 @@ describe("table sdk", () => { hiddenField: { visible: false }, }, } + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { name, description, ...newTableSchema } = { ...basicTable.schema, newField1: { @@ -502,6 +506,7 @@ describe("table sdk", () => { hiddenField: { visible: false }, }, } + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { description, ...newTableSchema } = { ...basicTable.schema, updatedDescription: { diff --git a/packages/server/src/sdk/tests/attachments.spec.ts b/packages/server/src/sdk/tests/attachments.spec.ts index f1abb246f8..0fd43ac5a8 100644 --- a/packages/server/src/sdk/tests/attachments.spec.ts +++ b/packages/server/src/sdk/tests/attachments.spec.ts @@ -44,7 +44,7 @@ import { db as dbCore } from "@budibase/backend-core" import sdk from "../index" describe("should be able to re-write attachment URLs", () => { - it("it should update URLs on a number of rows over the limit", async () => { + it("should update URLs on a number of rows over the limit", async () => { const db = dbCore.getDB("app_aaa") await db.put(table) const limit = 30 diff --git a/packages/server/src/sdk/tests/rows/row.spec.ts b/packages/server/src/sdk/tests/rows/row.spec.ts deleted file mode 100644 index 8b01356e35..0000000000 --- a/packages/server/src/sdk/tests/rows/row.spec.ts +++ /dev/null @@ -1,132 +0,0 @@ -import { exportRows } from "../../app/rows/search/external" -import sdk from "../.." -import { ExternalRequest } from "../../../api/controllers/row/ExternalRequest" -import { ExportRowsParams } from "../../app/rows/search" -import { Format } from "../../../api/controllers/view/exporters" -import { HTTPError } from "@budibase/backend-core" -import { Operation } from "@budibase/types" - -const mockDatasourcesGet = jest.fn() -const mockTableGet = jest.fn() -sdk.datasources.get = mockDatasourcesGet -sdk.tables.getTable = mockTableGet - -jest.mock("../../../api/controllers/row/ExternalRequest") -jest.mock("../../../utilities/rowProcessor", () => ({ - outputProcessing: jest.fn((_, rows) => rows), -})) - -jest.mock("../../../api/controllers/view/exporters", () => ({ - ...jest.requireActual("../../../api/controllers/view/exporters"), - Format: { - CSV: "csv", - }, -})) -jest.mock("../../../utilities/fileSystem") - -describe("external row sdk", () => { - describe("exportRows", () => { - function getExportOptions(): ExportRowsParams { - return { - tableId: "datasource__tablename", - format: Format.CSV, - query: {}, - } - } - - const externalRequestCall = jest.fn() - beforeAll(() => { - jest - .spyOn(ExternalRequest.prototype, "run") - .mockImplementation(externalRequestCall.mockResolvedValue([])) - }) - - afterEach(() => { - jest.clearAllMocks() - }) - - it("should throw a 400 if no datasource entities are present", async () => { - const exportOptions = getExportOptions() - await expect(exportRows(exportOptions)).rejects.toThrowError( - new HTTPError("Datasource has not been configured for plus API.", 400) - ) - }) - - it("should handle single quotes from a row ID", async () => { - mockDatasourcesGet.mockImplementation(async () => ({ - entities: { - tablename: { - schema: {}, - }, - }, - })) - const exportOptions = getExportOptions() - exportOptions.rowIds = ["['d001']"] - - await exportRows(exportOptions) - - expect(ExternalRequest).toBeCalledTimes(1) - expect(ExternalRequest).toBeCalledWith( - Operation.READ, - exportOptions.tableId, - undefined - ) - - expect(externalRequestCall).toBeCalledTimes(1) - expect(externalRequestCall).toBeCalledWith( - expect.objectContaining({ - filters: { - oneOf: { - _id: ["d001"], - }, - }, - }) - ) - }) - - it("should throw a 400 if any composite keys are present", async () => { - const exportOptions = getExportOptions() - exportOptions.rowIds = ["[123]", "['d001'%2C'10111']"] - await expect(exportRows(exportOptions)).rejects.toThrowError( - new HTTPError("Export data does not support composite keys.", 400) - ) - }) - - it("should throw a 400 if no table name was found", async () => { - const exportOptions = getExportOptions() - exportOptions.tableId = "datasource__" - exportOptions.rowIds = ["[123]"] - - await expect(exportRows(exportOptions)).rejects.toThrowError( - new HTTPError("Could not find table name.", 400) - ) - }) - - it("should only export specified columns", async () => { - mockDatasourcesGet.mockImplementation(async () => ({ - entities: { - tablename: { - schema: { - name: {}, - age: {}, - dob: {}, - }, - }, - }, - })) - const headers = ["name", "dob"] - - const result = await exportRows({ - tableId: "datasource__tablename", - format: Format.CSV, - query: {}, - columns: headers, - }) - - expect(result).toEqual({ - fileName: "export.csv", - content: `"name","dob"`, - }) - }) - }) -}) diff --git a/packages/server/src/sdk/tests/rows/search.spec.ts b/packages/server/src/sdk/tests/rows/search.spec.ts deleted file mode 100644 index feae5e7ee8..0000000000 --- a/packages/server/src/sdk/tests/rows/search.spec.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as search from "../../app/rows/search" - -describe("removeEmptyFilters", () => { - it("0 should not be removed", () => { - const filters = search.removeEmptyFilters({ - equal: { - column: 0, - }, - }) - expect((filters.equal as any).column).toBe(0) - }) - - it("empty string should be removed", () => { - const filters = search.removeEmptyFilters({ - equal: { - column: "", - }, - }) - expect(Object.values(filters.equal as any).length).toBe(0) - }) -}) diff --git a/packages/server/src/startup.ts b/packages/server/src/startup.ts index abe931f503..2cedda1099 100644 --- a/packages/server/src/startup.ts +++ b/packages/server/src/startup.ts @@ -7,6 +7,7 @@ import { logging, tenancy, users, + cache, } from "@budibase/backend-core" import fs from "fs" import { watch } from "./watch" @@ -74,6 +75,7 @@ export async function startup(app?: Koa, server?: Server) { eventEmitter.emitPort(env.PORT) fileSystem.init() await redis.init() + cache.docWritethrough.init() eventInit() if (app && server) { initialiseWebsockets(app, server) diff --git a/packages/server/src/tests/jestEnv.ts b/packages/server/src/tests/jestEnv.ts index 4763208c54..7c58470e9b 100644 --- a/packages/server/src/tests/jestEnv.ts +++ b/packages/server/src/tests/jestEnv.ts @@ -10,3 +10,4 @@ process.env.MOCK_REDIS = "1" process.env.PLATFORM_URL = "http://localhost:10000" process.env.REDIS_PASSWORD = "budibase" process.env.BUDIBASE_VERSION = "0.0.0+jest" +process.env.WORKER_URL = "http://localhost:10000" diff --git a/packages/server/src/tests/utilities/TestConfiguration.ts b/packages/server/src/tests/utilities/TestConfiguration.ts index 2127e9d1cd..22c03016c7 100644 --- a/packages/server/src/tests/utilities/TestConfiguration.ts +++ b/packages/server/src/tests/utilities/TestConfiguration.ts @@ -49,7 +49,6 @@ import { AuthToken, Automation, CreateViewRequest, - Ctx, Datasource, FieldType, INTERNAL_TABLE_SOURCE_ID, @@ -299,11 +298,11 @@ export default class TestConfiguration { } } - withUser(user: User, f: () => Promise) { + async withUser(user: User, f: () => Promise) { const oldUser = this.user this.user = user try { - return f() + return await f() } finally { this.user = oldUser } @@ -347,7 +346,7 @@ export default class TestConfiguration { lastName = generator.last(), builder = { global: true }, admin = { global: false }, - email = generator.email(), + email = generator.email({ domain: "example.com" }), tenantId = this.getTenantId(), roles = {}, } = config @@ -363,6 +362,7 @@ export default class TestConfiguration { _id, ...existing, ...config, + _rev: existing._rev, email, roles, tenantId, @@ -372,11 +372,12 @@ export default class TestConfiguration { admin, } await sessions.createASession(_id, { - sessionId: "sessionid", + sessionId: this.sessionIdForUser(_id), tenantId: this.getTenantId(), csrfToken: this.csrfToken, }) const resp = await db.put(user) + await cache.user.invalidateUser(_id) return { _rev: resp.rev, ...user, @@ -384,9 +385,7 @@ export default class TestConfiguration { } async createUser(user: Partial = {}): Promise { - const resp = await this.globalUser(user) - await cache.user.invalidateUser(resp._id!) - return resp + return await this.globalUser(user) } async createGroup(roleId: string = roles.BUILTIN_ROLE_IDS.BASIC) { @@ -416,6 +415,10 @@ export default class TestConfiguration { }) } + sessionIdForUser(userId: string): string { + return `sessionid-${userId}` + } + async login({ roleId, userId, @@ -442,13 +445,13 @@ export default class TestConfiguration { }) } await sessions.createASession(userId, { - sessionId: "sessionid", + sessionId: this.sessionIdForUser(userId), tenantId: this.getTenantId(), }) // have to fake this const authObj = { userId, - sessionId: "sessionid", + sessionId: this.sessionIdForUser(userId), tenantId: this.getTenantId(), } const authToken = jwt.sign(authObj, coreEnv.JWT_SECRET as Secret) @@ -470,7 +473,7 @@ export default class TestConfiguration { const user = this.getUser() const authObj: AuthToken = { userId: user._id!, - sessionId: "sessionid", + sessionId: this.sessionIdForUser(user._id!), tenantId, } const authToken = jwt.sign(authObj, coreEnv.JWT_SECRET as Secret) @@ -508,7 +511,7 @@ export default class TestConfiguration { async basicRoleHeaders() { return await this.roleHeaders({ - email: generator.email(), + email: generator.email({ domain: "example.com" }), builder: false, prodApp: true, roleId: roles.BUILTIN_ROLE_IDS.BASIC, @@ -516,7 +519,7 @@ export default class TestConfiguration { } async roleHeaders({ - email = generator.email(), + email = generator.email({ domain: "example.com" }), roleId = roles.BUILTIN_ROLE_IDS.ADMIN, builder = false, prodApp = true, @@ -576,7 +579,7 @@ export default class TestConfiguration { } // APP - async createApp(appName: string): Promise { + async createApp(appName: string, url?: string): Promise { // create dev app // clear any old app this.appId = undefined @@ -585,6 +588,7 @@ export default class TestConfiguration { async () => (await this._req(appController.create, { name: appName, + url, })) as App ) this.appId = this.app.appId diff --git a/packages/server/src/tests/utilities/api/application.ts b/packages/server/src/tests/utilities/api/application.ts index da3d7cefd8..d28df223b5 100644 --- a/packages/server/src/tests/utilities/api/application.ts +++ b/packages/server/src/tests/utilities/api/application.ts @@ -4,6 +4,7 @@ import { type CreateAppRequest, type FetchAppDefinitionResponse, type FetchAppPackageResponse, + DuplicateAppResponse, } from "@budibase/types" import { Expectations, TestAPI } from "./base" import { AppStatus } from "../../../db/utils" @@ -70,6 +71,22 @@ export class ApplicationAPI extends TestAPI { }) } + duplicateApp = async ( + appId: string, + fields: object, + expectations?: Expectations + ): Promise => { + let headers = { + ...this.config.defaultHeaders(), + [constants.Header.APP_ID]: appId, + } + return this._post(`/api/applications/${appId}/duplicate`, { + headers, + fields, + expectations, + }) + } + getDefinition = async ( appId: string, expectations?: Expectations diff --git a/packages/server/src/tests/utilities/api/base.ts b/packages/server/src/tests/utilities/api/base.ts index 3f534fba86..4df58ff425 100644 --- a/packages/server/src/tests/utilities/api/base.ts +++ b/packages/server/src/tests/utilities/api/base.ts @@ -143,16 +143,12 @@ export abstract class TestAPI { return await request } - protected _request = async ( - method: Method, - url: string, - opts?: RequestOpts - ): Promise => { - const { expectations } = opts || {} + protected _checkResponse = ( + response: Response, + expectations?: Expectations + ) => { const { status = 200 } = expectations || {} - const response = await this._requestRaw(method, url, opts) - if (response.status !== status) { let message = `Expected status ${status} but got ${response.status}` @@ -191,6 +187,17 @@ export abstract class TestAPI { expect(response.body).toMatchObject(expectations.body) } - return response.body + return response + } + + protected _request = async ( + method: Method, + url: string, + opts?: RequestOpts + ): Promise => { + return this._checkResponse( + await this._requestRaw(method, url, opts), + opts?.expectations + ).body } } diff --git a/packages/server/src/tests/utilities/api/index.ts b/packages/server/src/tests/utilities/api/index.ts index fdcec3098d..d66acd86fd 100644 --- a/packages/server/src/tests/utilities/api/index.ts +++ b/packages/server/src/tests/utilities/api/index.ts @@ -11,6 +11,7 @@ import { BackupAPI } from "./backup" import { AttachmentAPI } from "./attachment" import { UserAPI } from "./user" import { QueryAPI } from "./query" +import { RoleAPI } from "./role" export default class API { table: TableAPI @@ -25,6 +26,7 @@ export default class API { attachment: AttachmentAPI user: UserAPI query: QueryAPI + roles: RoleAPI constructor(config: TestConfiguration) { this.table = new TableAPI(config) @@ -39,5 +41,6 @@ export default class API { this.attachment = new AttachmentAPI(config) this.user = new UserAPI(config) this.query = new QueryAPI(config) + this.roles = new RoleAPI(config) } } diff --git a/packages/server/src/tests/utilities/api/legacyView.ts b/packages/server/src/tests/utilities/api/legacyView.ts index 38ef70d62a..ae250a81e2 100644 --- a/packages/server/src/tests/utilities/api/legacyView.ts +++ b/packages/server/src/tests/utilities/api/legacyView.ts @@ -1,8 +1,36 @@ import { Expectations, TestAPI } from "./base" -import { Row } from "@budibase/types" +import { Row, View, ViewCalculation } from "@budibase/types" export class LegacyViewAPI extends TestAPI { - get = async (id: string, expectations?: Expectations) => { - return await this._get(`/api/views/${id}`, { expectations }) + get = async ( + id: string, + query?: { calculation: ViewCalculation; group?: string }, + expectations?: Expectations + ) => { + return await this._get(`/api/views/${id}`, { query, expectations }) + } + + save = async (body: View, expectations?: Expectations) => { + return await this._post(`/api/views/`, { body, expectations }) + } + + fetch = async (expectations?: Expectations) => { + return await this._get(`/api/views`, { expectations }) + } + + destroy = async (id: string, expectations?: Expectations) => { + return await this._delete(`/api/views/${id}`, { expectations }) + } + + export = async ( + viewName: string, + format: "json" | "csv" | "jsonWithSchema", + expectations?: Expectations + ) => { + const response = await this._requestRaw("get", `/api/views/export`, { + query: { view: viewName, format }, + expectations, + }) + return this._checkResponse(response, expectations).text } } diff --git a/packages/server/src/tests/utilities/api/query.ts b/packages/server/src/tests/utilities/api/query.ts index 32866314ff..7b887c3fb6 100644 --- a/packages/server/src/tests/utilities/api/query.ts +++ b/packages/server/src/tests/utilities/api/query.ts @@ -5,7 +5,7 @@ import { PreviewQueryRequest, PreviewQueryResponse, } from "@budibase/types" -import { TestAPI } from "./base" +import { Expectations, TestAPI } from "./base" export class QueryAPI extends TestAPI { create = async (body: Query): Promise => { @@ -14,12 +14,14 @@ export class QueryAPI extends TestAPI { execute = async ( queryId: string, - body?: ExecuteQueryRequest + body?: ExecuteQueryRequest, + expectations?: Expectations ): Promise => { return await this._post( `/api/v2/queries/${queryId}`, { body, + expectations, } ) } diff --git a/packages/server/src/tests/utilities/api/role.ts b/packages/server/src/tests/utilities/api/role.ts new file mode 100644 index 0000000000..4defbc1220 --- /dev/null +++ b/packages/server/src/tests/utilities/api/role.ts @@ -0,0 +1,41 @@ +import { + AccessibleRolesResponse, + FetchRolesResponse, + FindRoleResponse, + SaveRoleRequest, + SaveRoleResponse, +} from "@budibase/types" +import { Expectations, TestAPI } from "./base" + +export class RoleAPI extends TestAPI { + fetch = async (expectations?: Expectations) => { + return await this._get(`/api/roles`, { + expectations, + }) + } + + find = async (roleId: string, expectations?: Expectations) => { + return await this._get(`/api/roles/${roleId}`, { + expectations, + }) + } + + save = async (body: SaveRoleRequest, expectations?: Expectations) => { + return await this._post(`/api/roles`, { + body, + expectations, + }) + } + + destroy = async (roleId: string, expectations?: Expectations) => { + return await this._delete(`/api/roles/${roleId}`, { + expectations, + }) + } + + accesssible = async (expectations?: Expectations) => { + return await this._get(`/api/roles/accessible`, { + expectations, + }) + } +} diff --git a/packages/server/src/tests/utilities/api/row.ts b/packages/server/src/tests/utilities/api/row.ts index 86664574cb..052e66b86e 100644 --- a/packages/server/src/tests/utilities/api/row.ts +++ b/packages/server/src/tests/utilities/api/row.ts @@ -8,10 +8,8 @@ import { BulkImportResponse, SearchRowResponse, SearchParams, - DeleteRowRequest, DeleteRows, DeleteRow, - ExportRowsResponse, } from "@budibase/types" import { Expectations, TestAPI } from "./base" @@ -117,6 +115,7 @@ export class RowAPI extends TestAPI { expectations, } ) + this._checkResponse(response, expectations) return response.text } diff --git a/packages/server/src/tests/utilities/api/viewV2.ts b/packages/server/src/tests/utilities/api/viewV2.ts index d4539e00b1..2bc2357551 100644 --- a/packages/server/src/tests/utilities/api/viewV2.ts +++ b/packages/server/src/tests/utilities/api/viewV2.ts @@ -6,26 +6,13 @@ import { PaginatedSearchRowResponse, } from "@budibase/types" import { Expectations, TestAPI } from "./base" -import { generator } from "@budibase/backend-core/tests" import sdk from "../../../sdk" export class ViewV2API extends TestAPI { create = async ( - viewData?: Partial, + view: CreateViewRequest, expectations?: Expectations ): Promise => { - let tableId = viewData?.tableId - if (!tableId && !this.config.table) { - throw "Test requires table to be configured." - } - - tableId = tableId || this.config.table!._id! - const view = { - tableId, - name: generator.guid(), - ...viewData, - } - const exp: Expectations = { status: 201, ...expectations, diff --git a/packages/server/src/threads/automation.ts b/packages/server/src/threads/automation.ts index a4938bb138..4e33fadce6 100644 --- a/packages/server/src/threads/automation.ts +++ b/packages/server/src/threads/automation.ts @@ -625,6 +625,7 @@ export async function executeInThread(job: Job) { }) return await context.doInAppContext(appId, async () => { + await context.ensureSnippetContext() const envVars = await sdkUtils.getEnvironmentVariables() // put into automation thread for whole context return await context.doInEnvironmentContext(envVars, async () => { diff --git a/packages/server/src/threads/query.ts b/packages/server/src/threads/query.ts index 9d7b7062a5..9f5e02bf69 100644 --- a/packages/server/src/threads/query.ts +++ b/packages/server/src/threads/query.ts @@ -8,14 +8,13 @@ import { QueryResponse, } from "./definitions" import { IsolatedVM } from "../jsRunner/vm" -import { iifeWrapper } from "../jsRunner/utilities" +import { iifeWrapper, processStringSync } from "@budibase/string-templates" import { getIntegration } from "../integrations" -import { processStringSync } from "@budibase/string-templates" import { context, cache, auth } from "@budibase/backend-core" import { getGlobalIDFromUserMetadataID } from "../db/utils" import sdk from "../sdk" import { cloneDeep } from "lodash/fp" -import { Datasource, Query, SourceName } from "@budibase/types" +import { Datasource, Query, SourceName, Row } from "@budibase/types" import { isSQL } from "../integrations/utils" import { interpolateSQL } from "../integrations/queries/sql" @@ -115,7 +114,7 @@ class QueryRunner { } let output = threadUtils.formatResponse(await integration[queryVerb](query)) - let rows = output, + let rows = output as Row[], info = undefined, extra = undefined, pagination = undefined @@ -170,7 +169,12 @@ class QueryRunner { } // get all the potential fields in the schema - let keys = rows.flatMap(Object.keys) + const keysSet: Set = new Set() + rows.forEach(row => { + const keys = Object.keys(row) + keys.forEach(key => keysSet.add(key)) + }) + const keys: string[] = [...keysSet] if (integration.end) { integration.end() diff --git a/packages/server/src/utilities/csv.ts b/packages/server/src/utilities/csv.ts index 477ebb896d..2fab1d11a4 100644 --- a/packages/server/src/utilities/csv.ts +++ b/packages/server/src/utilities/csv.ts @@ -9,9 +9,7 @@ export async function jsonFromCsvString(csvString: string) { // ignoreEmpty will remove the key completly if empty, so creating this empty object will ensure we return the values with the keys but empty values const result = await csv({ ignoreEmpty: false }).fromString(csvString) result.forEach((r, i) => { - for (const [key] of Object.entries(r).filter( - ([key, value]) => value === "" - )) { + for (const [key] of Object.entries(r).filter(([, value]) => value === "")) { if (castedWithEmptyValues[i][key] === undefined) { r[key] = null } diff --git a/packages/server/src/utilities/rowProcessor/attachments.ts b/packages/server/src/utilities/rowProcessor/attachments.ts index c289680eb3..e1c83352d4 100644 --- a/packages/server/src/utilities/rowProcessor/attachments.ts +++ b/packages/server/src/utilities/rowProcessor/attachments.ts @@ -43,7 +43,7 @@ export class AttachmentCleanup { if ((columnRemoved && !renaming) || opts.deleting) { rows.forEach(row => { files = files.concat( - row[key].map((attachment: any) => attachment.key) + (row[key] || []).map((attachment: any) => attachment.key) ) }) } diff --git a/packages/server/src/utilities/rowProcessor/bbReferenceProcessor.ts b/packages/server/src/utilities/rowProcessor/bbReferenceProcessor.ts index c7b8998bad..a5fbfa981d 100644 --- a/packages/server/src/utilities/rowProcessor/bbReferenceProcessor.ts +++ b/packages/server/src/utilities/rowProcessor/bbReferenceProcessor.ts @@ -7,7 +7,7 @@ const ROW_PREFIX = DocumentType.ROW + SEPARATOR export async function processInputBBReferences( value: string | string[] | { _id: string } | { _id: string }[], - subtype: FieldSubtype + subtype: FieldSubtype.USER | FieldSubtype.USERS ): Promise { let referenceIds: string[] = [] @@ -41,7 +41,7 @@ export async function processInputBBReferences( switch (subtype) { case FieldSubtype.USER: - case FieldSubtype.USERS: + case FieldSubtype.USERS: { const { notFoundIds } = await cache.user.getUsers(referenceIds) if (notFoundIds?.length) { @@ -53,7 +53,7 @@ export async function processInputBBReferences( } return referenceIds.join(",") || null - + } default: throw utils.unreachable(subtype) } @@ -61,7 +61,7 @@ export async function processInputBBReferences( export async function processOutputBBReferences( value: string | string[], - subtype: FieldSubtype + subtype: FieldSubtype.USER | FieldSubtype.USERS ) { if (value === null || value === undefined) { // Already processed or nothing to process @@ -73,7 +73,7 @@ export async function processOutputBBReferences( switch (subtype) { case FieldSubtype.USER: - case FieldSubtype.USERS: + case FieldSubtype.USERS: { const { users } = await cache.user.getUsers(ids) if (!users.length) { return undefined @@ -86,7 +86,7 @@ export async function processOutputBBReferences( firstName: u.firstName, lastName: u.lastName, })) - + } default: throw utils.unreachable(subtype) } diff --git a/packages/server/src/utilities/rowProcessor/index.ts b/packages/server/src/utilities/rowProcessor/index.ts index e3ca576fb7..0015680e77 100644 --- a/packages/server/src/utilities/rowProcessor/index.ts +++ b/packages/server/src/utilities/rowProcessor/index.ts @@ -6,7 +6,6 @@ import { TYPE_TRANSFORM_MAP } from "./map" import { FieldType, AutoFieldSubType, - FieldSubtype, Row, RowAttachment, Table, @@ -159,10 +158,7 @@ export async function inputProcessing( } if (field.type === FieldType.BB_REFERENCE && value) { - clonedRow[key] = await processInputBBReferences( - value, - field.subtype as FieldSubtype - ) + clonedRow[key] = await processInputBBReferences(value, field.subtype) } } @@ -238,14 +234,14 @@ export async function outputProcessing( for (let row of enriched) { row[property] = await processOutputBBReferences( row[property], - column.subtype as FieldSubtype + column.subtype ) } } } // process formulas after the complex types had been processed - enriched = processFormulas(table, enriched, { dynamic: true }) + enriched = await processFormulas(table, enriched, { dynamic: true }) if (opts.squash) { enriched = (await linkRows.squashLinksToPrimaryDisplay( diff --git a/packages/server/src/utilities/rowProcessor/tests/attachments.spec.ts b/packages/server/src/utilities/rowProcessor/tests/attachments.spec.ts index 43af79d82c..cefea7e504 100644 --- a/packages/server/src/utilities/rowProcessor/tests/attachments.spec.ts +++ b/packages/server/src/utilities/rowProcessor/tests/attachments.spec.ts @@ -64,12 +64,12 @@ describe("attachment cleanup", () => { await AttachmentCleanup.tableUpdate(originalTable, [row()], { oldTable: table(), }) - expect(mockedDeleteFiles).toBeCalledWith(BUCKET, [FILE_NAME]) + expect(mockedDeleteFiles).toHaveBeenCalledWith(BUCKET, [FILE_NAME]) }) it("should be able to cleanup a table deletion", async () => { await AttachmentCleanup.tableDelete(table(), [row()]) - expect(mockedDeleteFiles).toBeCalledWith(BUCKET, [FILE_NAME]) + expect(mockedDeleteFiles).toHaveBeenCalledWith(BUCKET, [FILE_NAME]) }) it("should handle table column renaming", async () => { @@ -80,12 +80,12 @@ describe("attachment cleanup", () => { oldTable: table(), rename: { old: "attach", updated: "attach2" }, }) - expect(mockedDeleteFiles).not.toBeCalled() + expect(mockedDeleteFiles).not.toHaveBeenCalled() }) it("shouldn't cleanup if no table changes", async () => { await AttachmentCleanup.tableUpdate(table(), [row()], { oldTable: table() }) - expect(mockedDeleteFiles).not.toBeCalled() + expect(mockedDeleteFiles).not.toHaveBeenCalled() }) it("should handle row updates", async () => { @@ -95,12 +95,12 @@ describe("attachment cleanup", () => { row: updatedRow, oldRow: row(), }) - expect(mockedDeleteFiles).toBeCalledWith(BUCKET, [FILE_NAME]) + expect(mockedDeleteFiles).toHaveBeenCalledWith(BUCKET, [FILE_NAME]) }) it("should handle row deletion", async () => { await AttachmentCleanup.rowDelete(table(), [row()]) - expect(mockedDeleteFiles).toBeCalledWith(BUCKET, [FILE_NAME]) + expect(mockedDeleteFiles).toHaveBeenCalledWith(BUCKET, [FILE_NAME]) }) it("should handle row deletion and not throw when attachments are undefined", async () => { @@ -113,6 +113,33 @@ describe("attachment cleanup", () => { it("shouldn't cleanup attachments if row not updated", async () => { await AttachmentCleanup.rowUpdate(table(), { row: row(), oldRow: row() }) - expect(mockedDeleteFiles).not.toBeCalled() + expect(mockedDeleteFiles).not.toHaveBeenCalled() + }) + + it("should be able to cleanup a column and not throw when attachments are undefined", async () => { + const originalTable = table() + delete originalTable.schema["attach"] + await AttachmentCleanup.tableUpdate( + originalTable, + [row("file 1"), { attach: undefined }, row("file 2")], + { + oldTable: table(), + } + ) + expect(mockedDeleteFiles).toHaveBeenCalledTimes(1) + expect(mockedDeleteFiles).toHaveBeenCalledWith(BUCKET, ["file 1", "file 2"]) + }) + + it("should be able to cleanup a column and not throw when ALL attachments are undefined", async () => { + const originalTable = table() + delete originalTable.schema["attach"] + await AttachmentCleanup.tableUpdate( + originalTable, + [{}, { attach: undefined }], + { + oldTable: table(), + } + ) + expect(mockedDeleteFiles).not.toHaveBeenCalled() }) }) diff --git a/packages/server/src/utilities/rowProcessor/tests/bbReferenceProcessor.spec.ts b/packages/server/src/utilities/rowProcessor/tests/bbReferenceProcessor.spec.ts index b6174861d4..e6ceaae323 100644 --- a/packages/server/src/utilities/rowProcessor/tests/bbReferenceProcessor.spec.ts +++ b/packages/server/src/utilities/rowProcessor/tests/bbReferenceProcessor.spec.ts @@ -67,8 +67,8 @@ describe("bbReferenceProcessor", () => { ) expect(result).toEqual(userId) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith([userId]) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith([userId]) }) it("throws an error given an invalid id", async () => { @@ -78,9 +78,9 @@ describe("bbReferenceProcessor", () => { config.doInTenant(() => processInputBBReferences(userId, FieldSubtype.USER) ) - ).rejects.toThrowError(new InvalidBBRefError(userId, FieldSubtype.USER)) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith([userId]) + ).rejects.toThrow(new InvalidBBRefError(userId, FieldSubtype.USER)) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith([userId]) }) it("validates valid user ids as csv", async () => { @@ -92,8 +92,8 @@ describe("bbReferenceProcessor", () => { ) expect(result).toEqual(userIds.join(",")) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith(userIds) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith(userIds) }) it("throws an error given an invalid id in a csv", async () => { @@ -110,9 +110,7 @@ describe("bbReferenceProcessor", () => { config.doInTenant(() => processInputBBReferences(userIdCsv, FieldSubtype.USER) ) - ).rejects.toThrowError( - new InvalidBBRefError(wrongId, FieldSubtype.USER) - ) + ).rejects.toThrow(new InvalidBBRefError(wrongId, FieldSubtype.USER)) }) it("validate valid user object", async () => { @@ -123,8 +121,8 @@ describe("bbReferenceProcessor", () => { ) expect(result).toEqual(userId) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith([userId]) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith([userId]) }) it("validate valid user object array", async () => { @@ -135,8 +133,8 @@ describe("bbReferenceProcessor", () => { ) expect(result).toEqual(userIds.join(",")) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith(userIds) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith(userIds) }) it("empty strings will return null", async () => { @@ -185,8 +183,8 @@ describe("bbReferenceProcessor", () => { lastName: user.lastName, }, ]) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith([userId]) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith([userId]) }) it("fetches user given a valid string id csv", async () => { @@ -213,8 +211,8 @@ describe("bbReferenceProcessor", () => { })) ) ) - expect(cacheGetUsersSpy).toBeCalledTimes(1) - expect(cacheGetUsersSpy).toBeCalledWith([userId1, userId2]) + expect(cacheGetUsersSpy).toHaveBeenCalledTimes(1) + expect(cacheGetUsersSpy).toHaveBeenCalledWith([userId1, userId2]) }) }) }) diff --git a/packages/server/src/utilities/rowProcessor/tests/inputProcessing.spec.ts b/packages/server/src/utilities/rowProcessor/tests/inputProcessing.spec.ts index b6c1db9159..859a203133 100644 --- a/packages/server/src/utilities/rowProcessor/tests/inputProcessing.spec.ts +++ b/packages/server/src/utilities/rowProcessor/tests/inputProcessing.spec.ts @@ -62,8 +62,10 @@ describe("rowProcessor - inputProcessing", () => { const { row } = await inputProcessing(userId, table, newRow) - expect(bbReferenceProcessor.processInputBBReferences).toBeCalledTimes(1) - expect(bbReferenceProcessor.processInputBBReferences).toBeCalledWith( + expect(bbReferenceProcessor.processInputBBReferences).toHaveBeenCalledTimes( + 1 + ) + expect(bbReferenceProcessor.processInputBBReferences).toHaveBeenCalledWith( "123", "user" ) @@ -71,7 +73,7 @@ describe("rowProcessor - inputProcessing", () => { expect(row).toEqual({ ...newRow, user }) }) - it("it does not process BB references if on the schema but it is not populated", async () => { + it("does not process BB references if on the schema but it is not populated", async () => { const userId = generator.guid() const table: Table = { @@ -107,12 +109,12 @@ describe("rowProcessor - inputProcessing", () => { const { row } = await inputProcessing(userId, table, newRow) - expect(bbReferenceProcessor.processInputBBReferences).not.toBeCalled() + expect(bbReferenceProcessor.processInputBBReferences).not.toHaveBeenCalled() expect(row).toEqual({ ...newRow, user: undefined }) }) it.each([undefined, null, ""])( - "it does not process BB references the field is $%", + "does not process BB references the field is $%", async userValue => { const userId = generator.guid() @@ -150,12 +152,14 @@ describe("rowProcessor - inputProcessing", () => { const { row } = await inputProcessing(userId, table, newRow) - expect(bbReferenceProcessor.processInputBBReferences).not.toBeCalled() + expect( + bbReferenceProcessor.processInputBBReferences + ).not.toHaveBeenCalled() expect(row).toEqual(newRow) } ) - it("it does not process BB references if not in the schema", async () => { + it("does not process BB references if not in the schema", async () => { const userId = generator.guid() const table: Table = { @@ -191,7 +195,7 @@ describe("rowProcessor - inputProcessing", () => { const { row } = await inputProcessing(userId, table, newRow) - expect(bbReferenceProcessor.processInputBBReferences).not.toBeCalled() + expect(bbReferenceProcessor.processInputBBReferences).not.toHaveBeenCalled() expect(row).toEqual({ name: "Jack", user: 123, diff --git a/packages/server/src/utilities/rowProcessor/tests/outputProcessing.spec.ts b/packages/server/src/utilities/rowProcessor/tests/outputProcessing.spec.ts index 95ce340910..a17bd5f393 100644 --- a/packages/server/src/utilities/rowProcessor/tests/outputProcessing.spec.ts +++ b/packages/server/src/utilities/rowProcessor/tests/outputProcessing.spec.ts @@ -64,8 +64,10 @@ describe("rowProcessor - outputProcessing", () => { expect(result).toEqual({ name: "Jack", user }) - expect(bbReferenceProcessor.processOutputBBReferences).toBeCalledTimes(1) - expect(bbReferenceProcessor.processOutputBBReferences).toBeCalledWith( + expect( + bbReferenceProcessor.processOutputBBReferences + ).toHaveBeenCalledTimes(1) + expect(bbReferenceProcessor.processOutputBBReferences).toHaveBeenCalledWith( "123", FieldSubtype.USER ) @@ -150,7 +152,9 @@ describe("rowProcessor - outputProcessing", () => { expect(result).toEqual({ name: "Jack" }) - expect(bbReferenceProcessor.processOutputBBReferences).toBeCalledTimes(1) + expect( + bbReferenceProcessor.processOutputBBReferences + ).toHaveBeenCalledTimes(1) }) it("does not fetch bb references when not in the schema", async () => { @@ -189,6 +193,8 @@ describe("rowProcessor - outputProcessing", () => { expect(result).toEqual({ name: "Jack", user: "123" }) - expect(bbReferenceProcessor.processOutputBBReferences).not.toBeCalled() + expect( + bbReferenceProcessor.processOutputBBReferences + ).not.toHaveBeenCalled() }) }) diff --git a/packages/server/src/utilities/rowProcessor/utils.ts b/packages/server/src/utilities/rowProcessor/utils.ts index d0fc82b3ee..8201680f13 100644 --- a/packages/server/src/utilities/rowProcessor/utils.ts +++ b/packages/server/src/utilities/rowProcessor/utils.ts @@ -10,6 +10,7 @@ import { FieldType, } from "@budibase/types" import tracer from "dd-trace" +import { context } from "@budibase/backend-core" interface FormulaOpts { dynamic?: boolean @@ -44,16 +45,19 @@ export function fixAutoColumnSubType( /** * Looks through the rows provided and finds formulas - which it then processes. */ -export function processFormulas( +export async function processFormulas( table: Table, inputRows: T, { dynamic, contextRows }: FormulaOpts = { dynamic: true } -): T { - return tracer.trace("processFormulas", {}, span => { +): Promise { + return tracer.trace("processFormulas", {}, async span => { const numRows = Array.isArray(inputRows) ? inputRows.length : 1 span?.addTags({ table_id: table._id, dynamic, numRows }) const rows = Array.isArray(inputRows) ? inputRows : [inputRows] if (rows) { + // Ensure we have snippet context + await context.ensureSnippetContext() + for (let [column, schema] of Object.entries(table.schema)) { if (schema.type !== FieldType.FORMULA) { continue diff --git a/packages/server/src/utilities/schema.ts b/packages/server/src/utilities/schema.ts index 500e922d65..85dfdd3506 100644 --- a/packages/server/src/utilities/schema.ts +++ b/packages/server/src/utilities/schema.ts @@ -1,26 +1,14 @@ -import { FieldType, FieldSubtype } from "@budibase/types" +import { + FieldType, + FieldSubtype, + TableSchema, + FieldSchema, + Row, +} from "@budibase/types" import { ValidColumnNameRegex, utils } from "@budibase/shared-core" import { db } from "@budibase/backend-core" import { parseCsvExport } from "../api/controllers/view/exporters" -interface SchemaColumn { - readonly name: string - readonly type: FieldType - readonly subtype: FieldSubtype - readonly autocolumn?: boolean - readonly constraints?: { - presence: boolean - } -} - -interface Schema { - readonly [index: string]: SchemaColumn -} - -interface Row { - [index: string]: any -} - type Rows = Array interface SchemaValidation { @@ -34,27 +22,10 @@ interface ValidationResults { errors: Record } -const PARSERS: any = { - [FieldType.NUMBER]: (attribute?: string) => { - if (!attribute) { - return attribute - } - return Number(attribute) - }, - [FieldType.DATETIME]: (attribute?: string) => { - if (!attribute) { - return attribute - } - return new Date(attribute).toISOString() - }, -} - -export function isSchema(schema: any): schema is Schema { +export function isSchema(schema: any): schema is TableSchema { return ( typeof schema === "object" && - Object.values(schema).every(rawColumn => { - const column = rawColumn as SchemaColumn - + Object.values(schema).every(column => { return ( column !== null && typeof column === "object" && @@ -69,7 +40,7 @@ export function isRows(rows: any): rows is Rows { return Array.isArray(rows) && rows.every(row => typeof row === "object") } -export function validate(rows: Rows, schema: Schema): ValidationResults { +export function validate(rows: Rows, schema: TableSchema): ValidationResults { const results: ValidationResults = { schemaValidation: {}, allValid: false, @@ -79,9 +50,11 @@ export function validate(rows: Rows, schema: Schema): ValidationResults { rows.forEach(row => { Object.entries(row).forEach(([columnName, columnData]) => { - const columnType = schema[columnName]?.type - const columnSubtype = schema[columnName]?.subtype - const isAutoColumn = schema[columnName]?.autocolumn + const { + type: columnType, + subtype: columnSubtype, + autocolumn: isAutoColumn, + } = schema[columnName] // If the column had an invalid value we don't want to override it if (results.schemaValidation[columnName] === false) { @@ -138,7 +111,7 @@ export function validate(rows: Rows, schema: Schema): ValidationResults { return results } -export function parse(rows: Rows, schema: Schema): Rows { +export function parse(rows: Rows, schema: TableSchema): Rows { return rows.map(row => { const parsedRow: Row = {} @@ -148,9 +121,7 @@ export function parse(rows: Rows, schema: Schema): Rows { return } - const columnType = schema[columnName].type - const columnSubtype = schema[columnName].subtype - + const { type: columnType, subtype: columnSubtype } = schema[columnName] if (columnType === FieldType.NUMBER) { // If provided must be a valid number parsedRow[columnName] = columnData ? Number(columnData) : columnData @@ -187,11 +158,11 @@ export function parse(rows: Rows, schema: Schema): Rows { function isValidBBReference( columnData: any, - columnSubtype: FieldSubtype + columnSubtype: FieldSubtype.USER | FieldSubtype.USERS ): boolean { switch (columnSubtype) { case FieldSubtype.USER: - case FieldSubtype.USERS: + case FieldSubtype.USERS: { if (typeof columnData !== "string") { return false } @@ -208,7 +179,7 @@ function isValidBBReference( user => !db.isGlobalUserID(user._id) ) return !constainsWrongId - + } default: throw utils.unreachable(columnSubtype) } diff --git a/packages/server/src/utilities/usageQuota/usageQuoteReset.ts b/packages/server/src/utilities/usageQuota/usageQuoteReset.ts deleted file mode 100644 index 579fa130d0..0000000000 --- a/packages/server/src/utilities/usageQuota/usageQuoteReset.ts +++ /dev/null @@ -1,18 +0,0 @@ -// UNUSED CODE -// Preserved for future use - -/* eslint-disable no-unused-vars */ - -function getNewQuotaReset() { - return Date.now() + 2592000000 -} - -function resetQuotasIfRequired(quota: { quotaReset: number; usageQuota: any }) { - // Check if the quota needs reset - if (Date.now() >= quota.quotaReset) { - quota.quotaReset = getNewQuotaReset() - for (let prop of Object.keys(quota.usageQuota)) { - quota.usageQuota[prop] = 0 - } - } -} diff --git a/packages/server/src/utilities/workerRequests.ts b/packages/server/src/utilities/workerRequests.ts index 91340c8d78..c3a0b0abfa 100644 --- a/packages/server/src/utilities/workerRequests.ts +++ b/packages/server/src/utilities/workerRequests.ts @@ -1,10 +1,4 @@ -import { - Response, - default as fetch, - type RequestInit, - Headers, - HeadersInit, -} from "node-fetch" +import { Response, default as fetch, type RequestInit } from "node-fetch" import env from "../environment" import { checkSlashesInUrl } from "./index" import { @@ -13,7 +7,6 @@ import { tenancy, logging, env as coreEnv, - utils, } from "@budibase/backend-core" import { Ctx, User, EmailInvite } from "@budibase/types" diff --git a/packages/server/src/websockets/websocket.ts b/packages/server/src/websockets/websocket.ts index 2861757de1..871122678d 100644 --- a/packages/server/src/websockets/websocket.ts +++ b/packages/server/src/websockets/websocket.ts @@ -262,10 +262,12 @@ export class BaseSocket { } } + // eslint-disable-next-line @typescript-eslint/no-unused-vars async onConnect(socket: Socket) { // Override } + // eslint-disable-next-line @typescript-eslint/no-unused-vars async onDisconnect(socket: Socket) { // Override } diff --git a/packages/server/tsconfig.build.json b/packages/server/tsconfig.build.json index e4552bdb18..c4b9b8788e 100644 --- a/packages/server/tsconfig.build.json +++ b/packages/server/tsconfig.build.json @@ -18,7 +18,8 @@ "@budibase/backend-core/*": ["../backend-core/*"], "@budibase/shared-core": ["../shared-core/src"], "@budibase/pro": ["../pro/src"], - "@budibase/string-templates": ["../string-templates/src"] + "@budibase/string-templates": ["../string-templates/src"], + "@budibase/string-templates/*": ["../string-templates/*"] }, "allowArbitraryExtensions": true }, diff --git a/packages/shared-core/jest.config.ts b/packages/shared-core/jest.config.ts new file mode 100644 index 0000000000..5c7c870b58 --- /dev/null +++ b/packages/shared-core/jest.config.ts @@ -0,0 +1,10 @@ +export default { + preset: "ts-jest", + testEnvironment: "node", + transform: { + "^.+\\.ts?$": "@swc/jest", + }, + moduleNameMapper: { + "@budibase/types": "/../types/src", + }, +} diff --git a/packages/shared-core/package.json b/packages/shared-core/package.json index 777896a7f7..c024d1b819 100644 --- a/packages/shared-core/package.json +++ b/packages/shared-core/package.json @@ -11,7 +11,9 @@ "build": "node ../../scripts/build.js && tsc -p tsconfig.build.json --emitDeclarationOnly --paths null", "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput", "dev": "tsc -p tsconfig.json --watch --preserveWatchOutput", - "check:types": "tsc -p tsconfig.json --noEmit --paths null" + "check:types": "tsc -p tsconfig.json --noEmit --paths null", + "test": "jest", + "test:watch": "yarn test --watchAll" }, "dependencies": { "@budibase/types": "0.0.0", @@ -20,29 +22,5 @@ "devDependencies": { "rimraf": "3.0.2", "typescript": "5.2.2" - }, - "nx": { - "targets": { - "build": { - "dependsOn": [ - { - "projects": [ - "@budibase/types" - ], - "target": "build" - } - ] - }, - "dev": { - "dependsOn": [ - { - "projects": [ - "@budibase/types" - ], - "target": "build" - } - ] - } - } } } diff --git a/packages/shared-core/src/constants/index.ts b/packages/shared-core/src/constants/index.ts index 7acaa2cba1..922f0d4387 100644 --- a/packages/shared-core/src/constants/index.ts +++ b/packages/shared-core/src/constants/index.ts @@ -98,6 +98,7 @@ export enum BuilderSocketEvent { export const SocketSessionTTL = 60 export const ValidQueryNameRegex = /^[^()]*$/ export const ValidColumnNameRegex = /^[_a-zA-Z0-9\s]*$/g +export const ValidSnippetNameRegex = /^[a-z_][a-z0-9_]*$/i export const REBOOT_CRON = "@reboot" diff --git a/packages/shared-core/src/filters.ts b/packages/shared-core/src/filters.ts index 46d765a7b5..d9fe533c88 100644 --- a/packages/shared-core/src/filters.ts +++ b/packages/shared-core/src/filters.ts @@ -390,24 +390,41 @@ export const runLuceneQuery = (docs: any[], query?: SearchQuery) => { } ) - // Match a document against all criteria const docMatch = (doc: any) => { - return ( - stringMatch(doc) && - fuzzyMatch(doc) && - rangeMatch(doc) && - equalMatch(doc) && - notEqualMatch(doc) && - emptyMatch(doc) && - notEmptyMatch(doc) && - oneOf(doc) && - contains(doc) && - containsAny(doc) && - notContains(doc) - ) - } + const filterFunctions: Record boolean> = + { + string: stringMatch, + fuzzy: fuzzyMatch, + range: rangeMatch, + equal: equalMatch, + notEqual: notEqualMatch, + empty: emptyMatch, + notEmpty: notEmptyMatch, + oneOf: oneOf, + contains: contains, + containsAny: containsAny, + notContains: notContains, + } - // Process all docs + const activeFilterKeys: SearchQueryOperators[] = Object.entries(query || {}) + .filter( + ([key, value]: [string, any]) => + !["allOr", "onEmptyFilter"].includes(key) && + value && + Object.keys(value as Record).length > 0 + ) + .map(([key]) => key as any) + + const results: boolean[] = activeFilterKeys.map(filterKey => { + return filterFunctions[filterKey]?.(doc) ?? false + }) + + if (query!.allOr) { + return results.some(result => result === true) + } else { + return results.every(result => result === true) + } + } return docs.filter(docMatch) } diff --git a/packages/shared-core/src/sdk/documents/users.ts b/packages/shared-core/src/sdk/documents/users.ts index 11e80dcf29..17aa8a1e58 100644 --- a/packages/shared-core/src/sdk/documents/users.ts +++ b/packages/shared-core/src/sdk/documents/users.ts @@ -46,10 +46,7 @@ export function isAdminOrBuilder( return isBuilder(user, appId) || isAdmin(user) } -export function isAdminOrGlobalBuilder( - user: User | ContextUser, - appId?: string -): boolean { +export function isAdminOrGlobalBuilder(user: User | ContextUser): boolean { return isGlobalBuilder(user) || isAdmin(user) } diff --git a/packages/shared-core/src/tests/cron.test.ts b/packages/shared-core/src/tests/cron.test.ts index d56165b2b8..3945acb565 100644 --- a/packages/shared-core/src/tests/cron.test.ts +++ b/packages/shared-core/src/tests/cron.test.ts @@ -1,4 +1,3 @@ -import { expect, describe, it } from "vitest" import { cron } from "../helpers" describe("check valid and invalid crons", () => { diff --git a/packages/shared-core/src/tests/filters.test.ts b/packages/shared-core/src/tests/filters.test.ts index 8586d58777..e74e37d681 100644 --- a/packages/shared-core/src/tests/filters.test.ts +++ b/packages/shared-core/src/tests/filters.test.ts @@ -5,7 +5,6 @@ import { SearchFilter, } from "@budibase/types" import { buildLuceneQuery, runLuceneQuery } from "../filters" -import { expect, describe, it, test } from "vitest" describe("runLuceneQuery", () => { const docs = [ @@ -47,10 +46,7 @@ describe("runLuceneQuery", () => { }, ] - function buildQuery( - filterKey: string, - value: { [key: string]: any } - ): SearchQuery { + function buildQuery(filters: { [filterKey: string]: any }): SearchQuery { const query: SearchQuery = { string: {}, fuzzy: {}, @@ -63,8 +59,13 @@ describe("runLuceneQuery", () => { notContains: {}, oneOf: {}, containsAny: {}, + allOr: false, } - query[filterKey as SearchQueryOperators] = value + + for (const filterKey in filters) { + query[filterKey as SearchQueryOperators] = filters[filterKey] + } + return query } @@ -73,16 +74,17 @@ describe("runLuceneQuery", () => { }) it("should return matching rows for equal filter", () => { - const query = buildQuery("equal", { - order_status: 4, + const query = buildQuery({ + equal: { order_status: 4 }, }) expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([1, 2]) }) it("should return matching row for notEqual filter", () => { - const query = buildQuery("notEqual", { - order_status: 4, + const query = buildQuery({ + notEqual: { order_status: 4 }, }) + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([3]) }) @@ -90,48 +92,56 @@ describe("runLuceneQuery", () => { expect( runLuceneQuery( docs, - buildQuery("fuzzy", { - description: "sm", + buildQuery({ + fuzzy: { description: "sm" }, }) ).map(row => row.description) ).toEqual(["Small box"]) expect( runLuceneQuery( docs, - buildQuery("string", { - description: "SM", + buildQuery({ + string: { description: "SM" }, }) ).map(row => row.description) ).toEqual(["Small box"]) }) it("should return rows within a range filter", () => { - const query = buildQuery("range", { - customer_id: { - low: 500, - high: 1000, + const query = buildQuery({ + range: { + customer_id: { + low: 500, + high: 1000, + }, }, }) + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([3]) }) it("should return rows with numeric strings within a range filter", () => { - const query = buildQuery("range", { - customer_id: { - low: "500", - high: "1000", + const query = buildQuery({ + range: { + customer_id: { + low: "500", + high: "1000", + }, }, }) expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([3]) }) it("should return rows with ISO date strings within a range filter", () => { - const query = buildQuery("range", { - order_date: { - low: "2016-01-04T00:00:00.000Z", - high: "2016-01-11T00:00:00.000Z", + const query = buildQuery({ + range: { + order_date: { + low: "2016-01-04T00:00:00.000Z", + high: "2016-01-11T00:00:00.000Z", + }, }, }) + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([2]) }) @@ -150,40 +160,88 @@ describe("runLuceneQuery", () => { label: "", }, ] - const query = buildQuery("range", { - order_date: { - low: "2016-01-04T00:00:00.000Z", - high: "2016-01-11T00:00:00.000Z", + + const query = buildQuery({ + range: { + order_date: { + low: "2016-01-04T00:00:00.000Z", + high: "2016-01-11T00:00:00.000Z", + }, }, }) + expect(runLuceneQuery(docs, query)).toEqual(docs) }) it("should return rows with matches on empty filter", () => { - const query = buildQuery("empty", { - label: null, + const query = buildQuery({ + empty: { + label: null, + }, }) + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([1]) }) it("should return rows with matches on notEmpty filter", () => { - const query = buildQuery("notEmpty", { - label: null, + const query = buildQuery({ + notEmpty: { + label: null, + }, }) + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([2, 3]) }) - test.each([[523, 259], "523,259"])( + it.each([[523, 259], "523,259"])( "should return rows with matches on numeric oneOf filter", input => { - let query = buildQuery("oneOf", { - customer_id: input, + const query = buildQuery({ + oneOf: { + customer_id: input, + }, }) + expect(runLuceneQuery(docs, query).map(row => row.customer_id)).toEqual([ 259, 523, ]) } ) + + it.each([ + [false, []], + [true, [1, 2, 3]], + ])("should return %s if allOr is %s ", (allOr, expectedResult) => { + const query = buildQuery({ + allOr, + oneOf: { staff_id: [10] }, + contains: { description: ["box"] }, + }) + + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual( + expectedResult + ) + }) + + it("should return matching results if allOr is true and only one filter matches with different operands", () => { + const query = buildQuery({ + allOr: true, + equal: { order_status: 4 }, + oneOf: { label: ["FRAGILE"] }, + }) + + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([1, 2]) + }) + + it("should handle when a value is null or undefined", () => { + const query = buildQuery({ + allOr: true, + equal: { order_status: null }, + oneOf: { label: ["FRAGILE"] }, + }) + + expect(runLuceneQuery(docs, query).map(row => row.order_id)).toEqual([2]) + }) }) describe("buildLuceneQuery", () => { diff --git a/packages/shared-core/tsconfig.build.json b/packages/shared-core/tsconfig.build.json index 8a7f0ea216..13e298d71c 100644 --- a/packages/shared-core/tsconfig.build.json +++ b/packages/shared-core/tsconfig.build.json @@ -18,13 +18,6 @@ }, "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo" }, - "include": ["**/*.js", "**/*.ts"], - "exclude": [ - "node_modules", - "dist", - "**/*.spec.ts", - "**/*.spec.js", - "__mocks__", - "src/tests" - ] + "include": ["src/**/*"], + "exclude": ["**/*.spec.ts", "**/*.spec.js", "__mocks__", "src/tests"] } diff --git a/packages/shared-core/tsconfig.json b/packages/shared-core/tsconfig.json index 5e3d49c8b9..d0c5134f1c 100644 --- a/packages/shared-core/tsconfig.json +++ b/packages/shared-core/tsconfig.json @@ -3,7 +3,8 @@ "compilerOptions": { "baseUrl": "..", "rootDir": "src", - "composite": true + "composite": true, + "types": ["node", "jest"] }, "exclude": ["node_modules", "dist"] } diff --git a/packages/string-templates/jest.config.js b/packages/string-templates/jest.config.js index c6391cdb92..4916ebf894 100644 --- a/packages/string-templates/jest.config.js +++ b/packages/string-templates/jest.config.js @@ -4,6 +4,7 @@ */ module.exports = { + preset: "ts-jest", // All imported modules in your tests should be mocked automatically // automock: false, diff --git a/packages/string-templates/package.json b/packages/string-templates/package.json index ceafd5364f..8cf8d92692 100644 --- a/packages/string-templates/package.json +++ b/packages/string-templates/package.json @@ -2,39 +2,39 @@ "name": "@budibase/string-templates", "version": "0.0.0", "description": "Handlebars wrapper for Budibase templating.", - "main": "src/index.js", + "main": "dist/bundle.cjs", "module": "dist/bundle.mjs", + "types": "src/index.ts", "license": "MPL-2.0", - "types": "dist/index.d.ts", "exports": { ".": { - "require": "./src/index.js", + "require": "./dist/bundle.cjs", "import": "./dist/bundle.mjs" }, "./package.json": "./package.json", - "./test/utils": "./test/utils.js" + "./iife": "./src/iife.js" }, "files": [ "dist", - "src", - "manifest.json" + "src" ], "scripts": { - "build": "tsc && rollup -c", - "dev": "concurrently \"tsc --watch\" \"rollup -cw\"", + "build": "tsc --emitDeclarationOnly && rollup -c", + "dev": "rollup -cw", + "check:types": "tsc -p tsconfig.json --noEmit --paths null", "test": "jest", - "manifest": "node ./scripts/gen-collection-info.js" + "manifest": "ts-node ./scripts/gen-collection-info.ts" }, "dependencies": { "@budibase/handlebars-helpers": "^0.13.1", "dayjs": "^1.10.8", - "handlebars": "^4.7.6", + "handlebars": "^4.7.8", "lodash.clonedeep": "^4.5.0" }, "devDependencies": { "@rollup/plugin-commonjs": "^17.1.0", - "@rollup/plugin-json": "^4.1.0", - "concurrently": "^8.2.2", + "@rollup/plugin-inject": "^5.0.5", + "@rollup/plugin-typescript": "8.3.0", "doctrine": "^3.0.0", "jest": "29.7.0", "marked": "^4.0.10", @@ -44,6 +44,7 @@ "rollup-plugin-node-globals": "^1.4.0", "rollup-plugin-node-resolve": "^5.2.0", "rollup-plugin-terser": "^7.0.2", + "ts-jest": "29.1.1", "typescript": "5.2.2" } } diff --git a/packages/string-templates/rollup.config.js b/packages/string-templates/rollup.config.js index d7f45489c9..a843286a82 100644 --- a/packages/string-templates/rollup.config.js +++ b/packages/string-templates/rollup.config.js @@ -4,31 +4,38 @@ import json from "@rollup/plugin-json" import { terser } from "rollup-plugin-terser" import builtins from "rollup-plugin-node-builtins" import globals from "rollup-plugin-node-globals" +import typescript from "@rollup/plugin-typescript" import injectProcessEnv from "rollup-plugin-inject-process-env" +import inject from "@rollup/plugin-inject" const production = !process.env.ROLLUP_WATCH -export default [ - { - input: "src/index.mjs", - output: { - sourcemap: !production, - format: "esm", - file: "./dist/bundle.mjs", - }, - plugins: [ - resolve({ - preferBuiltins: true, - browser: true, - }), - commonjs(), - globals(), - builtins(), - json(), - injectProcessEnv({ - NO_JS: process.env.NO_JS, - }), - production && terser(), - ], +const config = (format, outputFile) => ({ + input: "src/index.ts", + output: { + sourcemap: !production, + format, + file: outputFile, }, + plugins: [ + typescript(), + resolve({ + preferBuiltins: true, + browser: true, + }), + commonjs(), + globals(), + inject({ Buffer: ["buffer", "Buffer"] }), + builtins(), + json(), + injectProcessEnv({ + NO_JS: process.env.NO_JS, + }), + production && terser(), + ], +}) + +export default [ + config("cjs", "./dist/bundle.cjs"), + config("esm", "./dist/bundle.mjs"), ] diff --git a/packages/string-templates/scripts/gen-collection-info.js b/packages/string-templates/scripts/gen-collection-info.ts similarity index 95% rename from packages/string-templates/scripts/gen-collection-info.js rename to packages/string-templates/scripts/gen-collection-info.ts index ed57fe7fae..ae2a726661 100644 --- a/packages/string-templates/scripts/gen-collection-info.js +++ b/packages/string-templates/scripts/gen-collection-info.ts @@ -22,7 +22,7 @@ const COLLECTIONS = [ "object", "uuid", ] -const FILENAME = join(__dirname, "..", "manifest.json") +const FILENAME = join(__dirname, "..", "src", "manifest.json") const outputJSON = {} const ADDED_HELPERS = { date: { @@ -126,7 +126,7 @@ const excludeFunctions = { string: ["raw"] } * This script is very specific to purpose, parsing the handlebars-helpers files to attempt to get information about them. */ function run() { - const foundNames = [] + const foundNames: string[] = [] for (let collection of COLLECTIONS) { const collectionFile = fs.readFileSync( `${path.dirname(require.resolve(HELPER_LIBRARY))}/lib/${collection}.js`, @@ -147,7 +147,7 @@ function run() { } foundNames.push(name) // this is ridiculous, but it parse the function header - const fnc = entry[1].toString() + const fnc = entry[1]!.toString() const jsDocInfo = getCommentInfo(collectionFile, fnc) let args = jsDocInfo.tags .filter(tag => tag.title === "param") @@ -176,8 +176,8 @@ function run() { } // convert all markdown to HTML - for (let collection of Object.values(outputJSON)) { - for (let helper of Object.values(collection)) { + for (let collection of Object.values(outputJSON)) { + for (let helper of Object.values(collection)) { helper.description = marked.parse(helper.description) } } diff --git a/packages/string-templates/src/conversion/index.js b/packages/string-templates/src/conversion/index.ts similarity index 85% rename from packages/string-templates/src/conversion/index.js rename to packages/string-templates/src/conversion/index.ts index 10aaef0d2f..7eb5ea71af 100644 --- a/packages/string-templates/src/conversion/index.js +++ b/packages/string-templates/src/conversion/index.ts @@ -1,11 +1,11 @@ -const { getJsHelperList } = require("../helpers") +import { getJsHelperList } from "../helpers" -function getLayers(fullBlock) { +function getLayers(fullBlock: string): string[] { let layers = [] while (fullBlock.length) { const start = fullBlock.lastIndexOf("("), end = fullBlock.indexOf(")") - let layer + let layer: string if (start === -1 || end === -1) { layer = fullBlock.trim() fullBlock = "" @@ -21,7 +21,7 @@ function getLayers(fullBlock) { return layers } -function getVariable(variableName) { +function getVariable(variableName: string) { if (!variableName || typeof variableName !== "string") { return variableName } @@ -47,10 +47,12 @@ function getVariable(variableName) { return `$("${variableName}")` } -function buildList(parts, value) { +function buildList(parts: string[], value: any) { function build() { return parts - .map(part => (part.startsWith("helper") ? part : getVariable(part))) + .map((part: string) => + part.startsWith("helper") ? part : getVariable(part) + ) .join(", ") } if (!value) { @@ -60,12 +62,12 @@ function buildList(parts, value) { } } -function splitBySpace(layer) { - const parts = [] +function splitBySpace(layer: string) { + const parts: string[] = [] let started = null, endChar = null, last = 0 - function add(str) { + function add(str: string) { const startsWith = ["]"] while (startsWith.indexOf(str.substring(0, 1)) !== -1) { str = str.substring(1, str.length) @@ -103,7 +105,7 @@ function splitBySpace(layer) { return parts } -module.exports.convertHBSBlock = (block, blockNumber) => { +export function convertHBSBlock(block: string, blockNumber: number) { const braceLength = block[2] === "{" ? 3 : 2 block = block.substring(braceLength, block.length - braceLength).trim() const layers = getLayers(block) @@ -114,7 +116,7 @@ module.exports.convertHBSBlock = (block, blockNumber) => { const parts = splitBySpace(layer) if (value || parts.length > 1 || list[parts[0]]) { // first of layer should always be the helper - const helper = parts.splice(0, 1) + const [helper] = parts.splice(0, 1) if (list[helper]) { value = `helpers.${helper}(${buildList(parts, value)})` } diff --git a/packages/string-templates/src/errors.js b/packages/string-templates/src/errors.js deleted file mode 100644 index e0dcc3de1c..0000000000 --- a/packages/string-templates/src/errors.js +++ /dev/null @@ -1,11 +0,0 @@ -class JsErrorTimeout extends Error { - code = "ERR_SCRIPT_EXECUTION_TIMEOUT" - - constructor() { - super() - } -} - -module.exports = { - JsErrorTimeout, -} diff --git a/packages/string-templates/src/errors.ts b/packages/string-templates/src/errors.ts new file mode 100644 index 0000000000..79a8a525ef --- /dev/null +++ b/packages/string-templates/src/errors.ts @@ -0,0 +1,3 @@ +export class JsErrorTimeout extends Error { + code = "ERR_SCRIPT_EXECUTION_TIMEOUT" +} diff --git a/packages/string-templates/src/helpers/Helper.js b/packages/string-templates/src/helpers/Helper.js deleted file mode 100644 index d963c87158..0000000000 --- a/packages/string-templates/src/helpers/Helper.js +++ /dev/null @@ -1,29 +0,0 @@ -class Helper { - constructor(name, fn, useValueFallback = true) { - this.name = name - this.fn = fn - this.useValueFallback = useValueFallback - } - - register(handlebars) { - // wrap the function so that no helper can cause handlebars to break - handlebars.registerHelper(this.name, (value, info) => { - let context = {} - if (info && info.data && info.data.root) { - context = info.data.root - } - const result = this.fn(value, context) - if (result == null) { - return this.useValueFallback ? value : null - } else { - return result - } - }) - } - - unregister(handlebars) { - handlebars.unregisterHelper(this.name) - } -} - -module.exports = Helper diff --git a/packages/string-templates/src/helpers/Helper.ts b/packages/string-templates/src/helpers/Helper.ts new file mode 100644 index 0000000000..f6ee3bfd06 --- /dev/null +++ b/packages/string-templates/src/helpers/Helper.ts @@ -0,0 +1,36 @@ +import Handlebars from "handlebars" + +export default class Helper { + private name: any + private fn: any + private useValueFallback: boolean + + constructor(name: string, fn: any, useValueFallback = true) { + this.name = name + this.fn = fn + this.useValueFallback = useValueFallback + } + + register(handlebars: typeof Handlebars) { + // wrap the function so that no helper can cause handlebars to break + handlebars.registerHelper( + this.name, + (value: any, info: { data: { root: {} } }) => { + let context = {} + if (info && info.data && info.data.root) { + context = info.data.root + } + const result = this.fn(value, context) + if (result == null) { + return this.useValueFallback ? value : null + } else { + return result + } + } + ) + } + + unregister(handlebars: { unregisterHelper: any }) { + handlebars.unregisterHelper(this.name) + } +} diff --git a/packages/string-templates/src/helpers/constants.js b/packages/string-templates/src/helpers/constants.ts similarity index 66% rename from packages/string-templates/src/helpers/constants.js rename to packages/string-templates/src/helpers/constants.ts index 1f8cf7a59d..ffccd36ab0 100644 --- a/packages/string-templates/src/helpers/constants.js +++ b/packages/string-templates/src/helpers/constants.ts @@ -1,4 +1,4 @@ -module.exports.HelperFunctionBuiltin = [ +export const HelperFunctionBuiltin = [ "#if", "#unless", "#each", @@ -15,11 +15,11 @@ module.exports.HelperFunctionBuiltin = [ "with", ] -module.exports.HelperFunctionNames = { +export const HelperFunctionNames = { OBJECT: "object", ALL: "all", LITERAL: "literal", JS: "js", } -module.exports.LITERAL_MARKER = "%LITERAL%" +export const LITERAL_MARKER = "%LITERAL%" diff --git a/packages/string-templates/src/helpers/date.js b/packages/string-templates/src/helpers/date.ts similarity index 72% rename from packages/string-templates/src/helpers/date.js rename to packages/string-templates/src/helpers/date.ts index 6fe8b288d6..589cb3d978 100644 --- a/packages/string-templates/src/helpers/date.js +++ b/packages/string-templates/src/helpers/date.ts @@ -1,12 +1,22 @@ -const dayjs = require("dayjs") -dayjs.extend(require("dayjs/plugin/duration")) -dayjs.extend(require("dayjs/plugin/advancedFormat")) -dayjs.extend(require("dayjs/plugin/isoWeek")) -dayjs.extend(require("dayjs/plugin/weekYear")) -dayjs.extend(require("dayjs/plugin/weekOfYear")) -dayjs.extend(require("dayjs/plugin/relativeTime")) -dayjs.extend(require("dayjs/plugin/utc")) -dayjs.extend(require("dayjs/plugin/timezone")) +import dayjs from "dayjs" + +import dayjsDurationPlugin from "dayjs/plugin/duration" +import dayjsAdvancedFormatPlugin from "dayjs/plugin/advancedFormat" +import dayjsIsoWeekPlugin from "dayjs/plugin/isoWeek" +import dayjsWeekYearPlugin from "dayjs/plugin/weekYear" +import dayjsWeekOfYearPlugin from "dayjs/plugin/weekOfYear" +import dayjsRelativeTimePlugin from "dayjs/plugin/relativeTime" +import dayjsUtcPlugin from "dayjs/plugin/utc" +import dayjsTimezonePlugin from "dayjs/plugin/timezone" + +dayjs.extend(dayjsDurationPlugin) +dayjs.extend(dayjsAdvancedFormatPlugin) +dayjs.extend(dayjsIsoWeekPlugin) +dayjs.extend(dayjsWeekYearPlugin) +dayjs.extend(dayjsWeekOfYearPlugin) +dayjs.extend(dayjsRelativeTimePlugin) +dayjs.extend(dayjsUtcPlugin) +dayjs.extend(dayjsTimezonePlugin) /** * This file was largely taken from the helper-date package - we did this for two reasons: @@ -17,11 +27,11 @@ dayjs.extend(require("dayjs/plugin/timezone")) * https://github.com/helpers/helper-date */ -function isOptions(val) { +function isOptions(val: any) { return typeof val === "object" && typeof val.hash === "object" } -function isApp(thisArg) { +function isApp(thisArg: any) { return ( typeof thisArg === "object" && typeof thisArg.options === "object" && @@ -29,7 +39,7 @@ function isApp(thisArg) { ) } -function getContext(thisArg, locals, options) { +function getContext(thisArg: any, locals: any, options: any) { if (isOptions(thisArg)) { return getContext({}, locals, thisArg) } @@ -58,7 +68,7 @@ function getContext(thisArg, locals, options) { return context } -function initialConfig(str, pattern, options) { +function initialConfig(str: any, pattern: any, options?: any) { if (isOptions(pattern)) { options = pattern pattern = null @@ -72,7 +82,7 @@ function initialConfig(str, pattern, options) { return { str, pattern, options } } -function setLocale(str, pattern, options) { +function setLocale(this: any, str: any, pattern: any, options?: any) { // if options is null then it'll get updated here const config = initialConfig(str, pattern, options) const defaults = { lang: "en", date: new Date(config.str) } @@ -83,7 +93,7 @@ function setLocale(str, pattern, options) { dayjs.locale(opts.lang || opts.language) } -module.exports.date = (str, pattern, options) => { +export const date = (str: any, pattern: any, options: any) => { const config = initialConfig(str, pattern, options) // if no args are passed, return a formatted date @@ -109,7 +119,7 @@ module.exports.date = (str, pattern, options) => { return date.format(config.pattern) } -module.exports.duration = (str, pattern, format) => { +export const duration = (str: any, pattern: any, format: any) => { const config = initialConfig(str, pattern) setLocale(config.str, config.pattern) diff --git a/packages/string-templates/src/helpers/external.js b/packages/string-templates/src/helpers/external.ts similarity index 65% rename from packages/string-templates/src/helpers/external.js rename to packages/string-templates/src/helpers/external.ts index 2487fd91df..36d5ac0f54 100644 --- a/packages/string-templates/src/helpers/external.js +++ b/packages/string-templates/src/helpers/external.ts @@ -1,6 +1,9 @@ -const helpers = require("@budibase/handlebars-helpers") -const { date, duration } = require("./date") -const { HelperFunctionBuiltin } = require("./constants") +// @ts-ignore we don't have types for it +import helpers from "@budibase/handlebars-helpers" + +import { date, duration } from "./date" +import { HelperFunctionBuiltin } from "./constants" +import Handlebars from "handlebars" /** * full list of supported helpers can be found here: @@ -24,10 +27,10 @@ const ADDED_HELPERS = { duration: duration, } -exports.externalCollections = EXTERNAL_FUNCTION_COLLECTIONS -exports.addedHelpers = ADDED_HELPERS +export const externalCollections = EXTERNAL_FUNCTION_COLLECTIONS +export const addedHelpers = ADDED_HELPERS -exports.registerAll = handlebars => { +export function registerAll(handlebars: typeof Handlebars) { for (let [name, helper] of Object.entries(ADDED_HELPERS)) { handlebars.registerHelper(name, helper) } @@ -52,17 +55,17 @@ exports.registerAll = handlebars => { }) } // add date external functionality - exports.externalHelperNames = externalNames.concat(Object.keys(ADDED_HELPERS)) + externalHelperNames = externalNames.concat(Object.keys(ADDED_HELPERS)) } -exports.unregisterAll = handlebars => { +export function unregisterAll(handlebars: typeof Handlebars) { for (let name of Object.keys(ADDED_HELPERS)) { handlebars.unregisterHelper(name) } - for (let name of module.exports.externalHelperNames) { + for (let name of externalHelperNames) { handlebars.unregisterHelper(name) } - exports.externalHelperNames = [] + externalHelperNames = [] } -exports.externalHelperNames = [] +export let externalHelperNames: any[] = [] diff --git a/packages/string-templates/src/helpers/index.js b/packages/string-templates/src/helpers/index.js deleted file mode 100644 index 5e6dcbd2b9..0000000000 --- a/packages/string-templates/src/helpers/index.js +++ /dev/null @@ -1,100 +0,0 @@ -const Helper = require("./Helper") -const { SafeString } = require("handlebars") -const externalHandlebars = require("./external") -const { processJS } = require("./javascript") -const { - HelperFunctionNames, - HelperFunctionBuiltin, - LITERAL_MARKER, -} = require("./constants") -const { getJsHelperList } = require("./list") - -const HTML_SWAPS = { - "<": "<", - ">": ">", -} - -function isObject(value) { - if (value == null || typeof value !== "object") { - return false - } - return ( - value.toString() === "[object Object]" || - (value.length > 0 && typeof value[0] === "object") - ) -} - -const HELPERS = [ - // external helpers - new Helper(HelperFunctionNames.OBJECT, value => { - return new SafeString(JSON.stringify(value)) - }), - // javascript helper - new Helper(HelperFunctionNames.JS, processJS, false), - // this help is applied to all statements - new Helper(HelperFunctionNames.ALL, (value, inputs) => { - const { __opts } = inputs - if (isObject(value)) { - return new SafeString(JSON.stringify(value)) - } - // null/undefined values produce bad results - if (__opts && __opts.onlyFound && value == null) { - return __opts.input - } - if (value == null || typeof value !== "string") { - return value == null ? "" : value - } - if (value && value.string) { - value = value.string - } - let text = value - if (__opts && __opts.escapeNewlines) { - text = value.replace(/\n/g, "\\n") - } - text = new SafeString(text.replace(/&/g, "&")) - if (text == null || typeof text !== "string") { - return text - } - return text.replace(/[<>]/g, tag => { - return HTML_SWAPS[tag] || tag - }) - }), - // adds a note for post-processor - new Helper(HelperFunctionNames.LITERAL, value => { - if (value === undefined) { - return "" - } - const type = typeof value - const outputVal = type === "object" ? JSON.stringify(value) : value - return `{{${LITERAL_MARKER} ${type}-${outputVal}}}` - }), -] - -module.exports.HelperNames = () => { - return Object.values(HelperFunctionNames).concat( - HelperFunctionBuiltin, - externalHandlebars.externalHelperNames - ) -} - -module.exports.registerMinimum = handlebars => { - for (let helper of HELPERS) { - helper.register(handlebars) - } -} - -module.exports.registerAll = handlebars => { - module.exports.registerMinimum(handlebars) - // register imported helpers - externalHandlebars.registerAll(handlebars) -} - -module.exports.unregisterAll = handlebars => { - for (let helper of HELPERS) { - helper.unregister(handlebars) - } - // unregister all imported helpers - externalHandlebars.unregisterAll(handlebars) -} - -module.exports.getJsHelperList = getJsHelperList diff --git a/packages/string-templates/src/helpers/index.ts b/packages/string-templates/src/helpers/index.ts new file mode 100644 index 0000000000..fe74a6d711 --- /dev/null +++ b/packages/string-templates/src/helpers/index.ts @@ -0,0 +1,103 @@ +import Helper from "./Helper" +import Handlebars from "handlebars" +import * as externalHandlebars from "./external" +import { processJS } from "./javascript" +import { + HelperFunctionNames, + HelperFunctionBuiltin, + LITERAL_MARKER, +} from "./constants" + +export { getJsHelperList } from "./list" + +const HTML_SWAPS = { + "<": "<", + ">": ">", +} + +function isObject(value: string | any[]) { + if (value == null || typeof value !== "object") { + return false + } + return ( + value.toString() === "[object Object]" || + (value.length > 0 && typeof value[0] === "object") + ) +} + +const HELPERS = [ + // external helpers + new Helper(HelperFunctionNames.OBJECT, (value: any) => { + return new Handlebars.SafeString(JSON.stringify(value)) + }), + // javascript helper + new Helper(HelperFunctionNames.JS, processJS, false), + // this help is applied to all statements + new Helper( + HelperFunctionNames.ALL, + (value: string, inputs: { __opts: any }) => { + const { __opts } = inputs + if (isObject(value)) { + return new Handlebars.SafeString(JSON.stringify(value)) + } + // null/undefined values produce bad results + if (__opts && __opts.onlyFound && value == null) { + return __opts.input + } + if (value == null || typeof value !== "string") { + return value == null ? "" : value + } + // TODO: check, this should always be false + if (value && (value as any).string) { + value = (value as any).string + } + let text: any = value + if (__opts && __opts.escapeNewlines) { + text = value.replace(/\n/g, "\\n") + } + text = new Handlebars.SafeString(text.replace(/&/g, "&")) + if (text == null || typeof text !== "string") { + return text + } + return text.replace(/[<>]/g, (tag: string) => { + return HTML_SWAPS[tag as keyof typeof HTML_SWAPS] || tag + }) + } + ), + // adds a note for post-processor + new Helper(HelperFunctionNames.LITERAL, (value: any) => { + if (value === undefined) { + return "" + } + const type = typeof value + const outputVal = type === "object" ? JSON.stringify(value) : value + return `{{${LITERAL_MARKER} ${type}-${outputVal}}}` + }), +] + +export function HelperNames() { + return Object.values(HelperFunctionNames).concat( + HelperFunctionBuiltin, + externalHandlebars.externalHelperNames + ) +} + +export function registerMinimum(handlebars: typeof Handlebars) { + for (let helper of HELPERS) { + helper.register(handlebars) + } +} + +export function registerAll(handlebars: typeof Handlebars) { + registerMinimum(handlebars) + // register imported helpers + externalHandlebars.registerAll(handlebars) +} + +export function unregisterAll(handlebars: any) { + for (let helper of HELPERS) { + helper.unregister(handlebars) + } + // unregister all imported helpers + externalHandlebars.unregisterAll(handlebars) +} diff --git a/packages/string-templates/src/helpers/javascript.js b/packages/string-templates/src/helpers/javascript.ts similarity index 51% rename from packages/string-templates/src/helpers/javascript.js rename to packages/string-templates/src/helpers/javascript.ts index 7827736812..931cc46dc7 100644 --- a/packages/string-templates/src/helpers/javascript.js +++ b/packages/string-templates/src/helpers/javascript.ts @@ -1,21 +1,24 @@ -const { atob, isBackendService, isJSAllowed } = require("../utilities") -const cloneDeep = require("lodash.clonedeep") -const { LITERAL_MARKER } = require("../helpers/constants") -const { getJsHelperList } = require("./list") +import { atob, isJSAllowed } from "../utilities" +import cloneDeep from "lodash/fp/cloneDeep" +import { LITERAL_MARKER } from "../helpers/constants" +import { getJsHelperList } from "./list" +import { iifeWrapper } from "../iife" // The method of executing JS scripts depends on the bundle being built. // This setter is used in the entrypoint (either index.js or index.mjs). -let runJS -module.exports.setJSRunner = runner => (runJS = runner) -module.exports.removeJSRunner = () => { +let runJS: ((js: string, context: any) => any) | undefined = undefined +export const setJSRunner = (runner: typeof runJS) => (runJS = runner) + +export const removeJSRunner = () => { runJS = undefined } -let onErrorLog -module.exports.setOnErrorLog = delegate => (onErrorLog = delegate) +let onErrorLog: (message: Error) => void +export const setOnErrorLog = (delegate: typeof onErrorLog) => + (onErrorLog = delegate) // Helper utility to strip square brackets from a value -const removeSquareBrackets = value => { +const removeSquareBrackets = (value: string) => { if (!value || typeof value !== "string") { return value } @@ -29,7 +32,7 @@ const removeSquareBrackets = value => { // Our context getter function provided to JS code as $. // Extracts a value from context. -const getContextValue = (path, context) => { +const getContextValue = (path: string, context: any) => { let data = context path.split(".").forEach(key => { if (data == null || typeof data !== "object") { @@ -41,27 +44,49 @@ const getContextValue = (path, context) => { } // Evaluates JS code against a certain context -module.exports.processJS = (handlebars, context) => { - if (!isJSAllowed() || (isBackendService() && !runJS)) { +export function processJS(handlebars: string, context: any) { + if (!isJSAllowed() || !runJS) { throw new Error("JS disabled in environment.") } try { // Wrap JS in a function and immediately invoke it. // This is required to allow the final `return` statement to be valid. - const js = `(function(){${atob(handlebars)}})();` + const js = iifeWrapper(atob(handlebars)) + + // Transform snippets into an object for faster access, and cache previously + // evaluated snippets + let snippetMap: any = {} + let snippetCache: any = {} + for (let snippet of context.snippets || []) { + snippetMap[snippet.name] = snippet.code + } // Our $ context function gets a value from context. // We clone the context to avoid mutation in the binding affecting real // app context. + const clonedContext = cloneDeep({ ...context, snippets: null }) const sandboxContext = { - $: path => getContextValue(path, cloneDeep(context)), + $: (path: string) => getContextValue(path, clonedContext), helpers: getJsHelperList(), + + // Proxy to evaluate snippets when running in the browser + snippets: new Proxy( + {}, + { + get: function (_, name) { + if (!(name in snippetCache)) { + snippetCache[name] = eval(iifeWrapper(snippetMap[name])) + } + return snippetCache[name] + }, + } + ), } // Create a sandbox with our context and run the JS const res = { data: runJS(js, sandboxContext) } return `{{${LITERAL_MARKER} js_result-${JSON.stringify(res)}}}` - } catch (error) { + } catch (error: any) { onErrorLog && onErrorLog(error) if (error.code === "ERR_SCRIPT_EXECUTION_TIMEOUT") { diff --git a/packages/string-templates/src/helpers/list.js b/packages/string-templates/src/helpers/list.js deleted file mode 100644 index 883ab5678e..0000000000 --- a/packages/string-templates/src/helpers/list.js +++ /dev/null @@ -1,47 +0,0 @@ -const { date, duration } = require("./date") - -// https://github.com/evanw/esbuild/issues/56 -const externalCollections = { - math: require("@budibase/handlebars-helpers/lib/math"), - array: require("@budibase/handlebars-helpers/lib/array"), - number: require("@budibase/handlebars-helpers/lib/number"), - url: require("@budibase/handlebars-helpers/lib/url"), - string: require("@budibase/handlebars-helpers/lib/string"), - comparison: require("@budibase/handlebars-helpers/lib/comparison"), - object: require("@budibase/handlebars-helpers/lib/object"), - regex: require("@budibase/handlebars-helpers/lib/regex"), - uuid: require("@budibase/handlebars-helpers/lib/uuid"), -} - -const helpersToRemoveForJs = ["sortBy"] -module.exports.helpersToRemoveForJs = helpersToRemoveForJs - -const addedHelpers = { - date: date, - duration: duration, -} - -let helpers = undefined - -module.exports.getJsHelperList = () => { - if (helpers) { - return helpers - } - - helpers = {} - for (let collection of Object.values(externalCollections)) { - for (let [key, func] of Object.entries(collection)) { - // Handlebars injects the hbs options to the helpers by default. We are adding an empty {} as a last parameter to simulate it - helpers[key] = (...props) => func(...props, {}) - } - } - for (let key of Object.keys(addedHelpers)) { - helpers[key] = addedHelpers[key] - } - - for (const toRemove of helpersToRemoveForJs) { - delete helpers[toRemove] - } - Object.freeze(helpers) - return helpers -} diff --git a/packages/string-templates/src/helpers/list.ts b/packages/string-templates/src/helpers/list.ts new file mode 100644 index 0000000000..a7d6a502e7 --- /dev/null +++ b/packages/string-templates/src/helpers/list.ts @@ -0,0 +1,72 @@ +import { date, duration } from "./date" + +/* +@budibase/handlebars-helpers is not treeshakeable, so we can't use the barrel files. +Otherwise, we have issues when generating the isolated-vm bundle because of the treeshaking +*/ +/* eslint-disable local-rules/no-budibase-imports */ +// @ts-expect-error +import math from "@budibase/handlebars-helpers/lib/math" +// @ts-expect-error +import array from "@budibase/handlebars-helpers/lib/array" +// @ts-expect-error +import number from "@budibase/handlebars-helpers/lib/number" +// @ts-expect-error +import url from "@budibase/handlebars-helpers/lib/url" +// @ts-expect-error +import string from "@budibase/handlebars-helpers/lib/string" +// @ts-expect-error +import comparison from "@budibase/handlebars-helpers/lib/comparison" +// @ts-expect-error +import object from "@budibase/handlebars-helpers/lib/object" +// @ts-expect-error +import regex from "@budibase/handlebars-helpers/lib/regex" +// @ts-expect-error +import uuid from "@budibase/handlebars-helpers/lib/uuid" +/* eslint-enable local-rules/no-budibase-imports */ + +// https://github.com/evanw/esbuild/issues/56 +const externalCollections = { + math, + array, + number, + url, + string, + comparison, + object, + regex, + uuid, +} + +export const helpersToRemoveForJs = ["sortBy"] + +const addedHelpers = { + date: date, + duration: duration, +} + +let helpers: Record + +export function getJsHelperList() { + if (helpers) { + return helpers + } + + helpers = {} + for (let collection of Object.values(externalCollections)) { + for (let [key, func] of Object.entries(collection)) { + // Handlebars injects the hbs options to the helpers by default. We are adding an empty {} as a last parameter to simulate it + helpers[key] = (...props: any) => func(...props, {}) + } + } + helpers = { + ...helpers, + ...addedHelpers, + } + + for (const toRemove of helpersToRemoveForJs) { + delete helpers[toRemove] + } + Object.freeze(helpers) + return helpers +} diff --git a/packages/string-templates/src/iife.ts b/packages/string-templates/src/iife.ts new file mode 100644 index 0000000000..0ce3ad8f8e --- /dev/null +++ b/packages/string-templates/src/iife.ts @@ -0,0 +1,3 @@ +export const iifeWrapper = (script: string) => { + return `(function(){\n${script}\n})();` +} diff --git a/packages/string-templates/src/index.mjs b/packages/string-templates/src/index.mjs deleted file mode 100644 index f54ca7e23e..0000000000 --- a/packages/string-templates/src/index.mjs +++ /dev/null @@ -1,26 +0,0 @@ -import templates from "./index.js" - -/** - * ES6 entrypoint for rollup - */ -export const isValid = templates.isValid -export const makePropSafe = templates.makePropSafe -export const getManifest = templates.getManifest -export const isJSBinding = templates.isJSBinding -export const encodeJSBinding = templates.encodeJSBinding -export const decodeJSBinding = templates.decodeJSBinding -export const processStringSync = templates.processStringSync -export const processObjectSync = templates.processObjectSync -export const processString = templates.processString -export const processObject = templates.processObject -export const doesContainStrings = templates.doesContainStrings -export const doesContainString = templates.doesContainString -export const disableEscaping = templates.disableEscaping -export const findHBSBlocks = templates.findHBSBlocks -export const convertToJS = templates.convertToJS -export const setJSRunner = templates.setJSRunner -export const setOnErrorLog = templates.setOnErrorLog -export const FIND_ANY_HBS_REGEX = templates.FIND_ANY_HBS_REGEX -export const helpersToRemoveForJs = templates.helpersToRemoveForJs - -export * from "./errors.js" diff --git a/packages/string-templates/src/index.js b/packages/string-templates/src/index.ts similarity index 73% rename from packages/string-templates/src/index.js rename to packages/string-templates/src/index.ts index 0125b9e0ab..1ac91edd28 100644 --- a/packages/string-templates/src/index.js +++ b/packages/string-templates/src/index.ts @@ -1,23 +1,30 @@ -const vm = require("vm") -const handlebars = require("handlebars") -const { registerAll, registerMinimum } = require("./helpers/index") -const processors = require("./processors") -const { atob, btoa, isBackendService } = require("./utilities") -const manifest = require("../manifest.json") -const { +import { Context, createContext, runInNewContext } from "vm" +import { create, TemplateDelegate } from "handlebars" +import { registerAll, registerMinimum } from "./helpers/index" +import { preprocess, postprocess } from "./processors" +import { + atob, + btoa, + isBackendService, FIND_HBS_REGEX, FIND_ANY_HBS_REGEX, findDoubleHbsInstances, -} = require("./utilities") -const { convertHBSBlock } = require("./conversion") -const javascript = require("./helpers/javascript") -const { helpersToRemoveForJs } = require("./helpers/list") +} from "./utilities" +import { convertHBSBlock } from "./conversion" +import { setJSRunner, removeJSRunner } from "./helpers/javascript" +import { helpersToRemoveForJs } from "./helpers/list" -const hbsInstance = handlebars.create() +import manifest from "./manifest.json" +import { ProcessOptions } from "./types" + +export { setJSRunner, setOnErrorLog } from "./helpers/javascript" +export { iifeWrapper } from "./iife" + +const hbsInstance = create() registerAll(hbsInstance) -const hbsInstanceNoHelpers = handlebars.create() +const hbsInstanceNoHelpers = create() registerMinimum(hbsInstanceNoHelpers) -const defaultOpts = { +const defaultOpts: ProcessOptions = { noHelpers: false, cacheTemplates: false, noEscaping: false, @@ -28,7 +35,7 @@ const defaultOpts = { /** * Utility function to check if the object is valid. */ -function testObject(object) { +function testObject(object: any) { // JSON stringify will fail if there are any cycles, stops infinite recursion try { JSON.stringify(object) @@ -40,8 +47,8 @@ function testObject(object) { /** * Creates a HBS template function for a given string, and optionally caches it. */ -let templateCache = {} -function createTemplate(string, opts) { +const templateCache: Record> = {} +function createTemplate(string: string, opts?: ProcessOptions) { opts = { ...defaultOpts, ...opts } // Finalising adds a helper, can't do this with no helpers @@ -52,11 +59,11 @@ function createTemplate(string, opts) { return templateCache[key] } - string = processors.preprocess(string, opts) + string = preprocess(string, opts) // Optionally disable built in HBS escaping if (opts.noEscaping) { - string = exports.disableEscaping(string) + string = disableEscaping(string) } // This does not throw an error when template can't be fulfilled, @@ -77,24 +84,25 @@ function createTemplate(string, opts) { * @param {object|undefined} [opts] optional - specify some options for processing. * @returns {Promise} The structure input, as fully updated as possible. */ -module.exports.processObject = async (object, context, opts) => { +export async function processObject>( + object: T, + context: object, + opts?: { noHelpers?: boolean; escapeNewlines?: boolean; onlyFound?: boolean } +): Promise { testObject(object) - for (let key of Object.keys(object || {})) { + + for (const key of Object.keys(object || {})) { if (object[key] != null) { - let val = object[key] + const val = object[key] + let parsedValue = val if (typeof val === "string") { - object[key] = await module.exports.processString( - object[key], - context, - opts - ) + parsedValue = await processString(object[key], context, opts) } else if (typeof val === "object") { - object[key] = await module.exports.processObject( - object[key], - context, - opts - ) + parsedValue = await processObject(object[key], context, opts) } + + // @ts-ignore + object[key] = parsedValue } } return object @@ -108,9 +116,13 @@ module.exports.processObject = async (object, context, opts) => { * @param {object|undefined} [opts] optional - specify some options for processing. * @returns {Promise} The enriched string, all templates should have been replaced if they can be. */ -module.exports.processString = async (string, context, opts) => { +export async function processString( + string: string, + context: object, + opts?: ProcessOptions +): Promise { // TODO: carry out any async calls before carrying out async call - return module.exports.processStringSync(string, context, opts) + return processStringSync(string, context, opts) } /** @@ -122,14 +134,18 @@ module.exports.processString = async (string, context, opts) => { * @param {object|undefined} [opts] optional - specify some options for processing. * @returns {object|array} The structure input, as fully updated as possible. */ -module.exports.processObjectSync = (object, context, opts) => { +export function processObjectSync( + object: { [x: string]: any }, + context: any, + opts: any +): object | Array { testObject(object) for (let key of Object.keys(object || {})) { let val = object[key] if (typeof val === "string") { - object[key] = module.exports.processStringSync(object[key], context, opts) + object[key] = processStringSync(object[key], context, opts) } else if (typeof val === "object") { - object[key] = module.exports.processObjectSync(object[key], context, opts) + object[key] = processObjectSync(object[key], context, opts) } } return object @@ -143,29 +159,32 @@ module.exports.processObjectSync = (object, context, opts) => { * @param {object|undefined} [opts] optional - specify some options for processing. * @returns {string} The enriched string, all templates should have been replaced if they can be. */ -module.exports.processStringSync = (string, context, opts) => { +export function processStringSync( + string: string, + context?: object, + opts?: ProcessOptions +): string { // Take a copy of input in case of error const input = string if (typeof string !== "string") { throw "Cannot process non-string types." } - function process(stringPart) { + function process(stringPart: string) { const template = createTemplate(stringPart, opts) const now = Math.floor(Date.now() / 1000) * 1000 - return processors.postprocess( - template({ - now: new Date(now).toISOString(), - __opts: { - ...opts, - input: stringPart, - }, - ...context, - }) - ) + const processedString = template({ + now: new Date(now).toISOString(), + __opts: { + ...opts, + input: stringPart, + }, + ...context, + }) + return postprocess(processedString) } try { if (opts && opts.onlyFound) { - const blocks = exports.findHBSBlocks(string) + const blocks = findHBSBlocks(string) for (let block of blocks) { const outcome = process(block) string = string.replace(block, outcome) @@ -185,7 +204,7 @@ module.exports.processStringSync = (string, context, opts) => { * this function will find any double braces and switch to triple. * @param string the string to have double HBS statements converted to triple. */ -module.exports.disableEscaping = string => { +export function disableEscaping(string: string) { const matches = findDoubleHbsInstances(string) if (matches == null) { return string @@ -206,7 +225,7 @@ module.exports.disableEscaping = string => { * @param {string} property The property which is to be wrapped. * @returns {string} The wrapped property ready to be added to a templating string. */ -module.exports.makePropSafe = property => { +export function makePropSafe(property: any): string { return `[${property}]`.replace("[[", "[").replace("]]", "]") } @@ -216,7 +235,7 @@ module.exports.makePropSafe = property => { * @param [opts] optional - specify some options for processing. * @returns {boolean} Whether or not the input string is valid. */ -module.exports.isValid = (string, opts) => { +export function isValid(string: any, opts?: any): boolean { const validCases = [ "string", "number", @@ -237,7 +256,7 @@ module.exports.isValid = (string, opts) => { }) template(context) return true - } catch (err) { + } catch (err: any) { const msg = err && err.message ? err.message : err if (!msg) { return false @@ -258,7 +277,7 @@ module.exports.isValid = (string, opts) => { * This manifest provides information about each of the helpers and how it can be used. * @returns The manifest JSON which has been generated from the helpers. */ -module.exports.getManifest = () => { +export function getManifest() { return manifest } @@ -267,8 +286,8 @@ module.exports.getManifest = () => { * @param handlebars the HBS expression to check * @returns {boolean} whether the expression is JS or not */ -module.exports.isJSBinding = handlebars => { - return module.exports.decodeJSBinding(handlebars) != null +export function isJSBinding(handlebars: any): boolean { + return decodeJSBinding(handlebars) != null } /** @@ -276,7 +295,7 @@ module.exports.isJSBinding = handlebars => { * @param javascript the JS code to encode * @returns {string} the JS HBS expression */ -module.exports.encodeJSBinding = javascript => { +export function encodeJSBinding(javascript: string): string { return `{{ js "${btoa(javascript)}" }}` } @@ -285,7 +304,7 @@ module.exports.encodeJSBinding = javascript => { * @param handlebars the JS HBS expression * @returns {string|null} the raw JS code */ -module.exports.decodeJSBinding = handlebars => { +export function decodeJSBinding(handlebars: string): string | null { if (!handlebars || typeof handlebars !== "string") { return null } @@ -310,7 +329,7 @@ module.exports.decodeJSBinding = handlebars => { * @param {string[]} strings The strings to look for. * @returns {boolean} Will return true if all strings found in HBS statement. */ -module.exports.doesContainStrings = (template, strings) => { +export function doesContainStrings(template: string, strings: any[]): boolean { let regexp = new RegExp(FIND_HBS_REGEX) let matches = template.match(regexp) if (matches == null) { @@ -318,8 +337,8 @@ module.exports.doesContainStrings = (template, strings) => { } for (let match of matches) { let hbs = match - if (exports.isJSBinding(match)) { - hbs = exports.decodeJSBinding(match) + if (isJSBinding(match)) { + hbs = decodeJSBinding(match)! } let allFound = true for (let string of strings) { @@ -340,7 +359,7 @@ module.exports.doesContainStrings = (template, strings) => { * @param {string} string The string to search within. * @return {string[]} The found HBS blocks. */ -module.exports.findHBSBlocks = string => { +export function findHBSBlocks(string: string): string[] { if (!string || typeof string !== "string") { return [] } @@ -361,18 +380,15 @@ module.exports.findHBSBlocks = string => { * @param {string} string The word or sentence to search for. * @returns {boolean} The this return true if the string is found, false if not. */ -module.exports.doesContainString = (template, string) => { - return exports.doesContainStrings(template, [string]) +export function doesContainString(template: any, string: any): boolean { + return doesContainStrings(template, [string]) } -module.exports.setJSRunner = javascript.setJSRunner -module.exports.setOnErrorLog = javascript.setOnErrorLog - -module.exports.convertToJS = hbs => { - const blocks = exports.findHBSBlocks(hbs) +export function convertToJS(hbs: string) { + const blocks = findHBSBlocks(hbs) let js = "return `", - prevBlock = null - const variables = {} + prevBlock: string | null = null + const variables: Record = {} if (blocks.length === 0) { js += hbs } @@ -386,7 +402,7 @@ module.exports.convertToJS = hbs => { prevBlock = block const { variable, value } = convertHBSBlock(block, count++) variables[variable] = value - js += `${stringPart.split()}\${${variable}}` + js += `${[stringPart]}\${${variable}}` } let varBlock = "" for (let [variable, value] of Object.entries(variables)) { @@ -396,33 +412,34 @@ module.exports.convertToJS = hbs => { return `${varBlock}${js}` } -module.exports.FIND_ANY_HBS_REGEX = FIND_ANY_HBS_REGEX +const _FIND_ANY_HBS_REGEX = FIND_ANY_HBS_REGEX +export { _FIND_ANY_HBS_REGEX as FIND_ANY_HBS_REGEX } -const errors = require("./errors") -// We cannot use dynamic exports, otherwise the typescript file will not be generating it -module.exports.JsErrorTimeout = errors.JsErrorTimeout +export { JsErrorTimeout } from "./errors" -module.exports.helpersToRemoveForJs = helpersToRemoveForJs +const _helpersToRemoveForJs = helpersToRemoveForJs +export { _helpersToRemoveForJs as helpersToRemoveForJs } function defaultJSSetup() { if (!isBackendService()) { /** * Use polyfilled vm to run JS scripts in a browser Env */ - javascript.setJSRunner((js, context) => { + setJSRunner((js: string, context: Context) => { context = { ...context, alert: undefined, setInterval: undefined, setTimeout: undefined, } - vm.createContext(context) - return vm.runInNewContext(js, context, { timeout: 1000 }) + createContext(context) + return runInNewContext(js, context, { timeout: 1000 }) }) } else { - javascript.removeJSRunner() + removeJSRunner() } } defaultJSSetup() -module.exports.defaultJSSetup = defaultJSSetup +const _defaultJSSetup = defaultJSSetup +export { _defaultJSSetup as defaultJSSetup } diff --git a/packages/string-templates/manifest.json b/packages/string-templates/src/manifest.json similarity index 100% rename from packages/string-templates/manifest.json rename to packages/string-templates/src/manifest.json diff --git a/packages/string-templates/src/processors/index.js b/packages/string-templates/src/processors/index.ts similarity index 67% rename from packages/string-templates/src/processors/index.js rename to packages/string-templates/src/processors/index.ts index aae18aed8b..308ac5adf4 100644 --- a/packages/string-templates/src/processors/index.js +++ b/packages/string-templates/src/processors/index.ts @@ -1,8 +1,9 @@ -const { FIND_HBS_REGEX } = require("../utilities") -const preprocessor = require("./preprocessor") -const postprocessor = require("./postprocessor") +import { FIND_HBS_REGEX } from "../utilities" +import * as preprocessor from "./preprocessor" +import * as postprocessor from "./postprocessor" +import { ProcessOptions } from "../types" -function process(output, processors, opts) { +function process(output: string, processors: any[], opts?: ProcessOptions) { for (let processor of processors) { // if a literal statement has occurred stop if (typeof output !== "string") { @@ -21,7 +22,7 @@ function process(output, processors, opts) { return output } -module.exports.preprocess = (string, opts) => { +export function preprocess(string: string, opts: ProcessOptions) { let processors = preprocessor.processors if (opts.noFinalise) { processors = processors.filter( @@ -30,7 +31,7 @@ module.exports.preprocess = (string, opts) => { } return process(string, processors, opts) } -module.exports.postprocess = string => { +export function postprocess(string: string) { let processors = postprocessor.processors return process(string, processors) } diff --git a/packages/string-templates/src/processors/postprocessor.js b/packages/string-templates/src/processors/postprocessor.js deleted file mode 100644 index f78a572d07..0000000000 --- a/packages/string-templates/src/processors/postprocessor.js +++ /dev/null @@ -1,49 +0,0 @@ -const { LITERAL_MARKER } = require("../helpers/constants") - -const PostProcessorNames = { - CONVERT_LITERALS: "convert-literals", -} - -/* eslint-disable no-unused-vars */ -class Postprocessor { - constructor(name, fn) { - this.name = name - this.fn = fn - } - - process(statement) { - return this.fn(statement) - } -} - -module.exports.PostProcessorNames = PostProcessorNames - -module.exports.processors = [ - new Postprocessor(PostProcessorNames.CONVERT_LITERALS, statement => { - if (typeof statement !== "string" || !statement.includes(LITERAL_MARKER)) { - return statement - } - const splitMarkerIndex = statement.indexOf("-") - const type = statement.substring(12, splitMarkerIndex) - const value = statement.substring( - splitMarkerIndex + 1, - statement.length - 2 - ) - switch (type) { - case "string": - return value - case "number": - return parseFloat(value) - case "boolean": - return value === "true" - case "object": - return JSON.parse(value) - case "js_result": - // We use the literal helper to process the result of JS expressions - // as we want to be able to return any types. - // We wrap the value in an abject to be able to use undefined properly. - return JSON.parse(value).data - } - return value - }), -] diff --git a/packages/string-templates/src/processors/postprocessor.ts b/packages/string-templates/src/processors/postprocessor.ts new file mode 100644 index 0000000000..6f7260718b --- /dev/null +++ b/packages/string-templates/src/processors/postprocessor.ts @@ -0,0 +1,56 @@ +import { LITERAL_MARKER } from "../helpers/constants" + +export const PostProcessorNames = { + CONVERT_LITERALS: "convert-literals", +} + +/* eslint-disable no-unused-vars */ +class Postprocessor { + name: string + private fn: any + + constructor(name: string, fn: any) { + this.name = name + this.fn = fn + } + + process(statement: any) { + return this.fn(statement) + } +} + +export const processors = [ + new Postprocessor( + PostProcessorNames.CONVERT_LITERALS, + (statement: string) => { + if ( + typeof statement !== "string" || + !statement.includes(LITERAL_MARKER) + ) { + return statement + } + const splitMarkerIndex = statement.indexOf("-") + const type = statement.substring(12, splitMarkerIndex) + const value = statement.substring( + splitMarkerIndex + 1, + statement.length - 2 + ) + switch (type) { + case "string": + return value + case "number": + return parseFloat(value) + case "boolean": + return value === "true" + case "object": + return JSON.parse(value) + case "js_result": + // We use the literal helper to process the result of JS expressions + // as we want to be able to return any types. + // We wrap the value in an abject to be able to use undefined properly. + return JSON.parse(value).data + } + return value + } + ), +] diff --git a/packages/string-templates/src/processors/preprocessor.js b/packages/string-templates/src/processors/preprocessor.js deleted file mode 100644 index 185a3ab38a..0000000000 --- a/packages/string-templates/src/processors/preprocessor.js +++ /dev/null @@ -1,78 +0,0 @@ -const { HelperNames } = require("../helpers") -const { swapStrings, isAlphaNumeric } = require("../utilities") - -const FUNCTION_CASES = ["#", "else", "/"] - -const PreprocessorNames = { - SWAP_TO_DOT: "swap-to-dot-notation", - FIX_FUNCTIONS: "fix-functions", - FINALISE: "finalise", -} - -/* eslint-disable no-unused-vars */ -class Preprocessor { - constructor(name, fn) { - this.name = name - this.fn = fn - } - - process(fullString, statement, opts) { - const output = this.fn(statement, opts) - const idx = fullString.indexOf(statement) - return swapStrings(fullString, idx, statement.length, output) - } -} - -module.exports.processors = [ - new Preprocessor(PreprocessorNames.SWAP_TO_DOT, statement => { - let startBraceIdx = statement.indexOf("[") - let lastIdx = 0 - while (startBraceIdx !== -1) { - // if the character previous to the literal specifier is alphanumeric this should happen - if (isAlphaNumeric(statement.charAt(startBraceIdx - 1))) { - statement = swapStrings(statement, startBraceIdx + lastIdx, 1, ".[") - } - lastIdx = startBraceIdx + 1 - const nextBraceIdx = statement.substring(lastIdx + 1).indexOf("[") - startBraceIdx = nextBraceIdx > 0 ? lastIdx + 1 + nextBraceIdx : -1 - } - return statement - }), - - new Preprocessor(PreprocessorNames.FIX_FUNCTIONS, statement => { - for (let specialCase of FUNCTION_CASES) { - const toFind = `{ ${specialCase}`, - replacement = `{${specialCase}` - statement = statement.replace(new RegExp(toFind, "g"), replacement) - } - return statement - }), - - new Preprocessor(PreprocessorNames.FINALISE, (statement, opts) => { - const noHelpers = opts && opts.noHelpers - let insideStatement = statement.slice(2, statement.length - 2) - if (insideStatement.charAt(0) === " ") { - insideStatement = insideStatement.slice(1) - } - if (insideStatement.charAt(insideStatement.length - 1) === " ") { - insideStatement = insideStatement.slice(0, insideStatement.length - 1) - } - const possibleHelper = insideStatement.split(" ")[0] - // function helpers can't be wrapped - for (let specialCase of FUNCTION_CASES) { - if (possibleHelper.includes(specialCase)) { - return statement - } - } - const testHelper = possibleHelper.trim().toLowerCase() - if ( - !noHelpers && - HelperNames().some(option => testHelper === option.toLowerCase()) - ) { - insideStatement = `(${insideStatement})` - } - return `{{ all ${insideStatement} }}` - }), -] - -module.exports.PreprocessorNames = PreprocessorNames diff --git a/packages/string-templates/src/processors/preprocessor.ts b/packages/string-templates/src/processors/preprocessor.ts new file mode 100644 index 0000000000..141b2be3a9 --- /dev/null +++ b/packages/string-templates/src/processors/preprocessor.ts @@ -0,0 +1,82 @@ +import { HelperNames } from "../helpers" +import { swapStrings, isAlphaNumeric } from "../utilities" + +const FUNCTION_CASES = ["#", "else", "/"] + +export const PreprocessorNames = { + SWAP_TO_DOT: "swap-to-dot-notation", + FIX_FUNCTIONS: "fix-functions", + FINALISE: "finalise", +} + +/* eslint-disable no-unused-vars */ +class Preprocessor { + name: string + private fn: any + + constructor(name: string, fn: any) { + this.name = name + this.fn = fn + } + + process(fullString: string, statement: string, opts: Object) { + const output = this.fn(statement, opts) + const idx = fullString.indexOf(statement) + return swapStrings(fullString, idx, statement.length, output) + } +} + +export const processors = [ + new Preprocessor(PreprocessorNames.SWAP_TO_DOT, (statement: string) => { + let startBraceIdx = statement.indexOf("[") + let lastIdx = 0 + while (startBraceIdx !== -1) { + // if the character previous to the literal specifier is alphanumeric this should happen + if (isAlphaNumeric(statement.charAt(startBraceIdx - 1))) { + statement = swapStrings(statement, startBraceIdx + lastIdx, 1, ".[") + } + lastIdx = startBraceIdx + 1 + const nextBraceIdx = statement.substring(lastIdx + 1).indexOf("[") + startBraceIdx = nextBraceIdx > 0 ? lastIdx + 1 + nextBraceIdx : -1 + } + return statement + }), + + new Preprocessor(PreprocessorNames.FIX_FUNCTIONS, (statement: string) => { + for (let specialCase of FUNCTION_CASES) { + const toFind = `{ ${specialCase}`, + replacement = `{${specialCase}` + statement = statement.replace(new RegExp(toFind, "g"), replacement) + } + return statement + }), + + new Preprocessor( + PreprocessorNames.FINALISE, + (statement: string, opts: { noHelpers: any }) => { + const noHelpers = opts && opts.noHelpers + let insideStatement = statement.slice(2, statement.length - 2) + if (insideStatement.charAt(0) === " ") { + insideStatement = insideStatement.slice(1) + } + if (insideStatement.charAt(insideStatement.length - 1) === " ") { + insideStatement = insideStatement.slice(0, insideStatement.length - 1) + } + const possibleHelper = insideStatement.split(" ")[0] + // function helpers can't be wrapped + for (let specialCase of FUNCTION_CASES) { + if (possibleHelper.includes(specialCase)) { + return statement + } + } + const testHelper = possibleHelper.trim().toLowerCase() + if ( + !noHelpers && + HelperNames().some(option => testHelper === option.toLowerCase()) + ) { + insideStatement = `(${insideStatement})` + } + return `{{ all ${insideStatement} }}` + } + ), +] diff --git a/packages/string-templates/src/types.ts b/packages/string-templates/src/types.ts new file mode 100644 index 0000000000..1e1ef048a4 --- /dev/null +++ b/packages/string-templates/src/types.ts @@ -0,0 +1,8 @@ +export interface ProcessOptions { + cacheTemplates?: boolean + noEscaping?: boolean + noHelpers?: boolean + noFinalise?: boolean + escapeNewlines?: boolean + onlyFound?: boolean +} diff --git a/packages/string-templates/src/utilities.js b/packages/string-templates/src/utilities.ts similarity index 54% rename from packages/string-templates/src/utilities.js rename to packages/string-templates/src/utilities.ts index 00b2d7d855..bcb9987c89 100644 --- a/packages/string-templates/src/utilities.js +++ b/packages/string-templates/src/utilities.ts @@ -1,28 +1,28 @@ const ALPHA_NUMERIC_REGEX = /^[A-Za-z0-9]+$/g -module.exports.FIND_HBS_REGEX = /{{([^{].*?)}}/g -module.exports.FIND_ANY_HBS_REGEX = /{?{{([^{].*?)}}}?/g -module.exports.FIND_TRIPLE_HBS_REGEX = /{{{([^{].*?)}}}/g +export const FIND_HBS_REGEX = /{{([^{].*?)}}/g +export const FIND_ANY_HBS_REGEX = /{?{{([^{].*?)}}}?/g +export const FIND_TRIPLE_HBS_REGEX = /{{{([^{].*?)}}}/g -module.exports.isBackendService = () => { +export const isBackendService = () => { return typeof window === "undefined" } -module.exports.isJSAllowed = () => { +export const isJSAllowed = () => { return process && !process.env.NO_JS } // originally this could be done with a single regex using look behinds // but safari does not support this feature // original regex: /(? { +export const findDoubleHbsInstances = (string: string): string[] => { let copied = string - const doubleRegex = new RegExp(exports.FIND_HBS_REGEX) - const regex = new RegExp(exports.FIND_TRIPLE_HBS_REGEX) + const doubleRegex = new RegExp(FIND_HBS_REGEX) + const regex = new RegExp(FIND_TRIPLE_HBS_REGEX) const tripleMatches = copied.match(regex) // remove triple braces if (tripleMatches) { - tripleMatches.forEach(match => { + tripleMatches.forEach((match: string) => { copied = copied.replace(match, "") }) } @@ -30,34 +30,39 @@ module.exports.findDoubleHbsInstances = string => { return doubleMatches ? doubleMatches : [] } -module.exports.isAlphaNumeric = char => { +export const isAlphaNumeric = (char: string) => { return char.match(ALPHA_NUMERIC_REGEX) } -module.exports.swapStrings = (string, start, length, swap) => { +export const swapStrings = ( + string: string, + start: number, + length: number, + swap: string +) => { return string.slice(0, start) + swap + string.slice(start + length) } -module.exports.removeHandlebarsStatements = ( - string, +export const removeHandlebarsStatements = ( + string: string, replacement = "Invalid binding" ) => { - let regexp = new RegExp(exports.FIND_HBS_REGEX) + let regexp = new RegExp(FIND_HBS_REGEX) let matches = string.match(regexp) if (matches == null) { return string } for (let match of matches) { const idx = string.indexOf(match) - string = exports.swapStrings(string, idx, match.length, replacement) + string = swapStrings(string, idx, match.length, replacement) } return string } -module.exports.btoa = plainText => { +export const btoa = (plainText: string) => { return Buffer.from(plainText, "utf-8").toString("base64") } -module.exports.atob = base64 => { +export const atob = (base64: string) => { return Buffer.from(base64, "base64").toString("utf-8") } diff --git a/packages/string-templates/test/basic.spec.js b/packages/string-templates/test/basic.spec.ts similarity index 91% rename from packages/string-templates/test/basic.spec.js rename to packages/string-templates/test/basic.spec.ts index 0b78e3cafd..00058d4ecd 100644 --- a/packages/string-templates/test/basic.spec.js +++ b/packages/string-templates/test/basic.spec.ts @@ -1,4 +1,4 @@ -const { +import { processObject, processString, isValid, @@ -8,7 +8,7 @@ const { doesContainString, disableEscaping, findHBSBlocks, -} = require("../src/index.js") +} from "../src/index" describe("Test that the string processing works correctly", () => { it("should process a basic template string", async () => { @@ -28,7 +28,7 @@ describe("Test that the string processing works correctly", () => { it("should fail gracefully when wrong type passed in", async () => { let error = null try { - await processString(null, null) + await processString(null as any, null as any) } catch (err) { error = err } @@ -76,7 +76,7 @@ describe("Test that the object processing works correctly", () => { it("should fail gracefully when object passed in has cycles", async () => { let error = null try { - const innerObj = { a: "thing {{ a }}" } + const innerObj: any = { a: "thing {{ a }}" } innerObj.b = innerObj await processObject(innerObj, { a: 1 }) } catch (err) { @@ -98,12 +98,32 @@ describe("Test that the object processing works correctly", () => { it("should be able to handle null objects", async () => { let error = null try { - await processObject(null, null) + await processObject(null as any, null as any) } catch (err) { error = err } expect(error).toBeNull() }) + + it("should be able to handle booleans", async () => { + const output = await processObject( + { + first: true, + second: "true", + third: "another string", + forth: "with {{ template }}", + }, + { + template: "value", + } + ) + expect(output).toEqual({ + first: true, + second: "true", + third: "another string", + forth: "with value", + }) + }) }) describe("check returning objects", () => { diff --git a/packages/string-templates/test/constants.js b/packages/string-templates/test/constants.ts similarity index 72% rename from packages/string-templates/test/constants.js rename to packages/string-templates/test/constants.ts index aac0291636..b9e31bcfcc 100644 --- a/packages/string-templates/test/constants.js +++ b/packages/string-templates/test/constants.ts @@ -1,2 +1,2 @@ -module.exports.UUID_REGEX = +export const UUID_REGEX = /^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i diff --git a/packages/string-templates/test/escapes.spec.js b/packages/string-templates/test/escapes.spec.ts similarity index 98% rename from packages/string-templates/test/escapes.spec.js rename to packages/string-templates/test/escapes.spec.ts index caa2f7d0c1..ffc72a6b92 100644 --- a/packages/string-templates/test/escapes.spec.js +++ b/packages/string-templates/test/escapes.spec.ts @@ -1,4 +1,4 @@ -const { processString } = require("../src/index.js") +import { processString } from "../src/index" describe("Handling context properties with spaces in their name", () => { it("should allow through literal specifiers", async () => { diff --git a/packages/string-templates/test/hbsToJs.spec.js b/packages/string-templates/test/hbsToJs.spec.ts similarity index 97% rename from packages/string-templates/test/hbsToJs.spec.js rename to packages/string-templates/test/hbsToJs.spec.ts index 08d8ff5f67..ea375064a1 100644 --- a/packages/string-templates/test/hbsToJs.spec.js +++ b/packages/string-templates/test/hbsToJs.spec.ts @@ -1,6 +1,6 @@ -const { convertToJS } = require("../src/index.js") +import { convertToJS } from "../src/index" -function checkLines(response, lines) { +function checkLines(response: string, lines: string[]) { const toCheck = response.split("\n") let count = 0 for (let line of lines) { diff --git a/packages/string-templates/test/helpers.spec.js b/packages/string-templates/test/helpers.spec.ts similarity index 96% rename from packages/string-templates/test/helpers.spec.js rename to packages/string-templates/test/helpers.spec.ts index 86fef538d3..5f1855535d 100644 --- a/packages/string-templates/test/helpers.spec.js +++ b/packages/string-templates/test/helpers.spec.ts @@ -1,7 +1,7 @@ -const { processString, processObject, isValid } = require("../src/index.js") -const tableJson = require("./examples/table.json") -const dayjs = require("dayjs") -const { UUID_REGEX } = require("./constants") +import { processString, processObject, isValid } from "../src/index" +import tableJson from "./examples/table.json" +import dayjs from "dayjs" +import { UUID_REGEX } from "./constants" describe("test the custom helpers we have applied", () => { it("should be able to use the object helper", async () => { @@ -188,9 +188,7 @@ describe("test the date helpers", () => { time: date.toUTCString(), } ) - const formatted = new dayjs(date) - .tz("America/New_York") - .format("HH-mm-ss Z") + const formatted = dayjs(date).tz("America/New_York").format("HH-mm-ss Z") expect(output).toBe(formatted) }) @@ -200,7 +198,7 @@ describe("test the date helpers", () => { time: date.toUTCString(), }) const timezone = dayjs.tz.guess() - const offset = new dayjs(date).tz(timezone).format("Z") + const offset = dayjs(date).tz(timezone).format("Z") expect(output).toBe(offset) }) }) @@ -273,7 +271,7 @@ describe("test the string helpers", () => { }) describe("test the comparison helpers", () => { - async function compare(func, a, b) { + async function compare(func: string, a: any, b: any) { const output = await processString( `{{ #${func} a b }}Success{{ else }}Fail{{ /${func} }}`, { @@ -344,14 +342,14 @@ describe("Test the literal helper", () => { }) it("should allow use of the literal specifier for an object", async () => { - const output = await processString(`{{literal a}}`, { + const output: any = await processString(`{{literal a}}`, { a: { b: 1 }, }) expect(output.b).toBe(1) }) it("should allow use of the literal specifier for an object with dashes", async () => { - const output = await processString(`{{literal a}}`, { + const output: any = await processString(`{{literal a}}`, { a: { b: "i-have-dashes" }, }) expect(output.b).toBe("i-have-dashes") diff --git a/packages/string-templates/test/javascript.spec.js b/packages/string-templates/test/javascript.spec.ts similarity index 94% rename from packages/string-templates/test/javascript.spec.js rename to packages/string-templates/test/javascript.spec.ts index 0e9f196da6..cb2f765007 100644 --- a/packages/string-templates/test/javascript.spec.js +++ b/packages/string-templates/test/javascript.spec.ts @@ -1,13 +1,9 @@ -const vm = require("vm") +import vm from "vm" -const { - processStringSync, - encodeJSBinding, - setJSRunner, -} = require("../src/index.js") -const { UUID_REGEX } = require("./constants") +import { processStringSync, encodeJSBinding, setJSRunner } from "../src/index" +import { UUID_REGEX } from "./constants" -const processJS = (js, context) => { +const processJS = (js: string, context?: object): any => { return processStringSync(encodeJSBinding(js), context) } diff --git a/packages/string-templates/test/manifest.spec.js b/packages/string-templates/test/manifest.spec.ts similarity index 79% rename from packages/string-templates/test/manifest.spec.js rename to packages/string-templates/test/manifest.spec.ts index 81183f13c9..de0e3355fd 100644 --- a/packages/string-templates/test/manifest.spec.js +++ b/packages/string-templates/test/manifest.spec.ts @@ -1,4 +1,4 @@ -const vm = require("vm") +import vm from "vm" jest.mock("@budibase/handlebars-helpers/lib/math", () => { const actual = jest.requireActual("@budibase/handlebars-helpers/lib/math") @@ -17,14 +17,14 @@ jest.mock("@budibase/handlebars-helpers/lib/uuid", () => { } }) -const { processString, setJSRunner } = require("../src/index.js") +import { processString, setJSRunner } from "../src/index" -const tk = require("timekeeper") -const { getParsedManifest, runJsHelpersTests } = require("./utils") +import tk from "timekeeper" +import { getParsedManifest, runJsHelpersTests } from "./utils" tk.freeze("2021-01-21T12:00:00") -function escapeRegExp(string) { +function escapeRegExp(string: string) { return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") // $& means the whole matched string } @@ -40,15 +40,15 @@ describe("manifest", () => { describe("examples are valid", () => { describe.each(Object.keys(manifest))("%s", collection => { it.each(manifest[collection])("%s", async (_, { hbs, js }) => { - const context = { - double: i => i * 2, - isString: x => typeof x === "string", + const context: any = { + double: (i: number) => i * 2, + isString: (x: any) => typeof x === "string", } const arrays = hbs.match(/\[[^/\]]+\]/) arrays?.forEach((arrayString, i) => { hbs = hbs.replace(new RegExp(escapeRegExp(arrayString)), `array${i}`) - context[`array${i}`] = JSON.parse(arrayString.replace(/\'/g, '"')) + context[`array${i}`] = JSON.parse(arrayString.replace(/'/g, '"')) }) let result = await processString(hbs, context) diff --git a/packages/string-templates/test/renderApp.spec.js b/packages/string-templates/test/renderApp.spec.ts similarity index 94% rename from packages/string-templates/test/renderApp.spec.js rename to packages/string-templates/test/renderApp.spec.ts index 582e70701f..7570d1a8ec 100644 --- a/packages/string-templates/test/renderApp.spec.js +++ b/packages/string-templates/test/renderApp.spec.ts @@ -1,4 +1,4 @@ -const { processString } = require("../src/index.js") +import { processString } from "../src/index" describe("specific test case for whether or not full app template can still be rendered", () => { it("should be able to render the app template", async () => { diff --git a/packages/string-templates/test/utils.js b/packages/string-templates/test/utils.ts similarity index 61% rename from packages/string-templates/test/utils.js rename to packages/string-templates/test/utils.ts index 927a6e3aeb..957366fc59 100644 --- a/packages/string-templates/test/utils.js +++ b/packages/string-templates/test/utils.ts @@ -1,13 +1,9 @@ -const { getManifest } = require("../src") -const { getJsHelperList } = require("../src/helpers") +import { getManifest } from "../src" +import { getJsHelperList } from "../src/helpers" -const { - convertToJS, - processStringSync, - encodeJSBinding, -} = require("../src/index.js") +import { convertToJS, processStringSync, encodeJSBinding } from "../src/index" -function tryParseJson(str) { +function tryParseJson(str: string) { if (typeof str !== "string") { return } @@ -19,23 +15,35 @@ function tryParseJson(str) { } } -const getParsedManifest = () => { - const manifest = getManifest() +type ExampleType = [ + string, + { + hbs: string + js: string + requiresHbsBody: boolean + } +] + +export const getParsedManifest = () => { + const manifest: any = getManifest() const collections = Object.keys(manifest) + const examples = collections.reduce((acc, collection) => { - const functions = Object.entries(manifest[collection]) - .filter(([_, details]) => details.example) - .map(([name, details]) => { + const functions = Object.entries<{ + example: string + requiresBlock: boolean + }>(manifest[collection]) + .filter( + ([, details]) => + details.example?.split("->").map(x => x.trim()).length > 1 + ) + .map(([name, details]): ExampleType => { const example = details.example let [hbs, js] = example.split("->").map(x => x.trim()) - if (!js) { - // The function has no return value - return - } // Trim 's js = js.replace(/^'|'$/g, "") - let parsedExpected + let parsedExpected: string if ((parsedExpected = tryParseJson(js))) { if (Array.isArray(parsedExpected)) { if (typeof parsedExpected[0] === "object") { @@ -48,47 +56,51 @@ const getParsedManifest = () => { const requiresHbsBody = details.requiresBlock return [name, { hbs, js, requiresHbsBody }] }) - .filter(x => !!x) - if (Object.keys(functions).length) { + if (functions.length) { acc[collection] = functions } return acc - }, {}) + }, {} as Record) return examples } -module.exports.getParsedManifest = getParsedManifest -module.exports.runJsHelpersTests = ({ funcWrap, testsToSkip } = {}) => { - funcWrap = funcWrap || (delegate => delegate()) +export const runJsHelpersTests = ({ + funcWrap, + testsToSkip, +}: { + funcWrap?: any + testsToSkip?: any +} = {}) => { + funcWrap = funcWrap || ((delegate: () => any) => delegate()) const manifest = getParsedManifest() - const processJS = (js, context) => { + const processJS = (js: string, context: object | undefined) => { return funcWrap(() => processStringSync(encodeJSBinding(js), context)) } - function escapeRegExp(string) { + function escapeRegExp(string: string) { return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") // $& means the whole matched string } describe("can be parsed and run as js", () => { - const jsHelpers = getJsHelperList() + const jsHelpers = getJsHelperList()! const jsExamples = Object.keys(manifest).reduce((acc, v) => { acc[v] = manifest[v].filter(([key]) => jsHelpers[key]) return acc - }, {}) + }, {} as typeof manifest) describe.each(Object.keys(jsExamples))("%s", collection => { const examplesToRun = jsExamples[collection] - .filter(([_, { requiresHbsBody }]) => !requiresHbsBody) + .filter(([, { requiresHbsBody }]) => !requiresHbsBody) .filter(([key]) => !testsToSkip?.includes(key)) examplesToRun.length && it.each(examplesToRun)("%s", async (_, { hbs, js }) => { - const context = { - double: i => i * 2, - isString: x => typeof x === "string", + const context: any = { + double: (i: number) => i * 2, + isString: (x: any) => typeof x === "string", } const arrays = hbs.match(/\[[^/\]]+\]/) diff --git a/packages/string-templates/test/vm.spec.js b/packages/string-templates/test/vm.spec.ts similarity index 85% rename from packages/string-templates/test/vm.spec.js rename to packages/string-templates/test/vm.spec.ts index 7bf1612386..0581736af2 100644 --- a/packages/string-templates/test/vm.spec.js +++ b/packages/string-templates/test/vm.spec.ts @@ -5,8 +5,10 @@ jest.mock("../src/utilities", () => { isBackendService: jest.fn().mockReturnValue(true), } }) -const { defaultJSSetup, processStringSync, encodeJSBinding } = require("../src") -const { isBackendService } = require("../src/utilities") + +import { defaultJSSetup, processStringSync, encodeJSBinding } from "../src" +import { isBackendService } from "../src/utilities" + const mockedBackendService = jest.mocked(isBackendService) const binding = encodeJSBinding("return 1") diff --git a/packages/string-templates/tsconfig.json b/packages/string-templates/tsconfig.json index a7c7a0df67..7fc13ace8e 100644 --- a/packages/string-templates/tsconfig.json +++ b/packages/string-templates/tsconfig.json @@ -1,11 +1,15 @@ { "include": ["src/**/*"], "compilerOptions": { - "allowJs": true, "declaration": true, - "emitDeclarationOnly": true, + "target": "es6", + "moduleResolution": "node", + "noImplicitAny": true, + "incremental": true, + "lib": ["dom"], "outDir": "dist", "esModuleInterop": true, - "types": ["node", "jest"] + "types": ["node", "jest"], + "resolveJsonModule": true } } diff --git a/packages/types/package.json b/packages/types/package.json index ce4fce95fb..67b923ed54 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "description": "Budibase types", "main": "dist/index.js", - "types": "dist/index.d.ts", + "types": "src/index.ts", "author": "Budibase", "license": "GPL-3.0", "scripts": { @@ -18,11 +18,11 @@ "@budibase/nano": "10.1.5", "@types/koa": "2.13.4", "@types/pouchdb": "6.4.0", - "@types/redlock": "4.0.3", + "@types/redlock": "4.0.7", "rimraf": "3.0.2", "typescript": "5.2.2" }, "dependencies": { - "scim-patch": "^0.7.0" + "scim-patch": "^0.8.1" } } diff --git a/packages/types/src/api/web/application.ts b/packages/types/src/api/web/application.ts index 3d33fce5b1..68c349be5a 100644 --- a/packages/types/src/api/web/application.ts +++ b/packages/types/src/api/web/application.ts @@ -11,6 +11,17 @@ export interface CreateAppRequest { includeSampleData?: boolean encryptionPassword?: string templateString?: string + file?: { path: string } +} + +export interface DuplicateAppRequest { + name: string + url?: string +} + +export interface DuplicateAppResponse { + duplicateAppId: string + sourceAppId: string } export interface FetchAppDefinitionResponse { diff --git a/packages/types/src/api/web/auth.ts b/packages/types/src/api/web/auth.ts index 46b1e8cec9..30d129f650 100644 --- a/packages/types/src/api/web/auth.ts +++ b/packages/types/src/api/web/auth.ts @@ -18,6 +18,8 @@ export interface UpdateSelfRequest { password?: string forceResetPassword?: boolean onboardedAt?: string + appFavourites?: string[] + tours?: Record } export interface UpdateSelfResponse { diff --git a/packages/types/src/api/web/global/auditLogs.ts b/packages/types/src/api/web/global/auditLogs.ts index a890f3a751..bc6ab5724a 100644 --- a/packages/types/src/api/web/global/auditLogs.ts +++ b/packages/types/src/api/web/global/auditLogs.ts @@ -1,9 +1,5 @@ -import { Event, AuditedEventFriendlyName } from "../../../sdk" -import { - PaginationResponse, - PaginationRequest, - BasicPaginationRequest, -} from "../" +import { Event } from "../../../sdk" +import { PaginationResponse, BasicPaginationRequest } from "../" import { User, App } from "../../../" export interface AuditLogSearchParams { diff --git a/packages/types/src/api/web/query.ts b/packages/types/src/api/web/query.ts index 3959cdea19..66f0248647 100644 --- a/packages/types/src/api/web/query.ts +++ b/packages/types/src/api/web/query.ts @@ -11,7 +11,7 @@ export interface PreviewQueryResponse { } export interface ExecuteQueryRequest { - parameters?: { [key: string]: string } + parameters?: Record pagination?: any } diff --git a/packages/types/src/core/installation.ts b/packages/types/src/core/installation.ts index 7679290f36..ec89e439d9 100644 --- a/packages/types/src/core/installation.ts +++ b/packages/types/src/core/installation.ts @@ -2,3 +2,7 @@ export enum ServiceType { WORKER = "worker", APPS = "apps", } + +export enum MaintenanceType { + SQS_MISSING = "sqs_missing", +} diff --git a/packages/types/src/documents/app/app.ts b/packages/types/src/documents/app/app.ts index ae4f3fa6da..3b7f481253 100644 --- a/packages/types/src/documents/app/app.ts +++ b/packages/types/src/documents/app/app.ts @@ -1,4 +1,4 @@ -import { User, Document, Plugin } from "../" +import { User, Document, Plugin, Snippet } from "../" import { SocketSession } from "../../sdk" export type AppMetadataErrors = { [key: string]: string[] } @@ -26,6 +26,7 @@ export interface App extends Document { automations?: AutomationSettings usedPlugins?: Plugin[] upgradableVersion?: string + snippets?: Snippet[] } export interface AppInstance { diff --git a/packages/types/src/documents/app/index.ts b/packages/types/src/documents/app/index.ts index b81c9e36ac..a58b708de3 100644 --- a/packages/types/src/documents/app/index.ts +++ b/packages/types/src/documents/app/index.ts @@ -14,3 +14,4 @@ export * from "./backup" export * from "./webhook" export * from "./links" export * from "./component" +export * from "./snippet" diff --git a/packages/types/src/documents/app/query.ts b/packages/types/src/documents/app/query.ts index 3227666bf3..535c5dab3b 100644 --- a/packages/types/src/documents/app/query.ts +++ b/packages/types/src/documents/app/query.ts @@ -1,5 +1,4 @@ import { Document } from "../document" -import type { Row } from "./row" export interface QuerySchema { name?: string diff --git a/packages/types/src/documents/app/role.ts b/packages/types/src/documents/app/role.ts index d126a67b16..f32ba810b0 100644 --- a/packages/types/src/documents/app/role.ts +++ b/packages/types/src/documents/app/role.ts @@ -5,4 +5,5 @@ export interface Role extends Document { inherits?: string permissions: { [key: string]: string[] } version?: string + name: string } diff --git a/packages/types/src/documents/app/row.ts b/packages/types/src/documents/app/row.ts index b37412398d..aa8f50d4a8 100644 --- a/packages/types/src/documents/app/row.ts +++ b/packages/types/src/documents/app/row.ts @@ -38,11 +38,16 @@ export interface Row extends Document { export enum FieldSubtype { USER = "user", USERS = "users", + SINGLE = "single", } +// The 'as' are required for typescript not to type the outputs as generic FieldSubtype export const FieldTypeSubtypes = { BB_REFERENCE: { - USER: FieldSubtype.USER, - USERS: FieldSubtype.USERS, + USER: FieldSubtype.USER as FieldSubtype.USER, + USERS: FieldSubtype.USERS as FieldSubtype.USERS, + }, + ATTACHMENT: { + SINGLE: FieldSubtype.SINGLE as FieldSubtype.SINGLE, }, } diff --git a/packages/types/src/documents/app/snippet.ts b/packages/types/src/documents/app/snippet.ts new file mode 100644 index 0000000000..1b8433b32e --- /dev/null +++ b/packages/types/src/documents/app/snippet.ts @@ -0,0 +1,4 @@ +export interface Snippet { + name: string + code: string +} diff --git a/packages/types/src/documents/app/table/schema.ts b/packages/types/src/documents/app/table/schema.ts index 17abf747b2..45e39268ac 100644 --- a/packages/types/src/documents/app/table/schema.ts +++ b/packages/types/src/documents/app/table/schema.ts @@ -112,6 +112,12 @@ export interface BBReferenceFieldMetadata relationshipType?: RelationshipType } +export interface AttachmentFieldMetadata + extends Omit { + type: FieldType.ATTACHMENT + subtype?: FieldSubtype.SINGLE +} + export interface FieldConstraints { type?: string email?: boolean @@ -119,6 +125,7 @@ export interface FieldConstraints { length?: { minimum?: string | number | null maximum?: string | number | null + message?: string } numericality?: { greaterThanOrEqualTo: string | null @@ -156,6 +163,8 @@ interface OtherFieldMetadata extends BaseFieldSchema { | FieldType.FORMULA | FieldType.NUMBER | FieldType.LONGFORM + | FieldType.BB_REFERENCE + | FieldType.ATTACHMENT > } @@ -169,6 +178,7 @@ export type FieldSchema = | LongFormFieldMetadata | BBReferenceFieldMetadata | JsonFieldMetadata + | AttachmentFieldMetadata export interface TableSchema { [key: string]: FieldSchema @@ -203,3 +213,9 @@ export function isBBReferenceField( ): field is BBReferenceFieldMetadata { return field.type === FieldType.BB_REFERENCE } + +export function isAttachmentField( + field: FieldSchema +): field is AttachmentFieldMetadata { + return field.type === FieldType.ATTACHMENT +} diff --git a/packages/types/src/documents/app/view.ts b/packages/types/src/documents/app/view.ts index b5a22ec592..7b93d24f3d 100644 --- a/packages/types/src/documents/app/view.ts +++ b/packages/types/src/documents/app/view.ts @@ -30,6 +30,7 @@ export interface View { map?: string reduce?: any meta?: ViewTemplateOpts + groupBy?: string } export interface ViewV2 { diff --git a/packages/types/src/documents/document.ts b/packages/types/src/documents/document.ts index 18feb9b518..0de4337f4b 100644 --- a/packages/types/src/documents/document.ts +++ b/packages/types/src/documents/document.ts @@ -38,6 +38,7 @@ export enum DocumentType { AUTOMATION_METADATA = "meta_au", AUDIT_LOG = "al", APP_MIGRATION_METADATA = "_design/migrations", + SCIM_LOG = "scimlog", } // these are the core documents that make up the data, design diff --git a/packages/types/src/documents/global/user.ts b/packages/types/src/documents/global/user.ts index 337855787f..a4e6b613c6 100644 --- a/packages/types/src/documents/global/user.ts +++ b/packages/types/src/documents/global/user.ts @@ -55,7 +55,9 @@ export interface User extends Document { dayPassRecordedAt?: string userGroups?: string[] onboardedAt?: string + tours?: Record scimInfo?: { isSync: true } & Record + appFavourites?: string[] ssoId?: string } diff --git a/packages/types/src/documents/global/userGroup.ts b/packages/types/src/documents/global/userGroup.ts index e6b70a160c..f914b2876d 100644 --- a/packages/types/src/documents/global/userGroup.ts +++ b/packages/types/src/documents/global/userGroup.ts @@ -24,7 +24,7 @@ export interface GroupUser { } export interface UserGroupRoles { - [key: string]: string + [key: string]: string | undefined } export interface SearchGroupRequest {} diff --git a/packages/types/src/sdk/db.ts b/packages/types/src/sdk/db.ts index c4e4a4f02f..12c86bd9ba 100644 --- a/packages/types/src/sdk/db.ts +++ b/packages/types/src/sdk/db.ts @@ -7,6 +7,7 @@ import { ViewTemplateOpts, } from "../" import { Writable } from "stream" +import type PouchDB from "pouchdb-find" export enum SearchIndex { ROWS = "rows", @@ -128,6 +129,7 @@ export interface Database { exists(): Promise get(id?: string): Promise + exists(docId: string): Promise getMultiple( ids: string[], opts?: { allowMissing?: boolean } diff --git a/packages/types/src/sdk/events/app.ts b/packages/types/src/sdk/events/app.ts index 602dd8b6a5..8f03974035 100644 --- a/packages/types/src/sdk/events/app.ts +++ b/packages/types/src/sdk/events/app.ts @@ -44,6 +44,14 @@ export interface AppFileImportedEvent extends BaseEvent { } } +export interface AppDuplicatedEvent extends BaseEvent { + duplicateAppId: string + appId: string + audited: { + name: string + } +} + export interface AppTemplateImportedEvent extends BaseEvent { appId: string templateKey: string diff --git a/packages/types/src/sdk/events/event.ts b/packages/types/src/sdk/events/event.ts index f20f1b8fd6..05f4fe4be9 100644 --- a/packages/types/src/sdk/events/event.ts +++ b/packages/types/src/sdk/events/event.ts @@ -60,6 +60,7 @@ export enum Event { APP_CREATED = "app:created", APP_UPDATED = "app:updated", APP_DELETED = "app:deleted", + APP_DUPLICATED = "app:duplicated", APP_PUBLISHED = "app:published", APP_UNPUBLISHED = "app:unpublished", APP_TEMPLATE_IMPORTED = "app:template:imported", @@ -259,6 +260,7 @@ export const AuditedEventFriendlyName: Record = { [Event.APP_CREATED]: `App "{{ name }}" created`, [Event.APP_UPDATED]: `App "{{ name }}" updated`, [Event.APP_DELETED]: `App "{{ name }}" deleted`, + [Event.APP_DUPLICATED]: `App "{{ name }}" duplicated`, [Event.APP_PUBLISHED]: `App "{{ name }}" published`, [Event.APP_UNPUBLISHED]: `App "{{ name }}" unpublished`, [Event.APP_TEMPLATE_IMPORTED]: `App "{{ name }}" template imported`, diff --git a/packages/types/src/sdk/events/userGroup.ts b/packages/types/src/sdk/events/userGroup.ts index ea1f554cff..804db5196d 100644 --- a/packages/types/src/sdk/events/userGroup.ts +++ b/packages/types/src/sdk/events/userGroup.ts @@ -48,7 +48,7 @@ export interface GroupAddedOnboardingEvent extends BaseEvent { } export interface GroupPermissionsEditedEvent extends BaseEvent { - permissions: Record + permissions: Record groupId: string audited: { name: string diff --git a/packages/types/src/sdk/middleware/matchers.ts b/packages/types/src/sdk/middleware/matchers.ts index fc4ceb323e..671505eb13 100644 --- a/packages/types/src/sdk/middleware/matchers.ts +++ b/packages/types/src/sdk/middleware/matchers.ts @@ -8,15 +8,10 @@ export interface EndpointMatcher { * ALL is also accepted to cover all verbs. */ method: string - /** - * The route must match exactly - not just begins with - */ - strict?: boolean } export interface RegexMatcher { regex: RegExp method: string - strict: boolean route: string } diff --git a/packages/types/src/sdk/vm.ts b/packages/types/src/sdk/vm.ts index f1099524bc..1c5820bcc2 100644 --- a/packages/types/src/sdk/vm.ts +++ b/packages/types/src/sdk/vm.ts @@ -1,4 +1,5 @@ export interface VM { execute(code: string): any withContext(context: Record, executeWithContext: () => T): T + close(): void } diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index a2fd5207b4..ad5356c2dc 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -1,8 +1,6 @@ { "extends": "./tsconfig.build.json", "compilerOptions": { - "baseUrl": ".", - "rootDir": "./src", "composite": true }, "exclude": ["node_modules", "dist"] diff --git a/packages/worker/Dockerfile b/packages/worker/Dockerfile index 77869c48f1..28796ea666 100644 --- a/packages/worker/Dockerfile +++ b/packages/worker/Dockerfile @@ -16,17 +16,11 @@ COPY scripts/removeWorkspaceDependencies.sh scripts/removeWorkspaceDependencies. RUN chmod +x ./scripts/removeWorkspaceDependencies.sh -WORKDIR /string-templates -COPY packages/string-templates/package.json package.json -RUN ../scripts/removeWorkspaceDependencies.sh package.json -RUN --mount=type=cache,target=/root/.yarn YARN_CACHE_FOLDER=/root/.yarn yarn install --production=true --network-timeout 1000000 -COPY packages/string-templates . WORKDIR /app COPY packages/worker/package.json . COPY packages/worker/dist/yarn.lock . -RUN cd ../string-templates && yarn link && cd - && yarn link @budibase/string-templates RUN ../scripts/removeWorkspaceDependencies.sh package.json diff --git a/packages/worker/__mocks__/aws-sdk.ts b/packages/worker/__mocks__/aws-sdk.ts deleted file mode 100644 index 7fac80faa9..0000000000 --- a/packages/worker/__mocks__/aws-sdk.ts +++ /dev/null @@ -1,15 +0,0 @@ -const mockS3 = { - headBucket: jest.fn().mockReturnThis(), - deleteObject: jest.fn().mockReturnThis(), - deleteObjects: jest.fn().mockReturnThis(), - createBucket: jest.fn().mockReturnThis(), - listObjects: jest.fn().mockReturnThis(), - promise: jest.fn().mockReturnThis(), - catch: jest.fn(), -} - -const AWS = { - S3: jest.fn(() => mockS3), -} - -export default AWS diff --git a/packages/worker/__mocks__/node-fetch.ts b/packages/worker/__mocks__/node-fetch.ts deleted file mode 100644 index 27c9b507a4..0000000000 --- a/packages/worker/__mocks__/node-fetch.ts +++ /dev/null @@ -1,24 +0,0 @@ -import fs from "fs" - -module FetchMock { - const fetch = jest.requireActual("node-fetch") - - const func = async (url: any, opts: any) => { - if (url.includes("http://someconfigurl")) { - return { - ok: true, - json: () => ({ - issuer: "test", - authorization_endpoint: "http://localhost/auth", - token_endpoint: "http://localhost/token", - userinfo_endpoint: "http://localhost/userinfo", - }), - } - } - return fetch(url, opts) - } - - func.Headers = fetch.Headers - - module.exports = func -} diff --git a/packages/worker/__mocks__/oauth.ts b/packages/worker/__mocks__/oauth.ts deleted file mode 100644 index 8e8122a9e0..0000000000 --- a/packages/worker/__mocks__/oauth.ts +++ /dev/null @@ -1,57 +0,0 @@ -import * as jwt from "jsonwebtoken" - -const mockOAuth2 = { - getOAuthAccessToken: (code: string, p: any, cb: any) => { - const err = null - const accessToken = "access_token" - const refreshToken = "refresh_token" - - const exp = new Date() - exp.setDate(exp.getDate() + 1) - - const iat = new Date() - iat.setDate(iat.getDate() - 1) - - const claims = { - iss: "test", - sub: "sub", - aud: "clientId", - exp: exp.getTime() / 1000, - iat: iat.getTime() / 1000, - email: "oauth@example.com", - } - - const idToken = jwt.sign(claims, "secret") - - const params = { - id_token: idToken, - } - return cb(err, accessToken, refreshToken, params) - }, - _request: ( - method: string, - url: string, - headers: any, - postBody: any, - accessToken: string, - cb: any - ) => { - const err = null - const body = { - sub: "sub", - user_id: "userId", - name: "OAuth", - family_name: "2", - given_name: "OAuth", - middle_name: "", - } - const res = {} - return cb(err, JSON.stringify(body), res) - }, -} - -const oauth = { - OAuth2: jest.fn(() => mockOAuth2), -} - -export = oauth diff --git a/packages/worker/jest.config.ts b/packages/worker/jest.config.ts index 0a640766f4..1eb17f100f 100644 --- a/packages/worker/jest.config.ts +++ b/packages/worker/jest.config.ts @@ -15,6 +15,7 @@ const config: Config.InitialOptions = { "@budibase/backend-core": "/../backend-core/src", "@budibase/types": "/../types/src", "@budibase/shared-core": ["/../shared-core/src"], + "@budibase/string-templates": ["/../string-templates/src"], }, } diff --git a/packages/worker/package.json b/packages/worker/package.json index e01a50d981..efdbe6aa12 100644 --- a/packages/worker/package.json +++ b/packages/worker/package.json @@ -86,6 +86,7 @@ "@types/supertest": "2.0.14", "@types/uuid": "8.3.4", "jest": "29.7.0", + "nock": "^13.5.4", "nodemon": "2.0.15", "rimraf": "3.0.2", "supertest": "6.3.3", diff --git a/packages/worker/scripts/test.sh b/packages/worker/scripts/test.sh index 17b3ee17f4..4191674538 100644 --- a/packages/worker/scripts/test.sh +++ b/packages/worker/scripts/test.sh @@ -4,10 +4,10 @@ set -e if [[ -n $CI ]] then # Running in ci, where resources are limited - echo "jest --coverage --maxWorkers=2 --forceExit --bail $@" - jest --coverage --maxWorkers=2 --forceExit --bail $@ + echo "jest --coverage --maxWorkers=2 --forceExit --bail $@" + jest --coverage --maxWorkers=2 --forceExit --bail $@ else # --maxWorkers performs better in development - echo "jest --coverage --maxWorkers=2 --forceExit $@" - jest --coverage --maxWorkers=2 --forceExit $@ + echo "jest --coverage --detectOpenHandles $@" + jest --coverage --detectOpenHandles $@ fi \ No newline at end of file diff --git a/packages/worker/src/api/controllers/global/auth.ts b/packages/worker/src/api/controllers/global/auth.ts index cfee8c00dc..86c90f9cd3 100644 --- a/packages/worker/src/api/controllers/global/auth.ts +++ b/packages/worker/src/api/controllers/global/auth.ts @@ -225,7 +225,7 @@ export async function oidcCallbackUrl() { return ssoCallbackUrl(ConfigType.OIDC) } -export const oidcStrategyFactory = async (ctx: any, configId: any) => { +export const oidcStrategyFactory = async (ctx: any) => { const config = await configs.getOIDCConfig() if (!config) { return ctx.throw(400, "OIDC config not found") @@ -247,7 +247,7 @@ export const oidcPreAuth = async (ctx: Ctx, next: any) => { if (!configId) { ctx.throw(400, "OIDC config id is required") } - const strategy = await oidcStrategyFactory(ctx, configId) + const strategy = await oidcStrategyFactory(ctx) setCookie(ctx, configId, Cookie.OIDC_CONFIG) @@ -268,8 +268,7 @@ export const oidcPreAuth = async (ctx: Ctx, next: any) => { } export const oidcCallback = async (ctx: any, next: any) => { - const configId = getCookie(ctx, Cookie.OIDC_CONFIG) - const strategy = await oidcStrategyFactory(ctx, configId) + const strategy = await oidcStrategyFactory(ctx) return passport.authenticate( strategy, diff --git a/packages/worker/src/api/controllers/global/self.ts b/packages/worker/src/api/controllers/global/self.ts index 2d7e83a2c3..d762f5168a 100644 --- a/packages/worker/src/api/controllers/global/self.ts +++ b/packages/worker/src/api/controllers/global/self.ts @@ -9,7 +9,12 @@ import { } from "@budibase/backend-core" import env from "../../../environment" import { groups } from "@budibase/pro" -import { UpdateSelfRequest, UpdateSelfResponse, UserCtx } from "@budibase/types" +import { + UpdateSelfRequest, + UpdateSelfResponse, + User, + UserCtx, +} from "@budibase/types" const { newid } = utils @@ -105,16 +110,75 @@ export async function getSelf(ctx: any) { addSessionAttributesToUser(ctx) } +export const syncAppFavourites = async (processedAppIds: string[]) => { + if (processedAppIds.length === 0) { + return [] + } + + const tenantId = tenancy.getTenantId() + const appPrefix = + tenantId === tenancy.DEFAULT_TENANT_ID + ? dbCore.APP_DEV_PREFIX + : `${dbCore.APP_DEV_PREFIX}${tenantId}_` + + const apps = await fetchAppsByIds(processedAppIds, appPrefix) + return apps?.reduce((acc: string[], app) => { + const id = app.appId.replace(appPrefix, "") + if (processedAppIds.includes(id)) { + acc.push(id) + } + return acc + }, []) +} + +export const fetchAppsByIds = async ( + processedAppIds: string[], + appPrefix: string +) => { + return await dbCore.getAppsByIDs( + processedAppIds.map(appId => { + return `${appPrefix}${appId}` + }) + ) +} + +const processUserAppFavourites = async ( + user: User, + update: UpdateSelfRequest +) => { + if (!("appFavourites" in update)) { + // Ignore requests without an explicit update to favourites. + return + } + + const userAppFavourites = user.appFavourites || [] + const requestAppFavourites = new Set(update.appFavourites || []) + const containsAll = userAppFavourites.every(v => requestAppFavourites.has(v)) + + if (containsAll && requestAppFavourites.size === userAppFavourites.length) { + // Ignore request if the outcome will have no change + return + } + + // Clean up the request by purging apps that no longer exist. + const syncedAppFavourites = await syncAppFavourites([...requestAppFavourites]) + return syncedAppFavourites +} + export async function updateSelf( ctx: UserCtx ) { const update = ctx.request.body let user = await userSdk.db.getUser(ctx.user._id!) + const updatedAppFavourites = await processUserAppFavourites(user, update) + user = { ...user, ...update, + ...(updatedAppFavourites ? { appFavourites: updatedAppFavourites } : {}), } + user = await userSdk.db.save(user, { requirePassword: false }) if (update.password) { diff --git a/packages/worker/src/api/controllers/system/environment.ts b/packages/worker/src/api/controllers/system/environment.ts index bf9270607f..203d3d41ff 100644 --- a/packages/worker/src/api/controllers/system/environment.ts +++ b/packages/worker/src/api/controllers/system/environment.ts @@ -1,10 +1,18 @@ -import { Ctx } from "@budibase/types" +import { Ctx, MaintenanceType } from "@budibase/types" import env from "../../../environment" import { env as coreEnv } from "@budibase/backend-core" import nodeFetch from "node-fetch" +// When we come to move to SQS fully and move away from Clouseau, we will need +// to flip this to true (or remove it entirely). This will then be used to +// determine if we should show the maintenance page that links to the SQS +// migration docs. +const sqsRequired = false + let sqsAvailable: boolean async function isSqsAvailable() { + // We cache this value for the duration of the Node process because we don't + // want every page load to be making this relatively expensive check. if (sqsAvailable !== undefined) { return sqsAvailable } @@ -21,6 +29,10 @@ async function isSqsAvailable() { } } +async function isSqsMissing() { + return sqsRequired && !(await isSqsAvailable()) +} + export const fetch = async (ctx: Ctx) => { ctx.body = { multiTenancy: !!env.MULTI_TENANCY, @@ -30,11 +42,12 @@ export const fetch = async (ctx: Ctx) => { disableAccountPortal: env.DISABLE_ACCOUNT_PORTAL, baseUrl: env.PLATFORM_URL, isDev: env.isDev() && !env.isTest(), + maintenance: [], } if (env.SELF_HOSTED) { - ctx.body.infrastructure = { - sqs: await isSqsAvailable(), + if (await isSqsMissing()) { + ctx.body.maintenance.push({ type: MaintenanceType.SQS_MISSING }) } } } diff --git a/packages/worker/src/api/routes/global/tests/auth.spec.ts b/packages/worker/src/api/routes/global/tests/auth.spec.ts index e9edfdf1cf..3f2b3045de 100644 --- a/packages/worker/src/api/routes/global/tests/auth.spec.ts +++ b/packages/worker/src/api/routes/global/tests/auth.spec.ts @@ -13,6 +13,8 @@ import { events, constants } from "@budibase/backend-core" import { Response } from "superagent" import * as userSdk from "../../../../sdk/users" +import nock from "nock" +import * as jwt from "jsonwebtoken" function getAuthCookie(response: Response) { return response.headers["set-cookie"] @@ -58,7 +60,7 @@ describe("/api/global/auth", () => { const response = await config.api.auth.login(tenantId, email, password) expectSetAuthCookie(response) - expect(events.auth.login).toBeCalledTimes(1) + expect(events.auth.login).toHaveBeenCalledTimes(1) }) it("should return 403 with incorrect credentials", async () => { @@ -139,7 +141,7 @@ describe("/api/global/auth", () => { describe("POST /api/global/auth/logout", () => { it("should logout", async () => { const response = await config.api.auth.logout() - expect(events.auth.logout).toBeCalledTimes(1) + expect(events.auth.logout).toHaveBeenCalledTimes(1) const authCookie = getAuthCookie(response) expect(authCookie).toBe("") @@ -160,18 +162,15 @@ describe("/api/global/auth", () => { }) expect(sendMailMock).toHaveBeenCalled() expect(code).toBeDefined() - expect(events.user.passwordResetRequested).toBeCalledTimes(1) - expect(events.user.passwordResetRequested).toBeCalledWith(user) + expect(events.user.passwordResetRequested).toHaveBeenCalledTimes(1) + expect(events.user.passwordResetRequested).toHaveBeenCalledWith(user) }) describe("sso user", () => { let user: User async function testSSOUser() { - const { res } = await config.api.auth.requestPasswordReset( - sendMailMock, - user.email - ) + await config.api.auth.requestPasswordReset(sendMailMock, user.email) expect(sendMailMock).not.toHaveBeenCalled() } @@ -211,8 +210,8 @@ describe("/api/global/auth", () => { delete user.password expect(res.body).toEqual({ message: "password reset successfully." }) - expect(events.user.passwordReset).toBeCalledTimes(1) - expect(events.user.passwordReset).toBeCalledWith(user) + expect(events.user.passwordReset).toHaveBeenCalledTimes(1) + expect(events.user.passwordReset).toHaveBeenCalledWith(user) // login using new password await config.api.auth.login(user.tenantId, user.email, newPassword) @@ -277,45 +276,9 @@ describe("/api/global/auth", () => { }) }) - describe("init", () => { - describe("POST /api/global/auth/init", () => {}) - - describe("GET /api/global/auth/init", () => {}) - }) - - describe("datasource", () => { - // MULTI TENANT - - describe("GET /api/global/auth/:tenantId/datasource/:provider", () => {}) - - describe("GET /api/global/auth/:tenantId/datasource/:provider/callback", () => {}) - - // SINGLE TENANT - - describe("GET /api/global/auth/datasource/:provider/callback", () => {}) - }) - - describe("google", () => { - // MULTI TENANT - - describe("GET /api/global/auth/:tenantId/google", () => {}) - - describe("GET /api/global/auth/:tenantId/google/callback", () => {}) - - // SINGLE TENANT - - describe("GET /api/global/auth/google/callback", () => {}) - - describe("GET /api/admin/auth/google/callback", () => {}) - }) - describe("oidc", () => { - beforeEach(async () => { - jest.clearAllMocks() - mockGetWellKnownConfig() - - // see: __mocks__/oauth - // for associated mocking inside passport + afterEach(() => { + nock.cleanAll() }) const generateOidcConfig = async () => { @@ -324,21 +287,16 @@ describe("/api/global/auth", () => { return chosenConfig.uuid } - const mockGetWellKnownConfig = () => { - mocks.fetch.mockReturnValue({ - ok: true, - json: () => ({ + // MULTI TENANT + describe("GET /api/global/auth/:tenantId/oidc/configs/:configId", () => { + it("redirects to auth provider", async () => { + nock("http://someconfigurl").get("/").times(1).reply(200, { issuer: "test", authorization_endpoint: "http://localhost/auth", token_endpoint: "http://localhost/token", userinfo_endpoint: "http://localhost/userinfo", - }), - }) - } + }) - // MULTI TENANT - describe("GET /api/global/auth/:tenantId/oidc/configs/:configId", () => { - it("redirects to auth provider", async () => { const configId = await generateOidcConfig() const res = await config.api.configs.getOIDCConfig(configId) @@ -355,26 +313,54 @@ describe("/api/global/auth", () => { describe("GET /api/global/auth/:tenantId/oidc/callback", () => { it("logs in", async () => { + nock("http://someconfigurl").get("/").times(2).reply(200, { + issuer: "test", + authorization_endpoint: "http://localhost/auth", + token_endpoint: "http://localhost/token", + userinfo_endpoint: "http://localhost/userinfo", + }) + + const token = jwt.sign( + { + iss: "test", + sub: "sub", + aud: "clientId", + exp: Math.floor(Date.now() / 1000) + 60 * 60, + email: "oauth@example.com", + }, + "secret" + ) + + nock("http://localhost").post("/token").reply(200, { + access_token: "access", + refresh_token: "refresh", + id_token: token, + }) + + nock("http://localhost").get("/userinfo?schema=openid").reply(200, { + sub: "sub", + email: "oauth@example.com", + }) + const configId = await generateOidcConfig() const preAuthRes = await config.api.configs.getOIDCConfig(configId) - const res = await config.api.configs.OIDCCallback(configId, preAuthRes) + if (res.status > 399) { + throw new Error( + `OIDC callback failed with status ${res.status}: ${res.text}` + ) + } - expect(events.auth.login).toBeCalledWith("oidc", "oauth@example.com") - expect(events.auth.login).toBeCalledTimes(1) + expect(events.auth.login).toHaveBeenCalledWith( + "oidc", + "oauth@example.com" + ) + expect(events.auth.login).toHaveBeenCalledTimes(1) expect(res.status).toBe(302) const location: string = res.get("location") expect(location).toBe("/") expectSetAuthCookie(res) }) }) - - // SINGLE TENANT - - describe("GET /api/global/auth/oidc/callback", () => {}) - - describe("GET /api/global/auth/oidc/callback", () => {}) - - describe("GET /api/admin/auth/oidc/callback", () => {}) }) }) diff --git a/packages/worker/src/api/routes/global/tests/configs.spec.ts b/packages/worker/src/api/routes/global/tests/configs.spec.ts index 4d9f28d2cb..6e3558ba86 100644 --- a/packages/worker/src/api/routes/global/tests/configs.spec.ts +++ b/packages/worker/src/api/routes/global/tests/configs.spec.ts @@ -57,20 +57,22 @@ describe("configs", () => { describe("create", () => { it("should create activated google config", async () => { await saveGoogleConfig() - expect(events.auth.SSOCreated).toBeCalledTimes(1) - expect(events.auth.SSOCreated).toBeCalledWith(ConfigType.GOOGLE) - expect(events.auth.SSODeactivated).not.toBeCalled() - expect(events.auth.SSOActivated).toBeCalledTimes(1) - expect(events.auth.SSOActivated).toBeCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSOCreated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOCreated).toHaveBeenCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSODeactivated).not.toHaveBeenCalled() + expect(events.auth.SSOActivated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOActivated).toHaveBeenCalledWith( + ConfigType.GOOGLE + ) await config.deleteConfig(ConfigType.GOOGLE) }) it("should create deactivated google config", async () => { await saveGoogleConfig({ activated: false }) - expect(events.auth.SSOCreated).toBeCalledTimes(1) - expect(events.auth.SSOCreated).toBeCalledWith(ConfigType.GOOGLE) - expect(events.auth.SSOActivated).not.toBeCalled() - expect(events.auth.SSODeactivated).not.toBeCalled() + expect(events.auth.SSOCreated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOCreated).toHaveBeenCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSOActivated).not.toHaveBeenCalled() + expect(events.auth.SSODeactivated).not.toHaveBeenCalled() await config.deleteConfig(ConfigType.GOOGLE) }) }) @@ -84,11 +86,13 @@ describe("configs", () => { googleConf._id, googleConf._rev ) - expect(events.auth.SSOUpdated).toBeCalledTimes(1) - expect(events.auth.SSOUpdated).toBeCalledWith(ConfigType.GOOGLE) - expect(events.auth.SSOActivated).not.toBeCalled() - expect(events.auth.SSODeactivated).toBeCalledTimes(1) - expect(events.auth.SSODeactivated).toBeCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSOUpdated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOUpdated).toHaveBeenCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSOActivated).not.toHaveBeenCalled() + expect(events.auth.SSODeactivated).toHaveBeenCalledTimes(1) + expect(events.auth.SSODeactivated).toHaveBeenCalledWith( + ConfigType.GOOGLE + ) await config.deleteConfig(ConfigType.GOOGLE) }) @@ -100,11 +104,13 @@ describe("configs", () => { googleConf._id, googleConf._rev ) - expect(events.auth.SSOUpdated).toBeCalledTimes(1) - expect(events.auth.SSOUpdated).toBeCalledWith(ConfigType.GOOGLE) - expect(events.auth.SSODeactivated).not.toBeCalled() - expect(events.auth.SSOActivated).toBeCalledTimes(1) - expect(events.auth.SSOActivated).toBeCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSOUpdated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOUpdated).toHaveBeenCalledWith(ConfigType.GOOGLE) + expect(events.auth.SSODeactivated).not.toHaveBeenCalled() + expect(events.auth.SSOActivated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOActivated).toHaveBeenCalledWith( + ConfigType.GOOGLE + ) await config.deleteConfig(ConfigType.GOOGLE) }) }) @@ -123,20 +129,20 @@ describe("configs", () => { describe("create", () => { it("should create activated OIDC config", async () => { await saveOIDCConfig() - expect(events.auth.SSOCreated).toBeCalledTimes(1) - expect(events.auth.SSOCreated).toBeCalledWith(ConfigType.OIDC) - expect(events.auth.SSODeactivated).not.toBeCalled() - expect(events.auth.SSOActivated).toBeCalledTimes(1) - expect(events.auth.SSOActivated).toBeCalledWith(ConfigType.OIDC) + expect(events.auth.SSOCreated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOCreated).toHaveBeenCalledWith(ConfigType.OIDC) + expect(events.auth.SSODeactivated).not.toHaveBeenCalled() + expect(events.auth.SSOActivated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOActivated).toHaveBeenCalledWith(ConfigType.OIDC) await config.deleteConfig(ConfigType.OIDC) }) it("should create deactivated OIDC config", async () => { await saveOIDCConfig({ activated: false }) - expect(events.auth.SSOCreated).toBeCalledTimes(1) - expect(events.auth.SSOCreated).toBeCalledWith(ConfigType.OIDC) - expect(events.auth.SSOActivated).not.toBeCalled() - expect(events.auth.SSODeactivated).not.toBeCalled() + expect(events.auth.SSOCreated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOCreated).toHaveBeenCalledWith(ConfigType.OIDC) + expect(events.auth.SSOActivated).not.toHaveBeenCalled() + expect(events.auth.SSODeactivated).not.toHaveBeenCalled() await config.deleteConfig(ConfigType.OIDC) }) }) @@ -150,11 +156,13 @@ describe("configs", () => { oidcConf._id, oidcConf._rev ) - expect(events.auth.SSOUpdated).toBeCalledTimes(1) - expect(events.auth.SSOUpdated).toBeCalledWith(ConfigType.OIDC) - expect(events.auth.SSOActivated).not.toBeCalled() - expect(events.auth.SSODeactivated).toBeCalledTimes(1) - expect(events.auth.SSODeactivated).toBeCalledWith(ConfigType.OIDC) + expect(events.auth.SSOUpdated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOUpdated).toHaveBeenCalledWith(ConfigType.OIDC) + expect(events.auth.SSOActivated).not.toHaveBeenCalled() + expect(events.auth.SSODeactivated).toHaveBeenCalledTimes(1) + expect(events.auth.SSODeactivated).toHaveBeenCalledWith( + ConfigType.OIDC + ) await config.deleteConfig(ConfigType.OIDC) }) @@ -166,11 +174,11 @@ describe("configs", () => { oidcConf._id, oidcConf._rev ) - expect(events.auth.SSOUpdated).toBeCalledTimes(1) - expect(events.auth.SSOUpdated).toBeCalledWith(ConfigType.OIDC) - expect(events.auth.SSODeactivated).not.toBeCalled() - expect(events.auth.SSOActivated).toBeCalledTimes(1) - expect(events.auth.SSOActivated).toBeCalledWith(ConfigType.OIDC) + expect(events.auth.SSOUpdated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOUpdated).toHaveBeenCalledWith(ConfigType.OIDC) + expect(events.auth.SSODeactivated).not.toHaveBeenCalled() + expect(events.auth.SSOActivated).toHaveBeenCalledTimes(1) + expect(events.auth.SSOActivated).toHaveBeenCalledWith(ConfigType.OIDC) await config.deleteConfig(ConfigType.OIDC) }) }) @@ -190,8 +198,8 @@ describe("configs", () => { it("should create SMTP config", async () => { await config.deleteConfig(ConfigType.SMTP) await saveSMTPConfig() - expect(events.email.SMTPUpdated).not.toBeCalled() - expect(events.email.SMTPCreated).toBeCalledTimes(1) + expect(events.email.SMTPUpdated).not.toHaveBeenCalled() + expect(events.email.SMTPCreated).toHaveBeenCalledTimes(1) await config.deleteConfig(ConfigType.SMTP) }) }) @@ -201,8 +209,8 @@ describe("configs", () => { const smtpConf = await saveSMTPConfig() jest.clearAllMocks() await saveSMTPConfig(smtpConf.config, smtpConf._id, smtpConf._rev) - expect(events.email.SMTPCreated).not.toBeCalled() - expect(events.email.SMTPUpdated).toBeCalledTimes(1) + expect(events.email.SMTPCreated).not.toHaveBeenCalled() + expect(events.email.SMTPUpdated).toHaveBeenCalledTimes(1) await config.deleteConfig(ConfigType.SMTP) }) }) @@ -215,9 +223,9 @@ describe("configs", () => { await saveSettingsConfig() - expect(events.org.nameUpdated).not.toBeCalled() - expect(events.org.logoUpdated).not.toBeCalled() - expect(events.org.platformURLUpdated).not.toBeCalled() + expect(events.org.nameUpdated).not.toHaveBeenCalled() + expect(events.org.logoUpdated).not.toHaveBeenCalled() + expect(events.org.platformURLUpdated).not.toHaveBeenCalled() }) it("should create settings config with non-default settings", async () => { @@ -231,9 +239,9 @@ describe("configs", () => { await saveSettingsConfig(conf) - expect(events.org.nameUpdated).toBeCalledTimes(1) - expect(events.org.logoUpdated).toBeCalledTimes(1) - expect(events.org.platformURLUpdated).toBeCalledTimes(1) + expect(events.org.nameUpdated).toHaveBeenCalledTimes(1) + expect(events.org.logoUpdated).toHaveBeenCalledTimes(1) + expect(events.org.platformURLUpdated).toHaveBeenCalledTimes(1) config.cloudHosted() }) }) @@ -253,9 +261,9 @@ describe("configs", () => { settingsConfig._rev ) - expect(events.org.nameUpdated).toBeCalledTimes(1) - expect(events.org.logoUpdated).toBeCalledTimes(1) - expect(events.org.platformURLUpdated).toBeCalledTimes(1) + expect(events.org.nameUpdated).toHaveBeenCalledTimes(1) + expect(events.org.logoUpdated).toHaveBeenCalledTimes(1) + expect(events.org.platformURLUpdated).toHaveBeenCalledTimes(1) config.cloudHosted() }) }) diff --git a/packages/worker/src/api/routes/global/tests/groups.spec.ts b/packages/worker/src/api/routes/global/tests/groups.spec.ts index 8f0739a812..bc489348df 100644 --- a/packages/worker/src/api/routes/global/tests/groups.spec.ts +++ b/packages/worker/src/api/routes/global/tests/groups.spec.ts @@ -25,9 +25,9 @@ describe("/api/global/groups", () => { it("should be able to create a new group", async () => { const group = structures.groups.UserGroup() await config.api.groups.saveGroup(group) - expect(events.group.created).toBeCalledTimes(1) - expect(events.group.updated).not.toBeCalled() - expect(events.group.permissionsEdited).not.toBeCalled() + expect(events.group.created).toHaveBeenCalledTimes(1) + expect(events.group.updated).not.toHaveBeenCalled() + expect(events.group.permissionsEdited).not.toHaveBeenCalled() }) it("should not allow undefined names", async () => { @@ -57,7 +57,7 @@ describe("/api/global/groups", () => { it("should trim names", async () => { const group = { ...structures.groups.UserGroup(), name: " group name " } await config.api.groups.saveGroup(group) - expect(events.group.created).toBeCalledWith( + expect(events.group.created).toHaveBeenCalledWith( expect.objectContaining({ name: "group name" }) ) }) @@ -100,21 +100,83 @@ describe("/api/global/groups", () => { } await config.api.groups.saveGroup(updatedGroup) - expect(events.group.updated).toBeCalledTimes(1) - expect(events.group.permissionsEdited).not.toBeCalled() + expect(events.group.updated).toHaveBeenCalledTimes(1) + expect(events.group.permissionsEdited).not.toHaveBeenCalled() }) - describe("destroy", () => { - it("should be able to delete a basic group", async () => { - const group = structures.groups.UserGroup() - let oldGroup = await config.api.groups.saveGroup(group) - await config.api.groups.deleteGroup( - oldGroup.body._id, - oldGroup.body._rev - ) + describe("scim", () => { + async function createScimGroup() { + mocks.licenses.useScimIntegration() + await config.setSCIMConfig(true) - expect(events.group.deleted).toBeCalledTimes(1) + const scimGroup = await config.api.scimGroupsAPI.post({ + body: structures.scim.createGroupRequest({ + displayName: generator.word(), + }), + }) + + const { body: group } = await config.api.groups.find(scimGroup.id) + + expect(group).toBeDefined() + return group + } + + it("update will not allow sending SCIM fields", async () => { + const group = await createScimGroup() + + const updatedGroup: UserGroup = { + ...group, + name: generator.word(), + } + await config.api.groups.saveGroup(updatedGroup, { + expect: { + message: 'Invalid body - "scimInfo" is not allowed', + status: 400, + }, + }) + + expect(events.group.updated).not.toHaveBeenCalled() }) + + it("update will not amend the SCIM fields", async () => { + const group: UserGroup = await createScimGroup() + + const updatedGroup: UserGroup = { + ...group, + name: generator.word(), + scimInfo: undefined, + } + + await config.api.groups.saveGroup(updatedGroup, { + expect: 200, + }) + + expect(events.group.updated).toHaveBeenCalledTimes(1) + expect( + ( + await config.api.groups.find(group._id!, { + expect: 200, + }) + ).body + ).toEqual( + expect.objectContaining({ + ...group, + name: updatedGroup.name, + scimInfo: group.scimInfo, + _rev: expect.any(String), + }) + ) + }) + }) + }) + + describe("destroy", () => { + it("should be able to delete a basic group", async () => { + const group = structures.groups.UserGroup() + let oldGroup = await config.api.groups.saveGroup(group) + await config.api.groups.deleteGroup(oldGroup.body._id, oldGroup.body._rev) + + expect(events.group.deleted).toHaveBeenCalledTimes(1) }) }) @@ -147,7 +209,7 @@ describe("/api/global/groups", () => { await Promise.all( Array.from({ length: 30 }).map(async (_, i) => { - const email = `user${i}@${generator.domain()}` + const email = `user${i}+${generator.guid()}@example.com` const user = await config.api.users.saveUser({ ...structures.users.user(), email, @@ -257,12 +319,16 @@ describe("/api/global/groups", () => { }) }) - it("update should return 200", async () => { + it("update should return forbidden", async () => { await config.withUser(builder, async () => { - await config.api.groups.updateGroupUsers(group._id!, { - add: [builder._id!], - remove: [], - }) + await config.api.groups.updateGroupUsers( + group._id!, + { + add: [builder._id!], + remove: [], + }, + { expect: 403 } + ) }) }) }) diff --git a/packages/worker/src/api/routes/global/tests/license.spec.ts b/packages/worker/src/api/routes/global/tests/license.spec.ts index e08292c061..7c8fdb553c 100644 --- a/packages/worker/src/api/routes/global/tests/license.spec.ts +++ b/packages/worker/src/api/routes/global/tests/license.spec.ts @@ -22,7 +22,7 @@ describe("/api/global/license", () => { it("returns 200", async () => { const res = await config.api.license.refresh() expect(res.status).toBe(200) - expect(licensing.cache.refresh).toBeCalledTimes(1) + expect(licensing.cache.refresh).toHaveBeenCalledTimes(1) }) }) @@ -42,7 +42,9 @@ describe("/api/global/license", () => { licenseKey: "licenseKey", }) expect(res.status).toBe(200) - expect(licensing.keys.activateLicenseKey).toBeCalledWith("licenseKey") + expect(licensing.keys.activateLicenseKey).toHaveBeenCalledWith( + "licenseKey" + ) }) }) @@ -64,7 +66,7 @@ describe("/api/global/license", () => { describe("DELETE /api/global/license/key", () => { it("returns 204", async () => { const res = await config.api.license.deleteLicenseKey() - expect(licensing.keys.deleteLicenseKey).toBeCalledTimes(1) + expect(licensing.keys.deleteLicenseKey).toHaveBeenCalledTimes(1) expect(res.status).toBe(204) }) }) @@ -74,9 +76,9 @@ describe("/api/global/license", () => { const res = await config.api.license.activateOfflineLicense({ offlineLicenseToken: "offlineLicenseToken", }) - expect(licensing.offline.activateOfflineLicenseToken).toBeCalledWith( - "offlineLicenseToken" - ) + expect( + licensing.offline.activateOfflineLicenseToken + ).toHaveBeenCalledWith("offlineLicenseToken") expect(res.status).toBe(200) }) }) @@ -102,7 +104,9 @@ describe("/api/global/license", () => { it("returns 204", async () => { const res = await config.api.license.deleteOfflineLicense() expect(res.status).toBe(204) - expect(licensing.offline.deleteOfflineLicenseToken).toBeCalledTimes(1) + expect(licensing.offline.deleteOfflineLicenseToken).toHaveBeenCalledTimes( + 1 + ) }) }) diff --git a/packages/worker/src/api/routes/global/tests/realEmail.spec.ts b/packages/worker/src/api/routes/global/tests/realEmail.spec.ts index 544c2651dc..ee53f844f9 100644 --- a/packages/worker/src/api/routes/global/tests/realEmail.spec.ts +++ b/packages/worker/src/api/routes/global/tests/realEmail.spec.ts @@ -43,7 +43,6 @@ describe("/api/global/email", () => { } expect(res.body.message).toBeDefined() const testUrl = nodemailer.getTestMessageUrl(res.body) - console.log(`${purpose} URL: ${testUrl}`) expect(testUrl).toBeDefined() response = await fetch(testUrl) text = await response.text() diff --git a/packages/worker/src/api/routes/global/tests/scim.spec.ts b/packages/worker/src/api/routes/global/tests/scim.spec.ts index ae0abadc5d..85c70b7b63 100644 --- a/packages/worker/src/api/routes/global/tests/scim.spec.ts +++ b/packages/worker/src/api/routes/global/tests/scim.spec.ts @@ -2,6 +2,7 @@ import tk from "timekeeper" import _ from "lodash" import { generator, mocks, structures } from "@budibase/backend-core/tests" import { + CloudAccount, ScimCreateUserRequest, ScimGroupResponse, ScimUpdateRequest, @@ -10,25 +11,20 @@ import { import { TestConfiguration } from "../../../../tests" import { events } from "@budibase/backend-core" -// this test can 409 - retries reduce issues with this -jest.retryTimes(2, { logErrorsBeforeRetry: true }) jest.setTimeout(30000) describe("scim", () => { - beforeAll(async () => { - tk.freeze(mocks.date.MOCK_DATE) - mocks.licenses.useScimIntegration() - - await config.setSCIMConfig(true) - }) - - beforeEach(async () => { + async function setup() { jest.resetAllMocks() tk.freeze(mocks.date.MOCK_DATE) mocks.licenses.useScimIntegration() + mocks.licenses.useGroups() await config.setSCIMConfig(true) - }) + } + + beforeAll(setup) + beforeEach(setup) const config = new TestConfiguration() @@ -308,7 +304,7 @@ describe("scim", () => { await postScimUser({ body }) - expect(events.user.created).toBeCalledTimes(1) + expect(events.user.created).toHaveBeenCalledTimes(1) }) it("if the username is an email, the user name will be used as email", async () => { @@ -367,13 +363,77 @@ describe("scim", () => { }) }) - it("creating an existing user name returns a conflict", async () => { - const body = structures.scim.createUserRequest() + it("creating an external user that conflicts an internal one syncs the existing user", async () => { + const { body: internalUser } = await config.api.users.saveUser( + structures.users.user() + ) - await postScimUser({ body }) + const scimUserData = { + externalId: structures.uuid(), + email: internalUser.email, + firstName: structures.generator.first(), + lastName: structures.generator.last(), + username: structures.generator.name(), + } + const scimUserRequest = structures.scim.createUserRequest(scimUserData) - const res = await postScimUser({ body }, { expect: 409 }) - expect((res as any).message).toBe("Email already in use") + const res = await postScimUser( + { body: scimUserRequest }, + { expect: 200 } + ) + + const expectedScimUser: ScimUserResponse = { + schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"], + id: internalUser._id!, + externalId: scimUserRequest.externalId, + meta: { + resourceType: "User", + // @ts-ignore + created: mocks.date.MOCK_DATE.toISOString(), + // @ts-ignore + lastModified: mocks.date.MOCK_DATE.toISOString(), + }, + userName: scimUserData.username, + name: { + formatted: `${scimUserData.firstName} ${scimUserData.lastName}`, + familyName: scimUserData.lastName, + givenName: scimUserData.firstName, + }, + active: true, + emails: [ + { + value: internalUser.email, + type: "work", + primary: true, + }, + ], + } + + expect(res).toEqual(expectedScimUser) + }) + + it("a user cannot be SCIM synchronised with another SCIM user", async () => { + const { body: internalUser } = await config.api.users.saveUser( + structures.users.user() + ) + + await postScimUser( + { + body: structures.scim.createUserRequest({ + email: internalUser.email, + }), + }, + { expect: 200 } + ) + + await postScimUser( + { + body: structures.scim.createUserRequest({ + email: internalUser.email, + }), + }, + { expect: 409 } + ) }) }) @@ -511,7 +571,7 @@ describe("scim", () => { await patchScimUser({ id: user.id, body }) - expect(events.user.updated).toBeCalledTimes(1) + expect(events.user.updated).toHaveBeenCalledTimes(1) }) }) @@ -543,7 +603,26 @@ describe("scim", () => { it("an event is dispatched", async () => { await deleteScimUser(user.id, { expect: 204 }) - expect(events.user.deleted).toBeCalledTimes(1) + expect(events.user.deleted).toHaveBeenCalledTimes(1) + }) + + it("an account holder cannot be removed even when synched", async () => { + const account: CloudAccount = { + ...structures.accounts.account(), + budibaseUserId: user.id, + email: user.emails![0].value, + } + mocks.accounts.getAccount.mockResolvedValue(account) + + await deleteScimUser(user.id, { + expect: { + message: "Account holder cannot be deleted", + status: 400, + error: { code: "http" }, + }, + }) + + await config.api.scimUsersAPI.find(user.id, { expect: 200 }) }) }) }) @@ -625,6 +704,7 @@ describe("scim", () => { expect(response).toEqual({ Resources: expect.arrayContaining( groups.map(g => { + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { members, ...groupData } = g return groupData }) @@ -644,6 +724,7 @@ describe("scim", () => { expect(response).toEqual({ Resources: expect.arrayContaining( groups.map(g => { + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { members, displayName, ...groupData } = g return groupData }) @@ -656,7 +737,6 @@ describe("scim", () => { }) it("can fetch groups even if internal groups exist", async () => { - mocks.licenses.useGroups() await config.api.groups.saveGroup(structures.userGroups.userGroup()) await config.api.groups.saveGroup(structures.userGroups.userGroup()) @@ -722,6 +802,43 @@ describe("scim", () => { ) }) }) + + it("creating an external group that conflicts an internal one syncs the existing group", async () => { + const groupToSave = structures.userGroups.userGroup() + const { body: internalGroup } = await config.api.groups.saveGroup( + groupToSave + ) + + const scimGroupData = { + externalId: structures.uuid(), + displayName: groupToSave.name, + } + + const res = await postScimGroup( + { body: structures.scim.createGroupRequest(scimGroupData) }, + { expect: 200 } + ) + + expect(res).toEqual( + expect.objectContaining({ + id: internalGroup._id!, + externalId: scimGroupData.externalId, + displayName: scimGroupData.displayName, + }) + ) + }) + + it("a group cannot be SCIM synchronised with another SCIM group", async () => { + const groupToSave = structures.userGroups.userGroup() + await config.api.groups.saveGroup(groupToSave) + + const createGroupRequest = structures.scim.createGroupRequest({ + displayName: groupToSave.name, + }) + await postScimGroup({ body: createGroupRequest }, { expect: 200 }) + + await postScimGroup({ body: createGroupRequest }, { expect: 409 }) + }) }) describe("GET /api/global/scim/v2/groups/:id", () => { @@ -757,6 +874,7 @@ describe("scim", () => { qs: "excludedAttributes=members", }) + // eslint-disable-next-line @typescript-eslint/no-unused-vars const { members, ...expectedResponse } = group expect(response).toEqual(expectedResponse) diff --git a/packages/worker/src/api/routes/global/tests/self.spec.ts b/packages/worker/src/api/routes/global/tests/self.spec.ts index 274efb0aff..55eed0bca2 100644 --- a/packages/worker/src/api/routes/global/tests/self.spec.ts +++ b/packages/worker/src/api/routes/global/tests/self.spec.ts @@ -41,10 +41,10 @@ describe("/api/global/self", () => { user._rev = dbUser._rev user.dayPassRecordedAt = mocks.date.MOCK_DATE.toISOString() expect(res.body._id).toBe(user._id) - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.updated).toBeCalledWith(dbUser) - expect(events.user.passwordUpdated).toBeCalledTimes(1) - expect(events.user.passwordUpdated).toBeCalledWith(dbUser) + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.updated).toHaveBeenCalledWith(dbUser) + expect(events.user.passwordUpdated).toHaveBeenCalledTimes(1) + expect(events.user.passwordUpdated).toHaveBeenCalledWith(dbUser) }) }) diff --git a/packages/worker/src/api/routes/global/tests/users.spec.ts b/packages/worker/src/api/routes/global/tests/users.spec.ts index 744b0a5578..37f5721881 100644 --- a/packages/worker/src/api/routes/global/tests/users.spec.ts +++ b/packages/worker/src/api/routes/global/tests/users.spec.ts @@ -39,7 +39,7 @@ describe("/api/global/users", () => { expect(sendMailMock).toHaveBeenCalled() expect(code).toBeDefined() - expect(events.user.invited).toBeCalledTimes(1) + expect(events.user.invited).toHaveBeenCalledTimes(1) }) it("should not be able to generate an invitation for existing user", async () => { @@ -52,7 +52,7 @@ describe("/api/global/users", () => { expect(res.body.message).toBe(`Unavailable`) expect(sendMailMock).toHaveBeenCalledTimes(0) expect(code).toBeUndefined() - expect(events.user.invited).toBeCalledTimes(0) + expect(events.user.invited).toHaveBeenCalledTimes(0) }) it("should not invite the same user twice", async () => { @@ -70,7 +70,7 @@ describe("/api/global/users", () => { expect(res.body.message).toBe(`Unavailable`) expect(sendMailMock).toHaveBeenCalledTimes(0) expect(code).toBeUndefined() - expect(events.user.invited).toBeCalledTimes(0) + expect(events.user.invited).toHaveBeenCalledTimes(0) }) it("should be able to create new user from invite", async () => { @@ -86,8 +86,8 @@ describe("/api/global/users", () => { const user = await config.getUser(email) expect(user).toBeDefined() expect(user!._id).toEqual(res.body._id) - expect(events.user.inviteAccepted).toBeCalledTimes(1) - expect(events.user.inviteAccepted).toBeCalledWith(user) + expect(events.user.inviteAccepted).toHaveBeenCalledTimes(1) + expect(events.user.inviteAccepted).toHaveBeenCalledWith(user) }) }) @@ -105,7 +105,7 @@ describe("/api/global/users", () => { expect(body.successful.length).toBe(2) expect(body.unsuccessful.length).toBe(0) expect(sendMailMock).toHaveBeenCalledTimes(2) - expect(events.user.invited).toBeCalledTimes(2) + expect(events.user.invited).toHaveBeenCalledTimes(2) }) it("should not be able to generate an invitation for existing user", async () => { @@ -118,7 +118,7 @@ describe("/api/global/users", () => { expect(body.unsuccessful.length).toBe(1) expect(body.unsuccessful[0].reason).toBe("Unavailable") expect(sendMailMock).toHaveBeenCalledTimes(0) - expect(events.user.invited).toBeCalledTimes(0) + expect(events.user.invited).toHaveBeenCalledTimes(0) }) it("should not be able to generate an invitation for user that has already been invited", async () => { @@ -135,7 +135,7 @@ describe("/api/global/users", () => { expect(body.unsuccessful.length).toBe(1) expect(body.unsuccessful[0].reason).toBe("Unavailable") expect(sendMailMock).toHaveBeenCalledTimes(0) - expect(events.user.invited).toBeCalledTimes(0) + expect(events.user.invited).toHaveBeenCalledTimes(0) }) }) @@ -149,7 +149,7 @@ describe("/api/global/users", () => { expect(response.created?.successful.length).toBe(0) expect(response.created?.unsuccessful.length).toBe(1) expect(response.created?.unsuccessful[0].email).toBe(user.email) - expect(events.user.created).toBeCalledTimes(0) + expect(events.user.created).toHaveBeenCalledTimes(0) }) it("should ignore users existing in other tenants", async () => { @@ -162,7 +162,7 @@ describe("/api/global/users", () => { expect(response.created?.successful.length).toBe(0) expect(response.created?.unsuccessful.length).toBe(1) expect(response.created?.unsuccessful[0].email).toBe(user.email) - expect(events.user.created).toBeCalledTimes(0) + expect(events.user.created).toHaveBeenCalledTimes(0) }) }) @@ -177,7 +177,7 @@ describe("/api/global/users", () => { expect(response.created?.successful.length).toBe(0) expect(response.created?.unsuccessful.length).toBe(1) expect(response.created?.unsuccessful[0].email).toBe(user.email) - expect(events.user.created).toBeCalledTimes(0) + expect(events.user.created).toHaveBeenCalledTimes(0) }) it("should be able to bulk create users", async () => { @@ -196,9 +196,9 @@ describe("/api/global/users", () => { expect(response.created?.successful[1].email).toBe(admin.email) expect(response.created?.successful[2].email).toBe(user.email) expect(response.created?.unsuccessful.length).toBe(0) - expect(events.user.created).toBeCalledTimes(3) - expect(events.user.permissionAdminAssigned).toBeCalledTimes(1) - expect(events.user.permissionBuilderAssigned).toBeCalledTimes(2) + expect(events.user.created).toHaveBeenCalledTimes(3) + expect(events.user.permissionAdminAssigned).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderAssigned).toHaveBeenCalledTimes(2) }) }) @@ -208,10 +208,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) - expect(events.user.created).toBeCalledTimes(1) - expect(events.user.updated).not.toBeCalled() - expect(events.user.permissionBuilderAssigned).not.toBeCalled() - expect(events.user.permissionAdminAssigned).not.toBeCalled() + expect(events.user.created).toHaveBeenCalledTimes(1) + expect(events.user.updated).not.toHaveBeenCalled() + expect(events.user.permissionBuilderAssigned).not.toHaveBeenCalled() + expect(events.user.permissionAdminAssigned).not.toHaveBeenCalled() }) it("should be able to create an admin user", async () => { @@ -219,10 +219,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) - expect(events.user.created).toBeCalledTimes(1) - expect(events.user.updated).not.toBeCalled() - expect(events.user.permissionBuilderAssigned).toBeCalledTimes(1) - expect(events.user.permissionAdminAssigned).toBeCalledTimes(1) + expect(events.user.created).toHaveBeenCalledTimes(1) + expect(events.user.updated).not.toHaveBeenCalled() + expect(events.user.permissionBuilderAssigned).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminAssigned).toHaveBeenCalledTimes(1) }) it("should be able to create a builder user", async () => { @@ -230,10 +230,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) - expect(events.user.created).toBeCalledTimes(1) - expect(events.user.updated).not.toBeCalled() - expect(events.user.permissionBuilderAssigned).toBeCalledTimes(1) - expect(events.user.permissionAdminAssigned).not.toBeCalled() + expect(events.user.created).toHaveBeenCalledTimes(1) + expect(events.user.updated).not.toHaveBeenCalled() + expect(events.user.permissionBuilderAssigned).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminAssigned).not.toHaveBeenCalled() }) it("should be able to assign app roles", async () => { @@ -246,11 +246,11 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) const savedUser = await config.getUser(user.email) - expect(events.user.created).toBeCalledTimes(1) - expect(events.user.updated).not.toBeCalled() - expect(events.role.assigned).toBeCalledTimes(2) - expect(events.role.assigned).toBeCalledWith(savedUser, "role1") - expect(events.role.assigned).toBeCalledWith(savedUser, "role2") + expect(events.user.created).toHaveBeenCalledTimes(1) + expect(events.user.updated).not.toHaveBeenCalled() + expect(events.role.assigned).toHaveBeenCalledTimes(2) + expect(events.role.assigned).toHaveBeenCalledWith(savedUser, "role1") + expect(events.role.assigned).toHaveBeenCalledWith(savedUser, "role2") }) it("should not be able to create user that exists in same tenant", async () => { @@ -264,7 +264,7 @@ describe("/api/global/users", () => { expect(response.body.message).toBe( `Email already in use: '${user.email}'` ) - expect(events.user.created).toBeCalledTimes(0) + expect(events.user.created).toHaveBeenCalledTimes(0) }) it("should not be able to create user that exists in other tenant", async () => { @@ -278,7 +278,7 @@ describe("/api/global/users", () => { expect(response.body.message).toBe( `Email already in use: '${user.email}'` ) - expect(events.user.created).toBeCalledTimes(0) + expect(events.user.created).toHaveBeenCalledTimes(0) }) }) @@ -292,7 +292,7 @@ describe("/api/global/users", () => { expect(response.body.message).toBe( `Email already in use: '${user.email}'` ) - expect(events.user.created).toBeCalledTimes(0) + expect(events.user.created).toHaveBeenCalledTimes(0) }) it("should not be able to create a user with the same email and different casing", async () => { @@ -302,7 +302,7 @@ describe("/api/global/users", () => { user.email = user.email.toUpperCase() await config.api.users.saveUser(user, 400) - expect(events.user.created).toBeCalledTimes(1) + expect(events.user.created).toHaveBeenCalledTimes(1) }) it("should not be able to bulk create a user with the same email and different casing", async () => { @@ -312,7 +312,7 @@ describe("/api/global/users", () => { user.email = user.email.toUpperCase() await config.api.users.bulkCreateUsers([user]) - expect(events.user.created).toBeCalledTimes(1) + expect(events.user.created).toHaveBeenCalledTimes(1) }) it("should not allow a non-admin user to create a new user", async () => { @@ -335,11 +335,11 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.permissionBuilderAssigned).not.toBeCalled() - expect(events.user.permissionAdminAssigned).not.toBeCalled() - expect(events.user.passwordForceReset).not.toBeCalled() + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderAssigned).not.toHaveBeenCalled() + expect(events.user.permissionAdminAssigned).not.toHaveBeenCalled() + expect(events.user.passwordForceReset).not.toHaveBeenCalled() }) it("should not allow a user to update their own admin/builder status", async () => { @@ -367,11 +367,11 @@ describe("/api/global/users", () => { user.password = "tempPassword" await config.api.users.saveUser(user) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.permissionBuilderAssigned).not.toBeCalled() - expect(events.user.permissionAdminAssigned).not.toBeCalled() - expect(events.user.passwordForceReset).toBeCalledTimes(1) + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderAssigned).not.toHaveBeenCalled() + expect(events.user.permissionAdminAssigned).not.toHaveBeenCalled() + expect(events.user.passwordForceReset).toHaveBeenCalledTimes(1) }) it("should be able to update a basic user to an admin user", async () => { @@ -380,10 +380,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(structures.users.adminUser(user)) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.permissionBuilderAssigned).toBeCalledTimes(1) - expect(events.user.permissionAdminAssigned).toBeCalledTimes(1) + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderAssigned).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminAssigned).toHaveBeenCalledTimes(1) }) it("should be able to update a basic user to a builder user", async () => { @@ -392,10 +392,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(structures.users.builderUser(user)) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.permissionBuilderAssigned).toBeCalledTimes(1) - expect(events.user.permissionAdminAssigned).not.toBeCalled() + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderAssigned).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminAssigned).not.toHaveBeenCalled() }) it("should be able to update an admin user to a basic user", async () => { @@ -406,10 +406,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.permissionAdminRemoved).toBeCalledTimes(1) - expect(events.user.permissionBuilderRemoved).toBeCalledTimes(1) + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminRemoved).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderRemoved).toHaveBeenCalledTimes(1) }) it("should be able to update an builder user to a basic user", async () => { @@ -419,10 +419,10 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.user.permissionBuilderRemoved).toBeCalledTimes(1) - expect(events.user.permissionAdminRemoved).not.toBeCalled() + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderRemoved).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminRemoved).not.toHaveBeenCalled() }) it("should be able to assign app roles", async () => { @@ -436,11 +436,11 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) const savedUser = await config.getUser(user.email) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.role.assigned).toBeCalledTimes(2) - expect(events.role.assigned).toBeCalledWith(savedUser, "role1") - expect(events.role.assigned).toBeCalledWith(savedUser, "role2") + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.role.assigned).toHaveBeenCalledTimes(2) + expect(events.role.assigned).toHaveBeenCalledWith(savedUser, "role1") + expect(events.role.assigned).toHaveBeenCalledWith(savedUser, "role2") }) it("should be able to unassign app roles", async () => { @@ -456,11 +456,11 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) const savedUser = await config.getUser(user.email) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.role.unassigned).toBeCalledTimes(2) - expect(events.role.unassigned).toBeCalledWith(savedUser, "role1") - expect(events.role.unassigned).toBeCalledWith(savedUser, "role2") + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.role.unassigned).toHaveBeenCalledTimes(2) + expect(events.role.unassigned).toHaveBeenCalledWith(savedUser, "role1") + expect(events.role.unassigned).toHaveBeenCalledWith(savedUser, "role2") }) it("should be able to update existing app roles", async () => { @@ -479,12 +479,12 @@ describe("/api/global/users", () => { await config.api.users.saveUser(user) const savedUser = await config.getUser(user.email) - expect(events.user.created).not.toBeCalled() - expect(events.user.updated).toBeCalledTimes(1) - expect(events.role.unassigned).toBeCalledTimes(1) - expect(events.role.unassigned).toBeCalledWith(savedUser, "role2") - expect(events.role.assigned).toBeCalledTimes(1) - expect(events.role.assigned).toBeCalledWith(savedUser, "role2-edit") + expect(events.user.created).not.toHaveBeenCalled() + expect(events.user.updated).toHaveBeenCalledTimes(1) + expect(events.role.unassigned).toHaveBeenCalledTimes(1) + expect(events.role.unassigned).toHaveBeenCalledWith(savedUser, "role2") + expect(events.role.assigned).toHaveBeenCalledTimes(1) + expect(events.role.assigned).toHaveBeenCalledWith(savedUser, "role2-edit") }) it("should not be able to update email address", async () => { @@ -534,7 +534,7 @@ describe("/api/global/users", () => { const response = await config.api.users.bulkDeleteUsers([user._id!], 400) expect(response.message).toBe("Unable to delete self.") - expect(events.user.deleted).not.toBeCalled() + expect(events.user.deleted).not.toHaveBeenCalled() }) it("should not be able to bulk delete account owner", async () => { @@ -551,7 +551,7 @@ describe("/api/global/users", () => { "Account holder cannot be deleted" ) expect(response.deleted?.unsuccessful[0]._id).toBe(user._id) - expect(events.user.deleted).not.toBeCalled() + expect(events.user.deleted).not.toHaveBeenCalled() }) it("should be able to bulk delete users", async () => { @@ -574,9 +574,9 @@ describe("/api/global/users", () => { expect(response.deleted?.successful.length).toBe(3) expect(response.deleted?.unsuccessful.length).toBe(0) - expect(events.user.deleted).toBeCalledTimes(3) - expect(events.user.permissionAdminRemoved).toBeCalledTimes(1) - expect(events.user.permissionBuilderRemoved).toBeCalledTimes(2) + expect(events.user.deleted).toHaveBeenCalledTimes(3) + expect(events.user.permissionAdminRemoved).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderRemoved).toHaveBeenCalledTimes(2) }) }) @@ -669,9 +669,9 @@ describe("/api/global/users", () => { await config.api.users.deleteUser(user._id!) - expect(events.user.deleted).toBeCalledTimes(1) - expect(events.user.permissionBuilderRemoved).not.toBeCalled() - expect(events.user.permissionAdminRemoved).not.toBeCalled() + expect(events.user.deleted).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderRemoved).not.toHaveBeenCalled() + expect(events.user.permissionAdminRemoved).not.toHaveBeenCalled() }) it("should be able to destroy an admin user", async () => { @@ -680,9 +680,9 @@ describe("/api/global/users", () => { await config.api.users.deleteUser(user._id!) - expect(events.user.deleted).toBeCalledTimes(1) - expect(events.user.permissionBuilderRemoved).toBeCalledTimes(1) - expect(events.user.permissionAdminRemoved).toBeCalledTimes(1) + expect(events.user.deleted).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderRemoved).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminRemoved).toHaveBeenCalledTimes(1) }) it("should be able to destroy a builder user", async () => { @@ -691,9 +691,9 @@ describe("/api/global/users", () => { await config.api.users.deleteUser(user._id!) - expect(events.user.deleted).toBeCalledTimes(1) - expect(events.user.permissionBuilderRemoved).toBeCalledTimes(1) - expect(events.user.permissionAdminRemoved).not.toBeCalled() + expect(events.user.deleted).toHaveBeenCalledTimes(1) + expect(events.user.permissionBuilderRemoved).toHaveBeenCalledTimes(1) + expect(events.user.permissionAdminRemoved).not.toHaveBeenCalled() }) it("should not be able to destroy account owner", async () => { diff --git a/packages/worker/src/api/routes/global/tests/workspaces.spec.ts b/packages/worker/src/api/routes/global/tests/workspaces.spec.ts deleted file mode 100644 index 1a30c6525c..0000000000 --- a/packages/worker/src/api/routes/global/tests/workspaces.spec.ts +++ /dev/null @@ -1,29 +0,0 @@ -import { TestConfiguration } from "../../../../tests" - -// TODO - -describe("/api/global/workspaces", () => { - const config = new TestConfiguration() - - beforeAll(async () => { - await config.beforeAll() - }) - - afterAll(async () => { - await config.afterAll() - }) - - afterEach(() => { - jest.clearAllMocks() - }) - - describe("GET /api/global/workspaces", () => { - it("retrieves workspaces", () => {}) - }) - - describe("DELETE /api/global/workspaces/:id", () => {}) - - describe("GET /api/global/workspaces", () => {}) - - describe("GET /api/global/workspaces/:id", () => {}) -}) diff --git a/packages/worker/src/api/routes/system/tests/environment.spec.ts b/packages/worker/src/api/routes/system/tests/environment.spec.ts index 2efbfa07c9..dbe9be7374 100644 --- a/packages/worker/src/api/routes/system/tests/environment.spec.ts +++ b/packages/worker/src/api/routes/system/tests/environment.spec.ts @@ -27,6 +27,7 @@ describe("/api/system/environment", () => { multiTenancy: true, baseUrl: "http://localhost:10000", offlineMode: false, + maintenance: [], }) }) @@ -40,9 +41,7 @@ describe("/api/system/environment", () => { multiTenancy: true, baseUrl: "http://localhost:10000", offlineMode: false, - infrastructure: { - sqs: false, - }, + maintenance: [], }) }) }) diff --git a/packages/worker/src/api/routes/system/tests/migrations.spec.ts b/packages/worker/src/api/routes/system/tests/migrations.spec.ts index 950f5c2153..4198d65ee9 100644 --- a/packages/worker/src/api/routes/system/tests/migrations.spec.ts +++ b/packages/worker/src/api/routes/system/tests/migrations.spec.ts @@ -31,13 +31,13 @@ describe("/api/system/migrations", () => { status: 403, }) expect(res.body).toEqual({ message: "Unauthorized", status: 403 }) - expect(migrateFn).toBeCalledTimes(0) + expect(migrateFn).toHaveBeenCalledTimes(0) }) it("runs migrations", async () => { const res = await config.api.migrations.runMigrations() expect(res.text).toBe("OK") - expect(migrateFn).toBeCalledTimes(1) + expect(migrateFn).toHaveBeenCalledTimes(1) }) }) diff --git a/packages/worker/src/api/routes/system/tests/status.spec.ts b/packages/worker/src/api/routes/system/tests/status.spec.ts index e2011dc79a..71e01a0e72 100644 --- a/packages/worker/src/api/routes/system/tests/status.spec.ts +++ b/packages/worker/src/api/routes/system/tests/status.spec.ts @@ -28,7 +28,7 @@ describe("/api/system/status", () => { passing: true, }, }) - expect(accounts.getStatus).toBeCalledTimes(0) + expect(accounts.getStatus).toHaveBeenCalledTimes(0) config.cloudHosted() }) @@ -45,7 +45,7 @@ describe("/api/system/status", () => { const res = await config.api.status.getStatus() - expect(accounts.getStatus).toBeCalledTimes(1) + expect(accounts.getStatus).toHaveBeenCalledTimes(1) expect(res.body).toEqual(value) }) }) diff --git a/packages/worker/src/api/routes/validation/users.ts b/packages/worker/src/api/routes/validation/users.ts index dfc1e6fbbf..fbc85af2d3 100644 --- a/packages/worker/src/api/routes/validation/users.ts +++ b/packages/worker/src/api/routes/validation/users.ts @@ -26,6 +26,8 @@ export const buildSelfSaveValidation = () => { firstName: OPTIONAL_STRING, lastName: OPTIONAL_STRING, onboardedAt: Joi.string().optional(), + appFavourites: Joi.array().optional(), + tours: Joi.object().optional(), } return auth.joiValidator.body(Joi.object(schema).required().unknown(false)) } diff --git a/packages/worker/src/constants/index.ts b/packages/worker/src/constants/index.ts index 4301569a3a..17fce666db 100644 --- a/packages/worker/src/constants/index.ts +++ b/packages/worker/src/constants/index.ts @@ -52,7 +52,7 @@ export enum InternalTemplateBinding { RESET_URL = "resetUrl", RESET_CODE = "resetCode", INVITE_URL = "inviteUrl", - INVITE_CODE = "inviteUrl", + INVITE_CODE = "inviteCode", CONTENTS = "contents", } diff --git a/packages/worker/src/features.ts b/packages/worker/src/features.ts index 075b3b81ca..33fce3aebe 100644 --- a/packages/worker/src/features.ts +++ b/packages/worker/src/features.ts @@ -1,6 +1,7 @@ import { features } from "@budibase/backend-core" import env from "./environment" +// eslint-disable-next-line no-unused-vars enum WorkerFeature {} const featureList: WorkerFeature[] = features.processFeatureEnvVar( diff --git a/packages/worker/src/index.ts b/packages/worker/src/index.ts index 3da9a42065..4e770c6ecb 100644 --- a/packages/worker/src/index.ts +++ b/packages/worker/src/index.ts @@ -17,6 +17,7 @@ import { env as coreEnv, timers, redis, + cache, } from "@budibase/backend-core" db.init() @@ -90,6 +91,7 @@ export default server.listen(parseInt(env.PORT || "4002"), async () => { console.log(`Worker running on ${JSON.stringify(server.address())}`) await initPro() await redis.clients.init() + cache.docWritethrough.init() // configure events to use the pro audit log write // can't integrate directly into backend-core due to cyclic issues await events.processors.init(proSdk.auditLogs.write) diff --git a/packages/worker/src/initPro.ts b/packages/worker/src/initPro.ts index ddc8d2562a..b34d514992 100644 --- a/packages/worker/src/initPro.ts +++ b/packages/worker/src/initPro.ts @@ -1,5 +1,4 @@ import { sdk as proSdk } from "@budibase/pro" -import * as userSdk from "./sdk/users" export const initPro = async () => { await proSdk.init({}) diff --git a/packages/worker/src/migrations/functions/globalInfoSyncUsers.ts b/packages/worker/src/migrations/functions/globalInfoSyncUsers.ts index 4bb864a000..f09a01b449 100644 --- a/packages/worker/src/migrations/functions/globalInfoSyncUsers.ts +++ b/packages/worker/src/migrations/functions/globalInfoSyncUsers.ts @@ -9,7 +9,7 @@ import { platform } from "@budibase/backend-core" * Description: * Re-sync the global-db users to the global-info db users */ -export const run = async (globalDb: any) => { +export const run = async () => { const users = (await usersSdk.db.allUsers()) as User[] const promises = [] for (let user of users) { diff --git a/packages/worker/src/sdk/auth/tests/auth.spec.ts b/packages/worker/src/sdk/auth/tests/auth.spec.ts index e9f348f7c7..894a3e6eca 100644 --- a/packages/worker/src/sdk/auth/tests/auth.spec.ts +++ b/packages/worker/src/sdk/auth/tests/auth.spec.ts @@ -6,6 +6,8 @@ import { TestConfiguration } from "../../../tests" describe("auth", () => { const config = new TestConfiguration() + afterAll(config.afterAll) + describe("resetUpdate", () => { it("providing a valid code will update the password", async () => { await context.doInTenant(structures.tenant.id(), async () => { diff --git a/packages/worker/src/tests/TestConfiguration.ts b/packages/worker/src/tests/TestConfiguration.ts index 3ebfb5f020..e44e9e2923 100644 --- a/packages/worker/src/tests/TestConfiguration.ts +++ b/packages/worker/src/tests/TestConfiguration.ts @@ -19,7 +19,6 @@ import { users, context, sessions, - auth, constants, env as coreEnv, db as dbCore, diff --git a/packages/worker/src/tests/api/groups.ts b/packages/worker/src/tests/api/groups.ts index 0b9081cc92..5153c19db0 100644 --- a/packages/worker/src/tests/api/groups.ts +++ b/packages/worker/src/tests/api/groups.ts @@ -7,7 +7,10 @@ export class GroupsAPI extends TestAPI { super(config) } - saveGroup = (group: UserGroup, { expect } = { expect: 200 }) => { + saveGroup = ( + group: UserGroup, + { expect }: { expect: number | object } = { expect: 200 } + ) => { return this.request .post(`/api/global/groups`) .send(group) @@ -44,14 +47,15 @@ export class GroupsAPI extends TestAPI { updateGroupUsers = ( id: string, - body: { add: string[]; remove: string[] } + body: { add: string[]; remove: string[] }, + { expect } = { expect: 200 } ) => { return this.request .post(`/api/global/groups/${id}/users`) .send(body) .set(this.config.defaultHeaders()) .expect("Content-Type", /json/) - .expect(200) + .expect(expect) } fetch = ({ expect } = { expect: 200 }) => { @@ -61,4 +65,12 @@ export class GroupsAPI extends TestAPI { .expect("Content-Type", /json/) .expect(expect) } + + find = (id: string, { expect } = { expect: 200 }) => { + return this.request + .get(`/api/global/groups/${id}`) + .set(this.config.defaultHeaders()) + .expect("Content-Type", /json/) + .expect(expect) + } } diff --git a/packages/worker/src/tests/api/scim/shared.ts b/packages/worker/src/tests/api/scim/shared.ts index 1b064b8f41..546a940093 100644 --- a/packages/worker/src/tests/api/scim/shared.ts +++ b/packages/worker/src/tests/api/scim/shared.ts @@ -1,13 +1,17 @@ import TestConfiguration from "../../TestConfiguration" import { TestAPI } from "../base" -const defaultConfig = { +const defaultConfig: RequestSettings = { expect: 200, setHeaders: true, skipContentTypeCheck: false, } -export type RequestSettings = typeof defaultConfig +export type RequestSettings = { + expect: number | object + setHeaders: boolean + skipContentTypeCheck: boolean +} export abstract class ScimTestAPI extends TestAPI { constructor(config: TestConfiguration) { diff --git a/packages/worker/src/tests/structures/groups.ts b/packages/worker/src/tests/structures/groups.ts index d39dd74eb8..2ce6545b23 100644 --- a/packages/worker/src/tests/structures/groups.ts +++ b/packages/worker/src/tests/structures/groups.ts @@ -5,7 +5,7 @@ import { UserGroup as UserGroupType, UserGroupRoles } from "@budibase/types" export function UserGroup(): UserGroupType { const appsCount = generator.integer({ min: 0, max: 3 }) const roles = Array.from({ length: appsCount }).reduce( - (p: UserGroupRoles, v) => { + (p: UserGroupRoles) => { return { ...p, [db.generateAppID()]: generator.pickone(["ADMIN", "POWER", "BASIC"]), diff --git a/packages/worker/src/utilities/templates.ts b/packages/worker/src/utilities/templates.ts index 13fc5ef0cf..c9e86ae4f9 100644 --- a/packages/worker/src/utilities/templates.ts +++ b/packages/worker/src/utilities/templates.ts @@ -1,12 +1,10 @@ import { tenancy, configs } from "@budibase/backend-core" -import { SettingsInnerConfig } from "@budibase/types" import { InternalTemplateBinding, LOGO_URL, EmailTemplatePurpose, } from "../constants" import { checkSlashesInUrl } from "./index" -import { getLicensedConfig } from "./configs" const BASE_COMPANY = "Budibase" import * as pro from "@budibase/pro" diff --git a/packages/worker/tsconfig.build.json b/packages/worker/tsconfig.build.json index bc477abe4d..f38f31fe67 100644 --- a/packages/worker/tsconfig.build.json +++ b/packages/worker/tsconfig.build.json @@ -16,7 +16,8 @@ "@budibase/backend-core": ["../backend-core/src"], "@budibase/backend-core/*": ["../backend-core/*"], "@budibase/shared-core": ["../shared-core/src"], - "@budibase/pro": ["../pro/src"] + "@budibase/pro": ["../pro/src"], + "@budibase/string-templates": ["../string-templates/src"] } }, "include": ["src/**/*"], diff --git a/qa-core/src/account-api/tests/accounts/accounts.cloud.spec.ts b/qa-core/src/account-api/tests/accounts/accounts.cloud.spec.ts index 0969b72cf9..01338b609c 100644 --- a/qa-core/src/account-api/tests/accounts/accounts.cloud.spec.ts +++ b/qa-core/src/account-api/tests/accounts/accounts.cloud.spec.ts @@ -84,7 +84,7 @@ describe("Accounts", () => { }) it("searches by email", async () => { - const email = generator.email() + const email = generator.email({ domain: "example.com" }) // Empty result const [_, emptyBody] = await config.api.accounts.search(email, "email") diff --git a/qa-core/src/account-api/tests/licensing/offline.spec.ts b/qa-core/src/account-api/tests/licensing/offline.spec.ts index 8374677bd6..e524048153 100644 --- a/qa-core/src/account-api/tests/licensing/offline.spec.ts +++ b/qa-core/src/account-api/tests/licensing/offline.spec.ts @@ -15,7 +15,7 @@ describe("offline", () => { // TODO: Currently requires a self host install + account portal // Ignored until we set this up - xit("creates, activates and deletes offline license", async () => { + it.skip("creates, activates and deletes offline license", async () => { // installation: Delete any token await config.internalApi.license.deleteOfflineLicenseToken() diff --git a/qa-core/src/integrations/external-schema/mysql.integration.spec.ts b/qa-core/src/integrations/external-schema/mysql.integration.spec.ts index c34651ea0e..5a7e1989d2 100644 --- a/qa-core/src/integrations/external-schema/mysql.integration.spec.ts +++ b/qa-core/src/integrations/external-schema/mysql.integration.spec.ts @@ -1,8 +1,6 @@ import { GenericContainer } from "testcontainers" import mysql from "../../../../packages/server/src/integrations/mysql" -jest.unmock("mysql2/promise") - describe("datasource validators", () => { describe("mysql", () => { let config: any diff --git a/qa-core/src/integrations/validators/mysql.integration.spec.ts b/qa-core/src/integrations/validators/mysql.integration.spec.ts index 0f0de132fe..e828d192af 100644 --- a/qa-core/src/integrations/validators/mysql.integration.spec.ts +++ b/qa-core/src/integrations/validators/mysql.integration.spec.ts @@ -1,8 +1,6 @@ import { GenericContainer } from "testcontainers" import mysql from "../../../../packages/server/src/integrations/mysql" -jest.unmock("mysql2/promise") - describe("datasource validators", () => { describe("mysql", () => { let host: string diff --git a/qa-core/src/internal-api/tests/dataSources/mongoDB.integration.spec.ts b/qa-core/src/internal-api/tests/dataSources/mongoDB.integration.spec.ts index ace9ef32c5..efa9eb2dd2 100644 --- a/qa-core/src/internal-api/tests/dataSources/mongoDB.integration.spec.ts +++ b/qa-core/src/internal-api/tests/dataSources/mongoDB.integration.spec.ts @@ -2,7 +2,7 @@ import TestConfiguration from "../../config/TestConfiguration" import * as fixtures from "../../fixtures" import { Query } from "@budibase/types" -xdescribe("Internal API - Data Sources: MongoDB", () => { +describe.skip("Internal API - Data Sources: MongoDB", () => { const config = new TestConfiguration() beforeAll(async () => { diff --git a/qa-core/src/public-api/fixtures/users.ts b/qa-core/src/public-api/fixtures/users.ts index e20c464b34..418b565d2a 100644 --- a/qa-core/src/public-api/fixtures/users.ts +++ b/qa-core/src/public-api/fixtures/users.ts @@ -4,7 +4,7 @@ import { generator } from "../../shared" export const generateUser = ( overrides: Partial = {} ): CreateUserParams => ({ - email: generator.email(), + email: generator.email({ domain: "example.com" }), roles: { [generator.string({ length: 32, alpha: true, numeric: true })]: generator.word(), diff --git a/qa-core/yarn.lock b/qa-core/yarn.lock index 9b7a9c6c05..0eba6dd4d7 100644 --- a/qa-core/yarn.lock +++ b/qa-core/yarn.lock @@ -2062,9 +2062,9 @@ find-up@^4.0.0, find-up@^4.1.0: path-exists "^4.0.0" follow-redirects@^1.14.0, follow-redirects@^1.14.4, follow-redirects@^1.15.0: - version "1.15.2" - resolved "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz" - integrity sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA== + version "1.15.6" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.6.tgz#7f815c0cda4249c74ff09e95ef97c23b5fd0399b" + integrity sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA== forever-agent@~0.6.1: version "0.6.1" diff --git a/yarn.lock b/yarn.lock index 260ae3870a..601bbf4641 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1988,7 +1988,7 @@ resolved "https://registry.yarnpkg.com/@babel/regjsgen/-/regjsgen-0.8.0.tgz#f0ba69b075e1f05fb2825b7fad991e7adbb18310" integrity sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA== -"@babel/runtime@^7.10.5", "@babel/runtime@^7.13.10", "@babel/runtime@^7.21.0": +"@babel/runtime@^7.10.5", "@babel/runtime@^7.13.10": version "7.23.9" resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.23.9.tgz#47791a15e4603bb5f905bc0753801cf21d6345f7" integrity sha512-0CX6F+BI2s9dkUqr08KFrAIZgNFj75rdBU/DjCyYLIaV/quFjkk6T+EJ2LkZHyZTbEV4L5p97mNkUsHl2wLFAw== @@ -2526,14 +2526,14 @@ resolved "https://registry.yarnpkg.com/@esbuild/win32-x64/-/win32-x64-0.18.20.tgz#786c5f41f043b07afb1af37683d7c33668858f6d" integrity sha512-kTdfRcSiDfQca/y9QIkng02avJ+NCaQvrMejlsB3RRv5sE9rRoeBPISaZpKxHELzRxZyLvNts1P27W3wV+8geQ== -"@eslint-community/eslint-utils@^4.2.0": +"@eslint-community/eslint-utils@^4.2.0", "@eslint-community/eslint-utils@^4.4.0": version "4.4.0" resolved "https://registry.yarnpkg.com/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz#a23514e8fb9af1269d5f7788aa556798d61c6b59" integrity sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA== dependencies: eslint-visitor-keys "^3.3.0" -"@eslint-community/regexpp@^4.6.1": +"@eslint-community/regexpp@^4.5.1", "@eslint-community/regexpp@^4.6.1": version "4.10.0" resolved "https://registry.yarnpkg.com/@eslint-community/regexpp/-/regexpp-4.10.0.tgz#548f6de556857c8bb73bbee70c35dc82a2e74d63" integrity sha512-Cu96Sd2By9mCNTx2iyKOmq10v22jUVQv0lQnlGNy16oE9589yE+QADPbrMGCkA51cKZSg3Pu/aTJVTGfL/qjUA== @@ -3922,7 +3922,7 @@ "@rollup/pluginutils" "^5.0.1" mini-svg-data-uri "^1.4.4" -"@rollup/plugin-inject@^5.0.4": +"@rollup/plugin-inject@^5.0.4", "@rollup/plugin-inject@^5.0.5": version "5.0.5" resolved "https://registry.yarnpkg.com/@rollup/plugin-inject/-/plugin-inject-5.0.5.tgz#616f3a73fe075765f91c5bec90176608bed277a3" integrity sha512-2+DEJbNBoPROPkgTDNe8/1YXWcqxbN5DTjASVIOx8HS+pITXushyNiBV56RB08zuptzz8gT3YfkqriTBVycepg== @@ -5303,10 +5303,10 @@ dependencies: "@types/node" "*" -"@types/dockerode@^3.3.21": - version "3.3.23" - resolved "https://registry.yarnpkg.com/@types/dockerode/-/dockerode-3.3.23.tgz#07b2084013d01e14d5d97856446f4d9c9f27c223" - integrity sha512-Lz5J+NFgZS4cEVhquwjIGH4oQwlVn2h7LXD3boitujBnzOE5o7s9H8hchEjoDK2SlRsJTogdKnQeiJgPPKLIEw== +"@types/dockerode@^3.3.24": + version "3.3.24" + resolved "https://registry.yarnpkg.com/@types/dockerode/-/dockerode-3.3.24.tgz#bea354a4fcd0824a80fd5ea5ede3e8cda71137a7" + integrity sha512-679y69OYusf7Fr2HtdjXPUF6hnHxSA9K4EsuagsMuPno/XpJHjXxCOy2I5YL8POnWbzjsQAi0pyKIYM9HSpQog== dependencies: "@types/docker-modem" "*" "@types/node" "*" @@ -5408,7 +5408,7 @@ resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.1.tgz#20172f9578b225f6c7da63446f56d4ce108d5a65" integrity sha512-/K3ds8TRAfBvi5vfjuz8y6+GiAYBZ0x4tXv1Av6CWBWn0IlADc+ZX9pMq7oU0fNQPnBwIZl3rmeLp6SBApbxSQ== -"@types/ioredis@4.28.10": +"@types/ioredis@4.28.10", "@types/ioredis@^4.28.10": version "4.28.10" resolved "https://registry.yarnpkg.com/@types/ioredis/-/ioredis-4.28.10.tgz#40ceb157a4141088d1394bb87c98ed09a75a06ff" integrity sha512-69LyhUgrXdgcNDv7ogs1qXZomnfOEnSmrmMFqKgt1XMJxmoOSG/u3wYy13yACIfKuMJ8IhKgHafDO3sx19zVQQ== @@ -5447,6 +5447,11 @@ resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3" integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ== +"@types/json-schema@^7.0.12", "@types/json-schema@^7.0.9": + version "7.0.15" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" + integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== + "@types/json5@^0.0.29": version "0.0.29" resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee" @@ -5666,6 +5671,13 @@ dependencies: undici-types "~5.26.4" +"@types/node@^20.4.5": + version "20.11.25" + resolved "https://registry.yarnpkg.com/@types/node/-/node-20.11.25.tgz#0f50d62f274e54dd7a49f7704cc16bfbcccaf49f" + integrity sha512-TBHyJxk2b7HceLVGFcpAUjsa5zIdsPWlR6XHfyGzd0SFu+/NFgQgMAl96MSDZgQDvJAvV6BKsFOrt6zIL09JDw== + dependencies: + undici-types "~5.26.4" + "@types/nodemailer@^6.4.4": version "6.4.14" resolved "https://registry.yarnpkg.com/@types/nodemailer/-/nodemailer-6.4.14.tgz#5c81a5e856db7f8ede80013e6dbad7c5fb2283e2" @@ -5896,12 +5908,13 @@ dependencies: "@types/node" "*" -"@types/redlock@4.0.3": - version "4.0.3" - resolved "https://registry.yarnpkg.com/@types/redlock/-/redlock-4.0.3.tgz#aeab5fe5f0d433a125f6dcf9a884372ac0cddd4b" - integrity sha512-mcvvrquwREbAqyZALNBIlf49AL9Aa324BG+J/Dv4TAP8g+nxQMBI4/APNqqS99QEY7VTNT9XvsaczCVGK8uNnQ== +"@types/redlock@4.0.7": + version "4.0.7" + resolved "https://registry.yarnpkg.com/@types/redlock/-/redlock-4.0.7.tgz#33ed56f22a38d6b2f2e6ae5ed1b3fc1875a08e6b" + integrity sha512-5D6egBv0fCfdbmnCETjEynVuiwFMEFFc3YFjh9EwhaaVTAi0YmB6UI1swq1S1rjIu+n27ppmlTFDK3D3cadJqg== dependencies: "@types/bluebird" "*" + "@types/ioredis" "^4.28.10" "@types/redis" "^2.8.0" "@types/request@^2.48.7": @@ -5953,6 +5966,11 @@ resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.3.7.tgz#b9eb89d7dfa70d5d1ce525bc1411a35347f533a3" integrity sha512-4g1jrL98mdOIwSOUh6LTlB0Cs9I0dQPwINUhBg7C6pN4HLr8GS8xsksJxilW6S6dQHVi2K/o+lQuQcg7LroCnw== +"@types/semver@^7.3.12", "@types/semver@^7.5.0": + version "7.5.8" + resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.5.8.tgz#8268a8c57a3e4abd25c165ecd36237db7948a55e" + integrity sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ== + "@types/serve-static@*": version "1.15.1" resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-1.15.1.tgz#86b1753f0be4f9a1bee68d459fcda5be4ea52b5d" @@ -6114,6 +6132,23 @@ dependencies: "@types/yargs-parser" "*" +"@typescript-eslint/eslint-plugin@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.3.1.tgz#0d8f38a6c8a1802139e62184ee7a68ed024f30a1" + integrity sha512-STEDMVQGww5lhCuNXVSQfbfuNII5E08QWkvAw5Qwf+bj2WT+JkG1uc+5/vXA3AOYMDHVOSpL+9rcbEUiHIm2dw== + dependencies: + "@eslint-community/regexpp" "^4.5.1" + "@typescript-eslint/scope-manager" "7.3.1" + "@typescript-eslint/type-utils" "7.3.1" + "@typescript-eslint/utils" "7.3.1" + "@typescript-eslint/visitor-keys" "7.3.1" + debug "^4.3.4" + graphemer "^1.4.0" + ignore "^5.2.4" + natural-compare "^1.4.0" + semver "^7.5.4" + ts-api-utils "^1.0.1" + "@typescript-eslint/parser@6.9.0": version "6.9.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-6.9.0.tgz#2b402cadeadd3f211c25820e5433413347b27391" @@ -6125,6 +6160,25 @@ "@typescript-eslint/visitor-keys" "6.9.0" debug "^4.3.4" +"@typescript-eslint/parser@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-7.3.1.tgz#c4ba7dc2744318a5e4506596cbc3a0086255c526" + integrity sha512-Rq49+pq7viTRCH48XAbTA+wdLRrB/3sRq4Lpk0oGDm0VmnjBrAOVXH/Laalmwsv2VpekiEfVFwJYVk6/e8uvQw== + dependencies: + "@typescript-eslint/scope-manager" "7.3.1" + "@typescript-eslint/types" "7.3.1" + "@typescript-eslint/typescript-estree" "7.3.1" + "@typescript-eslint/visitor-keys" "7.3.1" + debug "^4.3.4" + +"@typescript-eslint/scope-manager@5.62.0": + version "5.62.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.62.0.tgz#d9457ccc6a0b8d6b37d0eb252a23022478c5460c" + integrity sha512-VXuvVvZeQCQb5Zgf4HAxc04q5j+WrNAtNh9OwCsCgpKqESMTu3tF/jhZ3xG6T4NZwWl65Bg8KuS2uEvhSfLl0w== + dependencies: + "@typescript-eslint/types" "5.62.0" + "@typescript-eslint/visitor-keys" "5.62.0" + "@typescript-eslint/scope-manager@6.9.0": version "6.9.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-6.9.0.tgz#2626e9a7fe0e004c3e25f3b986c75f584431134e" @@ -6133,6 +6187,24 @@ "@typescript-eslint/types" "6.9.0" "@typescript-eslint/visitor-keys" "6.9.0" +"@typescript-eslint/scope-manager@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-7.3.1.tgz#73fd0cb4211a7be23e49e5b6efec8820caa6ec36" + integrity sha512-fVS6fPxldsKY2nFvyT7IP78UO1/I2huG+AYu5AMjCT9wtl6JFiDnsv4uad4jQ0GTFzcUV5HShVeN96/17bTBag== + dependencies: + "@typescript-eslint/types" "7.3.1" + "@typescript-eslint/visitor-keys" "7.3.1" + +"@typescript-eslint/type-utils@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-7.3.1.tgz#cbf90d3d7e788466aa8a5c0ab3f46103f098aa0d" + integrity sha512-iFhaysxFsMDQlzJn+vr3OrxN8NmdQkHks4WaqD4QBnt5hsq234wcYdyQ9uquzJJIDAj5W4wQne3yEsYA6OmXGw== + dependencies: + "@typescript-eslint/typescript-estree" "7.3.1" + "@typescript-eslint/utils" "7.3.1" + debug "^4.3.4" + ts-api-utils "^1.0.1" + "@typescript-eslint/types@4.33.0": version "4.33.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.33.0.tgz#a1e59036a3b53ae8430ceebf2a919dc7f9af6d72" @@ -6143,11 +6215,34 @@ resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.53.0.tgz#f79eca62b97e518ee124086a21a24f3be267026f" integrity sha512-5kcDL9ZUIP756K6+QOAfPkigJmCPHcLN7Zjdz76lQWWDdzfOhZDTj1irs6gPBKiXx5/6O3L0+AvupAut3z7D2A== +"@typescript-eslint/types@5.62.0": + version "5.62.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.62.0.tgz#258607e60effa309f067608931c3df6fed41fd2f" + integrity sha512-87NVngcbVXUahrRTqIK27gD2t5Cu1yuCXxbLcFtCzZGlfyVWWh8mLHkoxzjsB6DDNnvdL+fW8MiwPEJyGJQDgQ== + "@typescript-eslint/types@6.9.0": version "6.9.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-6.9.0.tgz#86a0cbe7ac46c0761429f928467ff3d92f841098" integrity sha512-+KB0lbkpxBkBSiVCuQvduqMJy+I1FyDbdwSpM3IoBS7APl4Bu15lStPjgBIdykdRqQNYqYNMa8Kuidax6phaEw== +"@typescript-eslint/types@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-7.3.1.tgz#ae104de8efa4227a462c0874d856602c5994413c" + integrity sha512-2tUf3uWggBDl4S4183nivWQ2HqceOZh1U4hhu4p1tPiIJoRRXrab7Y+Y0p+dozYwZVvLPRI6r5wKe9kToF9FIw== + +"@typescript-eslint/typescript-estree@5.62.0": + version "5.62.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.62.0.tgz#7d17794b77fabcac615d6a48fb143330d962eb9b" + integrity sha512-CmcQ6uY7b9y694lKdRB8FEel7JbU/40iSAPomu++SjLMntB+2Leay2LO6i8VnJk58MtE9/nQSFIH6jpyRWyYzA== + dependencies: + "@typescript-eslint/types" "5.62.0" + "@typescript-eslint/visitor-keys" "5.62.0" + debug "^4.3.4" + globby "^11.1.0" + is-glob "^4.0.3" + semver "^7.3.7" + tsutils "^3.21.0" + "@typescript-eslint/typescript-estree@6.9.0": version "6.9.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-6.9.0.tgz#d0601b245be873d8fe49f3737f93f8662c8693d4" @@ -6161,6 +6256,20 @@ semver "^7.5.4" ts-api-utils "^1.0.1" +"@typescript-eslint/typescript-estree@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-7.3.1.tgz#598848195fad34c7aa73f548bd00a4d4e5f5e2bb" + integrity sha512-tLpuqM46LVkduWP7JO7yVoWshpJuJzxDOPYIVWUUZbW+4dBpgGeUdl/fQkhuV0A8eGnphYw3pp8d2EnvPOfxmQ== + dependencies: + "@typescript-eslint/types" "7.3.1" + "@typescript-eslint/visitor-keys" "7.3.1" + debug "^4.3.4" + globby "^11.1.0" + is-glob "^4.0.3" + minimatch "9.0.3" + semver "^7.5.4" + ts-api-utils "^1.0.1" + "@typescript-eslint/typescript-estree@^4.33.0": version "4.33.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-4.33.0.tgz#0dfb51c2908f68c5c08d82aefeaf166a17c24609" @@ -6187,6 +6296,33 @@ semver "^7.3.7" tsutils "^3.21.0" +"@typescript-eslint/utils@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-7.3.1.tgz#fc28fd508ccf89495012561b7c02a6fdad162460" + integrity sha512-jIERm/6bYQ9HkynYlNZvXpzmXWZGhMbrOvq3jJzOSOlKXsVjrrolzWBjDW6/TvT5Q3WqaN4EkmcfdQwi9tDjBQ== + dependencies: + "@eslint-community/eslint-utils" "^4.4.0" + "@types/json-schema" "^7.0.12" + "@types/semver" "^7.5.0" + "@typescript-eslint/scope-manager" "7.3.1" + "@typescript-eslint/types" "7.3.1" + "@typescript-eslint/typescript-estree" "7.3.1" + semver "^7.5.4" + +"@typescript-eslint/utils@^5.10.0": + version "5.62.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.62.0.tgz#141e809c71636e4a75daa39faed2fb5f4b10df86" + integrity sha512-n8oxjeb5aIbPFEtmQxQYOLI0i9n5ySBEY/ZEHHZqKQSFnxio1rv6dthascc9dLuwrL0RC5mPCxB7vnAVGAYWAQ== + dependencies: + "@eslint-community/eslint-utils" "^4.2.0" + "@types/json-schema" "^7.0.9" + "@types/semver" "^7.3.12" + "@typescript-eslint/scope-manager" "5.62.0" + "@typescript-eslint/types" "5.62.0" + "@typescript-eslint/typescript-estree" "5.62.0" + eslint-scope "^5.1.1" + semver "^7.3.7" + "@typescript-eslint/visitor-keys@4.33.0": version "4.33.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz#2a22f77a41604289b7a186586e9ec48ca92ef1dd" @@ -6203,6 +6339,14 @@ "@typescript-eslint/types" "5.53.0" eslint-visitor-keys "^3.3.0" +"@typescript-eslint/visitor-keys@5.62.0": + version "5.62.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.62.0.tgz#2174011917ce582875954ffe2f6912d5931e353e" + integrity sha512-07ny+LHRzQXepkGg6w0mFY41fVUNBrL2Roj/++7V1txKugfjm/Ci/qSND03r2RhlJhJYMcTn9AhhSSqQp0Ysyw== + dependencies: + "@typescript-eslint/types" "5.62.0" + eslint-visitor-keys "^3.3.0" + "@typescript-eslint/visitor-keys@6.9.0": version "6.9.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-6.9.0.tgz#cc69421c10c4ac997ed34f453027245988164e80" @@ -6211,6 +6355,14 @@ "@typescript-eslint/types" "6.9.0" eslint-visitor-keys "^3.4.1" +"@typescript-eslint/visitor-keys@7.3.1": + version "7.3.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-7.3.1.tgz#6ddef14a3ce2a79690f01176f5305c34d7b93d8c" + integrity sha512-9RMXwQF8knsZvfv9tdi+4D/j7dMG28X/wMJ8Jj6eOHyHWwDW4ngQJcqEczSsqIKKjFiLFr40Mnr7a5ulDD3vmw== + dependencies: + "@typescript-eslint/types" "7.3.1" + eslint-visitor-keys "^3.4.1" + "@ungap/structured-clone@^1.2.0": version "1.2.0" resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.2.0.tgz#756641adb587851b5ccb3e095daf27ae581c8406" @@ -7026,7 +7178,7 @@ ast-types@0.9.6: resolved "https://registry.yarnpkg.com/ast-types/-/ast-types-0.9.6.tgz#102c9e9e9005d3e7e3829bf0c4fa24ee862ee9b9" integrity sha512-qEdtR2UH78yyHX/AUNfXmJTlM48XoFZKBdwi1nzkI1mJL21cmbu0cvjxjpkXJ5NENMq42H+hNs8VLJcqXLerBQ== -async-lock@^1.4.0: +async-lock@^1.4.1: version "1.4.1" resolved "https://registry.yarnpkg.com/async-lock/-/async-lock-1.4.1.tgz#56b8718915a9b68b10fce2f2a9a3dddf765ef53f" integrity sha512-Az2ZTpuytrtqENulXwO3GGv1Bztugx6TT37NIo7imr/Qo0gsYiGtSdBa2B6fsXhTpVZDNfu1Qn3pk531e3q+nQ== @@ -7113,7 +7265,37 @@ axios-retry@^3.1.9: "@babel/runtime" "^7.15.4" is-retry-allowed "^2.2.0" -axios@0.24.0, axios@1.1.3, axios@1.6.3, axios@^0.21.1, axios@^0.21.4, axios@^0.26.0, axios@^1.0.0, axios@^1.1.3, axios@^1.5.0: +axios@0.24.0: + version "0.24.0" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.24.0.tgz#804e6fa1e4b9c5288501dd9dff56a7a0940d20d6" + integrity sha512-Q6cWsys88HoPgAaFAVUb0WpPk0O8iTeisR9IMqy9G8AbO4NlpVknrnQS03zzF9PGAWgO3cgletO3VjV/P7VztA== + dependencies: + follow-redirects "^1.14.4" + +axios@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/axios/-/axios-1.1.3.tgz#8274250dada2edf53814ed7db644b9c2866c1e35" + integrity sha512-00tXVRwKx/FZr/IDVFt4C+f9FYairX517WoGCL6dpOntqLkZofjhu43F/Xl44UOpqa+9sLFDrG/XAnFsUYgkDA== + dependencies: + follow-redirects "^1.15.0" + form-data "^4.0.0" + proxy-from-env "^1.1.0" + +axios@^0.21.1, axios@^0.21.4: + version "0.21.4" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.4.tgz#c67b90dc0568e5c1cf2b0b858c43ba28e2eda575" + integrity sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg== + dependencies: + follow-redirects "^1.14.0" + +axios@^0.26.0: + version "0.26.1" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.26.1.tgz#1ede41c51fcf51bbbd6fd43669caaa4f0495aaa9" + integrity sha512-fPwcX4EvnSHuInCMItEhAGnaSEXRBjtzh9fOtsE6E1G6p7vl7edEeZe11QHf18+6+9gR5PbKV/sGKNaD8YaMeA== + dependencies: + follow-redirects "^1.14.8" + +axios@^1.0.0, axios@^1.1.3, axios@^1.5.0: version "1.6.3" resolved "https://registry.yarnpkg.com/axios/-/axios-1.6.3.tgz#7f50f23b3aa246eff43c54834272346c396613f4" integrity sha512-fWyNdeawGam70jXSVlKl+SUNVcL6j6W79CuSIPfi6HnDUmSCH6gyUys/HrqHeA/wU0Az41rRgean494d0Jb+ww== @@ -7262,6 +7444,33 @@ balanced-match@^1.0.0: resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== +bare-events@^2.0.0, bare-events@^2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/bare-events/-/bare-events-2.2.1.tgz#7b6d421f26a7a755e20bf580b727c84b807964c1" + integrity sha512-9GYPpsPFvrWBkelIhOhTWtkeZxVxZOdb3VnFTCzlOo3OjvmTvzLoZFUT8kNFACx0vJej6QPney1Cf9BvzCNE/A== + +bare-fs@^2.1.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/bare-fs/-/bare-fs-2.2.1.tgz#c1985d8d3e07a178956b072d3af67cb8c1fa9391" + integrity sha512-+CjmZANQDFZWy4PGbVdmALIwmt33aJg8qTkVjClU6X4WmZkTPBDxRHiBn7fpqEWEfF3AC2io++erpViAIQbSjg== + dependencies: + bare-events "^2.0.0" + bare-os "^2.0.0" + bare-path "^2.0.0" + streamx "^2.13.0" + +bare-os@^2.0.0, bare-os@^2.1.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/bare-os/-/bare-os-2.2.0.tgz#24364692984d0bd507621754781b31d7872736b2" + integrity sha512-hD0rOPfYWOMpVirTACt4/nK8mC55La12K5fY1ij8HAdfQakD62M+H4o4tpfKzVGLgRDTuk3vjA4GqGXXCeFbag== + +bare-path@^2.0.0, bare-path@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/bare-path/-/bare-path-2.1.0.tgz#830f17fd39842813ca77d211ebbabe238a88cb4c" + integrity sha512-DIIg7ts8bdRKwJRJrUMy/PICEaQZaPGZ26lsSx9MJSwIhSrcdHn7/C8W+XmnG/rKi6BaRcz+JO00CjZteybDtw== + dependencies: + bare-os "^2.1.0" + base62@^1.1.0: version "1.2.8" resolved "https://registry.yarnpkg.com/base62/-/base62-1.2.8.tgz#1264cb0fb848d875792877479dbe8bae6bae3428" @@ -8207,11 +8416,16 @@ codemirror-spell-checker@1.1.2: dependencies: typo-js "*" -codemirror@^5.59.0, codemirror@^5.63.1: +codemirror@^5.63.1: version "5.65.12" resolved "https://registry.yarnpkg.com/codemirror/-/codemirror-5.65.12.tgz#294fdf097d10ac5b56a9e011a91eff252afc73ae" integrity sha512-z2jlHBocElRnPYysN2HAuhXbO3DNB0bcSKmNz3hcWR2Js2Dkhc1bEOxG93Z3DeUrnm+qx56XOY5wQmbP5KY0sw== +codemirror@^5.65.16: + version "5.65.16" + resolved "https://registry.yarnpkg.com/codemirror/-/codemirror-5.65.16.tgz#efc0661be6bf4988a6a1c2fe6893294638cdb334" + integrity sha512-br21LjYmSlVL0vFCPWPfhzUCT34FM/pAdK7rRIZwa0rrtrIdotvP4Oh4GUHsu2E3IrQMCfRkL/fN3ytMNxVQvg== + collect-v8-coverage@^1.0.0: version "1.0.1" resolved "https://registry.yarnpkg.com/collect-v8-coverage/-/collect-v8-coverage-1.0.1.tgz#cc2c8e94fc18bbdffe64d6534570c8a673b27f59" @@ -8427,21 +8641,6 @@ concat-with-sourcemaps@^1.1.0: dependencies: source-map "^0.6.1" -concurrently@^8.2.2: - version "8.2.2" - resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-8.2.2.tgz#353141985c198cfa5e4a3ef90082c336b5851784" - integrity sha512-1dP4gpXFhei8IOtlXRE/T/4H88ElHgTiUzh71YUmtjTEHMSRS2Z/fgOxHSxxusGHogsRfxNq1vyAwxSC+EVyDg== - dependencies: - chalk "^4.1.2" - date-fns "^2.30.0" - lodash "^4.17.21" - rxjs "^7.8.1" - shell-quote "^1.8.1" - spawn-command "0.0.2" - supports-color "^8.1.1" - tree-kill "^1.2.2" - yargs "^17.7.2" - condense-newlines@^0.2.1: version "0.2.1" resolved "https://registry.yarnpkg.com/condense-newlines/-/condense-newlines-0.2.1.tgz#3de985553139475d32502c83b02f60684d24c55f" @@ -9009,13 +9208,6 @@ data-urls@^4.0.0: whatwg-mimetype "^3.0.0" whatwg-url "^12.0.0" -date-fns@^2.30.0: - version "2.30.0" - resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.30.0.tgz#f367e644839ff57894ec6ac480de40cae4b0f4d0" - integrity sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw== - dependencies: - "@babel/runtime" "^7.21.0" - dateformat@^3.0.3: version "3.0.3" resolved "https://registry.yarnpkg.com/dateformat/-/dateformat-3.0.3.tgz#a6e37499a4d9a9cf85ef5872044d62901c9889ae" @@ -9614,10 +9806,10 @@ docker-compose@^0.23.5, docker-compose@^0.23.6: dependencies: yaml "^1.10.2" -docker-compose@^0.24.2: - version "0.24.3" - resolved "https://registry.yarnpkg.com/docker-compose/-/docker-compose-0.24.3.tgz#298d7bb4aaf37b3b45d0e4ef55c7f58ccc39cca9" - integrity sha512-x3/QN3AIOMe7j2c8f/jcycizMft7dl8MluoB9OGPAYCyKHHiPUFqI9GjCcsU0kYy24vYKMCcfR6+5ZaEyQlrxg== +docker-compose@^0.24.6: + version "0.24.6" + resolved "https://registry.yarnpkg.com/docker-compose/-/docker-compose-0.24.6.tgz#d1f490a641bdb7ccc07c4d446b264f026f9a1f15" + integrity sha512-VidlUyNzXMaVsuM79sjSvwC4nfojkP2VneL+Zfs538M2XFnffZDhx6veqnz/evCNIYGyz5O+1fgL6+g0NLWTBA== dependencies: yaml "^2.2.2" @@ -10379,6 +10571,13 @@ eslint-plugin-import@^2.29.0: semver "^6.3.1" tsconfig-paths "^3.14.2" +eslint-plugin-jest@^27.9.0: + version "27.9.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-27.9.0.tgz#7c98a33605e1d8b8442ace092b60e9919730000b" + integrity sha512-QIT7FH7fNmd9n4se7FFKHbsLKGQiw885Ds6Y/sxKgCZ6natwCsXdgPOADnYVxN2QrRweF0FZWbJ6S7Rsn7llug== + dependencies: + "@typescript-eslint/utils" "^5.10.0" + eslint-plugin-local-rules@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/eslint-plugin-local-rules/-/eslint-plugin-local-rules-2.0.0.tgz#cda95d7616cc0e2609d76c347c187ca2be1e252e" @@ -10402,7 +10601,7 @@ eslint-plugin-svelte@^2.34.0: semver "^7.5.3" svelte-eslint-parser ">=0.33.0 <1.0.0" -eslint-scope@5.1.1: +eslint-scope@5.1.1, eslint-scope@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== @@ -11086,6 +11285,11 @@ fn.name@1.x.x: resolved "https://registry.yarnpkg.com/fn.name/-/fn.name-1.1.0.tgz#26cad8017967aea8731bc42961d04a3d5988accc" integrity sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw== +follow-redirects@^1.14.0, follow-redirects@^1.14.4, follow-redirects@^1.14.8: + version "1.15.6" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.6.tgz#7f815c0cda4249c74ff09e95ef97c23b5fd0399b" + integrity sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA== + follow-redirects@^1.15.0: version "1.15.2" resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.2.tgz#b460864144ba63f2681096f274c4e57026da2c13" @@ -11963,7 +12167,7 @@ handlebars-utils@^1.0.6: kind-of "^6.0.0" typeof-article "^0.1.1" -handlebars@^4.7.6, handlebars@^4.7.7: +handlebars@^4.7.7: version "4.7.7" resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1" integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA== @@ -11975,6 +12179,18 @@ handlebars@^4.7.6, handlebars@^4.7.7: optionalDependencies: uglify-js "^3.1.4" +handlebars@^4.7.8: + version "4.7.8" + resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.8.tgz#41c42c18b1be2365439188c77c6afae71c0cd9e9" + integrity sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ== + dependencies: + minimist "^1.2.5" + neo-async "^2.6.2" + source-map "^0.6.1" + wordwrap "^1.0.0" + optionalDependencies: + uglify-js "^3.1.4" + har-schema@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/har-schema/-/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92" @@ -12215,7 +12431,12 @@ http-assert@^1.3.0: deep-equal "~1.0.1" http-errors "~1.8.0" -http-cache-semantics@3.8.1, http-cache-semantics@4.1.1, http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.0, http-cache-semantics@^4.1.1: +http-cache-semantics@3.8.1: + version "3.8.1" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-3.8.1.tgz#39b0e16add9b605bf0a9ef3d9daaf4843b4cacd2" + integrity sha512-5ai2iksyV8ZXmnZhHH4rWPoxxistEexSi5936zIQ1bnNTW5VnA85B6P/VpXiRM017IgRvb2kKo1a//y+0wSp3w== + +http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.0, http-cache-semantics@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a" integrity sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ== @@ -13165,11 +13386,6 @@ isobject@^3.0.1: resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df" integrity sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg== -isobject@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/isobject/-/isobject-4.0.0.tgz#3f1c9155e73b192022a80819bacd0343711697b0" - integrity sha512-S/2fF5wH8SJA/kmwr6HYhK/RI/OkhD84k8ntalo0iJjZikgq1XFvR5M8NPT1x5F7fBwCG3qHfnzeP/Vh/ZxCUA== - isolated-vm@^4.7.2: version "4.7.2" resolved "https://registry.yarnpkg.com/isolated-vm/-/isolated-vm-4.7.2.tgz#5670d5cce1d92004f9b825bec5b0b11fc7501b65" @@ -13909,6 +14125,11 @@ json-buffer@3.0.1: resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" integrity sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ== +json-format-highlight@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/json-format-highlight/-/json-format-highlight-1.0.4.tgz#2e44277edabcec79a3d2c84e984c62e2258037b9" + integrity sha512-RqenIjKr1I99XfXPAml9G7YlEZg/GnsH7emWyWJh2yuGXqHW8spN7qx6/ME+MoIBb35/fxrMC9Jauj6nvGe4Mg== + json-parse-better-errors@^1.0.1: version "1.0.2" resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9" @@ -15495,6 +15716,13 @@ minimatch@3.0.5: dependencies: brace-expansion "^1.1.7" +minimatch@9.0.3: + version "9.0.3" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.3.tgz#a6e00c3de44c3a542bfaae70abfc22420a6da825" + integrity sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg== + dependencies: + brace-expansion "^2.0.1" + minimatch@^5.0.1, minimatch@^5.1.0: version "5.1.6" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.6.tgz#1cfcb8cf5522ea69952cd2af95ae09477f122a96" @@ -15752,7 +15980,7 @@ msgpackr-extract@^3.0.2: "@msgpackr-extract/msgpackr-extract-linux-x64" "3.0.2" "@msgpackr-extract/msgpackr-extract-win32-x64" "3.0.2" -msgpackr@1.10.1, msgpackr@^1.5.2: +msgpackr@^1.5.2: version "1.10.1" resolved "https://registry.yarnpkg.com/msgpackr/-/msgpackr-1.10.1.tgz#51953bb4ce4f3494f0c4af3f484f01cfbb306555" integrity sha512-r5VRLv9qouXuLiIBrLpl2d5ZvPt8svdQTl5/vMvE4nzDMyEX4sgW5yWhuBBj5UmgwOTWj8CIdSXn5sAfsHAWIQ== @@ -15920,6 +16148,15 @@ nice-try@^1.0.4: resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366" integrity sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ== +nock@^13.5.4: + version "13.5.4" + resolved "https://registry.yarnpkg.com/nock/-/nock-13.5.4.tgz#8918f0addc70a63736170fef7106a9721e0dc479" + integrity sha512-yAyTfdeNJGGBFxWdzSKCBYxs5FxLbCg5X5Q4ets974hcQzG1+qCxvIyOo4j2Ry6MUlhWVMX4OoYDefAIIwupjw== + dependencies: + debug "^4.1.0" + json-stringify-safe "^5.0.1" + propagate "^2.0.0" + node-abi@^3.3.0: version "3.54.0" resolved "https://registry.yarnpkg.com/node-abi/-/node-abi-3.54.0.tgz#f6386f7548817acac6434c6cba02999c9aebcc69" @@ -15952,13 +16189,25 @@ node-duration@^1.0.4: resolved "https://registry.yarnpkg.com/node-duration/-/node-duration-1.0.4.tgz#3e94ecc0e473691c89c4560074503362071cecac" integrity sha512-eUXYNSY7DL53vqfTosggWkvyIW3bhAcqBDIlolgNYlZhianXTrCL50rlUJWD1eRqkIxMppXTfiFbp+9SjpPrgA== -node-fetch@2.6.0, node-fetch@2.6.7, node-fetch@^2.6.0, node-fetch@^2.6.1, node-fetch@^2.6.7, node-fetch@^2.6.9, node-fetch@^2.7.0: +node-fetch@2.6.0: + version "2.6.0" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd" + integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA== + +node-fetch@2.6.7, node-fetch@^2.6.0, node-fetch@^2.6.1, node-fetch@^2.6.7: version "2.6.7" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad" integrity sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ== dependencies: whatwg-url "^5.0.0" +node-fetch@^2.6.9, node-fetch@^2.7.0: + version "2.7.0" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d" + integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A== + dependencies: + whatwg-url "^5.0.0" + node-forge@^1.3.1: version "1.3.1" resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" @@ -17108,7 +17357,15 @@ passport-strategy@1.x.x, passport-strategy@^1.0.0: resolved "https://registry.yarnpkg.com/passport-strategy/-/passport-strategy-1.0.0.tgz#b5539aa8fc225a3d1ad179476ddf236b440f52e4" integrity sha512-CB97UUvDKJde2V0KDWWB3lyf6PC3FaZP7YxZ2G8OAtn9p4HI9j9JLP9qjOGZFvyl8uwNT8qM+hGnz/n16NI7oA== -passport@0.6.0, passport@^0.4.0, passport@^0.6.0: +passport@^0.4.0: + version "0.4.1" + resolved "https://registry.yarnpkg.com/passport/-/passport-0.4.1.tgz#941446a21cb92fc688d97a0861c38ce9f738f270" + integrity sha512-IxXgZZs8d7uFSt3eqNjM9NQ3g3uQCW5avD8mRNoXV99Yig50vjuaez6dQK2qC0kVWPRTujxY0dWgGfT09adjYg== + dependencies: + passport-strategy "1.x.x" + pause "0.0.1" + +passport@^0.6.0: version "0.6.0" resolved "https://registry.yarnpkg.com/passport/-/passport-0.6.0.tgz#e869579fab465b5c0b291e841e6cc95c005fac9d" integrity sha512-0fe+p3ZnrWRW74fe8+SvCyf4a3Pb2/h7gFkQ8yTJpAO50gDzlfjZUZTO1k5Eg9kUct22OxHLqDZoKUWRHOh9ug== @@ -18293,6 +18550,11 @@ promzard@^1.0.0: dependencies: read "^2.0.0" +propagate@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/propagate/-/propagate-2.0.1.tgz#40cdedab18085c792334e64f0ac17256d38f9a45" + integrity sha512-vGrhOavPSTz4QVNuBNdcNXePNdNMaO1xj9yBeH1ScQPjk/rhg9sSlCXPhMkFuaNNW/syTvYqsnbIJxMBfRbbag== + proper-lockfile@^4.1.2: version "4.1.2" resolved "https://registry.yarnpkg.com/proper-lockfile/-/proper-lockfile-4.1.2.tgz#c8b9de2af6b2f1601067f98e01ac66baa223141f" @@ -18403,7 +18665,7 @@ pseudomap@^1.0.2: resolved "https://registry.yarnpkg.com/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3" integrity sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ== -psl@^1.1.33: +psl@^1.1.28, psl@^1.1.33: version "1.9.0" resolved "https://registry.yarnpkg.com/psl/-/psl-1.9.0.tgz#d0df2a137f00794565fcaf3b2c00cd09f8d5a5a7" integrity sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag== @@ -19355,13 +19617,6 @@ rxjs@^7.5.5: dependencies: tslib "^2.1.0" -rxjs@^7.8.1: - version "7.8.1" - resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.8.1.tgz#6f6f3d99ea8044291efd92e7c7fcf562c4057543" - integrity sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg== - dependencies: - tslib "^2.1.0" - safe-array-concat@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/safe-array-concat/-/safe-array-concat-1.0.1.tgz#91686a63ce3adbea14d61b14c99572a8ff84754c" @@ -19435,6 +19690,11 @@ sax@1.2.1: resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.1.tgz#7b8e656190b228e81a66aea748480d828cd2d37a" integrity sha512-8I2a3LovHTOpm7NV5yOyO8IHqgVsfK4+UuySrXU8YXkSRX7k6hCV9b3HrkKCr3nMpgj+0bmocaJJWpvp1oc7ZA== +sax@>=0.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/sax/-/sax-1.3.0.tgz#a5dbe77db3be05c9d1ee7785dbd3ea9de51593d0" + integrity sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA== + sax@>=0.6.0: version "1.2.4" resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.4.tgz#2816234e2378bddc4e5354fab5caa895df7100d9" @@ -19463,11 +19723,12 @@ schema-utils@^3.1.1, schema-utils@^3.1.2: ajv "^6.12.5" ajv-keywords "^3.5.2" -scim-patch@^0.7.0: - version "0.7.0" - resolved "https://registry.yarnpkg.com/scim-patch/-/scim-patch-0.7.0.tgz#3f6d94256c07be415a74a49c0ff48dc91e4e0219" - integrity sha512-wXKcsZl+aLfE0yId7MjiOd91v8as6dEYLFvm1gGu3yJxSPhl1Fl3vWiNN4V3D68UKpqO/umK5rwWc8wGpBaOHw== +scim-patch@^0.8.1: + version "0.8.1" + resolved "https://registry.yarnpkg.com/scim-patch/-/scim-patch-0.8.1.tgz#611bfdb5538f6d8b97aba0ab0f8bd01055b70c1c" + integrity sha512-JRYTA+mJZ8Z5DJGO7kkFc0lGCDs100rNs7iN77mld7gQajTp1R1xjUzMfZTOMAkBDA75GSdbMmfdfMqMJCn/Yg== dependencies: + "@types/node" "^20.4.5" fast-deep-equal "3.1.3" scim2-parse-filter "0.2.8" @@ -19515,13 +19776,40 @@ semver-diff@^3.1.1: dependencies: semver "^6.3.0" -"semver@2 || 3 || 4 || 5", semver@7.5.3, semver@^5.5.0, semver@^5.6.0, semver@^5.7.1, semver@^6.0.0, semver@^6.1.1, semver@^6.1.2, semver@^6.2.0, semver@^6.3.0, semver@^6.3.1, semver@^7.0.0, semver@^7.1.1, semver@^7.1.2, semver@^7.3.2, semver@^7.3.4, semver@^7.3.5, semver@^7.3.7, semver@^7.3.8, semver@^7.5.3, semver@^7.5.4, semver@~2.3.1, semver@~7.0.0: +"semver@2 || 3 || 4 || 5", semver@^5.5.0, semver@^5.6.0, semver@^5.7.1: + version "5.7.2" + resolved "https://registry.yarnpkg.com/semver/-/semver-5.7.2.tgz#48d55db737c3287cd4835e17fa13feace1c41ef8" + integrity sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g== + +semver@7.5.3, semver@^7.0.0, semver@^7.1.1, semver@^7.1.2, semver@^7.3.2, semver@^7.3.4, semver@^7.3.5, semver@^7.3.7, semver@^7.3.8, semver@^7.5.3: version "7.5.3" resolved "https://registry.yarnpkg.com/semver/-/semver-7.5.3.tgz#161ce8c2c6b4b3bdca6caadc9fa3317a4c4fe88e" integrity sha512-QBlUtyVk/5EeHbi7X0fw6liDZc7BBmEaSYn01fMU1OUYbf6GPsbTtd8WmnqbI20SeycoHSeiybkE/q1Q+qlThQ== dependencies: lru-cache "^6.0.0" +semver@^6.0.0, semver@^6.1.1, semver@^6.1.2, semver@^6.2.0, semver@^6.3.0, semver@^6.3.1: + version "6.3.1" + resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" + integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== + +semver@^7.5.4: + version "7.6.0" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.6.0.tgz#1a46a4db4bffcccd97b743b5005c8325f23d4e2d" + integrity sha512-EnwXhrlwXMk9gKu5/flx5sv/an57AkRplG3hTK68W7FRDN+k+OWBj65M7719OkA82XLBxrcX0KSHj+X5COhOVg== + dependencies: + lru-cache "^6.0.0" + +semver@~2.3.1: + version "2.3.2" + resolved "https://registry.yarnpkg.com/semver/-/semver-2.3.2.tgz#b9848f25d6cf36333073ec9ef8856d42f1233e52" + integrity sha512-abLdIKCosKfpnmhS52NCTjO4RiLspDfsn37prjzGrp9im5DPJOgh82Os92vtwGh6XdQryKI/7SREZnV+aqiXrA== + +semver@~7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.0.0.tgz#5f3ca35761e47e05b206c6daff2cf814f0316b8e" + integrity sha512-+GB6zVA9LWh6zovYQLALHwv5rb2PHGlJi3lfiqIHxR0uuwCgefcOJc59v9fv1w8GbStwxuuqqAjI9NMAOOgq1A== + seq-queue@^0.0.5: version "0.0.5" resolved "https://registry.yarnpkg.com/seq-queue/-/seq-queue-0.0.5.tgz#d56812e1c017a6e4e7c3e3a37a1da6d78dd3c93e" @@ -19636,11 +19924,6 @@ shell-exec@1.0.2: resolved "https://registry.yarnpkg.com/shell-exec/-/shell-exec-1.0.2.tgz#2e9361b0fde1d73f476c4b6671fa17785f696756" integrity sha512-jyVd+kU2X+mWKMmGhx4fpWbPsjvD53k9ivqetutVW/BQ+WIZoDoP4d8vUMGezV6saZsiNoW2f9GIhg9Dondohg== -shell-quote@^1.8.1: - version "1.8.1" - resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.1.tgz#6dbf4db75515ad5bac63b4f1894c3a154c766680" - integrity sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA== - shortid@2.2.15: version "2.2.15" resolved "https://registry.yarnpkg.com/shortid/-/shortid-2.2.15.tgz#2b902eaa93a69b11120373cd42a1f1fe4437c122" @@ -19959,11 +20242,6 @@ sparse-bitfield@^3.0.3: dependencies: memory-pager "^1.0.2" -spawn-command@0.0.2: - version "0.0.2" - resolved "https://registry.yarnpkg.com/spawn-command/-/spawn-command-0.0.2.tgz#9544e1a43ca045f8531aac1a48cb29bdae62338e" - integrity sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ== - spdx-correct@^3.0.0: version "3.1.1" resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-3.1.1.tgz#dece81ac9c1e6713e5f7d1b6f17d468fa53d89a9" @@ -20178,6 +20456,16 @@ stream-to-array@^2.3.0: dependencies: any-promise "^1.1.0" +streamx@^2.13.0: + version "2.16.1" + resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.16.1.tgz#2b311bd34832f08aa6bb4d6a80297c9caef89614" + integrity sha512-m9QYj6WygWyWa3H1YY69amr4nVgy61xfjys7xO7kviL5rfIEc2naf+ewFiOA+aEJD7y0JO3h2GoiUv4TDwEGzQ== + dependencies: + fast-fifo "^1.1.0" + queue-tick "^1.0.1" + optionalDependencies: + bare-events "^2.2.0" + streamx@^2.15.0: version "2.15.6" resolved "https://registry.yarnpkg.com/streamx/-/streamx-2.15.6.tgz#28bf36997ebc7bf6c08f9eba958735231b833887" @@ -20526,7 +20814,7 @@ supports-color@^7.0.0, supports-color@^7.1.0: dependencies: has-flag "^4.0.0" -supports-color@^8.0.0, supports-color@^8.1.1: +supports-color@^8.0.0: version "8.1.1" resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== @@ -20729,14 +21017,16 @@ tar-fs@2.1.1, tar-fs@^2.0.0, tar-fs@^2.1.0: pump "^3.0.0" tar-stream "^2.1.4" -tar-fs@^3.0.4: - version "3.0.4" - resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-3.0.4.tgz#a21dc60a2d5d9f55e0089ccd78124f1d3771dbbf" - integrity sha512-5AFQU8b9qLfZCX9zp2duONhPmZv0hGYiBPJsyUdqMjzq/mqVpy/rEUSeHk1+YitmxugaptgBh5oDGU3VsAJq4w== +tar-fs@^3.0.5: + version "3.0.5" + resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-3.0.5.tgz#f954d77767e4e6edf973384e1eb95f8f81d64ed9" + integrity sha512-JOgGAmZyMgbqpLwct7ZV8VzkEB6pxXFBVErLtb+XCOqzc6w1xiWKI9GVd6bwk68EX7eJ4DWmfXVmq8K2ziZTGg== dependencies: - mkdirp-classic "^0.5.2" pump "^3.0.0" tar-stream "^3.1.5" + optionalDependencies: + bare-fs "^2.1.1" + bare-path "^2.1.0" tar-fs@~2.0.1: version "2.0.1" @@ -20874,25 +21164,25 @@ test-exclude@^6.0.0: glob "^7.1.4" minimatch "^3.0.4" -testcontainers@10.6.0: - version "10.6.0" - resolved "https://registry.yarnpkg.com/testcontainers/-/testcontainers-10.6.0.tgz#205ad9148e68ff5c43a6209a30b12965acbe89d8" - integrity sha512-FDJ3o3J8IMu1V7Uc6lNZ2MAD8+BV4HdpR/Vf5mHtgYHKdn6k1EbGFwtnvVNOxanJ99FCjf/EU8eA5ZQ4yjlsGA== +testcontainers@10.7.2, testcontainers@^10.7.2: + version "10.7.2" + resolved "https://registry.yarnpkg.com/testcontainers/-/testcontainers-10.7.2.tgz#619e93200dd47f174b307b40fa830cf023b74c25" + integrity sha512-7d+LVd/4YKp/cutiVMLL5cnj/8p8oYELAVRRyNUM4FyUDz1OLQuwW868nDl7Vd1ZAQxzGeCR+F86FlR9Yw9fMA== dependencies: "@balena/dockerignore" "^1.0.2" - "@types/dockerode" "^3.3.21" + "@types/dockerode" "^3.3.24" archiver "^5.3.2" - async-lock "^1.4.0" + async-lock "^1.4.1" byline "^5.0.0" debug "^4.3.4" - docker-compose "^0.24.2" + docker-compose "^0.24.6" dockerode "^3.3.5" get-port "^5.1.1" node-fetch "^2.7.0" proper-lockfile "^4.1.2" properties-reader "^2.3.0" ssh-remote-port-forward "^1.0.4" - tar-fs "^3.0.4" + tar-fs "^3.0.5" tmp "^0.2.1" testcontainers@4.7.0: @@ -21122,7 +21412,7 @@ touch@^3.1.0: dependencies: nopt "~1.0.10" -tough-cookie@4.1.3, "tough-cookie@^2.3.3 || ^3.0.1 || ^4.0.0", tough-cookie@^4.0.0, tough-cookie@^4.1.2, tough-cookie@~2.5.0: +"tough-cookie@^2.3.3 || ^3.0.1 || ^4.0.0", tough-cookie@^4.0.0, tough-cookie@^4.1.2: version "4.1.3" resolved "https://registry.yarnpkg.com/tough-cookie/-/tough-cookie-4.1.3.tgz#97b9adb0728b42280aa3d814b6b999b2ff0318bf" integrity sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw== @@ -21132,6 +21422,14 @@ tough-cookie@4.1.3, "tough-cookie@^2.3.3 || ^3.0.1 || ^4.0.0", tough-cookie@^4.0 universalify "^0.2.0" url-parse "^1.5.3" +tough-cookie@~2.5.0: + version "2.5.0" + resolved "https://registry.yarnpkg.com/tough-cookie/-/tough-cookie-2.5.0.tgz#cd9fb2a0aa1d5a12b473bd9fb96fa3dcff65ade2" + integrity sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g== + dependencies: + psl "^1.1.28" + punycode "^2.1.1" + tr46@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/tr46/-/tr46-2.1.0.tgz#fa87aa81ca5d5941da8cbf1f9b749dc969a4e240" @@ -21151,11 +21449,6 @@ tr46@~0.0.3: resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a" integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw== -tree-kill@^1.2.2: - version "1.2.2" - resolved "https://registry.yarnpkg.com/tree-kill/-/tree-kill-1.2.2.tgz#4ca09a9092c88b73a7cdc5e8a01b507b0790a0cc" - integrity sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A== - trim-newlines@^3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-3.0.1.tgz#260a5d962d8b752425b32f3a7db0dcacd176c144" @@ -21427,6 +21720,14 @@ typeof@^1.0.0: resolved "https://registry.yarnpkg.com/typeof/-/typeof-1.0.0.tgz#9c84403f2323ae5399167275497638ea1d2f2440" integrity sha512-Pze0mIxYXhaJdpw1ayMzOA7rtGr1OmsTY/Z+FWtRKIqXFz6aoDLjqdbWE/tcIBSC8nhnVXiRrEXujodR/xiFAA== +typescript-eslint@^7.3.1: + version "7.3.1" + resolved "https://registry.yarnpkg.com/typescript-eslint/-/typescript-eslint-7.3.1.tgz#9f4808abea3b33c4dd3bb51dd801471e91d1bd58" + integrity sha512-psqcnHPRCdVIDbgj6RvfpwUKqMcNxIw7eizgxYi46X2BmXK6LxYqPD+SbDfPuA9JW+yPItY6aKJLRNbW7lZ4rA== + dependencies: + "@typescript-eslint/eslint-plugin" "7.3.1" + "@typescript-eslint/parser" "7.3.1" + typescript@5.2.2, "typescript@>=3 < 6": version "5.2.2" resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78" @@ -21605,14 +21906,6 @@ unpipe@1.0.0: resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== -unset-value@2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/unset-value/-/unset-value-2.0.1.tgz#57bed0c22d26f28d69acde5df9a11b77c74d2df3" - integrity sha512-2hvrBfjUE00PkqN+q0XP6yRAOGrR06uSiUoIQGZkc7GxvQ9H7v8quUPNtZjMg4uux69i8HWpIjLPUKwCuRGyNg== - dependencies: - has-value "^2.0.2" - isobject "^4.0.0" - untildify@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/untildify/-/untildify-4.0.0.tgz#2bc947b953652487e4600949fb091e3ae8cd919b" @@ -22383,10 +22676,33 @@ xml-parse-from-string@^1.0.0: resolved "https://registry.yarnpkg.com/xml-parse-from-string/-/xml-parse-from-string-1.0.1.tgz#a9029e929d3dbcded169f3c6e28238d95a5d5a28" integrity sha512-ErcKwJTF54uRzzNMXq2X5sMIy88zJvfN2DmdoQvy7PAFJ+tPRU6ydWuOKNMyfmOjdyBQTFREi60s0Y0SyI0G0g== -xml2js@0.1.x, xml2js@0.4.19, xml2js@0.5.0, xml2js@0.6.2, xml2js@^0.4.19, xml2js@^0.4.5: - version "0.6.2" - resolved "https://registry.yarnpkg.com/xml2js/-/xml2js-0.6.2.tgz#dd0b630083aa09c161e25a4d0901e2b2a929b499" - integrity sha512-T4rieHaC1EXcES0Kxxj4JWgaUQHDk+qwHcYOCFHfiwKz7tOVPLq7Hjq9dM1WCMhylqMEfP7hMcOIChvotiZegA== +xml2js@0.1.x: + version "0.1.14" + resolved "https://registry.yarnpkg.com/xml2js/-/xml2js-0.1.14.tgz#5274e67f5a64c5f92974cd85139e0332adc6b90c" + integrity sha512-pbdws4PPPNc1HPluSUKamY4GWMk592K7qwcj6BExbVOhhubub8+pMda/ql68b6L3luZs/OGjGSB5goV7SnmgnA== + dependencies: + sax ">=0.1.1" + +xml2js@0.4.19: + version "0.4.19" + resolved "https://registry.yarnpkg.com/xml2js/-/xml2js-0.4.19.tgz#686c20f213209e94abf0d1bcf1efaa291c7827a7" + integrity sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q== + dependencies: + sax ">=0.6.0" + xmlbuilder "~9.0.1" + +xml2js@0.5.0: + version "0.5.0" + resolved "https://registry.yarnpkg.com/xml2js/-/xml2js-0.5.0.tgz#d9440631fbb2ed800203fad106f2724f62c493b7" + integrity sha512-drPFnkQJik/O+uPKpqSgr22mpuFHqKdbS835iAQrUC73L2F5WkboIRd63ai/2Yg6I1jzifPFKH2NTK+cfglkIA== + dependencies: + sax ">=0.6.0" + xmlbuilder "~11.0.0" + +xml2js@^0.4.19, xml2js@^0.4.5: + version "0.4.23" + resolved "https://registry.yarnpkg.com/xml2js/-/xml2js-0.4.23.tgz#a0c69516752421eb2ac758ee4d4ccf58843eac66" + integrity sha512-ySPiMjM0+pLDftHgXY4By0uswI3SPKLDw/i3UXbnO8M/p28zqexCUoPmQFrYD+/1BzhGJSs2i1ERWKJAtiLrug== dependencies: sax ">=0.6.0" xmlbuilder "~11.0.0" @@ -22396,6 +22712,11 @@ xmlbuilder@~11.0.0: resolved "https://registry.yarnpkg.com/xmlbuilder/-/xmlbuilder-11.0.1.tgz#be9bae1c8a046e76b31127726347d0ad7002beb3" integrity sha512-fDlsI/kFEx7gLvbecc0/ohLG50fugQp8ryHzMTuW9vSa1GJ0XYWKnhsUx7oie3G98+r56aTQIUB4kht42R3JvA== +xmlbuilder@~9.0.1: + version "9.0.7" + resolved "https://registry.yarnpkg.com/xmlbuilder/-/xmlbuilder-9.0.7.tgz#132ee63d2ec5565c557e20f4c22df9aca686b10d" + integrity sha512-7YXTQc3P2l9+0rjaUbLwMKRhtmwg1M1eDf6nag7urC7pIPYLD9W/jmzQ4ptRSUbodw5S0jfoGTflLemQibSpeQ== + xmlchars@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/xmlchars/-/xmlchars-2.2.0.tgz#060fe1bcb7f9c76fe2a17db86a9bc3ab894210cb"