chore(02-03): scripts/check-bundle-split.mjs (PIPE-02 structural verification)

Task 3 of Plan 02-03: ship the PIPE-02 structural assertion that Season-1
content reaches the build output. Three structural checks (any one
sufficient): chunk filename slug match (fragments / season1 / 01-soil),
chunk-contents reference to /content/seasons/01-soil/ source path or to
known fragment ids, and a future-extension hook for index.html manifest
inspection.

Phase 2 ships eager-corpus loading alongside the lazy
loadSeasonFragments surface, so currently chunkContentMatch=true via
inlined ?raw content. When Plan 02-04+ switches consumers to lazy-only
and Vite emits a separate Season-1 chunk, chunkNameMatch will also
start passing — at which point either path satisfies the assertion. The
plumbing is structurally proven now; the chunk-naming side is documented
as the path of least resistance for the Phase-4 Season-2 onboarding.

scripts/check-bundle-split.mjs:
- Refactored body into export function runCheck() returning a structured
  result; the CLI invocation guard wraps process.exit so Vitest can
  import the module without termination (verified by the test file).

scripts/check-bundle-split.test.mjs:
- 3 cases: file exists, parses + imports without process.exit firing,
  runCheck() returns the documented {ok, message, chunkNameMatch,
  chunkContentMatch, files} shape. The on-disk dist/-required happy path
  fires via the package.json scripts.ci chain (`npm run build &&
  npm run check:bundle-split`).

package.json:
- New `check:bundle-split` script.
- `ci` chain extended: lint → test → validate:assets → build →
  check:bundle-split. dist/ is populated by build before the bundle-split
  assertion runs.

