diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 70aeae2..da1c291 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -69,3 +69,65 @@ jobs: run: pnpm run build - name: Lint run: pnpm run lint + + e2e: + name: E2E (Obsidian) + runs-on: ubuntu-latest + timeout-minutes: 20 + env: + # Pinned like a dependency: bump deliberately, at least seven days after release. + OBSIDIAN_VERSION: 1.14.4 + OBSIDIAN_SHA256: e70b7cd63787e7f798a84fec453f5c446b91877bd3f612e8fb98e9b76cc81120 + steps: + - name: Harden Runner + uses: step-security/harden-runner@ccd8616d44fd3846e67624a50d5aad6d37bf2d25 # v2.22.1 + with: + egress-policy: audit + - name: Checkout + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - name: Setup pnpm + uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0 + - name: Use Node.js 24 + uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0 + with: + node-version: 24 + check-latest: true + cache: pnpm + - name: Install dependencies + run: pnpm install --frozen-lockfile + - name: Install Xvfb + run: sudo apt-get update && sudo apt-get install -y --no-install-recommends xvfb xauth + - name: Install Obsidian + run: | + archive="$RUNNER_TEMP/obsidian.tar.gz" + curl -fsSL -o "$archive" "https://github.com/obsidianmd/obsidian-releases/releases/download/v${OBSIDIAN_VERSION}/obsidian-${OBSIDIAN_VERSION}.tar.gz" + echo "${OBSIDIAN_SHA256} $archive" | sha256sum -c - + tar -xzf "$archive" -C "$RUNNER_TEMP" + echo "OBSIDIAN_DIR=$RUNNER_TEMP/obsidian-${OBSIDIAN_VERSION}" >> "$GITHUB_ENV" + - name: Build + run: pnpm run build + - name: Start Obsidian + run: | + pnpm run --silent start:e2e-obsidian -- \ + --obsidian-app "$OBSIDIAN_DIR/obsidian" \ + --obsidian-bin "$OBSIDIAN_DIR/obsidian-cli" \ + --print-env > "$RUNNER_TEMP/e2e-env.sh" + sed -n "s/^export \([A-Z0-9_]*\)='\(.*\)'$/\1=\2/p" "$RUNNER_TEMP/e2e-env.sh" >> "$GITHUB_ENV" + - name: Run E2E suite + # The instance's CLI socket lives under its private HOME. + run: HOME="$OBSIDIAN_E2E_OBSIDIAN_HOME" ./node_modules/.bin/vitest run --config vitest.e2e.config.mts + - name: Upload failure artifacts + if: failure() + uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2 + with: + name: e2e-failure-artifacts + path: | + .obsidian-e2e-artifacts/ + /tmp/metaedit-obsidian-e2e/*/obsidian.log + if-no-files-found: ignore + include-hidden-files: true + - name: Stop Obsidian + if: always() + run: pnpm run --silent stop:e2e-obsidian diff --git a/AGENTS.md b/AGENTS.md index 9dd75ab..3f59d0e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -42,6 +42,8 @@ hand-written, committed release asset. - `pnpm run lint`: ESLint over the TypeScript sources. - `pnpm run test`: Vitest unit suite (jsdom-free, `node` environment). - `pnpm run test:e2e`: build, then run the live Obsidian E2E suite (`tests/e2e/`). + CI's `E2E (Obsidian)` job runs the same suite headless under Xvfb against the + Obsidian version pinned in `.github/workflows/ci.yml`. - `pnpm run obsidian:e2e -- `: run an `obsidian` CLI command against an isolated, auto-provisioned worktree instance (see below). diff --git a/esbuild.config.mjs b/esbuild.config.mjs index ad56893..2f29fa2 100644 --- a/esbuild.config.mjs +++ b/esbuild.config.mjs @@ -4,6 +4,7 @@ import {dirname, join, relative, sep} from "node:path"; import {fileURLToPath} from "node:url"; import esbuild from "esbuild"; import {compile} from "svelte/compiler"; +import {rejectSvelteRuneModules} from "./scripts/svelte-rune-guard.mjs"; const isProduction = process.argv.includes("production"); const projectSrcDir = `${join(dirname(fileURLToPath(import.meta.url)), "src")}${sep}`; @@ -64,18 +65,6 @@ function toEsbuildMessage({message, start, end}, file, source) { }; } -// Registered first so no other loader can hand esbuild a rune module's source. -function rejectSvelteRuneModules() { - return { - name: "reject-svelte-rune-modules", - setup(build) { - build.onLoad({filter: /\.svelte\.[cm]?[jt]s$/}, (args) => ({ - errors: [{text: `Svelte rune modules (.svelte.js/.svelte.ts) are not supported by this build: ${args.path}`}], - })); - }, - }; -} - function compileSvelte() { return { name: "compile-svelte", @@ -116,6 +105,7 @@ const options = { }, logLevel: "info", plugins: [ + // Registered first so no other loader can hand esbuild a rune module's source. rejectSvelteRuneModules(), ...(isProduction ? [stripDevCommandBlocks()] : []), compileSvelte(), diff --git a/package.json b/package.json index ab586a7..3adb233 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "eslint-plugin-svelte": "^3.23.1", "globals": "^17.13.0", "obsidian": "1.14.4", - "obsidian-e2e": "^0.14.0", + "obsidian-e2e": "^0.15.0", "svelte": "^5.57.2", "svelte-check": "^4.7.7", "typescript": "^6.0.3", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1c0a3b9..b532b1e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -185,8 +185,8 @@ importers: specifier: 1.14.4 version: 1.14.4(@codemirror/state@6.7.6)(@codemirror/view@6.43.13) obsidian-e2e: - specifier: ^0.14.0 - version: 0.14.0(vitest@5.0.5(@types/node@26.6.5)(vite@8.3.4(@types/node@26.6.5)(esbuild@0.28.2)(yaml@2.9.1))) + specifier: ^0.15.0 + version: 0.15.0(vitest@5.0.5(@types/node@26.6.5)(vite@8.3.4(@types/node@26.6.5)(esbuild@0.28.2)(yaml@2.9.1))) svelte: specifier: ^5.57.2 version: 5.57.2(@typescript-eslint/types@8.71.2) @@ -1052,12 +1052,12 @@ packages: natural-compare@1.4.0: resolution: {integrity: sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==} - obsidian-e2e@0.14.0: - resolution: {integrity: sha512-774GBjGHITC+LneNhnYCxpowVTE8w6ZmEgu+nTXuv0x8E+L95ptIe2xYQ1oRfS5Tq/RHYcEG0+cezcnpWWXKNQ==} - engines: {node: ^20.19.0 || >=22.12.0} + obsidian-e2e@0.15.0: + resolution: {integrity: sha512-T1+YCiK1XB6VnpQ7NtwGGE8zybba23bXxn8gM2rv98Nnx9rw82qKiaaa6jh67NfO4rjeZKT3CQ3r/PdoP3vM3A==} + engines: {node: '>=22.12.0'} hasBin: true peerDependencies: - vitest: '>=3' + vitest: ^5.0.0 peerDependenciesMeta: vitest: optional: true @@ -2090,7 +2090,7 @@ snapshots: natural-compare@1.4.0: {} - obsidian-e2e@0.14.0(vitest@5.0.5(@types/node@26.6.5)(vite@8.3.4(@types/node@26.6.5)(esbuild@0.28.2)(yaml@2.9.1))): + obsidian-e2e@0.15.0(vitest@5.0.5(@types/node@26.6.5)(vite@8.3.4(@types/node@26.6.5)(esbuild@0.28.2)(yaml@2.9.1))): dependencies: yaml: 2.9.1 optionalDependencies: diff --git a/scripts/svelte-rune-guard.mjs b/scripts/svelte-rune-guard.mjs new file mode 100644 index 0000000..18e5e0f --- /dev/null +++ b/scripts/svelte-rune-guard.mjs @@ -0,0 +1,13 @@ +// The build compiles `.svelte` components only. A `.svelte.js`/`.svelte.ts` rune +// module would need svelte's compileModule, and without it esbuild would bundle +// the raw `$state`/`$derived` calls, which then throw at runtime. +export function rejectSvelteRuneModules() { + return { + name: "reject-svelte-rune-modules", + setup(build) { + build.onLoad({filter: /\.svelte\.[cm]?[jt]s$/}, (args) => ({ + errors: [{text: `Svelte rune modules (.svelte.js/.svelte.ts) are not supported by this build: ${args.path}`}], + })); + }, + }; +} diff --git a/scripts/svelte-rune-guard.test.ts b/scripts/svelte-rune-guard.test.ts new file mode 100644 index 0000000..ec184bc --- /dev/null +++ b/scripts/svelte-rune-guard.test.ts @@ -0,0 +1,33 @@ +import { mkdtempSync, rmSync, writeFileSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import esbuild from "esbuild"; +import { afterAll, describe, expect, it } from "vitest"; +import { rejectSvelteRuneModules } from "./svelte-rune-guard.mjs"; + +const dir = mkdtempSync(join(tmpdir(), "metaedit-rune-guard-")); +afterAll(() => rmSync(dir, { recursive: true, force: true })); + +function bundle(importPath: string, source: string) { + writeFileSync(join(dir, importPath), source); + return esbuild.build({ + stdin: { contents: `import {value} from "./${importPath}"; console.debug(value);`, resolveDir: dir }, + bundle: true, + write: false, + logLevel: "silent", + plugins: [rejectSvelteRuneModules()], + }); +} + +describe("rejectSvelteRuneModules", () => { + it.each(["counter.svelte.ts", "counter.svelte.js", "counter.svelte.mts"])("fails the build when %s is imported", async (file) => { + await expect(bundle(file, "export const value = $state(0);")).rejects.toThrow( + /Svelte rune modules \(\.svelte\.js\/\.svelte\.ts\) are not supported by this build/, + ); + }); + + it("leaves ordinary modules alone", async () => { + const result = await bundle("counter.ts", "export const value = 0;"); + expect(result.errors).toEqual([]); + }); +}); diff --git a/tests/e2e/audit-suggester.test.ts b/tests/e2e/audit-suggester.test.ts index 394d496..1c262d4 100644 --- a/tests/e2e/audit-suggester.test.ts +++ b/tests/e2e/audit-suggester.test.ts @@ -96,7 +96,8 @@ describe("MetaEdit Edit Meta suggester flows", () => { await sleep(300); // Adding an existing key triggers the duplicate Notice. await plugin.controller.addYamlProp("status", "x", f); - const notice = await waitFor(".notice"); + // Notices from earlier suites can still be on screen. + const notice = await waitFor(".notice", (n) => n.textContent.includes("already has property")); return (notice.textContent || "").trim(); })() `,