Compare commits

..
Author SHA1 Message Date
b05ebf6e4a fix(doctor): scope timeline labels to disambiguate entity coverage vs brain-score component (#2298)
doctor and the get_health CLI surface printed two different timeline
metrics under one ambiguous 'timeline' label: the entity-scoped
timeline_coverage fraction (eligible entity pages with a timeline entry)
and the whole-brain timeline_coverage_score brain-score component (all
pages with a timeline entry, 0-15). Different numerators AND
denominators, indistinguishable in output.

Label-only fix, scoring unchanged:
- graph_coverage check: 'entity timeline coverage N%'
- brain_score breakdown: 'timeline density (all pages) N/15'
- get_health CLI: 'Timeline coverage (entity pages)' plus a new
  'Timeline density (all pages): N/15' line when the score is present

Adds test/doctor-timeline-metric-labels-2298.test.ts pinning the
denominator semantics, the rendered doctor messages, and the CLI
guard matrix (fails on master, passes here).

Takeover of #2761.

Co-authored-by: TurgutKural <TurgutKural@users.noreply.github.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-21 14:18:54 -07:00
10 changed files with 167 additions and 228 deletions
+4 -1
View File
@@ -935,7 +935,10 @@ export function formatResult(opName: string, result: unknown): string {
lines.push(`Link coverage (entities): ${(h.link_coverage * 100).toFixed(1)}%`);
}
if (h.timeline_coverage !== undefined) {
lines.push(`Timeline coverage (entities): ${(h.timeline_coverage * 100).toFixed(1)}%`);
lines.push(`Timeline coverage (entity pages): ${(h.timeline_coverage * 100).toFixed(1)}%`);
}
if (h.timeline_coverage_score !== undefined) {
lines.push(`Timeline density (all pages): ${h.timeline_coverage_score}/15 (whole-brain brain-score component)`);
}
if (Array.isArray(h.most_connected) && h.most_connected.length > 0) {
lines.push('Most connected entities:');
+3 -3
View File
@@ -5868,12 +5868,12 @@ export async function buildChecks(
message: `Only code/test fixture entity pages found (${entityCount}); graph_coverage not applicable`,
});
} else if (linkCoverage >= 0.5 && timelineCoverage >= 0.5) {
checks.push({ name: 'graph_coverage', status: 'ok', message: `Entity link coverage ${linkPct}%, timeline ${timelinePct}%` });
checks.push({ name: 'graph_coverage', status: 'ok', message: `Entity link coverage ${linkPct}%, entity timeline coverage ${timelinePct}%` });
} else {
checks.push({
name: 'graph_coverage',
status: 'warn',
message: `Entity link coverage ${linkPct}%, timeline ${timelinePct}% (${eligibleEntityCount} entity pages). Run: gbrain extract all`,
message: `Entity link coverage ${linkPct}%, entity timeline coverage ${timelinePct}% (${eligibleEntityCount} entity pages). Run: gbrain extract all`,
});
}
@@ -5885,7 +5885,7 @@ export async function buildChecks(
const parts = [
`embed ${health.embed_coverage_score}/35`,
`links ${health.link_density_score}/25`,
`timeline ${health.timeline_coverage_score}/15`,
`timeline density (all pages) ${health.timeline_coverage_score}/15`,
`orphans ${health.no_orphans_score}/15`,
`dead-links ${health.no_dead_links_score}/10`,
];
+1 -1
View File
@@ -1651,7 +1651,7 @@ async function extractTimelineFromDB(
* make re-extraction idempotent). EVERY processed page is stamped, including
* zero-link pages — they WERE processed.
*/
export async function extractStaleFromDB(
async function extractStaleFromDB(
engine: BrainEngine,
opts: {
dryRun: boolean;
+1 -39
View File
@@ -1479,31 +1479,7 @@ export async function registerBuiltinHandlers(
embedSkipReason = 'auto_embed_disabled';
}
// #2849: large-sync extract deferral follow-up. performSync skips inline
// link/timeline extraction when totalChanges > 100, leaving
// links_extracted_at unstamped. A standalone sync job (webhook push,
// sync trigger) has no autopilot extract phase behind it, so the pages
// would stay extraction-stale until a manual `gbrain extract --stale`.
// Queue a source-scoped stale sweep instead. Best-effort + idempotent:
// a duplicate sweep finds 0 stale pages and no-ops.
let extractJobId: number | null = null;
if (result.extractDeferred) {
try {
const { MinionQueue } = await import('../core/minions/queue.ts');
const queue = new MinionQueue(engine);
const followUp = await queue.add(
'extract',
{ stale: true, ...(sourceId ? { sourceId } : {}) },
{
idempotency_key: `sync-extract-stale:${sourceId ?? 'default'}:${Math.floor(Date.now() / 30_000)}`,
maxWaiting: 1,
},
);
extractJobId = followUp.id;
} catch { /* best-effort: extract --stale sweeps it later */ }
}
return { ...result, embed_job_id: embedJobId, embed_skip_reason: embedSkipReason, extract_stale_job_id: extractJobId };
return { ...result, embed_job_id: embedJobId, embed_skip_reason: embedSkipReason };
});
registerBuiltinJob(worker, engine, 'embed', async (job) => {
@@ -1676,20 +1652,6 @@ export async function registerBuiltinHandlers(
});
worker.register('extract', async (job) => {
// #2849: stale-sweep mode — the sync handler's large-sync deferral
// follow-up. DB-source (reads page content from the DB, so it runs on
// checkout-less brains), source-scopable, idempotent. Same core as
// `gbrain extract --stale`.
if (job.data.stale === true) {
const { extractStaleFromDB } = await import('./extract.ts');
return await extractStaleFromDB(engine, {
dryRun: !!job.data.dryRun,
jsonMode: false,
includeFrontmatter: false,
sourceIdFilter: typeof job.data.sourceId === 'string' ? job.data.sourceId : undefined,
catchUp: false,
});
}
const { runExtractCore } = await import('./extract.ts');
const mode = (typeof job.data.mode === 'string' && ['links', 'timeline', 'all'].includes(job.data.mode))
? (job.data.mode as 'links' | 'timeline' | 'all')
+2 -8
View File
@@ -2146,13 +2146,8 @@ export async function runServeHttp(engine: BrainEngine, options: ServeHttpOption
// Other event types (ping, pull_request, etc.) return 202 'ignored'
// so GitHub doesn't retry.
// D15.5: HMAC compare uses the shared safeHexEqual helper.
// D18: submits 'sync' job with extraction + auto_embed_backfill enabled and
// priority -10 (above autopilot's 0). noExtract:false opts normal
// incremental pushes into sync's inline link/timeline extraction (#2849
// — the standalone sync handler defaults noExtract to TRUE, which left
// webhook-imported pages permanently stale). Large (>100 file) pushes
// defer inline extract; the sync handler queues an extract --stale
// follow-up job for that branch.
// D18: submits 'sync' job with auto_embed_backfill=true and priority -10
// (above autopilot's 0).
// ---------------------------------------------------------------------------
const githubWebhookLimiter = rateLimit({
windowMs: 60_000,
@@ -2272,7 +2267,6 @@ export async function runServeHttp(engine: BrainEngine, options: ServeHttpOption
'sync',
{
sourceId: source.id,
noExtract: false,
auto_embed_backfill: true,
embed_reason: 'webhook',
},
+1 -19
View File
@@ -222,14 +222,6 @@ export interface SyncResult {
* everything," the exact misdiagnosis in the #1794 recurrence report.
*/
bankedFiles?: number;
/**
* #2849: true when extraction was REQUESTED (noExtract false) but this sync
* skipped inline link/timeline extraction because totalChanges > 100 (the
* #1794 large-sync deferral). links_extracted_at stays unstamped for the
* imported pages. The standalone `sync` job handler queues a source-scoped
* `extract --stale` follow-up when set; CLI runs print the manual hint.
*/
extractDeferred?: boolean;
}
/**
@@ -1387,10 +1379,6 @@ See also:
{
sourceId: sourceIdArg,
repoPath: source.local_path,
// #2849: opt in to inline extraction — the standalone sync handler
// defaults noExtract to TRUE (dedupe for doctor's [sync, extract]
// remediation plan), which would leave triggered syncs extraction-stale.
noExtract: false,
auto_embed_backfill: true,
embed_reason: 'sync_trigger',
},
@@ -3299,16 +3287,11 @@ async function performSyncInner(engine: BrainEngine, opts: SyncOpts): Promise<Sy
// the stale sweep scans the whole source, so banked-across-runs pages are
// covered regardless.
const extractOpts = opts.sourceId ? { sourceId: opts.sourceId } : undefined;
let extractDeferred = false;
if (!opts.noExtract && totalChanges > 100 && pagesAffected.length > 0) {
// #2849: surface the deferral to callers. A standalone sync job (webhook
// push, sync trigger) has no autopilot extract phase behind it, so the
// job handler queues an `extract --stale` follow-up off this flag.
extractDeferred = true;
slog(
` Large sync: deferring link/timeline extraction. ` +
`Run 'gbrain extract --stale${opts.sourceId ? ` --source-id ${opts.sourceId}` : ''}' ` +
`(sync jobs queue this follow-up automatically).`,
`(or let the autopilot cycle's extract phase sweep it).`,
);
}
if (!opts.noExtract && totalChanges <= 100 && pagesAffected.length > 0) {
@@ -3417,7 +3400,6 @@ async function performSyncInner(engine: BrainEngine, opts: SyncOpts): Promise<Sy
chunksCreated,
embedded,
pagesAffected,
extractDeferred,
};
}
@@ -0,0 +1,155 @@
/**
* Issue #2298 timeline metric presentation contract.
*
* Authoritative upstream semantics (src/core/types.ts):
* - Metric A `timeline_coverage` (entity-scoped, fraction 01):
* eligible entity pages WITH a timeline entry / eligible entity pages
* -> surfaced by `graph_coverage` check AND `get_health` CLI entity line.
* - Metric B `timeline_coverage_score` (whole-brain, 015 brain-score component):
* all pages WITH a timeline entry / all pages
* -> surfaced by `brain_score` component breakdown AND (separately) CLI.
*
* The two have DIFFERENT numerators/denominators. This PR labels each
* explicitly and keeps BOTH the entity CLI line and the whole-brain line.
*
* Tests (no private EriadorMu data, no production/home DB, no network):
* - numeric denominator assertions (Metric A = 50%, Metric B = 4/15)
* - doctor rendered-message assertions (exact labels, no ambiguous old label)
* - CLI rendered-output assertions (exact lines, guard matrix)
* - red/green: same assertions FAIL on origin/master, PASS on this branch
*
* Scoring formula UNCHANGED. Canonical PGLite fixture via resetPgliteState.
*/
import { describe, expect, test, beforeAll, afterAll, beforeEach } from 'bun:test';
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { sqlQueryForEngine } from '../src/core/sql-query.ts';
import { resetPgliteState } from './helpers/reset-pglite.ts';
import { buildChecks } from '../src/commands/doctor.ts';
import { formatResult } from '../src/cli.ts';
let engine: PGLiteEngine;
async function seedFourPages(eng: PGLiteEngine): Promise<void> {
const sql = sqlQueryForEngine(eng);
// 2 eligible entity pages, 2 technical/non-entity pages.
// Only ONE entity page has a timeline entry; only ONE total page does.
await sql`
INSERT INTO pages (slug, source_id, type, title, compiled_truth, frontmatter, content_hash, created_at, updated_at)
VALUES
('acme-example', 'default', 'company', 'Acme', '', '{}', 'h1', now(), now()),
('alice-example', 'default', 'person', 'Alice', '', '{}', 'h2', now(), now()),
('technical-a', 'default', 'note', 'Tech A', '', '{}', 'h3', now(), now()),
('technical-b', 'default', 'note', 'Tech B', '', '{}', 'h4', now(), now())
`;
const companyId = (await sql`SELECT id FROM pages WHERE slug='acme-example'`)[0].id as number;
await sql`INSERT INTO timeline_entries (page_id, date, source, summary, detail)
VALUES (${companyId}, CURRENT_DATE, 'test', 'milestone', '{}')`;
}
beforeAll(async () => {
engine = new PGLiteEngine();
await engine.connect({});
await engine.initSchema();
});
afterAll(async () => {
await engine.disconnect();
});
beforeEach(async () => {
await resetPgliteState(engine);
});
describe('issue #2298 — numeric denominator semantics', () => {
test('entity timeline coverage = 1/2 = 50% (2 eligible entities, 1 with timeline)', async () => {
await seedFourPages(engine);
const health = await engine.getHealth();
expect(health.timeline_coverage).toBeDefined();
expect(Math.round((health.timeline_coverage ?? 0) * 100)).toBe(50);
});
test('whole-brain timeline density = 1/4 -> score 4/15 (4 total pages, 1 with timeline)', async () => {
await seedFourPages(engine);
const health = await engine.getHealth();
expect(health.timeline_coverage_score).toBeDefined();
expect(health.timeline_coverage_score).toBe(4);
});
test('the two metrics use independent denominators', async () => {
await seedFourPages(engine);
const health = await engine.getHealth();
expect(Math.round((health.timeline_coverage ?? 0) * 100)).toBe(50);
expect(health.timeline_coverage_score ?? 0).toBe(4);
// 50% (entity, /2) != 26.7% (whole-brain, /4). Provably distinct.
expect(Math.round(((health.timeline_coverage_score ?? 0) / 15) * 100)).not.toBe(50);
});
});
describe('issue #2298 — doctor rendered-message contract', () => {
test('graph_coverage renders entity-scoped label with 50%', async () => {
await seedFourPages(engine);
const checks = await buildChecks(engine, [], null);
const graph = checks.find((c) => c.name === 'graph_coverage');
expect(graph, 'graph_coverage check must be present').toBeDefined();
expect(graph!.message).toContain('entity timeline coverage 50%');
// ambiguous old label must NOT be present
expect(graph!.message).not.toMatch(/timeline 50%/);
expect(graph!.message).not.toMatch(/timeline \(entity, brain score\)/);
});
test('brain_score renders whole-brain density label 4/15', async () => {
await seedFourPages(engine);
const checks = await buildChecks(engine, [], null);
const brain = checks.find((c) => c.name === 'brain_score');
expect(brain, 'brain_score check must be present').toBeDefined();
expect(brain!.message).toContain('timeline density (all pages) 4/15');
// wrong labels must NOT be present
expect(brain!.message).not.toMatch(/timeline 4\/15/);
expect(brain!.message).not.toMatch(/timeline \(entity, brain score\)/);
// brain-score component must NOT carry the word "entity" (it is whole-brain)
const timelinePart = brain!.message.split('timeline density (all pages) 4/15')[0] + 'timeline density (all pages) 4/15';
expect(timelinePart).not.toMatch(/entity/);
});
});
describe('issue #2298 — CLI get_health rendered-output contract', () => {
function fakeHealth(overrides: Record<string, unknown>): any {
return {
embed_coverage: 1, missing_embeddings: 0, stale_pages: 0, orphan_pages: 0,
link_coverage: 1, timeline_coverage: 0.5, timeline_coverage_score: 4,
most_connected: [], ...overrides,
};
}
test('both entity and whole-brain lines render, no undefined/15', () => {
const out = formatResult('get_health', fakeHealth({}));
expect(out).toContain('Timeline coverage (entity pages): 50.0%');
expect(out).toContain('Timeline density (all pages): 4/15');
expect(out).not.toContain('undefined/15');
expect(out).not.toContain('Timeline coverage (entities)');
expect(out).not.toMatch(/timeline \(entity, brain score\)/);
expect(out).not.toMatch(/bare "timeline 4\/15"/);
});
test('guard matrix: entity present, whole-brain absent -> only entity line', () => {
const out = formatResult('get_health', fakeHealth({ timeline_coverage_score: undefined }));
expect(out).toContain('Timeline coverage (entity pages): 50.0%');
expect(out).not.toContain('Timeline density (all pages)');
expect(out).not.toContain('undefined/15');
});
test('guard matrix: whole-brain present, entity absent -> only whole-brain line', () => {
const out = formatResult('get_health', fakeHealth({ timeline_coverage: undefined }));
expect(out).toContain('Timeline density (all pages): 4/15');
expect(out).not.toContain('Timeline coverage (entity pages)');
expect(out).not.toContain('undefined/15');
});
test('guard matrix: both absent -> neither timeline line, never undefined/15', () => {
const out = formatResult('get_health', fakeHealth({ timeline_coverage: undefined, timeline_coverage_score: undefined }));
expect(out).not.toContain('Timeline coverage (entity pages)');
expect(out).not.toContain('Timeline density (all pages)');
expect(out).not.toContain('undefined/15');
});
});
-23
View File
@@ -16,7 +16,6 @@
*/
import { describe, test, expect } from 'bun:test';
import { createHmac } from 'node:crypto';
import { readFileSync } from 'node:fs';
import { safeHexEqual } from '../src/core/timing-safe.ts';
const GITHUB_SECRET = 'super-secret-webhook-key';
@@ -124,25 +123,3 @@ describe('Branch ref construction (D5)', () => {
expect(pushedRef === `refs/heads/${trackedBranch}`).toBe(false);
});
});
describe('Webhook sync job extraction contract (#2849)', () => {
test('opts into extraction before the pushed commit is consumed', () => {
const serveSource = readFileSync(
new URL('../src/commands/serve-http.ts', import.meta.url),
'utf8',
);
const routeStart = serveSource.indexOf("'/webhooks/github'");
const queueStart = serveSource.indexOf('const job = await queue.add(', routeStart);
const responseStart = serveSource.indexOf('res.status(202)', queueStart);
expect(routeStart).toBeGreaterThanOrEqual(0);
expect(queueStart).toBeGreaterThan(routeStart);
expect(responseStart).toBeGreaterThan(queueStart);
const routeSource = serveSource.slice(queueStart, responseStart);
const payload = routeSource.match(
/queue\.add\(\s*'sync',\s*\{([\s\S]*?)\}\s*,\s*\{/,
);
expect(payload).not.toBeNull();
expect(payload?.[1]).toMatch(/\bnoExtract:\s*false\b/);
});
});
@@ -1,130 +0,0 @@
/**
* #2849 large-sync extract deferral queues an `extract --stale` follow-up.
*
* performSync's incremental path skips inline link/timeline extraction when
* totalChanges > 100 (the #1794 large-sync deferral), leaving
* links_extracted_at unstamped. Pre-fix, a standalone sync job (webhook push,
* `gbrain sync trigger`) had NOTHING behind it to sweep those pages the
* autopilot cycle's extract phase only walks that cycle's changedSlugs so a
* large webhook push left extraction permanently stale until a manual
* `gbrain extract --stale`.
*
* Pins:
* (a) performSync surfaces `extractDeferred: true` on the >100 branch and
* leaves the pages unstamped/unlinked.
* (b) the `sync` job handler queues an `extract` job with
* { stale: true, sourceId? } when extractDeferred is set.
* (c) the `extract` handler's stale mode actually sweeps: links created +
* watermark stamped (end-to-end recovery, no manual step).
*
* Marked .serial.test.ts spawns git subprocesses + shares one PGLite engine.
*/
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { mkdtempSync, writeFileSync, rmSync, mkdirSync } from 'fs';
import { execSync } from 'child_process';
import { tmpdir } from 'os';
import { join } from 'path';
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { MinionWorker } from '../src/core/minions/worker.ts';
import { MinionQueue } from '../src/core/minions/queue.ts';
import { registerBuiltinHandlers } from '../src/commands/jobs.ts';
let engine: PGLiteEngine;
let worker: MinionWorker;
let repoPath: string;
function git(cmd: string): void { execSync(cmd, { cwd: repoPath, stdio: 'pipe' }); }
describe('#2849 — large sync defers extract and queues a stale sweep', () => {
beforeAll(async () => {
engine = new PGLiteEngine();
await engine.connect({});
await engine.initSchema();
worker = new MinionWorker(engine, { queue: 'test' });
await registerBuiltinHandlers(worker, engine, { quiet: true });
repoPath = mkdtempSync(join(tmpdir(), 'gbrain-large-defer-'));
git('git init');
git('git config user.email "t@t.com"');
git('git config user.name "T"');
mkdirSync(join(repoPath, 'people'), { recursive: true });
mkdirSync(join(repoPath, 'notes'), { recursive: true });
writeFileSync(join(repoPath, 'people/alice.md'), [
'---', 'type: person', 'title: Alice', '---', '', 'Alice is a founder.',
].join('\n'));
git('git add -A && git commit -m "initial"');
// Seed: full first sync imports the anchor page + sets last_commit.
const { performSync } = await import('../src/commands/sync.ts');
await performSync(engine, { repoPath, full: true, noPull: true, noEmbed: true });
// Second commit: 101 new pages → incremental totalChanges > 100.
for (let i = 0; i < 101; i++) {
writeFileSync(join(repoPath, `notes/n${i}.md`), [
'---', 'type: note', `title: Note ${i}`, '---', '',
`[Alice](people/alice) appears in note ${i}.`,
].join('\n'));
}
git('git add -A && git commit -m "add 101 pages"');
}, 120_000);
afterAll(async () => {
if (repoPath) rmSync(repoPath, { recursive: true, force: true });
if (engine) await engine.disconnect();
}, 60_000);
test('sync handler defers inline extract and queues extract{stale} follow-up; stale sweep recovers', async () => {
const syncHandler = (worker as unknown as { handlers: Map<string, (job: unknown) => Promise<unknown>> })
.handlers.get('sync');
expect(syncHandler).toBeDefined();
// Same payload shape the webhook submits (minus embed backfill noise).
const result = await syncHandler!({
data: { repoPath, noExtract: false, noPull: true, auto_embed_backfill: false },
signal: { aborted: false },
updateProgress: async () => {},
}) as { status: string; extractDeferred?: boolean; extract_stale_job_id?: number | null };
expect(result.status).toBe('synced');
// (a) inline extract was deferred, pages left stale.
expect(result.extractDeferred).toBe(true);
const staleBefore = await engine.countStalePagesForExtraction();
expect(staleBefore).toBeGreaterThan(100);
expect(await engine.getLinks('notes/n0')).toHaveLength(0);
// (b) a follow-up extract job with stale:true was queued.
expect(result.extract_stale_job_id).toBeGreaterThan(0);
const queue = new MinionQueue(engine);
const extractJobs = await queue.getJobs({ name: 'extract', limit: 5 });
expect(extractJobs.length).toBe(1);
expect((extractJobs[0].data as { stale: boolean }).stale).toBe(true);
// (c) running the extract handler's stale mode recovers: links + stamps.
const extractHandler = (worker as unknown as { handlers: Map<string, (job: unknown) => Promise<unknown>> })
.handlers.get('extract');
await extractHandler!({
data: extractJobs[0].data,
signal: { aborted: false },
updateProgress: async () => {},
});
const links = await engine.getLinks('notes/n0');
expect(links.some(l => l.to_slug === 'people/alice')).toBe(true);
const rows = await engine.executeRaw<{ links_extracted_at: string | null }>(
`SELECT links_extracted_at FROM pages WHERE slug = 'notes/n0'`,
);
expect(rows[0]?.links_extracted_at).not.toBeNull();
}, 180_000);
test('sub-threshold sync does NOT set extractDeferred (no spurious follow-up)', async () => {
// One more small commit → inline extract path, no deferral.
writeFileSync(join(repoPath, 'notes/small.md'), [
'---', 'type: note', 'title: Small', '---', '', 'No big deal.',
].join('\n'));
git('git add -A && git commit -m "one small page"');
const { performSync } = await import('../src/commands/sync.ts');
const result = await performSync(engine, { repoPath, noPull: true, noEmbed: true });
expect(result.status).toBe('synced');
expect(result.extractDeferred).toBeFalsy();
}, 60_000);
});
-4
View File
@@ -100,10 +100,6 @@ describe('runSyncTrigger', () => {
const job = jobs[0];
expect(job.priority).toBe(-10);
expect((job.data as { sourceId: string }).sourceId).toBe('default');
// #2849: opt in to inline extraction — the standalone sync handler
// defaults noExtract to TRUE, which would leave triggered syncs
// extraction-stale.
expect((job.data as { noExtract: boolean }).noExtract).toBe(false);
expect((job.data as { auto_embed_backfill: boolean }).auto_embed_backfill).toBe(true);
});