Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

refactor: Organize Builder development and test tooling (#6285)

Oleg Isonen4273b7001fa2
diff --git a/.github/actions/builder-e2e-build/action.yml b/.github/actions/builder-e2e-build/action.yml
index a11b08a24d..123f614177 100644
--- a/.github/actions/builder-e2e-build/action.yml
+++ b/.github/actions/builder-e2e-build/action.yml
@@ -30,11 +30,11 @@ runs:
- name: Build Builder
shell: bash
- run: pnpm e2e:builder:build
+ run: pnpm --filter @webstudio-is/builder build
- name: Generate schema snapshot
shell: bash
- run: pnpm e2e:builder:refresh-schema-cache
+ run: pnpm --filter @webstudio-is/builder e2e:schema-cache
- name: Upload prerequisites
uses: actions/upload-artifact@v6
diff --git a/.github/actions/builder-e2e-shard/action.yml b/.github/actions/builder-e2e-shard/action.yml
index fae6b18d3b..e1dd36d41d 100644
--- a/.github/actions/builder-e2e-shard/action.yml
+++ b/.github/actions/builder-e2e-shard/action.yml
@@ -42,8 +42,6 @@ runs:
- name: Run Builder E2E
shell: bash
env:
- E2E_SKIP_BUILDER_BUILD: "true"
- E2E_SKIP_CLEANUP: "true"
E2E_TEST_SHARD: ${{ inputs.shard }}
E2E_TEST_PARTITION: ${{ inputs.partition }}
run: |
@@ -51,7 +49,7 @@ runs:
if [ -n "$E2E_TEST_PARTITION" ]; then
args+=(--shard="$E2E_TEST_PARTITION")
fi
- pnpm e2e:builder -- "${args[@]}"
+ pnpm --filter @webstudio-is/builder e2e:ci:shard -- "${args[@]}"
- name: Upload report
if: failure()
@@ -66,9 +64,9 @@ runs:
- name: Print service logs
if: failure()
shell: bash
- run: docker compose $BUILDER_E2E_COMPOSE_ARGS logs
+ run: pnpm --filter @webstudio-is/builder backend snapshot logs
- name: Stop services
if: always()
shell: bash
- run: docker compose $BUILDER_E2E_COMPOSE_ARGS down --volumes --remove-orphans
+ run: pnpm --filter @webstudio-is/builder backend snapshot down --volumes --remove-orphans
diff --git a/.github/actions/test-suite/action.yml b/.github/actions/test-suite/action.yml
index 8cdc83aaa9..47b28a10b9 100644
--- a/.github/actions/test-suite/action.yml
+++ b/.github/actions/test-suite/action.yml
@@ -1,16 +1,17 @@
name: Test suite
-description: Run one package, CLI, or Builder test suite.
+description: Prepare browsers and run one repository test script.
inputs:
submodules-ssh-key:
description: SSH key for private test dependencies.
required: false
- scope:
- description: Test suite scope.
+ script:
+ description: Root package script to run.
required: true
- project:
- description: Builder Vitest project pattern.
+ browsers:
+ description: Browsers required by the test script.
+ default: none
required: false
runs:
@@ -23,7 +24,7 @@ runs:
- uses: ./.github/actions/ci-setup
- name: Cache Playwright Chromium
- if: inputs.scope != 'cli'
+ if: inputs.browsers != 'none'
uses: actions/cache@v5
with:
path: |
@@ -33,33 +34,22 @@ runs:
key: playwright-chromium-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
- name: Cache Playwright Firefox
- if: inputs.scope == 'packages'
+ if: inputs.browsers == 'chromium-firefox'
uses: actions/cache@v5
with:
path: ~/.cache/ms-playwright/firefox-*
key: playwright-firefox-${{ runner.os }}-${{ hashFiles('pnpm-lock.yaml') }}
- name: Install package test browsers
- if: inputs.scope == 'packages'
+ if: inputs.browsers == 'chromium-firefox'
shell: bash
run: pnpm --filter @webstudio-is/sdk-components-animation exec playwright install chromium firefox
- name: Install Builder test browser
- if: startsWith(inputs.scope, 'builder-')
+ if: inputs.browsers == 'chromium'
shell: bash
run: pnpm --filter @webstudio-is/builder exec playwright install chromium
- - name: Test packages
- if: inputs.scope == 'packages'
+ - name: Run test suite
shell: bash
- run: pnpm -r --filter "!@webstudio-is/builder" --filter "!webstudio" test
-
- - name: Test CLI
- if: inputs.scope == 'cli'
- shell: bash
- run: pnpm --filter webstudio test
-
- - name: Test Builder
- if: startsWith(inputs.scope, 'builder-')
- shell: bash
- run: pnpm --filter @webstudio-is/builder exec vitest run --project "${{ inputs.project }}"
+ run: pnpm run "${{ inputs.script }}"
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index f55a85309e..a056c53215 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -43,7 +43,7 @@ jobs:
run: pnpm --filter webstudio test:ssg-package
tests:
- name: tests (${{ matrix.environment }}, ${{ matrix.suite.scope }})
+ name: tests (${{ matrix.environment }}, ${{ matrix.suite.name }})
if: |
github.event_name == 'push' ||
github.event_name == 'pull_request' ||
@@ -57,12 +57,18 @@ jobs:
- empty
- development
suite:
- - scope: packages
- - scope: cli
- - scope: builder-core
- project: core-*
- - scope: builder-app
- project: app-*
+ - name: packages
+ script: test:packages
+ browsers: chromium-firefox
+ - name: cli
+ script: test:cli
+ browsers: none
+ - name: builder-core
+ script: test:builder:core
+ browsers: chromium
+ - name: builder-app
+ script: test:builder:app
+ browsers: chromium
environment:
name: ${{ matrix.environment }}
env:
@@ -77,8 +83,8 @@ jobs:
- uses: ./.github/actions/test-suite
with:
submodules-ssh-key: ${{ secrets.PRIVATE_GITHUB_DEPLOY_TOKEN }}
- scope: ${{ matrix.suite.scope }}
- project: ${{ matrix.suite.project }}
+ script: ${{ matrix.suite.script }}
+ browsers: ${{ matrix.suite.browsers }}
checks:
# Run on push, regular PR (for repo branches), or labeled PR with safe-to-deploy (for forks)
@@ -164,44 +170,7 @@ jobs:
- run: pnpm --filter "{./fixtures/*}..." build
- - uses: actions/github-script@v8
- with:
- script: |
- const assertSize = async (directory, maxSize) => {
- let result = ''
- await exec.exec('du', ['-sk', directory], {
- silent: true,
- listeners: {
- stdout: (data) => {
- result += data.toString()
- }
- }
- })
- const size = Number.parseInt(result, 10)
- return {
- passed: size <= maxSize,
- size,
- diff: size - maxSize,
- directory,
- }
- }
- const results = [
- await assertSize('./fixtures/ssg-cloudflare-pages/dist/client', 356),
- await assertSize('./fixtures/react-router-netlify/build/client', 376),
- await assertSize('./fixtures/webstudio-features/build/client', 3684),
- ]
- for (const result of results) {
- if (result.passed) {
- console.info(`${result.directory}: ${result.size}kB (${result.diff}kB)`)
- } else {
- console.info('')
- console.error(`${result.directory}: ${result.size}kB (+${result.diff}kB)`)
- }
- }
- if (results.some(result => result.passed === false)) {
- console.error('Some fixtures exceeded limits')
- process.exit(1)
- }
+ - run: pnpm check:fixture-sizes
builder-e2e-build:
name: builder-e2e build
@@ -252,7 +221,7 @@ jobs:
run-scripts: "true"
- name: Apply migrations to Supabase PostgreSQL
- run: pnpm e2e:builder:check-supabase-migrations
+ run: pnpm --filter @webstudio-is/builder e2e:supabase-migrations
builder-e2e:
name: builder-e2e (${{ matrix.shard }})
@@ -275,12 +244,6 @@ jobs:
environment:
name: development
- env:
- BUILDER_E2E_COMPOSE_ARGS: "--env-file apps/builder/.env -f apps/builder/docker-compose.yaml -f apps/builder/docker-compose.e2e-shard.yaml"
- COMPOSE_PROJECT_NAME: builder-e2e
- E2E_BUILD_DATABASE_IMAGE: "false"
- E2E_COMPOSE_OVERRIDE_FILE: ${{ github.workspace }}/apps/builder/docker-compose.e2e-shard.yaml
-
steps:
- uses: actions/checkout@v5
with:
diff --git a/apps/builder/docker-compose.local.yaml b/apps/builder/backend/compose.development.yaml
similarity index 100%
rename from apps/builder/docker-compose.local.yaml
rename to apps/builder/backend/compose.development.yaml
diff --git a/apps/builder/docker-compose.e2e-shard.yaml b/apps/builder/backend/compose.snapshot.yaml
similarity index 79%
rename from apps/builder/docker-compose.e2e-shard.yaml
rename to apps/builder/backend/compose.snapshot.yaml
index dcf1459c8a..0fe5376d33 100644
--- a/apps/builder/docker-compose.e2e-shard.yaml
+++ b/apps/builder/backend/compose.snapshot.yaml
@@ -8,4 +8,4 @@ services:
tmpfs:
- /var/lib/postgresql/data
volumes:
- - ./e2e/postgres-init.sql:/docker-entrypoint-initdb.d/postgres-init.sql:ro
+ - ./postgres/init.sql:/docker-entrypoint-initdb.d/postgres-init.sql:ro
diff --git a/apps/builder/docker-compose.e2e-supabase.yaml b/apps/builder/backend/compose.supabase.yaml
similarity index 66%
rename from apps/builder/docker-compose.e2e-supabase.yaml
rename to apps/builder/backend/compose.supabase.yaml
index 28b7f1b82a..b4d50e2e79 100644
--- a/apps/builder/docker-compose.e2e-supabase.yaml
+++ b/apps/builder/backend/compose.supabase.yaml
@@ -1,6 +1,6 @@
services:
db:
# Keep the compatibility check disposable while retaining the exact
- # Supabase image and initialization from docker-compose.yaml.
+ # Supabase image and initialization from compose.yaml.
tmpfs:
- /var/lib/postgresql/data
diff --git a/apps/builder/docker-compose.e2e.yaml b/apps/builder/backend/compose.test.yaml
similarity index 61%
rename from apps/builder/docker-compose.e2e.yaml
rename to apps/builder/backend/compose.test.yaml
index 3e2a54cb1a..f78c39bba5 100644
--- a/apps/builder/docker-compose.e2e.yaml
+++ b/apps/builder/backend/compose.test.yaml
@@ -2,11 +2,11 @@ services:
db:
build:
context: .
- dockerfile: e2e/postgres.Dockerfile
+ dockerfile: postgres/Dockerfile
image: webstudio-builder-e2e-postgres
environment:
POSTGRES_USER: ${POSTGRES_USER:?}
tmpfs:
- /var/lib/postgresql/data
volumes:
- - ./e2e/postgres-init.sql:/docker-entrypoint-initdb.d/postgres-init.sql:ro
+ - ./postgres/init.sql:/docker-entrypoint-initdb.d/postgres-init.sql:ro
diff --git a/apps/builder/docker-compose.yaml b/apps/builder/backend/compose.yaml
similarity index 100%
rename from apps/builder/docker-compose.yaml
rename to apps/builder/backend/compose.yaml
diff --git a/apps/builder/backend/lib.node.test.ts b/apps/builder/backend/lib.node.test.ts
new file mode 100644
index 0000000000..a6a79736ee
--- /dev/null
+++ b/apps/builder/backend/lib.node.test.ts
@@ -0,0 +1,120 @@
+import { execFile } from "node:child_process";
+import { mkdtemp, mkdir, rm, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { promisify } from "node:util";
+import { afterEach, expect, test } from "vitest";
+
+const execFileAsync = promisify(execFile);
+const backendLibrary = join(import.meta.dirname, "lib.sh");
+const temporaryDirectories: string[] = [];
+
+const createRepositoryFixture = async () => {
+ const root = await mkdtemp(join(tmpdir(), "webstudio-builder-backend-"));
+ temporaryDirectories.push(root);
+ await mkdir(join(root, "packages/prisma-client/prisma/migrations/initial"), {
+ recursive: true,
+ });
+ await mkdir(join(root, "apps/builder/backend"), { recursive: true });
+ await writeFile(
+ join(
+ root,
+ "packages/prisma-client/prisma/migrations/initial/migration.sql"
+ ),
+ "SELECT 1;"
+ );
+ await writeFile(join(root, "apps/builder/backend/compose.yaml"), "services:");
+ await writeFile(
+ join(root, "apps/builder/backend/compose.development.yaml"),
+ "services:"
+ );
+ await writeFile(
+ join(root, "apps/builder/backend/compose.test.yaml"),
+ "services:"
+ );
+ return root;
+};
+
+const readSchemaFingerprint = async (root: string) => {
+ const { stdout } = await execFileAsync(
+ "bash",
+ [
+ "-c",
+ 'source "$1"; ROOT_DIR="$2"; builder_backend_schema_fingerprint',
+ "bash",
+ backendLibrary,
+ root,
+ ],
+ { cwd: root }
+ );
+ return stdout.trim();
+};
+
+afterEach(async () => {
+ await Promise.all(
+ temporaryDirectories
+ .splice(0)
+ .map((directory) => rm(directory, { recursive: true, force: true }))
+ );
+});
+
+test("schema fingerprint includes new backend files", async () => {
+ const root = await createRepositoryFixture();
+ const before = await readSchemaFingerprint(root);
+
+ await writeFile(join(root, "apps/builder/backend/init.sql"), "SELECT 2;");
+
+ expect(await readSchemaFingerprint(root)).not.toBe(before);
+});
+
+test("backend modes select safe Compose projects", async () => {
+ const root = await createRepositoryFixture();
+ const readProjectName = async (mode: "development" | "test") => {
+ const { stdout } = await execFileAsync(
+ "bash",
+ [
+ "-c",
+ [
+ "unset COMPOSE_PROJECT_NAME",
+ 'source "$1"',
+ 'ROOT_DIR="$2"',
+ 'builder_backend_init "$3"',
+ 'printf "%s" "$COMPOSE_PROJECT_NAME"',
+ ].join("; "),
+ "bash",
+ backendLibrary,
+ root,
+ mode,
+ ],
+ { cwd: root }
+ );
+ return stdout;
+ };
+
+ expect(await readProjectName("development")).toBe("builder");
+ expect(await readProjectName("test")).toBe("builder-e2e");
+});
+
+test("migration bootstrap requires the Builder schema", async () => {
+ const root = await createRepositoryFixture();
+
+ await expect(
+ execFileAsync(
+ "bash",
+ [
+ "-c",
+ [
+ 'source "$1"',
+ 'ROOT_DIR="$2"',
+ "pnpm() { :; }",
+ "builder_backend_schema_exists() { return 1; }",
+ "builder_backend_migrate",
+ ].join("; "),
+ "bash",
+ backendLibrary,
+ root,
+ ],
+ { cwd: root }
+ )
+ ).rejects.toThrow("Migrations completed without creating the Builder schema");
+});
diff --git a/apps/builder/dev/backend.sh b/apps/builder/backend/lib.sh
similarity index 80%
rename from apps/builder/dev/backend.sh
rename to apps/builder/backend/lib.sh
index bfa8c41f3e..d114540670 100644
--- a/apps/builder/dev/backend.sh
+++ b/apps/builder/backend/lib.sh
@@ -1,8 +1,22 @@
#!/usr/bin/env bash
builder_backend_init() {
+ local mode="${1:?Builder backend mode is required}"
ROOT_DIR="${ROOT_DIR:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)}"
- SCHEMA_SNAPSHOT="${SCHEMA_SNAPSHOT:-$ROOT_DIR/.cache/builder-e2e/schema-$(builder_backend_migrations_fingerprint).sql}"
+ local backend_dir="$ROOT_DIR/apps/builder/backend"
+ local compose_override="$backend_dir/compose.${mode}.yaml"
+ if [ ! -f "$compose_override" ]; then
+ echo "Unknown Builder backend mode: $mode" >&2
+ return 1
+ fi
+
+ if [ "$mode" = "development" ]; then
+ export COMPOSE_PROJECT_NAME="${COMPOSE_PROJECT_NAME:-builder}"
+ else
+ # Disposable modes must never share the persistent development volume.
+ export COMPOSE_PROJECT_NAME="${COMPOSE_PROJECT_NAME:-builder-e2e}"
+ fi
+
COMPOSE_ENV=(
--env-file "$ROOT_DIR/apps/builder/.env"
)
@@ -10,12 +24,12 @@ builder_backend_init() {
COMPOSE_ENV+=(--env-file "$ROOT_DIR/apps/builder/.env.development")
fi
COMPOSE_FILES=(
- -f "$ROOT_DIR/apps/builder/docker-compose.yaml"
- -f "$COMPOSE_OVERRIDE_FILE"
+ -f "$backend_dir/compose.yaml"
+ -f "$compose_override"
)
}
-builder_backend_migrations_fingerprint() {
+builder_backend_schema_fingerprint() {
(
cd "$ROOT_DIR"
{
@@ -23,24 +37,22 @@ builder_backend_migrations_fingerprint() {
-mindepth 1 -maxdepth 1 -type d -print
find packages/prisma-client/prisma/migrations \
-type f \( -name migration.sql -o -name migration.ts \) -print
- printf '%s\n' \
- apps/builder/dev/backend.sh \
- apps/builder/docker-compose.yaml \
- apps/builder/docker-compose.e2e.yaml \
- apps/builder/docker-compose.e2e-shard.yaml \
- apps/builder/e2e/postgres.Dockerfile \
- apps/builder/e2e/postgres-init.sql
- } | LC_ALL=C sort | while IFS= read -r path; do
- if [ -f "$path" ]; then
- printf '%s ' "$path"
- git hash-object "$path"
+ find apps/builder/backend -type f ! -name '*.test.*' -print
+ } | LC_ALL=C sort | while IFS= read -r file; do
+ if [ -f "$file" ]; then
+ printf '%s ' "$file"
+ git hash-object "$file"
else
- printf '%s directory\n' "$path"
+ printf '%s directory\n' "$file"
fi
done
) | git hash-object --stdin
}
+builder_backend_init_schema_snapshot() {
+ SCHEMA_SNAPSHOT="${SCHEMA_SNAPSHOT:-$ROOT_DIR/.cache/builder-e2e/schema-$(builder_backend_schema_fingerprint).sql}"
+}
+
builder_compose() {
docker compose "${COMPOSE_ENV[@]}" "${COMPOSE_FILES[@]}" "$@"
}
@@ -120,7 +132,11 @@ builder_backend_bootstrap_schema_snapshot() {
}
builder_backend_migrate() {
- pnpm --dir "$ROOT_DIR" --filter=./packages/prisma-client migrations migrate --dev --cwd ../../apps/builder
+ pnpm --dir "$ROOT_DIR" --filter=@webstudio-is/prisma-client migrations migrate --dev --cwd ../../apps/builder
+ if ! builder_backend_schema_exists; then
+ echo "Migrations completed without creating the Builder schema" >&2
+ return 1
+ fi
}
builder_backend_bootstrap() {
diff --git a/apps/builder/e2e/postgres.Dockerfile b/apps/builder/backend/postgres/Dockerfile
similarity index 100%
rename from apps/builder/e2e/postgres.Dockerfile
rename to apps/builder/backend/postgres/Dockerfile
diff --git a/apps/builder/e2e/postgres-init.sql b/apps/builder/backend/postgres/init.sql
similarity index 100%
rename from apps/builder/e2e/postgres-init.sql
rename to apps/builder/backend/postgres/init.sql
diff --git a/apps/builder/backend/run.sh b/apps/builder/backend/run.sh
new file mode 100644
index 0000000000..13cad0fe6f
--- /dev/null
+++ b/apps/builder/backend/run.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
+mode="${1:?Usage: backend/run.sh <mode> <docker compose arguments...>}"
+shift
+
+source "$ROOT_DIR/apps/builder/backend/lib.sh"
+builder_backend_init "$mode"
+builder_compose "$@"
diff --git a/apps/builder/dev/run-local.sh b/apps/builder/dev/run-local.sh
index b39ac4c1a9..7b4af61dd0 100755
--- a/apps/builder/dev/run-local.sh
+++ b/apps/builder/dev/run-local.sh
@@ -2,9 +2,9 @@
set -euo pipefail
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
-COMPOSE_OVERRIDE_FILE="$ROOT_DIR/apps/builder/docker-compose.local.yaml"
-source "$ROOT_DIR/apps/builder/dev/backend.sh"
-builder_backend_init
+source "$ROOT_DIR/apps/builder/backend/lib.sh"
+builder_backend_init development
+builder_backend_init_schema_snapshot
cleanup() {
if [ "${LOCAL_DEV_CLEANUP:-${LOCAL_DEV_START_BUILDER:-true}}" != "true" ]; then
diff --git a/apps/builder/e2e/README.md b/apps/builder/e2e/README.md
index e930067bcb..b3a7043441 100644
--- a/apps/builder/e2e/README.md
+++ b/apps/builder/e2e/README.md
@@ -88,9 +88,9 @@ each invocation.
- Keep tests in a file independent even though Playwright runs them in
declaration order by default.
-CI discovers isolated Playwright shards from filename tags. Each shard uses two
-workers, and files are assigned by measured CI duration to keep jobs near three
-to four minutes:
+CI discovers isolated Playwright shards from filename tags. Each shard uses
+four workers, and files are assigned by measured CI duration to keep jobs near
+three to four minutes:
```txt
pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts
@@ -99,11 +99,24 @@ pages-actions.[shard-2].[shard-5].[shard-6].e2e.ts
Every E2E filename must contain at least one unique shard tag. CI derives its
matrix from those tags, so adding or removing a shard does not require editing
the workflow. Files with multiple tags are partitioned across those shards. All
-files selected by a shard must use the same set of tags. Each shard uses four
-workers. Rebalance by changing filename tags when measured job durations drift.
+files selected by a shard must use the same set of tags. Rebalance by changing
+filename tags when measured job durations drift.
Suites may opt into parallel mode only when every worker creates uniquely named
setup data and the tests do not depend on each other's mutations.
+## Backend organization
+
+Development, E2E, schema-cache, and Supabase compatibility commands share the
+backend definition in `apps/builder/backend`. `compose.yaml` defines the common
+services, and `compose.<mode>.yaml` defines only the differences for a named
+mode. Backend commands resolve these files by convention; callers do not pass
+Compose filenames.
+
+The schema-cache fingerprint discovers migration sources and non-test backend
+files automatically. Adding a database image, initialization script, Compose
+override, or migration therefore invalidates the cache without updating a
+filename registry.
+
## Failures
Failed shard jobs upload the Playwright HTML report, traces, screenshots,
diff --git a/apps/builder/e2e/db.ts b/apps/builder/e2e/db.ts
index 2c021bcd19..43260e33d1 100644
--- a/apps/builder/e2e/db.ts
+++ b/apps/builder/e2e/db.ts
@@ -9,11 +9,8 @@ import env from "../app/env/env.server";
const execFileAsync = promisify(execFile);
-const composeBaseFile = fileURLToPath(
- new URL("../docker-compose.yaml", import.meta.url)
-);
-const composeFile = fileURLToPath(
- new URL("../docker-compose.e2e.yaml", import.meta.url)
+const backendScript = fileURLToPath(
+ new URL("../backend/run.sh", import.meta.url)
);
const postgrest = createClient(env.POSTGREST_URL, env.POSTGREST_API_KEY);
@@ -53,13 +50,10 @@ export const resetDatabase = async () => {
`;
await execFileAsync(
- "docker",
+ "bash",
[
- "compose",
- "-f",
- composeBaseFile,
- "-f",
- composeFile,
+ backendScript,
+ process.env.E2E_BACKEND_MODE ?? "test",
"exec",
"-T",
"db",
diff --git a/apps/builder/e2e/run-step.node.test.ts b/apps/builder/e2e/run-step.node.test.ts
new file mode 100644
index 0000000000..54e496d91d
--- /dev/null
+++ b/apps/builder/e2e/run-step.node.test.ts
@@ -0,0 +1,26 @@
+import { execFile } from "node:child_process";
+import { join } from "node:path";
+import { promisify } from "node:util";
+import { expect, test } from "vitest";
+
+const execFileAsync = promisify(execFile);
+const runStepLibrary = join(import.meta.dirname, "run-step.sh");
+
+test("automated steps do not read from the caller's terminal", async () => {
+ const { stdout } = await execFileAsync("bash", [
+ "-c",
+ [
+ 'source "$1"',
+ "reject_input() {",
+ " if read -r; then",
+ " return 1",
+ " fi",
+ "}",
+ 'run_step "closed stdin" 2 reject_input <<< "terminal input"',
+ ].join("\n"),
+ "bash",
+ runStepLibrary,
+ ]);
+
+ expect(stdout).toContain("✓ closed stdin");
+});
diff --git a/apps/builder/e2e/run-step.sh b/apps/builder/e2e/run-step.sh
index 673a564534..f64be1d6e5 100644
--- a/apps/builder/e2e/run-step.sh
+++ b/apps/builder/e2e/run-step.sh
@@ -16,7 +16,7 @@ run_step() {
set -m
restore_monitor_mode=true
fi
- "$@" &
+ "$@" </dev/null &
local pid="$!"
if [ "$restore_monitor_mode" = "true" ]; then
set +m
diff --git a/apps/builder/e2e/run-local.sh b/apps/builder/e2e/run.sh
similarity index 82%
rename from apps/builder/e2e/run-local.sh
rename to apps/builder/e2e/run.sh
index 8480c9e43b..cfa1977df6 100644
--- a/apps/builder/e2e/run-local.sh
+++ b/apps/builder/e2e/run.sh
@@ -2,16 +2,55 @@
set -euo pipefail
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
-COMPOSE_OVERRIDE_FILE="${E2E_COMPOSE_OVERRIDE_FILE:-$ROOT_DIR/apps/builder/docker-compose.e2e.yaml}"
+mode="${1:-run}"
+if [ "$#" -gt 0 ]; then
+ shift
+fi
+
+case "$mode" in
+ run)
+ ;;
+ dev-backend)
+ export E2E_SKIP_CLEANUP=true
+ export E2E_RUN_TESTS=false
+ export E2E_START_POSTGREST=true
+ export E2E_DB_BOOTSTRAP=if-empty
+ export E2E_INSTALL_PLAYWRIGHT=false
+ ;;
+ dev)
+ export E2E_SKIP_CLEANUP=true
+ export E2E_DB_BOOTSTRAP=if-empty
+ export E2E_INSTALL_PLAYWRIGHT=false
+ export E2E_BUILDER_URL="${E2E_BUILDER_URL:-https://127.0.0.1:3000}"
+ ;;
+ schema-cache)
+ export E2E_DB_BOOTSTRAP=migrations
+ export E2E_WRITE_SCHEMA_SNAPSHOT=true
+ export E2E_RUN_TESTS=false
+ ;;
+ supabase-migrations)
+ export E2E_BACKEND_MODE=supabase
+ export E2E_BUILD_DATABASE_IMAGE=false
+ export E2E_DB_BOOTSTRAP=migrations
+ export E2E_RUN_TESTS=false
+ ;;
+ ci-shard)
+ export E2E_BACKEND_MODE=snapshot
+ export E2E_BUILD_DATABASE_IMAGE=false
+ export E2E_SKIP_BUILDER_BUILD=true
+ export E2E_SKIP_CLEANUP=true
+ ;;
+ *)
+ echo "Unknown Builder E2E mode: $mode" >&2
+ exit 1
+ ;;
+esac
+
PLAYWRIGHT_ARGS=("$@")
if [ "${PLAYWRIGHT_ARGS[0]:-}" = "--" ]; then
PLAYWRIGHT_ARGS=("${PLAYWRIGHT_ARGS[@]:1}")
fi
-# Keep the disposable E2E backend independent from the persistent local
-# development backend. In particular, E2E cleanup must never remove the local
-# database volume.
-export COMPOSE_PROJECT_NAME="${E2E_COMPOSE_PROJECT_NAME:-builder-e2e}"
export PGPORT="${E2E_PGPORT:-55434}"
export POSTGREST_PORT="${E2E_POSTGREST_PORT:-55435}"
export POSTGRES_DB="${E2E_POSTGRES_DB:-webstudio}"
@@ -23,10 +62,12 @@ export POSTGRES_PASSWORD="${E2E_POSTGRES_PASSWORD:-pass}"
export DATABASE_URL="${E2E_DATABASE_URL:-postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:${PGPORT}/${POSTGRES_DB}?pgbouncer=true}"
export DIRECT_URL="${E2E_DIRECT_URL:-postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:${PGPORT}/${POSTGRES_DB}}"
export POSTGREST_URL="${E2E_POSTGREST_URL:-http://localhost:${POSTGREST_PORT}}"
+export E2E_BACKEND_MODE="${E2E_BACKEND_MODE:-test}"
-source "$ROOT_DIR/apps/builder/dev/backend.sh"
+source "$ROOT_DIR/apps/builder/backend/lib.sh"
source "$ROOT_DIR/apps/builder/e2e/run-step.sh"
-builder_backend_init
+builder_backend_init "$E2E_BACKEND_MODE"
+builder_backend_init_schema_snapshot
export E2E_DB_BOOTSTRAP="${E2E_DB_BOOTSTRAP:-auto}"
export E2E_BUILD_DATABASE_IMAGE="${E2E_BUILD_DATABASE_IMAGE:-true}"
diff --git a/apps/builder/package.json b/apps/builder/package.json
index 9a592185ca..6daec101b8 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -12,12 +12,17 @@
"build:tailwind-preflight": "tsx --conditions=webstudio ./app/shared/tailwind/preflight-bin.ts && oxfmt ./app/shared/tailwind/__generated__/preflight.ts",
"generate-server-only-api-metadata": "tsx --conditions=webstudio --tsconfig tsconfig.json --import ../../scripts/register-react-global.ts ./scripts/generate-server-only-api-metadata.ts && (cd ../../packages/protocol && oxfmt src/builder-api/__generated__/server-only-router-operation-metadata.ts)",
"start": "remix-serve build/server/index.js",
+ "backend": "bash ./backend/run.sh",
"dev": "remix vite:dev",
+ "dev:local": "bash ./dev/run-local.sh",
"dev:auth": "DEBUG=ws:* remix vite:dev",
"e2e:ci": "node --env-file=.env --env-file-if-exists=.env.development --conditions=webstudio ./node_modules/@playwright/test/cli.js test --config=playwright.config.ts",
- "e2e:local": "bash ./e2e/run-local.sh",
- "e2e:dev:backend": "E2E_SKIP_CLEANUP=true E2E_RUN_TESTS=false E2E_START_POSTGREST=true E2E_DB_BOOTSTRAP=if-empty E2E_INSTALL_PLAYWRIGHT=false bash ./e2e/run-local.sh",
- "e2e:dev": "E2E_SKIP_CLEANUP=true E2E_DB_BOOTSTRAP=if-empty E2E_INSTALL_PLAYWRIGHT=false E2E_BUILDER_URL=${E2E_BUILDER_URL:-https://127.0.0.1:3000} bash ./e2e/run-local.sh",
+ "e2e": "bash ./e2e/run.sh run",
+ "e2e:dev:backend": "bash ./e2e/run.sh dev-backend",
+ "e2e:dev": "bash ./e2e/run.sh dev",
+ "e2e:schema-cache": "bash ./e2e/run.sh schema-cache",
+ "e2e:supabase-migrations": "bash ./e2e/run.sh supabase-migrations",
+ "e2e:ci:shard": "bash ./e2e/run.sh ci-shard",
"typecheck": "tsc --noEmit --emitDeclarationOnly false",
"test": "vitest run",
"test:browser": "vitest run --project '*-browser-*'"
diff --git a/apps/builder/vitest.config.ts b/apps/builder/vitest.config.ts
index d9b6e8c280..ab77d3f57e 100644
--- a/apps/builder/vitest.config.ts
+++ b/apps/builder/vitest.config.ts
@@ -1,13 +1,11 @@
import { resolve } from "node:path";
import { defineConfig } from "vitest/config";
-import { browserTestPorts } from "../../scripts/vitest-browser-workspace";
const nodeTestGlob = "**/*.{server,node}.{test,spec}.{ts,tsx}";
const browserProject = (
group: "core" | "app",
name: string,
- port: number,
include: string[],
exclude: string[] = []
) => ({
@@ -21,7 +19,6 @@ const browserProject = (
enabled: true,
headless: true,
screenshotFailures: false,
- api: { port },
instances: [{ browser: "chromium" as const }],
},
},
@@ -38,38 +35,33 @@ const serverProject = {
const projects = [
serverProject,
- browserProject("core", "builder-settings", browserTestPorts.builderSettings, [
+ browserProject("core", "builder-settings", [
"app/builder/features/{settings-panel,style-panel}/**/*.{test,spec}.{ts,tsx}",
]),
browserProject(
"core",
"builder-features",
- browserTestPorts.builderFeatures,
["app/builder/features/**/*.{test,spec}.{ts,tsx}"],
[
"app/builder/features/{settings-panel,style-panel}/**/*.{test,spec}.{ts,tsx}",
]
),
- browserProject("app", "builder-shared", browserTestPorts.builderShared, [
+ browserProject("app", "builder-shared", [
"app/builder/shared/**/*.{test,spec}.{ts,tsx}",
"app/builder/*.{test,spec}.{ts,tsx}",
]),
- browserProject("app", "shared-heavy", browserTestPorts.builderSharedHeavy, [
+ browserProject("app", "shared-heavy", [
"app/shared/{copy-paste,instance-utils,sync}/**/*.{test,spec}.{ts,tsx}",
]),
browserProject(
"app",
"shared",
- browserTestPorts.builderSharedGeneral,
["app/shared/**/*.{test,spec}.{ts,tsx}"],
["app/shared/{copy-paste,instance-utils,sync}/**/*.{test,spec}.{ts,tsx}"]
),
- browserProject(
- "app",
- "canvas-dashboard",
- browserTestPorts.builderCanvasDashboard,
- ["app/{canvas,dashboard}/**/*.{test,spec}.{ts,tsx}"]
- ),
+ browserProject("app", "canvas-dashboard", [
+ "app/{canvas,dashboard}/**/*.{test,spec}.{ts,tsx}",
+ ]),
];
export default defineConfig({
diff --git a/package.json b/package.json
index faa79aff69..c03707fed7 100644
--- a/package.json
+++ b/package.json
@@ -8,12 +8,13 @@
"build": "pnpm -r --filter='!./fixtures/*' build",
"webstudio": "node packages/cli/local.js",
"dts": "pnpm -r dts",
- "dev": "bash ./apps/builder/dev/run-local.sh",
+ "dev": "pnpm --filter=@webstudio-is/builder dev:local",
"evaluations": "pnpm --filter webstudio evaluations",
"lint": "oxlint --deny-warnings",
"check:package-boundaries": "node scripts/check-package-boundaries.mjs",
"check:generated-api": "pnpm --filter @webstudio-is/project-build generate-runtime-operation-contracts && pnpm --filter @webstudio-is/builder generate-server-only-api-metadata && node scripts/check-clean-files.mjs packages/project-build/src/contracts/__generated__/runtime-operation-contracts.ts packages/protocol/src/builder-api/__generated__/server-only-router-operation-metadata.ts",
"check:generated-docs": "pnpm --filter @webstudio-is/project-build generate-docs && pnpm --filter webstudio generate-docs && pnpm docs:mcp:test && pnpm docs:mcp:typecheck && pnpm docs:content-engine:test && pnpm docs:mcp:check && pnpm docs:content-engine:check && node scripts/check-clean-files.mjs packages/project-build/src/docs.generated.ts packages/cli/src/docs.generated.ts",
+ "check:fixture-sizes": "tsx scripts/check-fixture-sizes.ts",
"docs:mcp:sync": "tsx scripts/docs/generate-mcp-docs.ts",
"docs:mcp:check": "pnpm docs:mcp:sync && node scripts/check-clean-files.mjs docs/university/mcp.md",
"docs:mcp:test": "tsx --test scripts/docs/generate-mcp-docs.test.ts",
@@ -21,14 +22,18 @@
"docs:content-engine:sync": "tsx scripts/docs/generate-content-engine-docs.ts",
"docs:content-engine:check": "pnpm docs:content-engine:sync && node scripts/check-clean-files.mjs docs/university/foundations/content-engine-reference.md",
"docs:content-engine:test": "tsx --test scripts/docs/generate-content-engine-docs.test.ts && pnpm --filter webstudio exec vitest run src/content-engine-reference.test.ts",
+ "test:packages": "pnpm -r --filter '!@webstudio-is/builder' --filter '!webstudio' test",
+ "test:cli": "pnpm --filter webstudio test",
+ "test:builder:core": "pnpm --filter @webstudio-is/builder exec vitest run --project 'core-*'",
+ "test:builder:app": "pnpm --filter @webstudio-is/builder exec vitest run --project 'app-*'",
"fixtures": "pnpm -r fixtures:link && pnpm -r fixtures:sync && pnpm -r fixtures:build",
"checks": "pnpm -r test && pnpm -r typecheck && pnpm lint && pnpm check:package-boundaries && pnpm check:generated-api && pnpm check:generated-docs && pnpm fixtures",
- "e2e:builder": "bash ./apps/builder/e2e/run-local.sh",
+ "e2e:builder": "pnpm --filter=@webstudio-is/builder e2e",
"e2e:builder:build": "pnpm --filter=@webstudio-is/builder build",
- "e2e:builder:dev:backend": "E2E_SKIP_CLEANUP=true E2E_RUN_TESTS=false E2E_START_POSTGREST=true E2E_DB_BOOTSTRAP=if-empty E2E_INSTALL_PLAYWRIGHT=false bash ./apps/builder/e2e/run-local.sh",
- "e2e:builder:dev": "E2E_SKIP_CLEANUP=true E2E_DB_BOOTSTRAP=if-empty E2E_INSTALL_PLAYWRIGHT=false E2E_BUILDER_URL=${E2E_BUILDER_URL:-https://127.0.0.1:3000} bash ./apps/builder/e2e/run-local.sh",
- "e2e:builder:refresh-schema-cache": "E2E_DB_BOOTSTRAP=migrations E2E_WRITE_SCHEMA_SNAPSHOT=true E2E_RUN_TESTS=false bash ./apps/builder/e2e/run-local.sh",
- "e2e:builder:check-supabase-migrations": "E2E_BUILD_DATABASE_IMAGE=false E2E_COMPOSE_OVERRIDE_FILE=./apps/builder/docker-compose.e2e-supabase.yaml E2E_DB_BOOTSTRAP=migrations E2E_RUN_TESTS=false bash ./apps/builder/e2e/run-local.sh",
+ "e2e:builder:dev:backend": "pnpm --filter=@webstudio-is/builder e2e:dev:backend",
+ "e2e:builder:dev": "pnpm --filter=@webstudio-is/builder e2e:dev",
+ "e2e:builder:refresh-schema-cache": "pnpm --filter=@webstudio-is/builder e2e:schema-cache",
+ "e2e:builder:check-supabase-migrations": "pnpm --filter=@webstudio-is/builder e2e:supabase-migrations",
"playwright": "pnpm -r playwright-init",
"format": "oxfmt",
"storybook:dev": "storybook dev -p 6006",
diff --git a/packages/design-system/vitest.config.ts b/packages/design-system/vitest.config.ts
index 7f0235b70e..6195b9614f 100644
--- a/packages/design-system/vitest.config.ts
+++ b/packages/design-system/vitest.config.ts
@@ -1,9 +1,4 @@
import { defineConfig } from "vitest/config";
-import {
- browserTestPorts,
- createBrowserTestConfig,
-} from "../../scripts/vitest-browser-workspace";
+import { createBrowserTestConfig } from "../../scripts/vitest-browser-workspace";
-export default defineConfig(
- createBrowserTestConfig(browserTestPorts.designSystem)
-);
+export default defineConfig(createBrowserTestConfig());
diff --git a/packages/query-builder-react/vitest.config.ts b/packages/query-builder-react/vitest.config.ts
index d77973d90d..6195b9614f 100644
--- a/packages/query-builder-react/vitest.config.ts
+++ b/packages/query-builder-react/vitest.config.ts
@@ -1,9 +1,4 @@
import { defineConfig } from "vitest/config";
-import {
- browserTestPorts,
- createBrowserTestConfig,
-} from "../../scripts/vitest-browser-workspace";
+import { createBrowserTestConfig } from "../../scripts/vitest-browser-workspace";
-export default defineConfig(
- createBrowserTestConfig(browserTestPorts.queryBuilderReact)
-);
+export default defineConfig(createBrowserTestConfig());
diff --git a/packages/sdk-components-animation/vitest.config.ts b/packages/sdk-components-animation/vitest.config.ts
index 38b4cefdb7..92144867e5 100644
--- a/packages/sdk-components-animation/vitest.config.ts
+++ b/packages/sdk-components-animation/vitest.config.ts
@@ -2,7 +2,6 @@ import { defineConfig } from "vitest/config";
import { existsSync } from "node:fs";
import path from "node:path";
import fg from "fast-glob";
-import { browserTestPorts } from "../../scripts/vitest-browser-workspace";
const rootDir = ["..", "../..", "../../.."]
.map((dir) => path.join(__dirname, dir))
@@ -42,7 +41,6 @@ export default defineConfig({
enabled: true,
headless: true,
screenshotFailures: false,
- api: { port: browserTestPorts.sdkComponentsAnimation },
instances: [{ browser: "chromium" }, { browser: "firefox" }],
fileParallelism: false,
},
diff --git a/packages/sdk-components-react-radix/vitest.config.ts b/packages/sdk-components-react-radix/vitest.config.ts
index d14e37ac42..6195b9614f 100644
--- a/packages/sdk-components-react-radix/vitest.config.ts
+++ b/packages/sdk-components-react-radix/vitest.config.ts
@@ -1,9 +1,4 @@
import { defineConfig } from "vitest/config";
-import {
- browserTestPorts,
- createBrowserTestConfig,
-} from "../../scripts/vitest-browser-workspace";
+import { createBrowserTestConfig } from "../../scripts/vitest-browser-workspace";
-export default defineConfig(
- createBrowserTestConfig(browserTestPorts.sdkComponentsReactRadix)
-);
+export default defineConfig(createBrowserTestConfig());
diff --git a/packages/sdk-components-react-router/vitest.config.ts b/packages/sdk-components-react-router/vitest.config.ts
index 66519991b6..6195b9614f 100644
--- a/packages/sdk-components-react-router/vitest.config.ts
+++ b/packages/sdk-components-react-router/vitest.config.ts
@@ -1,9 +1,4 @@
import { defineConfig } from "vitest/config";
-import {
- browserTestPorts,
- createBrowserTestConfig,
-} from "../../scripts/vitest-browser-workspace";
+import { createBrowserTestConfig } from "../../scripts/vitest-browser-workspace";
-export default defineConfig(
- createBrowserTestConfig(browserTestPorts.sdkComponentsReactRouter)
-);
+export default defineConfig(createBrowserTestConfig());
diff --git a/packages/sdk-components-react/vitest.config.ts b/packages/sdk-components-react/vitest.config.ts
index 0bd31a65be..6195b9614f 100644
--- a/packages/sdk-components-react/vitest.config.ts
+++ b/packages/sdk-components-react/vitest.config.ts
@@ -1,9 +1,4 @@
import { defineConfig } from "vitest/config";
-import {
- browserTestPorts,
- createBrowserTestConfig,
-} from "../../scripts/vitest-browser-workspace";
+import { createBrowserTestConfig } from "../../scripts/vitest-browser-workspace";
-export default defineConfig(
- createBrowserTestConfig(browserTestPorts.sdkComponentsReact)
-);
+export default defineConfig(createBrowserTestConfig());
diff --git a/scripts/check-fixture-sizes.ts b/scripts/check-fixture-sizes.ts
new file mode 100644
index 0000000000..8e7ebc6622
--- /dev/null
+++ b/scripts/check-fixture-sizes.ts
@@ -0,0 +1,38 @@
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+
+const execFileAsync = promisify(execFile);
+
+const fixtureLimits = [
+ ["./fixtures/ssg-cloudflare-pages/dist/client", 356],
+ ["./fixtures/react-router-netlify/build/client", 376],
+ ["./fixtures/webstudio-features/build/client", 3684],
+] as const;
+
+const results = await Promise.all(
+ fixtureLimits.map(async ([directory, maxSize]) => {
+ const { stdout } = await execFileAsync("du", ["-sk", directory]);
+ const size = Number.parseInt(stdout, 10);
+ return {
+ directory,
+ size,
+ diff: size - maxSize,
+ passed: size <= maxSize,
+ };
+ })
+);
+
+for (const result of results) {
+ const difference = result.diff > 0 ? `+${result.diff}` : result.diff;
+ const message = `${result.directory}: ${result.size}kB (${difference}kB)`;
+ if (result.passed) {
+ console.info(message);
+ } else {
+ console.error(`\n${message}`);
+ }
+}
+
+if (results.some((result) => result.passed === false)) {
+ console.error("Some fixtures exceeded limits");
+ process.exitCode = 1;
+}
diff --git a/scripts/vitest-browser-workspace.ts b/scripts/vitest-browser-workspace.ts
index b1b9ccb664..f6ea2a650f 100644
--- a/scripts/vitest-browser-workspace.ts
+++ b/scripts/vitest-browser-workspace.ts
@@ -1,19 +1,4 @@
-export const browserTestPorts = {
- builderSettings: 63401,
- builderFeatures: 63402,
- builderShared: 63403,
- builderSharedHeavy: 63404,
- builderSharedGeneral: 63405,
- builderCanvasDashboard: 63406,
- designSystem: 63407,
- queryBuilderReact: 63408,
- sdkComponentsAnimation: 63409,
- sdkComponentsReact: 63410,
- sdkComponentsReactRadix: 63411,
- sdkComponentsReactRouter: 63412,
-} as const;
-
-const createBrowserWorkspace = (port: number) => [
+const createBrowserWorkspace = () => [
{
extends: "./vitest.config.ts",
test: {
@@ -24,7 +9,6 @@ const createBrowserWorkspace = (port: number) => [
enabled: true,
headless: true,
screenshotFailures: false,
- api: { port },
instances: [{ browser: "chromium" as const }],
},
},
@@ -42,7 +26,7 @@ const createBrowserWorkspace = (port: number) => [
},
];
-export const createBrowserTestConfig = (port: number) => ({
+export const createBrowserTestConfig = () => ({
optimizeDeps: {
include: ["react/jsx-dev-runtime"],
},
@@ -55,6 +39,6 @@ export const createBrowserTestConfig = (port: number) => ({
},
},
test: {
- workspace: createBrowserWorkspace(port),
+ workspace: createBrowserWorkspace(),
},
});