mirror of
https://github.com/garrytan/gbrain.git
synced 2026-07-27 22:15:33 +00:00
* fix(tests): root-cause two master test-infra flakes
gateway.test.ts: add afterAll(resetGateway) hook. The file's tests use
beforeEach(resetGateway) for per-test isolation, but the FINAL test was
leaving configureGateway({env: {OPENAI_API_KEY: 'openai-fake'}}) in the
gateway module state. Sibling files in the same bun shard (e.g.
test/ingestion/ingest-capture.test.ts) then triggered embed() against
the real OpenAI endpoint with the leaked fake key, wedging the shard
with 'Incorrect API key provided: openai-fake'.
header-transport.test.ts → .serial.test.ts: the file mutates RECIPES
(gateway's module-scoped recipe map) plus configureGateway, then asserts
fakeChatFetch was invoked. Under bun's intra-shard parallelism, sibling
files like test/ai/rerank.test.ts race the same state — chat would see
result.text === '[]' instead of 'ok' because another test called
resetGateway between this test's configureGateway and chat. Quarantining
as .serial.test.ts moves the file into the post-parallel serial pass
at --max-concurrency=1 per repo convention.
* refactor(doctor): extract buildChecks seam + behavioral coverage
src/commands/doctor.ts: extract buildChecks(engine, args, dbSource):
Promise<Check[]> from runDoctor. The check-building logic moves into
the new exported function; existing exported computeDoctorReport(checks)
at line 78 stays untouched. runDoctor becomes a thin wrapper:
buildChecks → computeDoctorReport → render + process.exit. All 10
process.exit sites stay in place. The two early-return paths drop
their inline outputResults+process.exit calls and return the partial
check list; the wrapper still produces identical observable output.
test/doctor-behavioral.test.ts (13 cases): pure pure-aggregation cases
pin computeDoctorReport math (3 fails → -60 points, score clamped at 0,
mixed outcome → unhealthy with fail dominating). Orchestrator cases
assert --fast flag honors the skip set, --json doesn't alter the list,
no-engine path returns partial without process.exit, and the snapshot
of load-bearing check names catches accidental drop-outs during
future refactors.
test/doctor-cli-smoke.serial.test.ts (1 case): subprocess smoke spawning
'bun run src/cli.ts doctor --json' against a fresh PGLite tempdir brain.
Catches render-path bugs that buildChecks-only tests miss — the class
the v0.38.2.0 partial-scan wave exposed. Quarantined as .serial because
PGLite write-locks don't play well with parallel runners; skippable via
GBRAIN_SKIP_SUBPROCESS_TESTS=1.
* feat(operations): trust-boundary contract test + filter-bypass shell guard
test/operations-trust-boundary.test.ts (14 cases): hybrid design per
plan D7. Pure assertions over all 74 ops cover the drift-detection
win (every op has a scope; every mutating op has a non-read scope;
hasScope(['read'], op.scope) correctly rejects 'admin' or 'write').
Plus the canonical filter contract: every localOnly: true op is
excluded from operations.filter(op => !op.localOnly). Plus targeted
handler-invocation cases for the two historically-broken HTTP-callable
classes: submit_job(name='shell', ctx.remote=true) MUST reject (F7b
HTTP MCP shell-job RCE class), and search_by_image(image_path,
ctx.remote=true) MUST reject (D18 P0 image-leak class). file_upload
and sync_brain are deliberately omitted from handler-invocation tests
because they're localOnly — calling their handlers directly tests an
impossible production path (codex CMT-3). All 7 localOnly ops are
snapshot-pinned by name to catch future flag-flips.
scripts/check-operations-filter-bypass.sh: greps src/ for any module
that imports the 'operations' value from core/operations.ts outside
the canonical filter site. Three import shapes detected: destructured,
aliased ('as ops'), namespace ('import * as'). Explicit allow-list of
10 known-safe importers with one-line rationale per entry. Plus a
filter-presence check on serve-http.ts that fails if the canonical
filter expression is refactored out. Codex /ship adversarial review
caught the original narrow regex missed aliased + namespace bypasses;
the expanded regex closes that class. Type-only imports of sibling
exports (sourceScopeOpts, OperationContext) are not flagged.
package.json: wires check:operations-filter-bypass into the verify
chain alongside check:jsonb and check:progress.
* refactor(cycle): export runPhaseLint+runPhaseBacklinks; add wrapper tests
src/core/cycle.ts: adds 'export' keyword to two existing phase
functions so behavioral tests can drive them without going through
runCycle's full setup cost. No body changes; no behavior change.
Documented as internal helpers exposed for test-only consumption —
downstream code should NOT take a dependency on them; existing
plan-eng-review D9 explicitly accepted the API-widening tax for
testability.
test/cycle-legacy-phases.test.ts (11 cases): combined file with two
describe blocks per plan D5 (DRY — shared setup, future phase
wrappers land as additional describes). Narrowed to result-mapping
+ error envelope per codex CMT-1 (legacy phases don't extend
BaseCyclePhase and don't take a progress reporter or AbortSignal
directly, so the contract surface is counter → status enum + try/catch
envelope). Cases: clean run → status='ok', partial fix → status='warn'
with dryRun in details, dry-run path doesn't write, throw-from-lib
→ status='fail' with envelope populated (no exception escape).
Verified runLintCore and runBacklinksCore both throw on missing dir,
so the throw-from-lib cases are deterministic.
* chore: bump version and changelog (v0.40.4.1)
E2E + unit test gap coverage wave. Closes 4 audit gaps with new
behavioral coverage (doctor orchestrator + subprocess smoke, operations
trust-boundary contract + filter-bypass guard, cycle phase wrapper
result-mapping). Verifies 3 audit gaps were already covered (ingestion
dedup/daemon/skillpack-load, phantom-redirect, ingestion test-harness).
Root-causes 2 pre-existing master flakes (gateway state leak, header-
transport cross-shard race). Files 5 follow-up TODOs from codex
adversarial-review findings.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: note v0.40.4.1 doctor.buildChecks + cycle phase exports in CLAUDE.md
Adds three Key-files entries pinning the v0.40.4.1 test-wave additions:
- doctor.ts extension: buildChecks seam + behavioral tests (13+1 cases)
- cycle.ts extension: runPhaseLint + runPhaseBacklinks exports (11 cases)
- operations-trust-boundary contract + check-operations-filter-bypass.sh
Regenerates llms-full.txt to match (CLAUDE.md edits require build:llms per
project rule, otherwise test/build-llms.test.ts fails in CI shard 1).
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
* fix(tests): reset gateway in put_page write-through tests to skip embed in CI
CI failure mode: 9 tests in test/ingestion/put-page-write-through.test.ts
failed with `AIConfigError: [embed(zeroentropyai:zembed-1)] Unauthorized`
because put_page's handler at src/core/operations.ts:622 computes
`noEmbed = !isAvailable('embedding')`. When the gateway state has been
configured by a sibling test (or by the cli.ts module-load path reading
.env.testing) with a fake/stale ZEROENTROPY_API_KEY, isAvailable returns
true → put_page tries to embed → the real ZeroEntropy API returns 401.
Local dev passes because real ZE keys are present; CI doesn't have them.
Fix: call resetGateway() in beforeEach so isAvailable('embedding')
returns false → put_page's noEmbed path activates → no network call.
Also reset in afterAll to avoid leaking the cleared state to sibling
files in the same bun shard (the v0.40.4.1 gateway state-leak class
that motivated the earlier gateway.test.ts fix).
The test exercises write-through behavior, not embedding. No need for
a real or fake embed transport — bypass entirely.
* fix(tests): widen brain-writer partial-scan deadlines to absorb CI timing variance
CI failure: scanBrainSources partial-scan state > "hanging COUNT does not
exceed deadline — Promise.race timeout fires" failed once on a GitHub
Actions runner. The test asserted a 100ms deadline budget with a 500ms
bound; observed test duration was 187ms on CI (passes locally 20/20
runs at the original budget).
Root cause: Node.js timer drift under shard parallelism. The deadline
check at src/core/brain-writer.ts:503 uses strict `Date.now() > deadline`,
so when the setTimeout in Promise.race fires exactly at the boundary
(e.g. start+100ms when deadline is start+100ms), the post-await check
sees equality and skips the markRemainingSkipped branch. The test
also asserts elapsed < 500ms; CI overhead can push elapsed past that
bound when setTimeout drifts.
Fix: widen the deadline budget on both deadline-race tests proportionally
(keeps the same 2x ratio that proves "query exceeds deadline"). No
src/ changes — this is purely a test robustness widening.
- "hanging COUNT" test: 100ms → 500ms deadline, 500ms → 2500ms bound
- "slow COUNT" test: 50ms → 250ms deadline, 100ms → 500ms query delay
Verified locally: 20/20 stress runs at the widened budgets, no fails.
* fix(brain-writer): deadline check is >= not > (closes CI flake at boundary)
CI failure recurred: same "hanging COUNT does not exceed deadline" test
failed again at 588ms (past my previous 500ms deadline + 2500ms bound
widening). The root cause isn't test timing — it's an off-by-one in
the source.
src/core/brain-writer.ts had two deadline checks using strict `>`:
- line 445 (between-source abort)
- line 503 (post-COUNT-await re-check)
The Promise.race setTimeout resolves null at exactly `remainingMs` from
now, so post-await Date.now() OFTEN equals the deadline within
integer-ms precision. With `>`, the check skipped → scanOneSource ran
on the source whose budget had just been eaten → that source got
status='scanned' instead of 'skipped'. The test's `expect(firstSource
.status).toBe('skipped')` failed.
Fix: both checks now use `>=`. When Date.now() equals deadline exactly,
the budget IS exhausted — proceeding would let the next source eat its
own budget on top of what's already spent. Matches the boundary the
Promise.race's remainingMs <= 0 immediate-null path uses (line 481).
This is the real fix for the v0.40.x CI flakes; my earlier test-budget
widening papered over the symptom without closing the boundary. Kept
the wider 500ms deadline for headroom but added a comment pointing at
the operator fix as the load-bearing change.
Verified: 20/20 stress runs green locally after the operator fix.
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
268 lines
10 KiB
TypeScript
268 lines
10 KiB
TypeScript
/**
|
|
* v0.39 trust-boundary contract test (GAP 3 of the e2e-test-wave audit).
|
|
*
|
|
* Hybrid design (D7 — pure + targeted handler invocation):
|
|
*
|
|
* - Pure assertions over ALL operations (~74 ops): scope annotations
|
|
* present + correct; localOnly ops are filtered out of the canonical
|
|
* mcpOperations list; hasScope semantics work for the standard tiers.
|
|
*
|
|
* - Handler-invocation cases for ops that are NOT localOnly but DO
|
|
* enforce remote/scope at the handler layer (defense-in-depth where
|
|
* it actually fires in production):
|
|
*
|
|
* * submit_job — name='shell' + ctx.remote=true MUST reject
|
|
* (the HTTP MCP shell-job RCE class, F7b)
|
|
* * search_by_image — image_path + ctx.remote=true MUST reject
|
|
* (D18 P0 source-isolation leak class)
|
|
*
|
|
* `file_upload` and `sync_brain` are intentionally NOT in the
|
|
* handler-invocation set — both are localOnly, so the canonical
|
|
* filter removes them from mcpOperations and the HTTP path never
|
|
* reaches their handlers. Calling their handlers with remote=true
|
|
* tests an impossible production path (codex CMT-3). The defense-
|
|
* in-depth strict-mode checks inside those handlers still exist;
|
|
* they're proven by the localOnly-filtered-out contract here.
|
|
*
|
|
* Criterion for the curated sensitive-ops list:
|
|
* ops whose HANDLER (not transport) has been broken historically.
|
|
* Add an op here when a real exploit class is fixed at the handler
|
|
* level; remove only when the handler-level defense becomes
|
|
* structurally unreachable (e.g., the op becomes localOnly).
|
|
*
|
|
* Companion guard at scripts/check-operations-filter-bypass.sh enforces
|
|
* the canonical filter site so a future HTTP route can't bypass it.
|
|
*/
|
|
import { describe, test, expect, beforeAll, afterAll, beforeEach } from 'bun:test';
|
|
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
|
|
import { resetPgliteState } from './helpers/reset-pglite.ts';
|
|
import { operations, type OperationContext } from '../src/core/operations.ts';
|
|
import { hasScope } from '../src/core/scope.ts';
|
|
|
|
let engine: PGLiteEngine;
|
|
|
|
beforeAll(async () => {
|
|
engine = new PGLiteEngine();
|
|
await engine.connect({});
|
|
await engine.initSchema();
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await engine.disconnect();
|
|
});
|
|
|
|
beforeEach(async () => {
|
|
await resetPgliteState(engine);
|
|
});
|
|
|
|
// Minimal context factory — every test that invokes a handler builds
|
|
// one of these. Defaults to remote=true (untrusted) because that's the
|
|
// trust posture the bug-class regressions live in; tests opt back to
|
|
// local trust by overriding remote=false.
|
|
function makeContext(overrides: Partial<OperationContext> = {}): OperationContext {
|
|
return {
|
|
engine: engine as any,
|
|
config: {} as any,
|
|
logger: console as any,
|
|
dryRun: false,
|
|
remote: true,
|
|
sourceId: 'default',
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe('operations contract — every op has scope + correct mutability shape', () => {
|
|
test('every op declares a scope annotation', () => {
|
|
for (const op of operations) {
|
|
expect(op.scope, `op "${op.name}" missing scope annotation`).toBeDefined();
|
|
}
|
|
});
|
|
|
|
test('every mutating op has a write-class scope (not "read")', () => {
|
|
const WRITE_CLASS_SCOPES = new Set([
|
|
'write',
|
|
'admin',
|
|
'sources_admin',
|
|
'users_admin',
|
|
'agent',
|
|
]);
|
|
for (const op of operations) {
|
|
if (op.mutating === true) {
|
|
expect(
|
|
WRITE_CLASS_SCOPES.has(op.scope ?? 'read'),
|
|
`mutating op "${op.name}" has read-tier scope "${op.scope}"; expected one of ${[...WRITE_CLASS_SCOPES].join('/')}`,
|
|
).toBe(true);
|
|
}
|
|
}
|
|
});
|
|
|
|
test('scope is one of the documented enum values', () => {
|
|
const KNOWN_SCOPES = new Set([
|
|
'read',
|
|
'write',
|
|
'admin',
|
|
'sources_admin',
|
|
'users_admin',
|
|
'agent',
|
|
]);
|
|
for (const op of operations) {
|
|
expect(
|
|
KNOWN_SCOPES.has(op.scope!),
|
|
`op "${op.name}" has unknown scope "${op.scope}"`,
|
|
).toBe(true);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('mcpOperations filter — localOnly ops are excluded from the HTTP-exposed surface', () => {
|
|
// This filter is what serve-http.ts uses to build the tools/list response:
|
|
// const mcpOperations = operations.filter(op => !op.localOnly);
|
|
// A localOnly op that leaks into mcpOperations is exposed via HTTP MCP
|
|
// and bypasses the trust boundary. Pin the filter contract here so a
|
|
// regression surfaces as a structural test failure.
|
|
|
|
test('the canonical filter excludes every localOnly op', () => {
|
|
const mcpOps = operations.filter(op => !op.localOnly);
|
|
const mcpNames = new Set(mcpOps.map(op => op.name));
|
|
const localOnlyOps = operations.filter(op => op.localOnly === true);
|
|
|
|
expect(localOnlyOps.length).toBeGreaterThan(0);
|
|
for (const op of localOnlyOps) {
|
|
expect(
|
|
mcpNames.has(op.name),
|
|
`localOnly op "${op.name}" leaked into the HTTP MCP surface`,
|
|
).toBe(false);
|
|
}
|
|
});
|
|
|
|
test('known historically-sensitive localOnly ops stay filtered', () => {
|
|
// Pin every localOnly op by name so a refactor that flips localOnly off
|
|
// on any of them fails this test even if the generic contract above
|
|
// somehow regresses. Codex /ship review caught the original 4-name
|
|
// snapshot was missing purge_deleted_pages, get_recent_transcripts, and
|
|
// code_traversal_cache_clear — additions that already qualified.
|
|
//
|
|
// When adding a NEW localOnly op: add its name here too. The generic
|
|
// contract above proves the filter rule applies; this list proves the
|
|
// specific ops we care about haven't silently shed their localOnly flag.
|
|
const KNOWN_LOCAL_ONLY = [
|
|
'sync_brain',
|
|
'file_upload',
|
|
'file_list',
|
|
'file_url',
|
|
'purge_deleted_pages',
|
|
'get_recent_transcripts',
|
|
'code_traversal_cache_clear',
|
|
];
|
|
const lookup = new Map(operations.map(op => [op.name, op] as const));
|
|
for (const name of KNOWN_LOCAL_ONLY) {
|
|
const op = lookup.get(name);
|
|
expect(op, `expected canonical op "${name}" to still exist`).toBeDefined();
|
|
expect(op!.localOnly, `"${name}" must stay localOnly`).toBe(true);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('hasScope — read-only token cannot satisfy write or admin scopes', () => {
|
|
// The HTTP path computes `requiredScope = op.scope || 'read'` and gates
|
|
// every call on `hasScope(authInfo.scopes, requiredScope)`. Pin the
|
|
// semantics here so a refactor of the IMPLIES table can't silently
|
|
// grant admin via a read-class token.
|
|
test('read scope does NOT satisfy write', () => {
|
|
expect(hasScope(['read'], 'write')).toBe(false);
|
|
});
|
|
|
|
test('read scope does NOT satisfy admin', () => {
|
|
expect(hasScope(['read'], 'admin')).toBe(false);
|
|
});
|
|
|
|
test('write scope satisfies write AND read', () => {
|
|
expect(hasScope(['write'], 'write')).toBe(true);
|
|
expect(hasScope(['write'], 'read')).toBe(true);
|
|
});
|
|
|
|
test('admin scope satisfies admin, write, AND read (umbrella implies)', () => {
|
|
expect(hasScope(['admin'], 'admin')).toBe(true);
|
|
expect(hasScope(['admin'], 'write')).toBe(true);
|
|
expect(hasScope(['admin'], 'read')).toBe(true);
|
|
});
|
|
|
|
test('unknown scope strings are ignored, do not satisfy anything', () => {
|
|
expect(hasScope(['bogus'], 'read')).toBe(false);
|
|
expect(hasScope(['bogus'], 'write')).toBe(false);
|
|
});
|
|
|
|
test('every read-scope op accepts a read-only token; every write-scope op rejects it', () => {
|
|
// Walk the op surface and assert that a synthetic read-only token
|
|
// satisfies every read-scope op but no write/admin op.
|
|
const READ_TOKEN_SCOPES = ['read'] as const;
|
|
for (const op of operations) {
|
|
const required = op.scope ?? 'read';
|
|
const accepted = hasScope(READ_TOKEN_SCOPES, required);
|
|
if (required === 'read') {
|
|
expect(accepted, `read op "${op.name}" should accept read-only token`).toBe(true);
|
|
} else {
|
|
expect(accepted, `${required} op "${op.name}" must reject read-only token`).toBe(false);
|
|
}
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('handler invocation — historically-broken trust-boundary classes', () => {
|
|
// The two non-localOnly ops whose handler-level defense fires in
|
|
// production and has been broken historically (F7b HTTP MCP shell-job
|
|
// RCE; D18 P0 image_path remote-leak). file_upload and sync_brain are
|
|
// omitted because they're localOnly (codex CMT-3 — testing their
|
|
// handlers with remote=true tests an impossible production path).
|
|
|
|
test('submit_job rejects shell with ctx.remote=true (HTTP MCP shell-job RCE class)', async () => {
|
|
const submitJob = operations.find(op => op.name === 'submit_job');
|
|
expect(submitJob).toBeDefined();
|
|
const ctx = makeContext({ remote: true });
|
|
|
|
let threw = false;
|
|
let message = '';
|
|
try {
|
|
await submitJob!.handler(ctx, { name: 'shell', data: { cmd: 'echo hi' } });
|
|
} catch (e) {
|
|
threw = true;
|
|
message = e instanceof Error ? e.message : String(e);
|
|
}
|
|
expect(threw, 'submit_job(shell) with remote=true MUST reject').toBe(true);
|
|
// Should mention the protected status — "permission_denied" is the
|
|
// canonical OperationError code, plus the user-facing string names
|
|
// the rejected name.
|
|
expect(message.toLowerCase()).toContain('shell');
|
|
});
|
|
|
|
test('submit_job allows shell when ctx.remote=false (local CLI is trusted)', async () => {
|
|
// The flip side of the trust boundary: a local trusted caller with
|
|
// explicit remote=false MUST be allowed to submit shell jobs (that's
|
|
// how the CLI works in production). We don't actually want to run the
|
|
// job — pass dryRun so the op short-circuits.
|
|
const submitJob = operations.find(op => op.name === 'submit_job');
|
|
const ctx = makeContext({ remote: false, dryRun: true });
|
|
|
|
const result = await submitJob!.handler(ctx, { name: 'shell', data: { cmd: 'echo hi' } });
|
|
expect(result).toMatchObject({ dry_run: true, action: 'submit_job', name: 'shell' });
|
|
});
|
|
|
|
test('search_by_image rejects image_path with ctx.remote=true (D18 P0)', async () => {
|
|
const searchByImage = operations.find(op => op.name === 'search_by_image');
|
|
expect(searchByImage).toBeDefined();
|
|
const ctx = makeContext({ remote: true });
|
|
|
|
let threw = false;
|
|
let message = '';
|
|
try {
|
|
await searchByImage!.handler(ctx, { image_path: '/tmp/some-image.png' });
|
|
} catch (e) {
|
|
threw = true;
|
|
message = e instanceof Error ? e.message : String(e);
|
|
}
|
|
expect(threw, 'search_by_image(image_path) with remote=true MUST reject').toBe(true);
|
|
expect(message.toLowerCase()).toContain('image_path');
|
|
expect(message.toLowerCase()).toContain('permission_denied');
|
|
});
|
|
});
|