Files
gbrain/test/fix-wave-structural.test.ts
T
Garry TanandClaude Fable 5 421a06eebe fix(cli): own the exit verdict — never trust ambient process.exitCode (#2084)
Caught by the full unit suite: `gbrain apply-migrations` on PGLite started
exiting 99. Root cause: PGLite's Emscripten runtime writes the WASM
backend's proc_exit status into process.exitCode (initdb at create-time,
the postmaster at close-time — `exitCode=status` in pglite's dist), and
the writes land ASYNCHRONOUSLY, outside any snapshot/restore window around
create/close (a guarded attempt verified this). The pre-#2084 success path
never read process.exitCode, so the pollution was invisible; the new
deliberate flush-exit propagated it faithfully.

Fix: gbrain records its own verdict. setCliExitCode(n)/getCliExitCode() in
cli-force-exit.ts — every gbrain-owned exit-code assignment routes through
the setter (still mirrored to process.exitCode for outside readers), and
both exit paths (entrypoint flushStdoutThenExit + the drainThenDisconnect
hard-deadline backstop) read the getter. Swept all assignment sites:
cli.ts (op error, friction, claw-test, smoke-test, eval runners, status,
import errors) + reindex/transcripts/brainstorm/frontmatter/autopilot.

Also updates the v0.42.20 structural pins to the drainThenDisconnect shape
(ordering invariant asserted INSIDE the helper + >=8 helper call sites,
superseding the two-inline-pairs assertion).

Verified: apply-migrations spawn test green; `init --migrate-only` exits 0;
an errored op still exits 1.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-11 23:06:29 -07:00

214 lines
12 KiB
TypeScript

/**
* Structural assertions for fix-wave fixes whose behavior is best verified
* at source-shape level rather than via a runtime harness:
*
* - #1125 query drain cache writes — assert cli.ts awaits the drain after
* the query op completes.
* - #1090 admin embed — assert the two-tier resolution (cwd path + embedded
* manifest fallback) is in serve-http.ts and consumes ADMIN_ASSETS.
* - #1077 admin register-client PKCE — assert the admin endpoint honors
* grantTypes / redirectUris / tokenEndpointAuthMethod from the body.
* - #1100 PGLite phaseASchema — assert the v0.11.0 orchestrator routes
* in-process when the engine is pglite (not via execSync subprocess).
* - #1124 query no-expand — assert the parseOpArgs negation logic exists.
*
* Source-grep regression tests are the right tool when the rule is "this
* specific line shape must stay present"; a behavioral test would either
* duplicate what an E2E covers or require heavy mocking that hides the
* regression behind a test seam.
*/
import { describe, test, expect } from 'bun:test';
import { readFileSync } from 'fs';
describe('v0.42.20.0 — search-cache drained via the background-work registry', () => {
// Supersedes the v0.36.1.x #1125 query-only drain: search-cache now registers
// a registry drainer (drained for BOTH search and query, bounded), and cli.ts
// drains the whole registry rather than calling awaitPendingSearchCacheWrites
// directly for the 'query' op only.
test('hybrid.ts registers a bounded search-cache drainer', () => {
const src = readFileSync('src/core/search/hybrid.ts', 'utf8');
expect(src).toMatch(/export async function awaitPendingSearchCacheWrites/);
expect(src).toMatch(/pendingCacheWrites\.add\(promise\)/);
expect(src).toMatch(/trackCacheWrite\(/);
// Now bounded (was an unbounded Promise.allSettled) + registered.
expect(src).toMatch(/registerBackgroundWorkDrainer\(\{[\s\S]*?name:\s*'search-cache'/);
expect(src).toMatch(/Promise\.race/);
});
});
describe('v0.36.1.x #1090 — admin embed two-tier resolution', () => {
test('serve-http.ts uses ADMIN_ASSETS manifest when admin/dist is not next to cwd', () => {
const src = readFileSync('src/commands/serve-http.ts', 'utf8');
expect(src).toMatch(/import\(['"]\.\.\/admin-embedded/);
expect(src).toMatch(/ADMIN_ASSETS/);
expect(src).toMatch(/ADMIN_INDEX_HTML/);
// Two-tier: dev path (cwd-relative admin/dist) AND embedded manifest fallback
expect(src).toMatch(/useDevPath/);
});
test('src/admin-embedded.ts is auto-generated with file: imports', () => {
const src = readFileSync('src/admin-embedded.ts', 'utf8');
expect(src).toMatch(/AUTO-GENERATED/);
expect(src).toMatch(/with \{ type: 'file' \}/);
expect(src).toMatch(/export const ADMIN_ASSETS/);
expect(src).toMatch(/export const ADMIN_INDEX_HTML/);
});
test('build script + CI guard exist', () => {
const buildSrc = readFileSync('scripts/build-admin-embedded.ts', 'utf8');
expect(buildSrc).toMatch(/walk\(DIST/);
expect(buildSrc).toMatch(/with \{ type: 'file' \}/);
const guard = readFileSync('scripts/check-admin-embedded.sh', 'utf8');
expect(guard).toMatch(/git diff --exit-code -- src\/admin-embedded\.ts/);
});
});
describe('v0.36.1.x #1077 — admin register-client supports PKCE public clients', () => {
test('admin endpoint reads grantTypes / redirectUris / tokenEndpointAuthMethod from request body', () => {
const src = readFileSync('src/commands/serve-http.ts', 'utf8');
// The destructure must surface name / tokenTtl / grantTypes /
// redirectUris / tokenEndpointAuthMethod from req.body. v0.39.3.0
// WARN-9 (PR #1308) moved `scopes` to a separate read line that
// accepts BOTH `scopes` (admin SPA) AND `scope` (OAuth wire singular)
// via `?? `, so this regex no longer requires `scopes` in the inline
// destructure — it's separately covered by the scope-source check
// below.
expect(src).toMatch(/const\s+\{\s*name,\s*(?:[^}]*?,\s*)?tokenTtl,\s*grantTypes,\s*redirectUris,\s*tokenEndpointAuthMethod\s*\}\s*=\s*req\.body/);
// v0.39.3.0 WARN-9: the route must still read a `scope`/`scopes` field
// (under either name) from req.body. Pin the fallback pattern so the
// PKCE-fix regression contract stays load-bearing.
expect(src).toMatch(/req\.body[^;]*scopes\s*\?\?\s*[^;]*scope\b/);
// v0.41.3 (T4 atomicity fix, codex F4): admin endpoint now validates
// tokenEndpointAuthMethod via the shared validator and passes it to
// registerClientManual as a positional arg. Pre-v0.41.3 the route did
// INSERT (confidential) → UPDATE (NULL out secret_hash) for the 'none'
// case, which left a confidential row stranded if the UPDATE failed.
// Atomic now: one INSERT writes the correct shape; no post-insert
// UPDATE block (the regex deliberately asserts the post-insert UPDATE
// is GONE).
expect(src).toMatch(/validateTokenEndpointAuthMethod\(tokenEndpointAuthMethod\)/);
expect(src).toMatch(/registerClientManual\([^)]*validatedAuthMethod[^)]*\)/);
// Regression guard: post-insert UPDATE flipping client_secret_hash to
// NULL based on a runtime check is exactly the non-atomic pattern T4
// killed. Re-introducing it brings back codex F4.
expect(src).not.toMatch(/UPDATE oauth_clients SET client_secret_hash = NULL, token_endpoint_auth_method = 'none'/);
});
});
describe('v0.41.37.0 #1605 — v0.11.0 phaseASchema routes in-process for ALL engines', () => {
test('phaseASchema calls runMigrateOnlyCore (in-process) + is awaited', () => {
// Supersedes #1100's PGLite-only in-process branch. v0.41.37.0 #1605 routes
// EVERY engine through runMigrateOnlyCore (no execSync subprocess at all),
// which is strictly stronger: PGLite still never subprocesses, AND the
// Windows+Postgres getaddrinfo-ENOTFOUND spawn bug is closed too.
// The eng.initSchema() call moved into src/commands/migrations/in-process.ts.
const src = readFileSync('src/commands/migrations/v0_11_0.ts', 'utf8');
expect(src).toContain('runMigrateOnlyCore()');
expect(src).not.toContain("execSync('gbrain init --migrate-only'");
expect(src).toMatch(/await\s+phaseASchema/);
});
test('apply-migrations skips pre-flight schema-version probe on PGLite', () => {
const src = readFileSync('src/commands/apply-migrations.ts', 'utf8');
expect(src).toMatch(/skipPreflight\s*=\s*cfg\.engine\s*===\s*'pglite'/);
});
});
describe('v0.36.1.x #1124 — query --no-expand actually negates expand', () => {
test("cli.ts parseOpArgs handles --no-<key> as boolean negation", () => {
const src = readFileSync('src/cli.ts', 'utf8');
expect(src).toMatch(/arg\.startsWith\(['"]--no-['"]\)/);
expect(src).toMatch(/positiveDef\?\.type\s*===\s*'boolean'/);
expect(src).toMatch(/params\[positiveKey\]\s*=\s*false/);
});
});
describe('v0.42.20.0 — background-work registry drains every sink before disconnect', () => {
// Supersedes the v0.41.8.0 #1247/#1269/#1290 per-call last-retrieved drain:
// last-retrieved is one of the registry sinks. Since the v0.43 #2084 drain
// hoist, cli.ts routes EVERY owner-disconnect through drainThenDisconnect
// (one helper, all 8 sites) instead of two inline drain+disconnect pairs.
test('cli.ts imports the registry drain + routes owner-disconnects through drainThenDisconnect', () => {
const src = readFileSync('src/cli.ts', 'utf8');
expect(src).toMatch(/import\s+\{\s*drainAllBackgroundWorkForCliExit\s*\}\s*from\s+['"]\.\/core\/background-work\.ts['"]/);
// The single registry-drain call site lives inside the shared helper...
expect(src).toMatch(/export async function drainThenDisconnect/);
expect(src).toMatch(/await\s+drainAllBackgroundWorkForCliExit\s*\(/);
// ...and the helper covers every owner-disconnect (op-dispatch, CLI_ONLY
// fall-through, search dashboard, doctor x3, ze-switch, dream,
// read-only-timeout path).
const calls = src.match(/await\s+drainThenDisconnect\s*\(/g) ?? [];
expect(calls.length).toBeGreaterThanOrEqual(8);
});
test('last-retrieved.ts still exports the bounded drain + registers a drainer', () => {
const src = readFileSync('src/core/last-retrieved.ts', 'utf8');
expect(src).toMatch(/export async function awaitPendingLastRetrievedWrites/);
expect(src).toMatch(/pendingLastRetrievedWrites\s*=\s*new\s+Set/);
expect(src).toMatch(/Promise\.race/);
expect(src).toMatch(/registerBackgroundWorkDrainer\(\{[\s\S]*?name:\s*'last-retrieved'/);
});
test('all four sinks register a drainer', () => {
expect(readFileSync('src/core/facts/queue.ts', 'utf8'))
.toMatch(/registerBackgroundWorkDrainer\(\{[\s\S]*?name:\s*'facts'[\s\S]*?abort:/);
expect(readFileSync('src/core/search/hybrid.ts', 'utf8'))
.toMatch(/name:\s*'search-cache'/);
expect(readFileSync('src/core/last-retrieved.ts', 'utf8'))
.toMatch(/name:\s*'last-retrieved'/);
expect(readFileSync('src/core/eval-capture.ts', 'utf8'))
.toMatch(/name:\s*'eval-capture'/);
});
test('cli.ts behavioral positioning: drainThenDisconnect drains the registry BEFORE engine.disconnect', () => {
const src = readFileSync('src/cli.ts', 'utf8');
// The ordering invariant lives ONCE, inside the shared helper (v0.43
// #2084 drain hoist): registry drain, THEN best-effort disconnect.
const helper = src.match(/export async function drainThenDisconnect[\s\S]+?^\}/m);
expect(helper).not.toBeNull();
const block = helper![0];
const drainCallRe = /await\s+drainAllBackgroundWorkForCliExit\s*\(/;
const disconnectCallRe = /await\s+engine\.disconnect\s*\(/;
expect(block).toMatch(drainCallRe);
expect(block).toMatch(disconnectCallRe);
const drainIdx = block.indexOf(block.match(drainCallRe)![0]);
const disconnectIdx = block.indexOf(block.match(disconnectCallRe)![0]);
expect(drainIdx).toBeLessThan(disconnectIdx);
// And the op-dispatch finally routes through the helper.
const localPath = src.match(/\/\/ Local engine path \(unchanged behavior[\s\S]+?\n \}\n\}/m);
expect(localPath).not.toBeNull();
expect(localPath![0]).toMatch(/await\s+drainThenDisconnect\s*\(/);
});
test('background-work.ts: Map registry, ordered drain, awaited abort, test seam', () => {
const src = readFileSync('src/core/background-work.ts', 'utf8');
expect(src).toMatch(/new\s+Map<string,\s*BackgroundWorkDrainer>/);
expect(src).toMatch(/sort\(\s*\(a,\s*b\)\s*=>\s*a\.order\s*-\s*b\.order/);
expect(src).toMatch(/if\s*\(unfinished\s*>\s*0\s*&&\s*d\.abort\)\s*\{[\s\S]*?await\s+d\.abort\(\)/);
expect(src).toMatch(/export function __registerDrainerForTest/);
});
test('cli-force-exit.ts daemon guard excludes "serve"', () => {
const src = readFileSync('src/core/cli-force-exit.ts', 'utf8');
expect(src).toMatch(/export function shouldForceExitAfterMain/);
expect(src).toMatch(/DAEMON_COMMANDS[\s\S]*serve/);
});
});
describe('v0.41.8.0 #1340 — PGLite WASM init classifier', () => {
test('pglite-engine.ts exports classifyPgliteInitError + buildPgliteInitErrorMessage', () => {
const src = readFileSync('src/core/pglite-engine.ts', 'utf8');
expect(src).toMatch(/export function classifyPgliteInitError/);
expect(src).toMatch(/export function buildPgliteInitErrorMessage/);
// Per Codex finding #9: regex tightened to $$bunfs OR ENOENT+pglite.data
expect(src).toMatch(/\$\$bunfs/);
expect(src).toMatch(/ENOENT/);
});
test('pglite-engine.ts connect catch block routes through the classifier', () => {
const src = readFileSync('src/core/pglite-engine.ts', 'utf8');
expect(src).toMatch(/classifyPgliteInitError\(original\)/);
expect(src).toMatch(/buildPgliteInitErrorMessage\(verdict, original\)/);
});
});