mirror of
https://github.com/garrytan/gbrain.git
synced 2026-07-27 22:15:33 +00:00
* fix(serve): clean up stdio MCP server on client disconnect
The PGLite write lock leaked indefinitely when the parent of `gbrain serve`
disconnected. Three root causes: serve.ts never called engine.disconnect()
after startMcpServer() resolved; cli.ts short-circuited with a "serve doesn't
disconnect" comment; and the MCP SDK's StdioServerTransport only listens for
'data'/'error' on stdin, never 'end'/'close', so even a clean stdin EOF never
reached the SDK.
Net effect: the next `gbrain serve` waited for the in-process 5-minute stale-
lock check or hung indefinitely.
stdio path now installs a unified lifecycle:
- SIGTERM/SIGINT/SIGHUP all funnel into one idempotent shutdown path
(SIGHUP coverage matters for Claude Desktop on macOS / MCP gateway
restarts; SIGINT for Ctrl-C; SIGTERM for daemon shutdown).
- stdin 'end' (clean EOF) and 'close' (parent SIGKILL with pipe still
open) both trigger the same graceful path. TTY stdin skips the watchers
so interactive `gbrain serve` is unaffected.
- Parent-process watchdog polls the live kernel parent PID via spawnSync
('ps','-o','ppid=','-p',PID) every 5s. process.ppid is cached at process
creation by Bun (and Node) and never refreshes on re-parent — empirical
evidence on macOS shows ps reports the new parent within one tick while
process.ppid stays at the original PID indefinitely (oven-sh/bun#30305).
- Watchdog fires on `getParentPid() !== initialParentPid` (any reparent),
not just `=== 1`. Catches launchd / systemd / tmux / parent-shell-with-
PR_SET_CHILD_SUBREAPER cases where the kernel re-anchors us to a non-1
subreaper PID. Codex review caught the original `=== 1` was incomplete.
- One-shot startup probe verifies `spawnSync('ps')` actually works on this
host. If the probe fails (stripped containers / busybox without procps),
we skip installing the watchdog interval entirely AND emit a loud stderr
line — the operator sees "watchdog disabled" instead of an installed-
but-never-fires phantom that silently falls back to cached process.ppid.
- 5-second cleanup deadline: if engine.disconnect() wedges (PGLite WASM
stall, etc.), the process still calls process.exit(0). The abandoned
lock dir is reclaimed on the next start by the existing stale-lock
check in pglite-lock.ts.
- Optional `--stdio-idle-timeout <sec>`: default OFF safety net for
parents that leak the pipe but never close it. Strict parsing rejects
`abc` / `30junk` / `-1` / `1.5` / blank values explicitly so a typo
doesn't silently disable the safety net (closes #446).
Test seam: ServeOptions { stdin, signals, exit, log, startMcpServer,
getParentPid, setInterval, clearInterval, probeWatchdog } lets the
lifecycle be unit-tested deterministically without spawning a real Bun
child or booting the MCP SDK.
22 test cases covering signals, stdin EOF, TTY skip, watchdog reparent
(both PID-1 and subreaper-PID-N cases), ps-unavailable degraded mode,
idle timeout, idempotent shutdown, and cleanup-deadline behavior.
Closes #413, #446. Supersedes #591.
Co-Authored-By: Aragorn2046 <noreply@github.com>
Co-Authored-By: seungsu-kr <noreply@github.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* fix(auth): route HTTP auth/admin SQL through active engine
`gbrain auth` and `gbrain serve --http` previously routed every SQL
through the postgres.js singleton in src/core/db.ts, which silently fell
back to a file-backed PGLite when DATABASE_URL was set but the config
file disagreed. The HTTP transport's verbatim use of the singleton also
made `gbrain serve --http` Postgres-only, even though the
`access_tokens` and `mcp_request_log` tables exist in both engine
schemas.
Auth, OAuth, admin, file uploads, and HTTP-transport SQL now run through
`engine.executeRaw` via a deliberately narrow tagged-template adapter
(`src/core/sql-query.ts`). The contract is scalar-binds-only — adding
JSONB or fragment composition would invite the adapter to drift into a
partial postgres.js clone. JSONB writes use a separate
`executeRawJsonb(engine, sql, scalarParams, jsonbParams)` helper that
composes positional `$N::jsonb` casts and passes objects through
`engine.executeRaw`. The CI guard at `scripts/check-jsonb-pattern.sh`
doesn't fire because the helper is a method call, not the banned
`${JSON.stringify(x)}::jsonb` template-literal interpolation, and the
v0.12.0 double-encode bug class doesn't apply to positional binding via
`postgres.js`'s `unsafe()` (verified by
`test/e2e/auth-permissions.test.ts:67` on Postgres and the new
`test/sql-query.test.ts` on PGLite).
Migrated call sites:
- src/commands/auth.ts: takes-holders writes (lines 52, 86) →
executeRawJsonb. List, revoke, register-client, revoke-client →
SqlQuery via withConfiguredSql() helper that opens an engine, runs
the callback, disconnects.
- src/commands/serve-http.ts: ~25 call sites including the four
mcp_request_log.params INSERTs (now write real JSONB objects, not
JSON-encoded strings — the read side `params->>'op'` returns the
operation name, closing CLAUDE.md's outstanding "JSON-string-into-
JSONB" note as a side effect). The /admin/api/requests dynamic
filter pattern (postgres.js fragment composition) is rewritten as
parametrized SQL string + params array.
- src/mcp/http-transport.ts: legacy bearer-auth path. The
Postgres-only fail-fast at startup is removed because both schemas
now carry access_tokens + mcp_request_log.
- src/core/oauth-provider.ts: SqlQuery / SqlValue types relocated
from here to sql-query.ts as the canonical home (Codex finding #8).
- src/commands/files.ts: all 5 db.getConnection() sites (lines 104,
139, 252, 326, 355). The line-256 INSERT into files.metadata uses
executeRawJsonb; the other four are scalar-only SqlQuery (Codex
finding #6 — scope was bigger than the plan's "lone INSERT" framing).
- src/core/config.ts: env-var DATABASE_URL inference. When dbUrl is
set, infer Postgres engine and clear the stale database_path.
Engine-internal sql.json() sites in src/core/postgres-engine.ts (5
sites: lines 520, 1689, 1728, 1790, 2313) STAY UNCHANGED. They live
inside PostgresEngine itself, where the postgres.js template-tag
sql.json() pattern is correct — those methods are only loaded when
Postgres is the active engine, so there's no PGLite-routing concern.
Migration v45 (mcp_request_log_params_jsonb_normalize): one-shot UPDATE
that lifts pre-v0.31 string-shaped JSONB rows to objects so the
/admin/api/requests endpoint at serve-http.ts:605 returns one
consistent shape to the admin SPA. Idempotent (subsequent runs find no
rows where jsonb_typeof = 'string'). Closes the mixed-shape window
that would otherwise have made post-deploy admin reads break.
Tests:
- test/sql-query.test.ts: 7 cases covering scalar binds, the
.json() rejection (defense in depth — SqlQuery is scalar-only),
JSONB round-trip with `jsonb_typeof = 'object'` and `->>`
semantics, the v0.12.0 double-encode regression guard, null
JSONB handling, and the scalars-then-jsonb call shape.
- test/config-env.test.ts: migrated from PR's manual `restoreEnv()`
in afterEach to the canonical `withEnv()` helper at
test/helpers/with-env.ts (CLAUDE.md R1 / codex finding D3).
Five cases covering DATABASE_URL precedence, GBRAIN_DATABASE_URL
operator override, file-only config, env-only config, and the
no-config null path.
- test/e2e/auth-takes-holders-pglite.test.ts: 6 cases against
in-memory PGLite (no DATABASE_URL gate). Covers create / update /
read of access_tokens.permissions, mcp_request_log.params object
+ null writes, and the migration v45 normalizer (seed
string-shaped row, run UPDATE, assert object shape; second-run
no-op for idempotency).
- test/http-transport.test.ts: mock updated to intercept
engine.executeRaw (the new code path) instead of the postgres.js
template tag. 24 cases pass.
Plan reference: ~/.claude/plans/system-instruction-you-are-working-peppy-moore.md.
Codex outside-voice review applied: D-codex-1, D-codex-2, D-codex-5,
D-codex-8, D-codex-9, D-codex-10 (and D1, D5 reversed by codex).
Closes the architectural intent of #681. Supersedes its branch.
Co-Authored-By: codex-bot <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: update CLAUDE.md key files for v0.31.3
Annotate the v0.31.3 changes in the canonical Key Files section:
new src/core/sql-query.ts adapter (#681), src/commands/serve.ts stdio
cleanup (#676), v0.31.3 amendments to auth.ts / serve-http.ts /
oauth-provider.ts surfaces, and migration v46 normalizer in migrate.ts.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
* chore: regenerate llms-full.txt for v0.31.3 docs sync
CI's build-llms test asserts the committed llms.txt + llms-full.txt
match what scripts/build-llms.ts produces from current source state.
CLAUDE.md was amended by /document-release post-merge (new entries for
src/core/sql-query.ts and src/commands/serve.ts; amended notes on
auth.ts / serve-http.ts / migrate.ts), so the inlined-bundle fell out
of sync. Regenerated via `bun run build:llms`.
llms.txt unchanged (curated index — no new web URLs added).
llms-full.txt updated to inline the new CLAUDE.md content.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Aragorn2046 <noreply@github.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
212 lines
8.2 KiB
TypeScript
212 lines
8.2 KiB
TypeScript
/**
|
|
* E2E for the v0.31 auth/admin SQL routing wave: full takes-holders
|
|
* round-trip on PGLite, in-memory, no DATABASE_URL gate.
|
|
*
|
|
* Mirrors test/e2e/auth-permissions.test.ts (which exercises the Postgres
|
|
* path) so JSONB shape parity is proven for both engines (Codex finding
|
|
* #1 from the v0.31 plan review).
|
|
*
|
|
* The path under test is the one auth.ts and src/mcp/http-transport.ts
|
|
* actually run after migration:
|
|
* 1. Token create with takes-holders → executeRawJsonb writes a JSONB object
|
|
* 2. validateToken-shaped read → SELECT permissions; jsonb_typeof = 'object'
|
|
* 3. Permissions update → executeRawJsonb again (UPDATE)
|
|
* 4. mcp_request_log.params write → executeRawJsonb (the serve-http flow)
|
|
* 5. Migration v45 normalizer → seed a string-shaped row, run the
|
|
* UPDATE, assert it's lifted to an object
|
|
*/
|
|
import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
|
|
import { PGLiteEngine } from '../../src/core/pglite-engine.ts';
|
|
import { sqlQueryForEngine, executeRawJsonb } from '../../src/core/sql-query.ts';
|
|
|
|
let engine: PGLiteEngine;
|
|
|
|
beforeAll(async () => {
|
|
engine = new PGLiteEngine();
|
|
await engine.connect({});
|
|
await engine.initSchema();
|
|
}, 60_000);
|
|
|
|
afterAll(async () => {
|
|
if (engine) await engine.disconnect();
|
|
});
|
|
|
|
describe('auth takes-holders + mcp_request_log JSONB on PGLite (v0.31)', () => {
|
|
test('access_tokens.permissions: create + read returns a real JSONB object', async () => {
|
|
const sql = sqlQueryForEngine(engine);
|
|
const name = `tok-create-${Math.random().toString(36).slice(2, 8)}`;
|
|
const hash = `hash-${name}`;
|
|
const permissions = { takes_holders: ['world', 'garry'] };
|
|
|
|
// The exact shape auth.ts:create uses post-migration.
|
|
await executeRawJsonb(
|
|
engine,
|
|
`INSERT INTO access_tokens (name, token_hash, permissions)
|
|
VALUES ($1, $2, $3::jsonb)`,
|
|
[name, hash],
|
|
[permissions],
|
|
);
|
|
|
|
// The exact shape http-transport.ts:validateToken uses to read it back.
|
|
const rows = await sql`
|
|
SELECT permissions FROM access_tokens
|
|
WHERE token_hash = ${hash}
|
|
`;
|
|
const perms = (rows[0] as { permissions?: { takes_holders?: unknown } }).permissions;
|
|
expect(perms).toBeDefined();
|
|
expect(Array.isArray(perms?.takes_holders)).toBe(true);
|
|
expect(perms?.takes_holders).toEqual(['world', 'garry']);
|
|
|
|
// Defense in depth: the JSONB-text representation must be an object,
|
|
// not a JSON-encoded string. Codex finding #9 — assert the contract.
|
|
const typed = await engine.executeRaw<{ kind: string; first_holder: string }>(
|
|
`SELECT jsonb_typeof(permissions) AS kind,
|
|
permissions->'takes_holders'->>0 AS first_holder
|
|
FROM access_tokens WHERE token_hash = $1`,
|
|
[hash],
|
|
);
|
|
expect(typed[0].kind).toBe('object');
|
|
expect(typed[0].first_holder).toBe('world');
|
|
});
|
|
|
|
test('access_tokens.permissions: UPDATE preserves JSONB object shape', async () => {
|
|
const sql = sqlQueryForEngine(engine);
|
|
const name = `tok-update-${Math.random().toString(36).slice(2, 8)}`;
|
|
const hash = `hash-${name}`;
|
|
|
|
// Seed with default ['world'].
|
|
await executeRawJsonb(
|
|
engine,
|
|
`INSERT INTO access_tokens (name, token_hash, permissions)
|
|
VALUES ($1, $2, $3::jsonb)`,
|
|
[name, hash],
|
|
[{ takes_holders: ['world'] }],
|
|
);
|
|
|
|
// The exact shape auth.ts:permissions uses (set-takes-holders).
|
|
const result = await executeRawJsonb(
|
|
engine,
|
|
`UPDATE access_tokens
|
|
SET permissions = $2::jsonb
|
|
WHERE name = $1
|
|
RETURNING id`,
|
|
[name],
|
|
[{ takes_holders: ['world', 'garry', 'brain'] }],
|
|
);
|
|
expect(result).toHaveLength(1);
|
|
|
|
const rows = await sql`
|
|
SELECT permissions FROM access_tokens
|
|
WHERE token_hash = ${hash}
|
|
`;
|
|
const perms = (rows[0] as { permissions: { takes_holders: string[] } }).permissions;
|
|
expect(perms.takes_holders).toEqual(['world', 'garry', 'brain']);
|
|
});
|
|
|
|
test('mcp_request_log.params: object writes round-trip as JSONB object', async () => {
|
|
// The serve-http.ts INSERT shape after the v0.31 migration.
|
|
const summary = { redacted: true, declared_keys: ['query', 'limit'], approx_bytes: 1024 };
|
|
await executeRawJsonb(
|
|
engine,
|
|
`INSERT INTO mcp_request_log (token_name, agent_name, operation, latency_ms, status, params)
|
|
VALUES ($1, $2, $3, $4, $5, $6::jsonb)`,
|
|
['test-token', 'test-agent', 'tools/call:query', 12, 'success'],
|
|
[summary],
|
|
);
|
|
|
|
const rows = await engine.executeRaw<{
|
|
kind: string;
|
|
redacted: boolean;
|
|
bytes: number;
|
|
first_key: string;
|
|
}>(
|
|
`SELECT jsonb_typeof(params) AS kind,
|
|
(params->>'redacted')::boolean AS redacted,
|
|
(params->>'approx_bytes')::int AS bytes,
|
|
params->'declared_keys'->>0 AS first_key
|
|
FROM mcp_request_log
|
|
WHERE operation = $1`,
|
|
['tools/call:query'],
|
|
);
|
|
expect(rows[0].kind).toBe('object');
|
|
expect(rows[0].redacted).toBe(true);
|
|
expect(rows[0].bytes).toBe(1024);
|
|
expect(rows[0].first_key).toBe('query');
|
|
});
|
|
|
|
test('mcp_request_log.params: NULL writes (no params) round-trip as SQL NULL', async () => {
|
|
// tools/list and scope-rejected paths write NULL params. Must not
|
|
// be encoded as the string "null".
|
|
await executeRawJsonb(
|
|
engine,
|
|
`INSERT INTO mcp_request_log (token_name, agent_name, operation, latency_ms, status, params)
|
|
VALUES ($1, $2, $3, $4, $5, $6::jsonb)`,
|
|
['test-token', 'test-agent', 'tools/list', 5, 'success'],
|
|
[null],
|
|
);
|
|
|
|
const rows = await engine.executeRaw<{ is_null: boolean }>(
|
|
`SELECT (params IS NULL) AS is_null FROM mcp_request_log
|
|
WHERE operation = 'tools/list'`,
|
|
);
|
|
expect(rows[0].is_null).toBe(true);
|
|
});
|
|
|
|
test('migration v45 normalizer: lifts pre-v0.31 string-shaped rows to objects', async () => {
|
|
// Seed a row in the broken pre-v0.31 shape: a JSON-encoded object
|
|
// stored as a string-typed JSONB. This is what postgres.js's loose
|
|
// template-tag typing produced when `${JSON.stringify(obj)}` was
|
|
// bound to a JSONB column without sql.json().
|
|
const broken = JSON.stringify({ legacy: 'shape', op: 'search' });
|
|
await engine.executeRaw(
|
|
`INSERT INTO mcp_request_log (token_name, agent_name, operation, latency_ms, status, params)
|
|
VALUES ($1, $2, $3, $4, $5, to_jsonb($6::text))`,
|
|
['legacy-token', 'legacy-agent', 'tools/call:legacy', 8, 'success', broken],
|
|
);
|
|
// Confirm the seed produced the broken shape (jsonb_typeof = 'string').
|
|
const before = await engine.executeRaw<{ kind: string }>(
|
|
`SELECT jsonb_typeof(params) AS kind FROM mcp_request_log
|
|
WHERE operation = 'tools/call:legacy'`,
|
|
);
|
|
expect(before[0].kind).toBe('string');
|
|
|
|
// Run the migration v45 SQL exactly as it lives in src/core/migrate.ts.
|
|
await engine.executeRaw(`
|
|
UPDATE mcp_request_log
|
|
SET params = (params #>> '{}')::jsonb
|
|
WHERE jsonb_typeof(params) = 'string'
|
|
AND params #>> '{}' LIKE '{%'
|
|
`);
|
|
|
|
// After: real object, ->> reads the values.
|
|
const after = await engine.executeRaw<{ kind: string; legacy: string; op: string }>(
|
|
`SELECT jsonb_typeof(params) AS kind,
|
|
params->>'legacy' AS legacy,
|
|
params->>'op' AS op
|
|
FROM mcp_request_log
|
|
WHERE operation = 'tools/call:legacy'`,
|
|
);
|
|
expect(after[0].kind).toBe('object');
|
|
expect(after[0].legacy).toBe('shape');
|
|
expect(after[0].op).toBe('search');
|
|
});
|
|
|
|
test('migration v45 normalizer: idempotent — re-running on already-fixed rows is a no-op', async () => {
|
|
// Run the migration a second time. The WHERE jsonb_typeof = 'string'
|
|
// guard means already-object rows are skipped, so this should leave
|
|
// the legacy row unchanged.
|
|
await engine.executeRaw(`
|
|
UPDATE mcp_request_log
|
|
SET params = (params #>> '{}')::jsonb
|
|
WHERE jsonb_typeof(params) = 'string'
|
|
AND params #>> '{}' LIKE '{%'
|
|
`);
|
|
const after = await engine.executeRaw<{ kind: string; legacy: string }>(
|
|
`SELECT jsonb_typeof(params) AS kind, params->>'legacy' AS legacy
|
|
FROM mcp_request_log WHERE operation = 'tools/call:legacy'`,
|
|
);
|
|
expect(after[0].kind).toBe('object');
|
|
expect(after[0].legacy).toBe('shape');
|
|
});
|
|
});
|