Files
gstack/test/devex-finding-fixture.test.ts
T
01593aa67c v1.91.2.0 fix: consolidate gstack reliability wave (#2959)
* fix(memory-ingest): --scan-secrets scans the rendered page and fails closed

--scan-secrets ran gitleaks on the raw transcript .jsonl, then imported a
page rendered from it. gitleaks' assignment rules don't match across a
JSON-escaped quote (KEY=\"v\" on disk), so a secret the rendered page
shows as KEY="v" was imported unflagged. And the gate skipped a file only
on scanner "gitleaks" with findings, so a scan that errored (non-zero
exit, 16MB maxBuffer overflow on a file with many findings, unparseable
report) or could not run (gitleaks missing, slow-probe cooldown) imported
the file unscanned.

Scan the rendered page body, the exact bytes writeStaged() writes, via a
new secretScanText() helper, and skip the file whenever the scan did not
complete. Skipped files stay out of the state file, so the next run
retries them. Reword the helper warnings and setup-gbrain/memory.md,
which described the fail-open as intended.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(test): reconcile Bun failure markers and footer counts

* fix(sync-gbrain): verify source-scoped reads without mutation

* fix(test): recognize grounded TTHW target choices structurally

* fix(aside): make the readiness probe work under zsh and report why it failed

The probe built its deadline into `_T` and expanded it unquoted, so
`$_T aside repl …` only worked in a shell that word-splits. zsh does not: it
looked for a command literally named "gtimeout 30", the probe answered
ASIDE_NOT_RUNNING with Aside installed and ready, and every browsing skill
fell back to the bundled Chromium in silence. zsh is the macOS default and
Aside is macOS-only, so on a stock Mac the probe could never report READY.

The deadline becomes a function, `_gs_d`. It receives the command as "$@",
already split, so sh, bash and zsh all behave the same, and the gtimeout →
timeout → perl alarm chain is unchanged. A 4th arm runs the call unbounded
when none of the three is present, which is what the empty `_T` did before.
Not `eval`: it re-parses the string, so the parens and `;` of the perl arm
become syntax and that arm dies in bash *and* zsh — on a stock Mac, the arm
that actually runs.

On failure the probe now prints the CLI's reason after ASIDE_NOT_RUNNING:,
the shape gstack-render already uses: the first line that starts with a
capital letter, i.e. the CLI's own sentence or Node's `Error:` line below its
loader frame. "Not running" covers states with different fixes — no window
open for the profile, a NODE_OPTIONS preload that kills the CLI — and a bare
verdict sent all of them to "open the Aside app". The BROWSER SETUP prose
quotes that reason before asking the user to open the app.

The text pin asserted the broken invocation verbatim, so it now pins the
function and asserts neither `$_T aside repl` nor an eval form comes back. A
second test executes the rendered probe in sh, bash and zsh on each of the
four deadline arms with stubbed binaries on a narrowed PATH, plus two failing
CLIs: one that prints its own sentence, one that crashes like Node with the
useful line below the frame.

The deadline function costs zero bytes against the lines it replaces; the
reason costs 53 per copy of the probe (44 where the reworded BROWSER SETUP
line gives 9 back). That moves four guards by the measured amount:
plan-devex-review's skeleton cap to 68,550 (measured 68,544), plan-ceo-review's
skeleton cap to 80,150 (measured 80,111) and union ratio to 1.081 (measured
1.0803), and plan-eng-review's union ratio to 1.151 (measured 1.1504).

Fixes #2842, #2941.

* Clarify engineering review startup and decision flow

* Fix Windows readiness fixture PATH and command shim

* fix(test): recognize grounded TTHW target choices structurally

* Clarify engineering review startup and decision flow

* fix(test): restrict QA-only fixture tools to its no-Edit contract

* v1.90.0.0 fix(sync-gbrain): guard readiness verdicts and refresh metadata

* fix(browse): validate canonical upload targets

* fix(gbrain): classify structured PGLite busy response

* fix(browse): preserve native extension runtime APIs

* Fix displayless browser handoff ownership

* Accept unique installed autoplan methodology aliases

* fix(skills): preserve positional literals during installation

* fix(browse): checksum installer contents through stdin

* fix(test): normalize Windows checksum fixture paths

* test: emulate unavailable shasum in Windows checksum fixture

* fix(investigate): preserve owned freeze lifecycle

* fix(review): preserve N+1 retry and Red Team completion

* fix: bound Aside readiness and preserve safe fallback

* test: exercise setup and Chromium on native ARM

* fix: preserve install ownership and ARM browser selection

* Fix gbrain ingest scan boundaries and seed observation

* Refresh managed ship hooks and supervise expanded paid census

* Reject resumed gbrain pages excluded by current policy

* Recover zombie agent locks safely and enable CI Python venv

* Repair paid actor declarations and Aside pitch assertions

* Bump consolidated wave to next free minor release

* Clarify CEO review admin choices and option tradeoffs

* Preserve CEO mode handoff anchors in clarified workflow

* Make Windows portability fixtures use shell-native paths

* Restore ARM Bun alias and clarify ship review gates

* Refresh ship workflow golden snapshots

* Fix Windows DX documentation controls without piped stdin

* Decode Codex child pipes without Bun's encoded-stream stall

* Bound DX pre-review audit before product questions

* Clarify trusted review-start read in paid revalidation

* Bump consolidated wave to next free minor release

* Clarify CEO review admin choices and option tradeoffs

* Preserve CEO mode handoff anchors in clarified workflow

* Make Windows portability fixtures use shell-native paths

* Restore ARM Bun alias and clarify ship review gates

* Refresh ship workflow golden snapshots

* Fix Windows DX documentation controls without piped stdin

* Decode Codex child pipes without Bun's encoded-stream stall

* Bound DX pre-review audit before product questions

* Clarify trusted review-start read in paid revalidation

* Reconcile new main planning flow and paid judge census

* fix: reconcile rebased planning and source-bound validation

* test: pin cookie workflow judge to scored Sonnet model

* fix: keep terminal agent boot out of module imports

* fix: preserve pending-question uncertainty in engineering review

* fix: stabilize Windows reliability-wave fixtures

* fix: clarify design consultation research workflow

* fix: preserve independent design consultation inputs

* fix: resolve design taste scope and browser research guidance

* fix: make consultation opt-in preflight unambiguous

* test: await native Edge owner readiness or terminal result

---------

Co-authored-by: Bruce Krysiak <brucek@alum.mit.edu>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Antonio Vitalic <antoninte99@gmail.com>
2026-09-26 18:57:53 -04:00

515 lines
33 KiB
TypeScript

import { expect, test } from 'bun:test';
import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import { runGeneration } from '../scripts/gen-skill-docs';
import { ALL_HOST_NAMES, getHostConfig } from '../hosts';
const ROOT = path.resolve(import.meta.dir, '..');
test('every host exposes the DX per-call rule before the pre-review audit and Step 0', async () => {
const outputRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'devex-rule-free-'));
try {
const generated = await runGeneration({ host: 'all', outputRoot });
expect(generated.exitCode).toBe(0);
const skills = generated.artifacts.filter(artifact => artifact.kind === 'skill'
&& /(?:^|\/)gstack-plan-devex-review\/SKILL\.md$|^plan-devex-review\/SKILL\.md$/.test(artifact.relativePath));
expect(skills.map(artifact => artifact.host).sort()).toEqual([...ALL_HOST_NAMES].sort());
for (const artifact of skills) {
const content = fs.readFileSync(path.join(outputRoot, artifact.relativePath), 'utf8');
const audit = content.indexOf('## PRE-REVIEW SYSTEM AUDIT');
expect(audit).toBeGreaterThan(0);
const preReview = content.slice(audit, content.indexOf('## Auto-Detect Product Type', audit));
expect(preReview).toContain('origin/<detected-base-branch>...HEAD');
expect(preReview).not.toContain('git merge-base HEAD main');
expect(preReview).toContain('Defer exhaustive branch exploration until after product type and persona are confirmed.');
const productGate = content.slice(content.indexOf('## Auto-Detect Product Type', audit),
content.indexOf('## Step 0: DX Investigation', audit));
expect(productGate).toContain('STOP. Ask for product-type confirmation before deeper branch research.');
const brain = content.indexOf('## Brain Context (preflight)', audit);
const productType = content.indexOf('## Auto-Detect Product Type', audit);
const persona = content.indexOf('### 0A. Developer Persona Interrogation', productType);
const personaStop = content.indexOf('**STOP.** Do NOT proceed until user responds.', persona);
const prerequisite = content.indexOf('## Prerequisite Skill Offer', persona);
expect(brain).toBeGreaterThan(audit);
expect(brain).toBeLessThan(productType);
expect(prerequisite).toBeGreaterThan(personaStop);
expect(prerequisite).toBeLessThan(content.indexOf('### 0B. Empathy Narrative', persona));
const beforeAudit = content.slice(0, audit);
expect(beforeAudit).toContain('including Step 0 and outside voice');
expect(beforeAudit).toContain('One independent choice per AskUserQuestion call, never separate tabs');
// Claude loads the review section later; these evidence limits must also
// govern Step 0's first journey questions on every host.
const earlyEvidence = beforeAudit.replace(/\s+/g, ' ');
expect(earlyEvidence).toContain('A description of what a reporter includes does not establish its exact words');
expect(earlyEvidence).toContain('Confirmation of an empathy narrative is not runtime observation');
// The retained DX run reopened an approved CLI/library entrypoint after
// its outside prompt reduced the mode to "no new APIs". These are source
// propagation checks; the native eval still owns behavioral acceptance.
expect(earlyEvidence).toContain('selected option, answer reference and approved scope');
expect(earlyEvidence).toContain("user's task boundaries and requested mode, amended only by exact approved exceptions");
expect(earlyEvidence).toContain("A mode's default does not cancel an explicitly approved exception");
// Required factual/navigation repair is review work; it must not become
// an approval solely because the rating pass finds a gap. New approaches
// and policies still go through the same gate.
const classification = earlyEvidence.slice(earlyEvidence.indexOf('2. **Classify the finding.**'),
earlyEvidence.indexOf('3. **Check the scope.**'));
expect(classification).toContain('verifying sources, correcting facts and restoring docs or navigation');
expect(classification).toContain('unverified behavior or destinations stay unknown');
expect(classification).toContain('A new presentation approach, guarantee, channel, scope extension or optional verification depth remains a decision');
const rating = content.slice(content.indexOf('## The 0-10 Rating Method'));
expect(rating).toContain('4. Run the Decision gate for each gap.');
expect(rating).not.toContain('Resolve each new in-scope gap via AskUserQuestion');
const journey = content.slice(content.indexOf('### 0F.'), content.indexOf('### 0G.'));
const wholeGate = journey.indexOf('Run all four Decision gate steps');
expect(wholeGate).toBeGreaterThanOrEqual(0);
expect(wholeGate).toBeLessThan(journey.indexOf('> "Journey Stage: INSTALL'));
expect(journey).not.toContain('AskUserQuestion per friction point');
const mode = content.slice(content.indexOf('### 0E. Mode Selection'), content.indexOf('Context-dependent defaults:'));
expect(mode).toContain('Use the mode the user explicitly requested for this review.');
expect(mode).toContain('skip the mode question and continue to 0F. Otherwise, ask below.');
const sectionText = generated.artifacts.filter(item => item.kind === 'section'
&& item.host === artifact.host && item.relativePath.startsWith('plan-devex-review/'))
.map(item => fs.readFileSync(path.join(outputRoot, item.relativePath), 'utf8')).join('\n');
const allContent = content + '\n' + sectionText;
expect(allContent).toContain('if viable, split them before asking');
expect(allContent).toContain('A code example and an optional checklist are separate choices');
expect(allContent).toContain('as are a timer and its release-gate policy');
const gate = beforeAudit.indexOf('### Decision gate');
const ground = beforeAudit.indexOf('1. **Ground the evidence.**', gate);
const classify = beforeAudit.indexOf('2. **Classify the finding.**', gate);
const scope = beforeAudit.indexOf('3. **Check the scope.**', gate);
const options = beforeAudit.indexOf('4. **Draft and answer one decision.**', gate);
expect([gate, ground, classify, scope, options].every((offset, i, offsets) =>
offset >= 0 && (i === 0 || offset > offsets[i - 1]!))).toBe(true);
const localRule = allContent.slice(allContent.indexOf('## CRITICAL RULE — How to ask questions'),
allContent.indexOf('## Required Outputs', allContent.indexOf('## CRITICAL RULE — How to ask questions')));
expect(localRule).toContain('Run the Decision gate before drafting options.');
expect(localRule).not.toContain('use AskUserQuestion for each gap');
expect(allContent).toContain('Record observed human onboarding separately from automated execution');
expect(allContent).toContain('a warm snippet timer is neither a fresh-start check nor a human benchmark');
expect(allContent).toContain('Keep estimates labeled until measured');
const benchmark = content.slice(content.indexOf('### 0C. Competitive DX Benchmarking'),
content.indexOf('### 0D. Magical Moment Design'));
expect(benchmark.indexOf('Define the clock before comparing')).toBeGreaterThanOrEqual(0);
expect(benchmark.indexOf('Define the clock before comparing')).toBeLessThan(benchmark.indexOf('AskUserQuestion:'));
expect(benchmark).toContain('Compare times only across equivalent boundaries');
expect(benchmark).toContain('Never infer no wait from a peer');
expect(benchmark).toContain('Start → result');
expect(benchmark).toContain('Carry the approved clock and target into 0D, Pass 1, Pass 8 and the report');
expect(allContent).toContain('Measure the approved 0C clock and 0D useful result');
expect(allContent).not.toContain('**STOP.** AskUserQuestion once per issue.');
expect(allContent).toContain('A target tier does not itself approve telemetry, an automated');
expect(allContent).toContain('only when proposing them, with ownership and frequency explicit');
expect(allContent).toContain('Continue the same working list from Step 0');
expect(allContent).toContain('compare its evidence with the prior decision and options already considered');
expect(allContent).toContain('A disclosed tradeoff or rejected alternative is not new evidence merely because a reviewer prefers it');
expect(allContent).toContain('identify a concrete contradiction or changed assumption before reopening');
expect(allContent).toContain('Unverified loss of existing coverage remains a risk to verify');
expect(allContent).toContain('not proof that a new release policy is needed');
expect(allContent).toContain('If a necessary remedy crosses an explicit scope boundary, name that boundary');
expect(allContent).toContain('obtain scope approval before choosing or applying the remedy');
expect(allContent).toContain('Implementation details and proof of one chosen behavior\nstay together; independent policies each need their own decision');
if (!getHostConfig(artifact.host!).suppressedResolvers.includes('CODEX_PLAN_REVIEW')) {
const outside = allContent.slice(allContent.indexOf('## Outside Voice — Independent Plan Challenge'));
const context = outside.indexOf('REVIEW CONTEXT (from the full working list, outside the truncated plan body)');
const planBody = outside.indexOf('THE PLAN:\n<plan content>');
expect(context).toBeGreaterThan(0);
expect(planBody).toBeGreaterThan(context);
expect(outside.slice(context, planBody)).toContain('selected option, answer reference and exact scope');
expect(outside.slice(context, planBody)).toContain('including any explicitly approved exception');
expect(outside.slice(context, planBody)).toContain('Missing implementation remains a verification');
expect(outside.slice(context, planBody)).toContain('concrete new evidence or a changed assumption');
expect(outside).toContain("Apply the Decision gate's distinction between routine review work and a new choice.");
} else {
expect(allContent).not.toContain('REVIEW CONTEXT (from the full working list, outside the truncated plan body)');
}
}
} finally { fs.rmSync(outputRoot, { recursive: true, force: true }); }
}, 20_000);
// Import the actual paid registration in a child with only its process boundary
// mocked. Coverage and report validation remain the production predicates.
function runDxRegistration(scenario: string) {
const directory = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'devex-registration-free-')));
const script = path.join(directory, 'registration.test.ts');
const facts = path.join(directory, 'facts.json');
fs.writeFileSync(script, `
import { describe, expect, mock } from 'bun:test';
import * as fs from 'node:fs';
import * as path from 'node:path';
import { DEVEX_COUNT_FILES, planDevexCountFixture, isDevexReviewIssue, devexReviewModePick }
from ${JSON.stringify(path.join(ROOT, 'test/helpers/devex-count-fixture.ts'))};
import captured from ${JSON.stringify(path.join(ROOT, 'test/fixtures/devex-seed-coverage-ad-v3.json'))};
const { assertReviewReportAtBottom: actualReport, devexStep0Boundary } =
await import(${JSON.stringify(path.join(ROOT, 'test/helpers/claude-pty-runner.ts'))});
const scenario = ${JSON.stringify(scenario)};
const factsPath = ${JSON.stringify(facts)};
const finalPlan = '# Reviewed DX plan\\n\\nThe five seeded gaps each have a recorded decision.\\n\\n## GSTACK REVIEW REPORT\\n\\nDX review complete.\\n';
const facts = { checked: false, runnerCalls: 0, reportCalls: 0, judgeCalls: 0, planPath: '', finalPlan: '' };
const save = () => fs.writeFileSync(factsPath, JSON.stringify(facts));
mock.module(${JSON.stringify(path.join(ROOT, 'test/helpers/e2e-gate.ts'))}, () => ({
describeE2ETier: tier => { expect(tier).toBe('periodic'); return describe; },
}));
mock.module(${JSON.stringify(path.join(ROOT, 'test/helpers/claude-pty-runner.ts'))}, () => ({
devexStep0Boundary,
assertReviewReportAtBottom: content => {
facts.reportCalls++;
facts.finalPlan = content;
save();
expect(content).toBe(fs.readFileSync(facts.planPath, 'utf8'));
return actualReport(content);
},
runPlanSkillCounting: async opts => {
facts.runnerCalls++;
facts.planPath = opts.expectedPlanPath;
save();
expect(path.dirname(path.dirname(opts.expectedPlanPath))).toBe(${JSON.stringify(directory)});
expect(fs.existsSync(path.dirname(opts.expectedPlanPath))).toBe(true);
// The runner owns the seeded Git project. The caller owns only its report.
expect(opts.cwd).toBeUndefined();
expect(opts.skillName).toBe('plan-devex-review');
expect(opts.slashCommand).toBe('/plan-devex-review');
expect(opts.timeoutMs).toBe(1500000);
expect(opts.reviewCountCeiling).toBe(Infinity);
expect(opts.pickAUQ).toBe(devexReviewModePick);
expect(opts.isReviewAUQ).toBe(isDevexReviewIssue);
expect(opts.isLastStep0AUQ).toBe(devexStep0Boundary);
expect(opts.env).toEqual({ QUESTION_TUNING: 'false', EXPLAIN_LEVEL: 'default' });
expect(opts.followUpPrompt).toBe(planDevexCountFixture(opts.expectedPlanPath) +
'\\nFinish this DX review; I will handle subsequent reviews manually.');
expect(opts.fixtureFiles).toEqual(DEVEX_COUNT_FILES);
expect(opts.followUpPrompt).toContain('Use DX POLISH');
// These are the five unresolved contracts in the current native fixture.
expect(opts.fixtureFiles['docs/current-contracts.md']).toContain('There is no skip flag or offline first-run path.');
expect(opts.fixtureFiles['docs/package-contents.txt']).toContain('that file is absent');
expect(opts.fixtureFiles['docs/api.md']).toContain('run_eval(dataset, evaluator)');
expect(opts.fixtureFiles['docs/api.md']).toContain('run_batch(evaluator, dataset)');
expect(opts.fixtureFiles['docs/api.md']).toContain('AuthError("request failed")');
expect(opts.fixtureFiles['docs/api.md']).toContain('removes the old name immediately');
facts.checked = true;
save();
if (scenario === 'throw') throw new Error('controlled DX runner failure');
// Replay public question/reply evidence only. Its historical run did not
// complete; the terminal/report below are controlled caller-boundary inputs.
const transcript = { status: 'ready', calls: structuredClone(captured.attempts[0].calls), assistantMessages: [] };
if (scenario.startsWith('missing-seed-')) transcript.calls.splice(Number(scenario.slice(-1)), 1);
if (scenario === 'missing-native') transcript.status = 'missing';
if (scenario === 'repeated-seed') transcript.calls = Array.from({length: 5}, (_, i) =>
({ ...structuredClone(transcript.calls[0]), toolUseId: 'repeated-' + i }));
if (scenario === 'batched') {
const call = structuredClone(transcript.calls[0]);
call.questions = transcript.calls.flatMap(item => item.questions);
call.answers = Object.fromEntries(transcript.calls.flatMap(item => Object.entries(item.answers)));
transcript.calls = [call];
}
if (scenario === 'pending') transcript.calls[0].answered = false;
if (scenario !== 'missing-report') fs.writeFileSync(opts.expectedPlanPath,
finalPlan + (scenario === 'trailing-report' ? '\\n## Unexpected follow-up\\n' : ''));
return { outcome: scenario === 'timeout' ? 'timeout' : scenario === 'summary' ? 'completion_summary' : 'plan_ready',
transcript, fingerprints: [], step0Count: 2, reviewCount: scenario.startsWith('missing-seed-') ? 100 : 5,
elapsedMs: 100, evidence: 'controlled DX observation' };
},
}));
mock.module(${JSON.stringify(path.join(ROOT, 'test/helpers/plan-review-decisions.ts'))}, () => ({
evaluatePlanReviewDecisions: () => { facts.judgeCalls++; save(); throw new Error('unexpected paid judge'); },
}));
await import(${JSON.stringify(path.join(ROOT, 'test/skill-e2e-plan-devex-finding-count.test.ts'))});
`);
try {
const child = Bun.spawnSync([process.execPath, 'test', script], {
cwd: ROOT, timeout: 10_000,
env: { PATH: process.env.PATH ?? '', HOME: directory, TMPDIR: directory, TMP: directory, TEMP: directory,
GIT_CONFIG_NOSYSTEM: '1', ...(process.env.SystemRoot ? { SystemRoot: process.env.SystemRoot } : {}) },
});
const output = child.stdout.toString() + child.stderr.toString();
expect(child.signalCode ?? null, output).toBeNull();
expect(fs.existsSync(facts), output).toBe(true);
const observed = JSON.parse(fs.readFileSync(facts, 'utf8'));
expect(observed.checked, output).toBe(true);
expect(observed.runnerCalls, output).toBe(1);
expect(observed.judgeCalls, output).toBe(0);
expect(fs.existsSync(path.dirname(observed.planPath)), 'actual paid finally must remove its owned report directory').toBe(false);
return { output, exitCode: child.exitCode, observed };
} finally { fs.rmSync(directory, { recursive: true, force: true }); }
}
test('the actual DX registration supplies its complete native fixture and preserves runner failure', () => {
const result = runDxRegistration('throw');
expect(result.exitCode, result.output).toBe(1);
expect(result.output).toContain('controlled DX runner failure');
expect(result.observed.reportCalls).toBe(0);
});
for (const outcome of ['success', 'summary']) test(`DX registration accepts completed seed decisions and the owned final report: ${outcome}`, () => {
const result = runDxRegistration(outcome);
expect(result.exitCode, result.output).toBe(0);
expect(result.observed.reportCalls).toBe(1);
expect(result.observed.finalPlan).toContain('## GSTACK REVIEW REPORT');
});
for (const scenario of [
...Array.from({ length: 5 }, (_, index) => 'missing-seed-' + index),
'missing-native', 'repeated-seed', 'batched', 'pending',
]) test(`DX registration requires complete distinct native coverage: ${scenario}`, () => {
const result = runDxRegistration(scenario);
expect(result.exitCode, result.output).toBe(1);
expect(result.output).toContain('SEEDED COVERAGE FAIL');
expect(result.observed.reportCalls).toBe(0);
});
for (const scenario of ['missing-report', 'trailing-report', 'timeout']) test(`DX registration rejects incomplete delivery: ${scenario}`, () => {
const result = runDxRegistration(scenario);
expect(result.exitCode, result.output).toBe(1);
expect(result.output).toContain(scenario === 'timeout' ? 'outcome=timeout' : 'D19 FAIL');
expect(result.observed.reportCalls).toBe(scenario === 'trailing-report' ? 1 : 0);
});
test('materialized DX references have working local links without inventing completed launch work', () => {
const fixture = path.join(ROOT, 'test/fixtures/devex-existing-sdk');
const files = ['README.md', 'docs/getting-started.md', 'docs/feedback.md', 'docs/reference-v1.md'];
for (const file of files) {
const body = fs.readFileSync(path.join(fixture, file), 'utf8');
for (const [, target] of body.matchAll(/\[[^\]]+\]\(([^)]+)\)/g)) {
const [relative, anchor] = target!.split('#');
const destination = path.resolve(path.dirname(path.join(fixture, file)), relative || path.basename(file));
expect(destination.startsWith(fixture + path.sep)).toBe(true);
const linked = fs.readFileSync(destination, 'utf8');
if (anchor) {
const headings = [...linked.matchAll(/^#+ (.+)$/gm)].map(match => match[1]!.toLowerCase()
.replace(/[^\w\s-]/g, '').replace(/\s/g, '-'));
expect(headings, target).toContain(anchor);
}
}
}
const readme = fs.readFileSync(path.join(fixture, 'README.md'), 'utf8');
expect(readme).toContain('no selected primary developer persona or peer-DX study');
expect(readme).toContain('No first-run duration has\nbeen measured');
expect(readme).toContain('There is no skip');
expect(readme).toContain('no interactive demo or designed aha sequence');
expect(readme).toContain('one ordinary passing case; it has no staged regression');
const reference = fs.readFileSync(path.join(fixture, 'docs/reference-v1.md'), 'utf8');
const guide = fs.readFileSync(path.join(fixture, 'docs/getting-started.md'), 'utf8');
const errorLink = /^Reference: (docs\/[^#]+)#([^\s]+)$/m.exec(guide);
expect(errorLink).not.toBeNull();
expect(fs.readFileSync(path.join(fixture, errorLink![1]!), 'utf8')).toBe(reference);
const errorHeadings = [...reference.matchAll(/^### (.+)$/gm)].map(match => match[1]!.toLowerCase().replace(/\s/g, '-'));
expect(errorHeadings).toContain(errorLink![2]!);
expect(reference).toContain('cannot interrupt arbitrary application code or cap requests made by a separate');
expect(reference).toContain('those calls have not been executed against\nthe SDK here');
expect(reference).toContain('Fixture checks execute the local application files and explicit\ncontract doubles');
});
test('materialized DX error examples identify their cause, bound and reachable code reference', () => {
const reference = fs.readFileSync(path.join(ROOT, 'test/fixtures/devex-existing-sdk/docs/reference-v1.md'), 'utf8');
const expected = [
{ heading: '### SDK E002', count: 1, causes: ['MetricTypeError'], values: ['cases[0]'] },
{ heading: '### SDK E003', count: 2, causes: ['DeadlineExceeded', 'ManagedProviderCostLimit'],
values: ['deadline_seconds=20', 'max_cost_usd=0.25'] },
];
for (const spec of expected) {
const start = reference.indexOf(spec.heading);
const next = reference.indexOf('\n##', start + spec.heading.length);
const section = reference.slice(start, next < 0 ? undefined : next);
const blocks = [...section.matchAll(/```text\n([\s\S]*?)\n```/g)].map(match => match[1]!);
expect(blocks, spec.heading).toHaveLength(spec.count);
for (const [index, block] of blocks.entries()) {
const code = spec.heading.replace('### SDK ', 'SDK_');
expect(block.split('\n')[0]).toStartWith(code + ':');
expect(block).toContain('Cause: ' + spec.causes[index]);
expect(block).toContain(spec.values[index]!);
expect(block).toMatch(/^Next: .+/m);
const anchor = spec.heading.replace('### ', '').toLowerCase().replace(/ /g, '-');
expect(block).toContain('Reference: docs/reference-v1.md#' + anchor);
}
}
});
// Materialize the documented files in a temp directory. These controls test
// application examples against an explicit contract stub, never the absent SDK.
const dxDocs = () => Object.fromEntries(['README.md', 'docs/getting-started.md', 'docs/reference-v1.md']
.map(file => [file, fs.readFileSync(path.join(ROOT, 'test/fixtures/devex-existing-sdk', file), 'utf8')]));
function dxBlock(body: string, after: string, language: string): string {
const offset = body.indexOf(after);
expect(offset, `missing documented example: ${after}`).toBeGreaterThanOrEqual(0);
const match = new RegExp('```' + language + '\\n([\\s\\S]*?)\\n```').exec(body.slice(offset));
expect(match, `missing ${language} block after ${after}`).not.toBeNull();
return match![1]!;
}
function runDxDocumentationControl(code: string, payload: unknown) {
const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'devex-doc-control-'));
try {
const script = path.join(directory, 'control.py');
fs.writeFileSync(script, code);
const input = path.join(directory, 'input.json');
fs.writeFileSync(input, JSON.stringify(payload));
// Like bin/gstack-config, support both Python command names. Windows
// installs normally expose python.exe; avoid preferring its python3 Store alias.
const python = (process.platform === 'win32' ? ['python', 'python3'] : ['python3', 'python'])
.map(command => Bun.which(command)).find((command): command is string => command !== null);
if (!python) throw new Error('Python 3 is required for the DX documentation controls');
const child = Bun.spawnSync([python, script, input], { cwd: directory, timeout: 10_000,
stdin: 'ignore', stdout: 'pipe', stderr: 'pipe' });
expect(child.signalCode ?? null, child.stderr.toString()).toBeNull();
expect(child.exitCode, child.stderr.toString()).toBe(0);
return child.stdout.toString();
} finally { fs.rmSync(directory, { recursive: true, force: true }); }
}
test('materialized DX success blocks print the documented structured fields without assuming SDK repr', () => {
const docs = dxDocs();
const first = dxBlock(docs['README.md']!, '## Quick start', 'python');
expect(first).toBe(dxBlock(docs['docs/getting-started.md']!, '## Neutral first evaluation', 'python'));
const examples = [
{ code: first, expected: dxBlock(docs['README.md']!, 'Shown application output', 'text') },
{ code: dxBlock(docs['docs/getting-started.md']!, '## Neutral first evaluation', 'python'),
expected: dxBlock(docs['docs/getting-started.md']!, 'Shown application output', 'text') },
{ code: dxBlock(docs['docs/getting-started.md']!, '## Caller-owned metric for free text', 'python'),
expected: dxBlock(docs['docs/getting-started.md']!, 'Shown free-text application output', 'text') },
];
for (const { code } of examples) { expect(code).not.toContain('print(result)'); expect(code).toContain('result.cases'); }
const output = runDxDocumentationControl(String.raw`
import contextlib, io, json, sys, types
with open(sys.argv[1], encoding='utf-8') as source:
examples = json.load(source)
# Deliberate assumed-contract double: not an implementation of eval-sdk.
def evaluate(target, cases, metric):
result = []
for case in cases:
actual = target(case['inputs'])
result.append(types.SimpleNamespace(actual=actual, expected=case['expected'], score=metric(actual, case['expected'])))
return types.SimpleNamespace(cases=result)
stub = types.ModuleType('eval_sdk'); stub.evaluate = evaluate; sys.modules['eval_sdk'] = stub
for example in examples:
output = io.StringIO(); namespace = {}
with contextlib.redirect_stdout(output): exec(example['code'], namespace)
assert output.getvalue().strip() == example['expected']
assert json.loads(output.getvalue())[0]['score'] == 1.0
# Preserve the caller-owned metric's mismatching-prose behavior separately.
assert namespace['text_metric']('red', 'green') == 0.0
print('three documented outputs match the contract stub; no SDK executed')
`, examples);
expect(output).toContain('three documented outputs match the contract stub; no SDK executed');
});
test('materialized DX application client bounds actual local process timeouts, retries and reservations', () => {
const guide = dxDocs()['docs/getting-started.md']!;
const client = dxBlock(guide, 'Save as `bounded_client.py`', 'python');
const transport = dxBlock(guide, 'Save as `fixture_transport.py`', 'python');
const usage = dxBlock(guide, 'Use the application client in the callable', 'python');
expect(guide).toContain('verified upper bound');
expect(guide).toContain('not refunded');
expect(guide).toContain('does not prove that a remote provider cancelled');
const output = runDxDocumentationControl(String.raw`
import json, pathlib, subprocess, sys, time, types
with open(sys.argv[1], encoding='utf-8') as source:
payload = json.load(source)
pathlib.Path('bounded_client.py').write_text(payload['client'])
pathlib.Path('fixture_transport.py').write_text(payload['transport'])
from bounded_client import BoundedClient
# Observe the real handles; subprocess.run still owns timeout/kill/wait.
original_popen = subprocess.Popen
children = []
def capture_popen(*args, **kwargs):
child = original_popen(*args, **kwargs)
children.append(child)
return child
subprocess.Popen = capture_popen
command = [sys.executable, 'fixture_transport.py']
client = BoundedClient(command, timeout_seconds=1, max_attempts=2, total_cents=4, attempt_cents=2)
assert client({'enabled': True}) == {'ready': True}
assert client.reserved_cents == 2
assert client({'enabled': False}) == {'ready': False}
assert client.reserved_cents == 4
try: client({'enabled': True}); raise AssertionError('budget exceeded')
except RuntimeError as e: assert 'spending limit' in str(e)
assert client.reserved_cents == 4
# Calls sharing this application client also share one reservation ceiling.
from concurrent.futures import ThreadPoolExecutor
client = BoundedClient(command, timeout_seconds=1, max_attempts=2, total_cents=4, attempt_cents=2)
def concurrent_call(_):
try: return client({'enabled': True})
except RuntimeError as e:
assert 'spending limit' in str(e); return None
with ThreadPoolExecutor(max_workers=4) as pool: outputs = list(pool.map(concurrent_call, range(4)))
assert outputs.count({'ready': True}) == 2 and outputs.count(None) == 2
assert client.reserved_cents == 4
# Real child failure/retry and real child timeout: no network or SDK involved.
pathlib.Path('controlled_transport.py').write_text('''import sys, time
mode = sys.argv[1]
with open('attempts', 'a') as f: f.write('attempt\\n')
if mode == 'stall': time.sleep(30)
if mode == 'fail': sys.exit(75)
''')
for mode in ('fail', 'stall'):
first_child = len(children)
pathlib.Path('attempts').unlink(missing_ok=True)
client = BoundedClient([sys.executable, 'controlled_transport.py', mode], timeout_seconds=0.2,
max_attempts=2, total_cents=6, attempt_cents=2)
started = time.monotonic()
try: client({'enabled': True}); raise AssertionError('failed transport succeeded')
except (RuntimeError, subprocess.TimeoutExpired): pass
assert time.monotonic() - started < 3
attempts = pathlib.Path('attempts').read_text().splitlines()
owned_children = children[first_child:]
assert len(attempts) == len(owned_children) == 2 and client.reserved_cents == 4
for child in owned_children:
assert child.poll() is not None, 'transport process leaked'
assert child.wait(timeout=0) == child.returncode
assert child.returncode != 0
if mode == 'fail': assert child.returncode == 75
# Insufficient reservation prevents even the retry from starting.
pathlib.Path('attempts').unlink()
client = BoundedClient([sys.executable, 'controlled_transport.py', 'fail'], timeout_seconds=1,
max_attempts=2, total_cents=2, attempt_cents=2)
try: client({'enabled': True}); raise AssertionError('budget exceeded')
except RuntimeError as e: assert 'spending limit' in str(e)
assert len(pathlib.Path('attempts').read_text().splitlines()) == 1
assert client.reserved_cents == 2
# The full shown usage sends independent limits to the SDK contract double.
seen = []
def evaluate(target, cases, metric, **options):
seen.append(options)
assert target(cases[0]['inputs']) == cases[0]['expected']
return types.SimpleNamespace(cases=[])
stub = types.ModuleType('eval_sdk'); stub.evaluate = evaluate; sys.modules['eval_sdk'] = stub
exec(payload['usage'], {})
assert seen == [{'deadline_seconds': 20, 'max_cost_usd': 0.25}]
print('local timeout/retry/reservation bounds verified; no SDK/provider call')
`, { client, transport, usage });
expect(output).toContain('local timeout/retry/reservation bounds verified; no SDK/provider call');
});
test('materialized DX CLI cases and import targets match the exact shown invocation in an offline contract double', () => {
const reference = dxDocs()['docs/reference-v1.md']!;
const cli = reference.slice(reference.indexOf('## CLI'), reference.indexOf('## Errors'));
const payload = { app: dxBlock(cli, 'Save as `app.py`', 'python'), cases: dxBlock(cli, 'Save as `cases.json`', 'json'),
command: dxBlock(cli, 'Run with the assumed SDK', 'bash') };
expect(JSON.parse(payload.cases)).toEqual([{ inputs: { enabled: true }, expected: { ready: true } }]);
const output = runDxDocumentationControl(String.raw`
import argparse, importlib, json, pathlib, shlex, sys
with open(sys.argv[1], encoding='utf-8') as source:
payload = json.load(source)
pathlib.Path('app.py').write_text(payload['app']); pathlib.Path('cases.json').write_text(payload['cases'])
# Parse the documented command as an explicit contract double, not the absent CLI.
args = shlex.split(payload['command']); assert args[:2] == ['eval-sdk', 'run']
parser = argparse.ArgumentParser()
for flag in ('target', 'cases', 'metric', 'deadline-seconds', 'max-cost-usd'): parser.add_argument('--' + flag, required=True)
parser.add_argument('--no-input', action='store_true')
options = parser.parse_args(args[2:])
assert options.no_input and options.deadline_seconds == '20' and options.max_cost_usd == '0.25'
def resolve(value):
module, name = value.split(':'); return getattr(importlib.import_module(module), name)
target, metric = resolve(options.target), resolve(options.metric)
cases = json.loads(pathlib.Path(options.cases).read_text())
assert isinstance(cases, list) and len(cases) == 1
for case in cases:
assert set(case) == {'inputs', 'expected'}
assert metric(target(case['inputs']), case['expected']) == 1.0
print('shown cases file, CLI arguments and import targets agree; no SDK executed')
`, payload);
expect(output).toContain('shown cases file, CLI arguments and import targets agree; no SDK executed');
});