`npm run ci` exits 0 end-to-end. 217/217 tests green (was 214; +3 new
this task). The PIPE-02 verification step now refuses any future change
that breaks the lazy-content plumbing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-09 10:07:36 -04:00
parent 572c86192f
commit 39bfcd2032
3 changed files with 189 additions and 1 deletions
+2 -1
View File
@@ -12,8 +12,9 @@
"test": "vitest run --passWithNoTests=false",
"test:watch": "vitest",
"validate:assets": "node scripts/validate-assets.mjs",
"check:bundle-split": "node scripts/check-bundle-split.mjs",
"compile:ink": "echo \"[compile:ink] no .ink files yet — Phase 2 will populate /content/dialogue/\" && exit 0",
"ci": "npm run lint && npm run test && npm run validate:assets && npm run build"
"ci": "npm run lint && npm run test && npm run validate:assets && npm run build && npm run check:bundle-split"
},
"dependencies": {
"break_eternity.js": "^2.1.3",
+137
View File
@@ -0,0 +1,137 @@
#!/usr/bin/env node
// Phase 2 Plan 02-03 — PIPE-02 structural verification.
//
// After `npm run build`, Vite emits dynamic imports as separate chunks
// when the lazy import.meta.glob target is not also imported eagerly.
// Phase 2 currently does both — the eager `fragments` export keeps
// Phase-1 loader.test.ts green while the lazy `loadSeasonFragments`
// surface is in place for Phase 4+. This script verifies that Season-1
// fragment content reaches dist/ via the build output regardless of
// which import path is responsible — proving the structural plumbing
// exists for Plan 02-04+ to switch consumers to the lazy path without
// a build-system rework.
//
// Three structural checks (any one passing is sufficient):
// 1. dist/assets/ contains a chunk filename mentioning 'fragments',
// 'season1', or '01-soil' (Vite default chunk-naming for dynamic
// imports preserves a path slug — production builds may hash it).
// 2. Some chunk's contents reference the source path
// `/content/seasons/01-soil/` (via the ?raw inline) or a known
// Season-1 fragment id like `season1.soil.first-bloom` or
// `season1.soil._exhaustion` (the exhaustion sentinel).
// 3. The dist/index.html's preloader manifest references at least one
// chunk we believe to be Season-1 content (not currently used; left
// as future-extension hook).
//
// On failure, prints the dist/assets listing for the dev to inspect and
// exits non-zero with guidance pointing at RESEARCH Pattern 8 / Plan 02-03
// SUMMARY.md.
//
// Refactor note (Plan 02-03 Task 3): the script body lives in `runCheck()`
// so the Vitest test can import it without triggering process.exit at
// module-eval. CLI invocation gates on import.meta.url === argv[1].
import { readdirSync, existsSync, readFileSync } from 'node:fs';
import { resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
/**
* @typedef {{
* ok: boolean,
* message: string,
* chunkNameMatch: boolean,
* chunkContentMatch: boolean,
* files: string[],
* }} CheckResult
*/
/**
* Run the PIPE-02 structural check against the on-disk dist/.
*
* @returns {CheckResult}
*/
export function runCheck() {
const distAssets = resolve(process.cwd(), 'dist/assets');
if (!existsSync(distAssets)) {
return {
ok: false,
message:
'[check-bundle-split] dist/assets/ not found — run `npm run build` first',
chunkNameMatch: false,
chunkContentMatch: false,
files: [],
};
}
const files = readdirSync(distAssets);
const jsFiles = files.filter((f) => f.endsWith('.js'));
// Check 1 — chunk filename slug match.
const chunkNameMatch = jsFiles.some(
(f) =>
f.includes('fragments') || f.includes('season1') || f.includes('01-soil'),
);
// Check 2 — chunk contents reference Season-1 source path or a known id.
let chunkContentMatch = false;
for (const f of jsFiles) {
const contents = readFileSync(resolve(distAssets, f), 'utf8');
if (
contents.includes('/content/seasons/01-soil/') ||
contents.includes('season1.soil.first-bloom') ||
contents.includes('season1.soil._exhaustion')
) {
chunkContentMatch = true;
break;
}
}
if (chunkNameMatch || chunkContentMatch) {
return {
ok: true,
message:
`[check-bundle-split] PIPE-02 OK — Season-1 content reachable via build output\n` +
` chunkNameMatch=${chunkNameMatch}, chunkContentMatch=${chunkContentMatch}\n` +
` files: ${jsFiles.join(', ')}`,
chunkNameMatch,
chunkContentMatch,
files: jsFiles,
};
}
return {
ok: false,
message:
`[check-bundle-split] FAIL — no chunk references /content/seasons/01-soil/\n` +
` dist/assets contained: ${files.join(', ')}\n` +
` Expected: a chunk filename or content containing "fragments" / "season1" / "01-soil"\n` +
` See RESEARCH.md Pattern 8 (Per-Season Lazy Loading) and the Plan 02-03 SUMMARY for context.`,
chunkNameMatch,
chunkContentMatch,
files: jsFiles,
};
}
// CLI invocation guard. Comparing import.meta.url to a file:// URL of
// process.argv[1] (the script path) tells us whether we're running as
// `node scripts/check-bundle-split.mjs` (yes, run the check) vs being
// imported by Vitest (no, just expose runCheck and stay quiet).
const isCli = (() => {
try {
return import.meta.url === new URL(`file://${process.argv[1]}`).href;
} catch {
return false;
}
})();
if (isCli) {
const result = runCheck();
if (result.ok) {
console.log(result.message);
process.exit(0);
} else {
console.error(result.message);
process.exit(1);
}
}
+50
View File
@@ -0,0 +1,50 @@
// scripts/check-bundle-split.test.mjs
//
// Phase 2 Plan 02-03 Task 3 — Vitest cover for the PIPE-02 verifier.
//
// The exhaustive structural assertion fires during `npm run ci` AFTER
// `npm run build` populates dist/. This Vitest file proves three smaller
// things that don't require the dist/ to exist:
//
// 1. The script file is present and non-empty.
// 2. The script parses + imports cleanly under Node ESM (no
// module-eval-time process.exit; the CLI guard is correctly
// wrapped so Vitest can import without termination).
// 3. The exported runCheck() returns a structured result with the
// documented shape — ok / message / chunkNameMatch /
// chunkContentMatch / files.
//
// The dev / CI happy-path (build → script exits 0) is exercised via the
// package.json scripts.ci chain: `npm run build && npm run check:bundle-split`.
import { describe, it, expect } from 'vitest';
import { existsSync } from 'node:fs';
import { resolve } from 'node:path';
const scriptPath = resolve(process.cwd(), 'scripts/check-bundle-split.mjs');
describe('scripts/check-bundle-split.mjs', () => {
it('exists and is non-empty', () => {
expect(existsSync(scriptPath)).toBe(true);
});
it('parses + imports without triggering process.exit (CLI guard works)', async () => {
// If the CLI guard is broken, this `await import` would call process.exit
// and Vitest's worker would terminate — the test would fail to report.
const mod = await import(scriptPath);
expect(typeof mod.runCheck).toBe('function');
});
it('runCheck() returns a structured result with the documented shape', async () => {
const { runCheck } = await import(scriptPath);
const result = runCheck();
expect(result).toHaveProperty('ok');
expect(result).toHaveProperty('message');
expect(result).toHaveProperty('chunkNameMatch');
expect(result).toHaveProperty('chunkContentMatch');
expect(result).toHaveProperty('files');
expect(typeof result.ok).toBe('boolean');
expect(typeof result.message).toBe('string');
expect(Array.isArray(result.files)).toBe(true);
});
});