Compare commits

..
Author SHA1 Message Date
Garry TanandClaude Fable 5 adb7f07ac4 fix(reference): route exit codes through setCliExitVerdict; use withEnv in e2e test
CI red on two guards:
- test/cli-exit-verdict-pin.test.ts: raw process.exitCode writes in
  src/commands/reference.ts -> replaced with setCliExitVerdict.
- check:test-isolation R1: direct process.env.GBRAIN_SOURCE mutation in
  test/reference-flag.test.ts -> wrapped the two runReference calls in
  withEnv({ GBRAIN_SOURCE: undefined }).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-22 10:58:08 -07:00
7a8046574a feat(reference): reference-only entity flag, exempt from coverage metrics (#1899)
Takeover of #1900 (rebased onto master + source-scoping repair).

Canon/reference figures imported from books/articles are real person/company
pages but have no dated history in the user's own life, so they sat
permanently red in timeline_coverage / entity_link_coverage with no
actionable fix.

- src/core/reference-flag.ts: single source of truth for the exclusion
  predicate (frontmatter->>'reference') IS DISTINCT FROM 'true'.
- Predicate ANDed into numerator AND denominator at every entity-coverage
  site: getHealth() entity_pages CTE (BOTH engines; postgres inlines the
  literal since tagged-template interpolation binds), onboard/checks.ts,
  onboard/init-nudge.ts. most_connected intentionally unfiltered.
- New CLI-only 'gbrain reference <slug> [--unset] [--source <id>]' writes
  the flag to markdown frontmatter (durable) AND engine JSONB (immediate).
- Repair over #1900: the JSONB UPDATEs are now scoped to (source_id, slug)
  — slug is only unique per source — with the source resolved from the
  brain dir via the standard resolveSourceId chain (--source overrides).
- Skills/conventions docs + KEY_FILES entry; llms bundles regenerated.
- Tests: predicate/frontmatter units + PGLite e2e pinning the getHealth
  exemption and the cross-source-twin scoping.

Fixes #1899

Co-authored-by: ElliotDrel <ElliotDrel@users.noreply.github.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-21 14:27:16 -07:00
25 changed files with 470 additions and 283 deletions
File diff suppressed because one or more lines are too long
+4
View File
@@ -85,6 +85,10 @@ gbrain get media/articles/<slug>
# 5. Cross-link entities
# For every person/company mentioned, add a timeline back-link.
# Mark NEW pages minted for article subjects the reader only reads ABOUT
# (not personal contacts) as reference: `gbrain reference <slug>`
# (or reference: true in frontmatter). Exempts them from coverage nudges;
# they stay searchable. Default for real contacts: do NOT set it.
```
## Quality bar
+7
View File
@@ -273,6 +273,13 @@ Cross-link entities mentioned in the analysis:
- For every person the right column references with a brain page, add a
back-link from `people/<slug>` to the new `media/books/<slug>-personalized`
page (per `conventions/quality.md` Iron Law).
- **Mark book figures as reference entities.** Any NEW person/company page you
mint for a figure from the book (an author, a historical figure, a company
the book discusses) — someone the reader reads ABOUT but doesn't personally
interact with — should be flagged: `gbrain reference <slug>` (or
`reference: true` in frontmatter). They stay fully searchable/linkable but
are exempt from coverage nudges (timeline/links). Skip this for anyone the
reader actually knows. Default for normal contacts: do NOT set it.
## Quality bar (the bar)
+62
View File
@@ -0,0 +1,62 @@
# Convention: Reference entities (canon figures)
Some person/company pages are people/orgs the user **reads about** but does not
personally interact with — a book's author, a historical figure, a company an
article discusses (Andy Grove, Kleiner Perkins, Intel…). They are real
knowledge, worth a page, but they have **no dated history in the user's own
life**, so the entity coverage metrics (`timeline_coverage`,
`entity_link_coverage`) flag them as permanently incomplete with no honest fix.
The `reference: true` frontmatter flag resolves this.
## What it does
- A page with `reference: true` is **exempt from the entity coverage metrics
only** (`timeline_coverage`, `entity_link_coverage`, and their onboard
nudges).
- It keeps its real `type` (`person` / `company`), so it stays **fully
searchable, enrichable, linkable, and edge-resolvable**. NOTHING about
retrieval changes — this is the whole reason it's a flag, not a new `type`.
- It is **opt-in**. Absent / `false` / anything-but-`true` = a normal entity
that DOES count toward coverage. **This is the default — do not set it on real
contacts.**
## When to set it
Set `reference: true` when the entity is a figure/org the user reads ABOUT, not
someone they deal with:
- authors and figures discussed in a book (book-mirror) or article
(article-enrichment)
- historical / canon figures imported as reference knowledge
- companies named only as examples in source material
Do NOT set it for people the user actually meets, emails, or works with — those
are normal entities whose missing timeline/links is a real, actionable gap.
## How to set it
```bash
gbrain reference <slug> # mark as reference
gbrain reference <slug> --unset # back to a normal entity
```
The command writes the flag to BOTH the markdown frontmatter (durable; survives
re-ingest / engine rebuild — markdown is the source of truth) AND the engine
JSONB (so coverage reflects it immediately, no re-sync). It's idempotent. You
can also hand-edit frontmatter (`reference: true`) and re-ingest.
## Why a flag, not a type
A new `type: reference-person` would drop the page out of every
`type IN ('person','company')` filter — search, enrichment, whoknows, link
inference — so you'd lose the figure everywhere, not just the metric. The flag
narrows the change to exactly the coverage denominators and nothing else.
## Implementation
`src/core/reference-flag.ts``referenceExclusionSql(alias?)` is the single
source of truth for the predicate `(frontmatter->>'reference') IS DISTINCT FROM
'true'`, ANDed into both numerator and denominator at every coverage site
(getHealth in both engines, onboard/checks.ts, init-nudge.ts). Backed by the GIN
index on `pages.frontmatter`.
+12
View File
@@ -268,6 +268,18 @@ Active items, pending decisions, things to track.
- **YYYY-MM-DD** | Event description [Source: ...]
```
### Reference entities (canon figures)
If the entity is someone/something the user reads ABOUT but does not personally
interact with — a book author, a historical figure, a company discussed in an
article — mark the page as reference: `gbrain reference <slug>` (or
`reference: true` in frontmatter). Reference pages keep their `person`/`company`
type and stay fully searchable, enrichable, and linkable; they are only exempt
from the entity coverage nudges (timeline/links) that don't apply to figures
with no dated history in the user's own life. **Default: do NOT set it** — real
people and companies the user deals with are normal entities. Full convention:
`conventions/reference-entities.md`.
### Step 7: Cross-reference
- Update company pages from person enrichment (and vice versa)
+5
View File
@@ -270,6 +270,11 @@ Populate them periodically or after major imports:
- `gbrain stats` — verify `link_count > 0` and `timeline_entry_count > 0` after extraction.
- `gbrain health` — review `link_coverage` and `timeline_coverage` percentages
on entity pages (person/company). Below 50% means more extraction is needed.
Note: pages flagged `reference: true` (canon/reference figures the user only
reads about) are EXEMPT from these two metrics — if coverage looks stuck
because of book/article-imported figures with no real history, mark them with
`gbrain reference <slug>` rather than chasing the percentage. See
`conventions/reference-entities.md`.
Available link types (use with `gbrain graph-query --type`):
`attended`, `works_at`, `invested_in`, `founded`, `advises`, `mentions`, `source`.
+6 -1
View File
@@ -54,7 +54,7 @@ export function bigintToStringReplacer(_key: string, value: unknown): unknown {
}
// CLI-only commands that bypass the operation layer
export const CLI_ONLY = new Set(['init', 'reinit-pglite', 'upgrade', 'post-upgrade', 'check-update', 'integrations', 'publish', 'check-backlinks', 'lint', 'report', 'import', 'export', 'files', 'embed', 'serve', 'call', 'config', 'doctor', 'migrate', 'eval', 'sync', 'extract', 'extract-conversation-facts', 'enrich', 'features', 'autopilot', 'graph-query', 'jobs', 'agent', 'apply-migrations', 'skillpack-check', 'skillpack', 'resolvers', 'integrity', 'repair-jsonb', 'orphans', 'sources', 'mounts', 'dream', 'check-resolvable', 'routing-eval', 'skillify', 'smoke-test', 'providers', 'storage', 'repos', 'code-def', 'code-refs', 'reindex', 'reindex-code', 'reindex-frontmatter', 'code-callers', 'code-callees', 'reconcile-links', 'frontmatter', 'auth', 'friction', 'claw-test', 'book-mirror', 'takes', 'think', 'salience', 'anomalies', 'calibration', 'transcripts', 'models', 'remote', 'recall', 'forget', 'edges-backfill', 'cache', 'ze-switch', 'founder', 'brainstorm', 'lsd', 'schema', 'capture', 'onboard', 'conversation-parser', 'status', 'connect', 'skillopt', 'quarantine', 'self-upgrade', 'advisor', 'watch', 'reindex-search-vector']);
export const CLI_ONLY = new Set(['init', 'reinit-pglite', 'upgrade', 'post-upgrade', 'check-update', 'integrations', 'publish', 'check-backlinks', 'lint', 'report', 'import', 'export', 'files', 'embed', 'serve', 'call', 'config', 'doctor', 'migrate', 'eval', 'sync', 'extract', 'extract-conversation-facts', 'enrich', 'reference', 'features', 'autopilot', 'graph-query', 'jobs', 'agent', 'apply-migrations', 'skillpack-check', 'skillpack', 'resolvers', 'integrity', 'repair-jsonb', 'orphans', 'sources', 'mounts', 'dream', 'check-resolvable', 'routing-eval', 'skillify', 'smoke-test', 'providers', 'storage', 'repos', 'code-def', 'code-refs', 'reindex', 'reindex-code', 'reindex-frontmatter', 'code-callers', 'code-callees', 'reconcile-links', 'frontmatter', 'auth', 'friction', 'claw-test', 'book-mirror', 'takes', 'think', 'salience', 'anomalies', 'calibration', 'transcripts', 'models', 'remote', 'recall', 'forget', 'edges-backfill', 'cache', 'ze-switch', 'founder', 'brainstorm', 'lsd', 'schema', 'capture', 'onboard', 'conversation-parser', 'status', 'connect', 'skillopt', 'quarantine', 'self-upgrade', 'advisor', 'watch', 'reindex-search-vector']);
// CLI-only commands whose handlers print their own --help text. These are
// excluded from the generic short-circuit so detailed per-command and
// per-subcommand usage stays reachable.
@@ -1652,6 +1652,11 @@ async function handleCliOnly(command: string, args: string[]) {
await runFiles(engine, args);
break;
}
case 'reference': {
const { runReference } = await import('./commands/reference.ts');
await runReference(engine, args);
break;
}
case 'embed': {
const { runEmbed } = await import('./commands/embed.ts');
await runEmbed(engine, args);
+5 -5
View File
@@ -19,7 +19,7 @@
*/
import type { BrainEngine } from '../core/engine.ts';
import { resolveCalibrationHolder, runPhaseCalibrationProfile } from '../core/cycle/calibration-profile.ts';
import { runPhaseCalibrationProfile } from '../core/cycle/calibration-profile.ts';
import { sourceScopeOpts, type OperationContext } from '../core/operations.ts';
import type { GBrainConfig } from '../core/config.ts';
import { GBrainError } from '../core/types.ts';
@@ -167,7 +167,7 @@ export async function runCalibration(
config: GBrainConfig,
): Promise<void> {
const { opts } = parseArgs(args);
const holder = await resolveCalibrationHolder(engine, opts.holder);
const holder = opts.holder ?? 'garry';
// Resolve --source / GBRAIN_SOURCE / .gbrain-source so the (now reachable, #2035)
// calibration command targets the right source in a multi-source brain instead
// of always reading `default`. No signal → 'default' (prior behavior).
@@ -253,14 +253,14 @@ export async function getCalibrationProfileOp(
ctx: OperationContext,
params: { holder?: string },
): Promise<CalibrationProfileRow | null> {
if (params.holder !== undefined && (typeof params.holder !== 'string' || params.holder.length === 0)) {
const holder = params.holder ?? 'garry';
if (typeof holder !== 'string' || holder.length === 0) {
throw new GBrainError(
'INVALID_HOLDER',
'get_calibration_profile.holder must be a non-empty string',
'pass holder="<slug>" or omit to default to the calibration.user_holder config (then "garry")',
'pass holder="<slug>" or omit to default to "garry"',
);
}
const holder = await resolveCalibrationHolder(ctx.engine, params.holder);
const scope = sourceScopeOpts(ctx);
return getLatestProfile(ctx.engine, { holder, ...scope });
}
+130
View File
@@ -0,0 +1,130 @@
// gbrain reference <slug> [--unset] [--brain <dir>] [--json]
//
// Mark (or unmark) a page as a reference-only entity. A reference page keeps its
// real type (person/company) — fully searchable/enrichable/linkable — but is
// exempt from the entity coverage metrics (timeline_coverage,
// entity_link_coverage). See src/core/reference-flag.ts for the rationale.
//
// Durability: the flag is written to BOTH the markdown frontmatter (source of
// truth; survives re-ingest / engine rebuild) AND the engine `pages.frontmatter`
// JSONB (so the metric reflects it immediately, no re-sync needed).
import { existsSync, readFileSync, writeFileSync } from 'node:fs';
import { isAbsolute, join, resolve } from 'node:path';
import { setCliExitVerdict } from '../core/cli-force-exit.ts';
import type { BrainEngine } from '../core/engine.ts';
import { REFERENCE_FRONTMATTER_KEY } from '../core/reference-flag.ts';
import { resolveSourceId } from '../core/source-resolver.ts';
/** Insert/replace/remove `reference: true` in a markdown frontmatter block.
* Minimal-diff: only the one line changes; key order is otherwise preserved. */
export function applyReferenceFrontmatter(content: string, on: boolean): string {
const keyLine = `${REFERENCE_FRONTMATTER_KEY}: true`;
const block = content.match(/^---\n([\s\S]*?)\n---/);
if (!block) {
// No frontmatter. Nothing to remove; if setting, prepend a block.
if (!on) return content;
return `---\n${keyLine}\n---\n\n${content}`;
}
let fm = block[1];
const hasKey = new RegExp(`^${REFERENCE_FRONTMATTER_KEY}:.*$`, 'm').test(fm);
if (on) {
fm = hasKey
? fm.replace(new RegExp(`^${REFERENCE_FRONTMATTER_KEY}:.*$`, 'm'), keyLine)
: `${fm}\n${keyLine}`;
} else {
if (!hasKey) return content;
fm = fm.replace(new RegExp(`^${REFERENCE_FRONTMATTER_KEY}:.*$\\n?`, 'm'), '');
}
// Function replacement so YAML chars ($, & …) in fm aren't treated as
// replacement patterns.
return content.replace(/^---\n[\s\S]*?\n---/, () => `---\n${fm}\n---`);
}
function parseArgs(args: string[]): { slug?: string; unset: boolean; json: boolean; brain?: string; source?: string } {
let slug: string | undefined;
let unset = false;
let json = false;
let brain: string | undefined;
let source: string | undefined;
for (let i = 0; i < args.length; i++) {
const a = args[i];
if (a === '--unset') unset = true;
else if (a === '--json') json = true;
else if (a === '--brain' || a === '--dir') brain = args[++i];
else if (a === '--source') source = args[++i];
else if (!a.startsWith('--') && !slug) slug = a;
}
return { slug, unset, json, brain, source };
}
async function resolveBrainDir(engine: BrainEngine, explicit?: string): Promise<string | null> {
if (explicit) return resolve(explicit);
const configured = await engine.getConfig('sync.repo_path');
if (configured && existsSync(configured)) return resolve(configured);
return null;
}
export async function runReference(engine: BrainEngine, args: string[]): Promise<void> {
const { slug, unset, json, brain, source } = parseArgs(args);
if (!slug) {
console.error('Usage: gbrain reference <slug> [--unset] [--source <id>] [--brain <dir>] [--json]');
setCliExitVerdict(2);
return;
}
const brainDir = await resolveBrainDir(engine, brain);
if (!brainDir) {
console.error('reference: could not resolve brain dir. Pass --brain <dir> or set sync.repo_path.');
setCliExitVerdict(1);
return;
}
const rel = slug.endsWith('.md') ? slug : `${slug}.md`;
const filePath = isAbsolute(rel) ? rel : join(brainDir, rel);
if (!existsSync(filePath)) {
console.error(`reference: page not found on disk: ${filePath}`);
setCliExitVerdict(1);
return;
}
// 1) Durable: edit the markdown frontmatter.
const before = readFileSync(filePath, 'utf8');
const after = applyReferenceFrontmatter(before, !unset);
const fileChanged = after !== before;
if (fileChanged) writeFileSync(filePath, after, 'utf8');
// 2) Immediate: update the engine frontmatter JSONB so the metric reflects it
// without waiting for a re-sync. Scoped to (source_id, slug) — slug is only
// unique per source, so a bare-slug UPDATE would clobber same-named pages
// in every other source. Resolve the source from the brain dir (tier-4
// local_path match) unless --source / GBRAIN_SOURCE overrides.
const cleanSlug = slug.replace(/\.md$/, '');
const sourceId = await resolveSourceId(engine, source ?? null, brainDir);
if (unset) {
await engine.executeRaw(
`UPDATE pages SET frontmatter = frontmatter - '${REFERENCE_FRONTMATTER_KEY}' WHERE slug = $1 AND source_id = $2`,
[cleanSlug, sourceId],
);
} else {
await engine.executeRaw(
`UPDATE pages SET frontmatter = jsonb_set(COALESCE(frontmatter, '{}'::jsonb), '{${REFERENCE_FRONTMATTER_KEY}}', 'true'::jsonb) WHERE slug = $1 AND source_id = $2`,
[cleanSlug, sourceId],
);
}
const result = { slug: cleanSlug, source_id: sourceId, reference: !unset, file_changed: fileChanged, file: filePath };
if (json) {
console.log(JSON.stringify(result));
} else {
const verb = unset ? 'unmarked' : 'marked';
console.log(`${verb} ${cleanSlug} as reference=${!unset}${fileChanged ? '' : ' (frontmatter already current)'}`);
if (!unset) {
console.log(' → exempt from timeline_coverage / entity_link_coverage; still fully searchable & linkable.');
}
}
}
-4
View File
@@ -928,10 +928,6 @@ export const KNOWN_CONFIG_KEYS: readonly string[] = [
// Emotional weight (v0.29)
'emotional_weight.high_tags',
'emotional_weight.user_holder',
// Calibration holder (#1726): persistent default for the nightly
// calibration_profile phase + `gbrain calibration`, symmetric with
// emotional_weight.user_holder. Falls back to 'garry' when unset.
'calibration.user_holder',
// Cycle phase config
'cycle.grade_takes.write_gstack_learnings',
// Content sanity (v0.41)
+2 -22
View File
@@ -96,7 +96,7 @@ export type PatternStatementsGenerator = (input: {
export type BiasTagsGenerator = (patterns: string[]) => Promise<string[]>;
export interface CalibrationProfileOpts extends BasePhaseOpts {
/** Holder to generate the profile for. Default: `calibration.user_holder` config, then 'garry'. */
/** Holder to generate the profile for. Default 'garry'. */
holder?: string;
/** Inject the patterns generator (tests). */
patternsGenerator?: PatternStatementsGenerator;
@@ -194,26 +194,6 @@ export function parseBiasTagsOutput(raw: string): string[] {
.slice(0, 4);
}
/**
* #1726: resolve the calibration holder. Explicit param wins, then the
* persistent `calibration.user_holder` config key (symmetric with
* emotional_weight.user_holder), then the legacy 'garry' default. Fail-open:
* a missing config table / mock engine without getConfig falls through.
*/
export async function resolveCalibrationHolder(
engine: BrainEngine,
explicit?: string,
): Promise<string> {
if (explicit) return explicit;
try {
const configured = await engine.getConfig('calibration.user_holder');
if (configured && configured.trim().length > 0) return configured.trim();
} catch {
// Config unavailable — use the legacy default.
}
return 'garry';
}
/** Pick the "loudest" pattern slot for the template fallback. */
function pickFallbackSlots(scorecard: TakesScorecard): PatternStatementSlots {
if (!scorecard || scorecard.resolved === 0) {
@@ -247,7 +227,7 @@ class CalibrationProfilePhase extends BaseCyclePhase {
_ctx: OperationContext,
opts: CalibrationProfileOpts,
): Promise<{ summary: string; details: Record<string, unknown>; status?: PhaseStatus }> {
const holder = await resolveCalibrationHolder(engine, opts.holder);
const holder = opts.holder ?? 'garry';
const promptVersion = opts.promptVersion ?? CALIBRATION_PROFILE_PROMPT_VERSION;
const modelId = opts.model ?? TIER_DEFAULTS.reasoning;
const gradeCompletion = opts.gradeCompletion ?? 1.0;
+2 -5
View File
@@ -68,14 +68,11 @@ export async function extractTimelineFromMeetings(
// 1. Fetch all meeting pages (one round-trip).
const sourceFilter = opts.sourceIdFilter ? `AND source_id = $1` : '';
const meetingParams = opts.sourceIdFilter ? [opts.sourceIdFilter] : [];
// #2109: gbrain-base-v2's unify-types catch-all retypes meeting pages to
// `note` with frontmatter.legacy_type = 'meeting'. Match both spellings so
// the extractor keeps working on migrated (v2) brains, not just v1 ones.
const meetings = await engine.executeRaw<MeetingRow>(
`SELECT slug, source_id, title, effective_date, updated_at,
compiled_truth, COALESCE(timeline, '') AS timeline
FROM pages
WHERE (type = 'meeting' OR frontmatter ->> 'legacy_type' = 'meeting')
WHERE type = 'meeting'
AND deleted_at IS NULL
${sourceFilter}
ORDER BY effective_date DESC NULLS LAST, slug`,
@@ -97,7 +94,7 @@ export async function extractTimelineFromMeetings(
JOIN pages pf ON pf.id = l.from_page_id
JOIN pages pt ON pt.id = l.to_page_id
WHERE l.link_type = 'attended'
AND (pf.type = 'meeting' OR pf.frontmatter ->> 'legacy_type' = 'meeting')
AND pf.type = 'meeting'
AND pf.deleted_at IS NULL
AND pt.deleted_at IS NULL`,
);
+7 -2
View File
@@ -18,6 +18,7 @@
import type { BrainEngine } from '../engine.ts';
import type { RemediationStep } from '../remediation-step.ts';
import { makeRemediationStep } from '../remediation-step.ts';
import { referenceExclusionSql } from '../reference-flag.ts';
/** Shared shape returned by all four checks. */
export interface OnboardCheckResult {
@@ -120,7 +121,8 @@ export async function checkEntityLinkCoverage(
engine,
`SELECT COUNT(*) AS count FROM pages
WHERE type IN ('person', 'company', 'organization', 'entity')
AND deleted_at IS NULL`,
AND deleted_at IS NULL
AND ${referenceExclusionSql()}`,
);
if (totalEntities === 0) {
@@ -144,6 +146,7 @@ export async function checkEntityLinkCoverage(
SELECT p.id FROM pages p ${sampleClause}
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM links l WHERE l.to_page_id = p.id)
) sub`,
);
@@ -215,7 +218,8 @@ export async function checkTimelineCoverage(
engine,
`SELECT COUNT(*) AS count FROM pages
WHERE type IN ('person', 'company', 'organization', 'entity')
AND deleted_at IS NULL`,
AND deleted_at IS NULL
AND ${referenceExclusionSql()}`,
);
if (totalEntities === 0) {
@@ -237,6 +241,7 @@ export async function checkTimelineCoverage(
SELECT p.id FROM pages p ${sampleClause}
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM timeline_entries t WHERE t.page_id = p.id)
) sub`,
);
+5 -1
View File
@@ -14,6 +14,7 @@
// also short-circuits (CI/scripted callers see nothing).
import type { BrainEngine } from '../engine.ts';
import { referenceExclusionSql } from '../reference-flag.ts';
const NUDGE_BUDGET_MS = 3000;
@@ -57,7 +58,8 @@ export async function runInitNudge(engine: BrainEngine): Promise<void> {
engine.executeRaw<{ count: string | number }>(
`SELECT COUNT(*) AS count FROM pages
WHERE type IN ('person', 'company', 'organization', 'entity')
AND deleted_at IS NULL`,
AND deleted_at IS NULL
AND ${referenceExclusionSql()}`,
[],
{ signal: controller.signal },
),
@@ -65,6 +67,7 @@ export async function runInitNudge(engine: BrainEngine): Promise<void> {
`SELECT COUNT(*) AS count FROM pages p
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM links l WHERE l.to_page_id = p.id)`,
[],
{ signal: controller.signal },
@@ -73,6 +76,7 @@ export async function runInitNudge(engine: BrainEngine): Promise<void> {
`SELECT COUNT(*) AS count FROM pages p
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM timeline_entries t WHERE t.page_id = p.id)`,
[],
{ signal: controller.signal },
+1 -4
View File
@@ -4562,10 +4562,7 @@ const list_schema_packs: Operation = {
const { existsSync, readdirSync } = await import('node:fs');
const { join } = await import('node:path');
const { gbrainPath } = await import('./config.ts');
// #1726: derive from the locator's registry instead of a hand-copied
// subset (which had frozen at 2 of 7 bundled packs).
const { BUNDLED_PACKS } = await import('./schema-pack/load-active.ts');
const bundled = [...BUNDLED_PACKS];
const bundled = ['gbrain-base', 'gbrain-recommended'];
const installedDir = gbrainPath('schema-packs');
const installed: string[] = [];
if (existsSync(installedDir)) {
+2
View File
@@ -23,6 +23,7 @@ import { runMigrations } from './migrate.ts';
import { PGLITE_SCHEMA_SQL, getPGLiteSchema } from './pglite-schema.ts';
import { DEFAULT_EMBEDDING_MODEL, DEFAULT_EMBEDDING_DIMENSIONS } from './ai/defaults.ts';
import { DELETE_BATCH_SIZE } from './engine-constants.ts';
import { referenceExclusionSql } from './reference-flag.ts';
import { MARKDOWN_CHUNKER_VERSION } from './chunkers/recursive.ts';
import { acquireLock, releaseLock, type LockHandle } from './pglite-lock.ts';
import { getFtsLanguage } from './fts-language.ts';
@@ -5202,6 +5203,7 @@ export class PGLiteEngine implements BrainEngine {
const { rows: [h] } = await this.db.query(`
WITH entity_pages AS (
SELECT id, slug FROM pages WHERE type IN ('person', 'company')
AND ${referenceExclusionSql()}
)
SELECT
(SELECT count(*) FROM pages) as page_count,
+5
View File
@@ -5320,7 +5320,12 @@ export class PostgresEngine implements BrainEngine {
// is working as intended, not an orphan.
const [h] = await sql`
WITH entity_pages AS (
-- reference:true pages are exempt from coverage metrics.
-- Inlined (postgres.js tagged-template interpolation = bound param,
-- not raw SQL); keep in sync with referenceExclusionSql() in
-- reference-flag.ts.
SELECT id, slug FROM pages WHERE type IN ('person', 'company')
AND (frontmatter->>'reference') IS DISTINCT FROM 'true'
)
SELECT
(SELECT count(*) FROM pages) as page_count,
+37
View File
@@ -0,0 +1,37 @@
// Reference / canon entities.
//
// A page with frontmatter `reference: true` is a reference-only entity — a
// figure or organization imported from a book / article / external source that
// the user reads ABOUT but does not actively interact with (e.g. Andy Grove,
// Kleiner Perkins). It keeps its real `type` (`person` / `company`), so it stays
// fully searchable, enrichable, linkable, and edge-resolvable — NOTHING about
// retrieval changes.
//
// The ONLY behavior it opts out of is the entity *coverage* metrics
// (`timeline_coverage`, `entity_link_coverage` + their onboard-nudge mirrors).
// Those metrics nudge "this entity should accumulate dated history / inbound
// links"; that assumption is right for people you actually deal with and wrong
// for canon imports, which have no dated events in the user's life. Excluding
// them keeps the metric honest and actionable instead of permanently red.
//
// Opt-in: absent / false / anything-but-true = normal entity (the default).
// Set via `gbrain reference <slug>` (or hand-edit frontmatter).
export const REFERENCE_FRONTMATTER_KEY = 'reference';
/**
* SQL predicate (true for NON-reference pages) to AND into entity-coverage
* denominators AND numerators so the ratio stays consistent. JSONB `->>` yields
* text; `IS DISTINCT FROM 'true'` treats absent (NULL) and every non-true value
* as a normal counted entity. Backed by the GIN index on `pages.frontmatter`.
*
* @param alias optional table alias (e.g. 'p' for `pages p`); omit for bare `pages`.
*
* NOTE: postgres-engine.ts uses a postgres.js tagged template where `${}` is a
* bound parameter, not raw SQL, so it inlines this predicate literally — keep
* the two in sync.
*/
export function referenceExclusionSql(alias = ''): string {
const col = alias ? `${alias}.frontmatter` : 'frontmatter';
return `(${col}->>'${REFERENCE_FRONTMATTER_KEY}') IS DISTINCT FROM 'true'`;
}
@@ -41,12 +41,6 @@ migration_from:
pack: gbrain-base
version: "1.x"
# #2117 — cycle-phase participation. `phases:` is additive and pack-gated;
# without this key extract_atoms is silently off on v2 brains even though
# onboard + doctor recommend it (v2 declares the `atom` type it writes).
phases:
- extract_atoms
page_types:
- name: person
primitive: entity
@@ -325,10 +319,6 @@ page_types:
extractable: false
expert_routing: false
# #2117 — inference rules ported from gbrain-base v1 so extract-ner keeps
# working on v2 brains (it hard-skips with pack_unavailable when no
# link_type declares an inference.regex). Same ReDoS-guarded sketch
# regexes v1 ships; production matchers in link-extraction.ts still apply.
link_types:
- name: partner_of
inverse: partner_of
@@ -338,24 +328,14 @@ link_types:
- name: discusses
- name: founded
inverse: founded_by
inference:
regex: \b(founded|founder of|co-?founded|started)\b
- name: works_at
inverse: employs
inference:
regex: \b(works? at|employed by|works? for|joined|hired by|ceo of|cto of|cmo of)\b
- name: invested_in
inverse: investor_of
inference:
regex: \b(invested in|backed|seeded|funded|wrote a check)\b
- name: sourced_from
- name: derived_from
- name: supersedes
- name: redirects_to
# NOTE: v1's `attended` inference is page_type-bound to `meeting`, which
# v2 does not declare (lint: link_types_undeclared_page_type). Meeting
# pages retyped by unify-types are matched via frontmatter.legacy_type
# in extract-timeline-from-meetings (#2109) instead.
- name: attended
inverse: attended_by
- name: authored
+22 -26
View File
@@ -91,33 +91,29 @@ export function _resetPackLocatorForTests(): void {
* Returns null when the pack is not found. Callers handle null by
* throwing UnknownPackError with a paste-ready install hint.
*/
// v0.39 T8 — bundled packs registry. gbrain-base + gbrain-recommended
// ship in src/core/schema-pack/base/. Add a new entry here to bundle
// additional canonical packs.
//
// v0.41 T4 — lens packs join the bundle: creator (atoms + concepts +
// extract_atoms/synthesize_concepts phases), investor (theses + bet
// resolution + 3 calibration domains), engineer (gstack-learnings bridge
// + 3 calibration domains), everything (meta-pack stacking all three
// via extends + borrow_from). Each ships as a real YAML at base/<name>.yaml.
//
// #1726: exported so reporting surfaces (list_schema_packs) derive from the
// same list the locator resolves — no more hand-copied 2-of-7 subsets.
export const BUNDLED_PACKS: ReadonlyArray<string> = [
'gbrain-base',
'gbrain-recommended',
'gbrain-creator',
'gbrain-investor',
'gbrain-engineer',
'gbrain-everything',
// v0.42 type-unification: 15-type canonical successor to gbrain-base.
// Ships as install default (Lane E T17) + via gbrain onboard pack
// upgrade flow (the unify-types Minion handler).
'gbrain-base-v2',
];
function defaultPackLocator(name: string): string | null {
if (BUNDLED_PACKS.includes(name)) {
// v0.39 T8 — bundled packs registry. gbrain-base + gbrain-recommended
// ship in src/core/schema-pack/base/. Add a new entry here to bundle
// additional canonical packs.
//
// v0.41 T4 — lens packs join the bundle: creator (atoms + concepts +
// extract_atoms/synthesize_concepts phases), investor (theses + bet
// resolution + 3 calibration domains), engineer (gstack-learnings bridge
// + 3 calibration domains), everything (meta-pack stacking all three
// via extends + borrow_from). Each ships as a real YAML at base/<name>.yaml.
const BUNDLED: ReadonlyArray<string> = [
'gbrain-base',
'gbrain-recommended',
'gbrain-creator',
'gbrain-investor',
'gbrain-engineer',
'gbrain-everything',
// v0.42 type-unification: 15-type canonical successor to gbrain-base.
// Ships as install default (Lane E T17) + via gbrain onboard pack
// upgrade flow (the unify-types Minion handler).
'gbrain-base-v2',
];
if (BUNDLED.includes(name)) {
// Resolve bundled YAML relative to this source file. Works in both
// direct-bun execution and bun --compile binaries.
const here = dirname(fileURLToPath(import.meta.url));
+1 -34
View File
@@ -32,7 +32,7 @@ interface CapturedSql {
params: unknown[];
}
function buildMockEngine(opts: { scorecard: TakesScorecard; config?: Record<string, string> }): {
function buildMockEngine(opts: { scorecard: TakesScorecard }): {
engine: BrainEngine;
captured: CapturedSql[];
} {
@@ -42,9 +42,6 @@ function buildMockEngine(opts: { scorecard: TakesScorecard; config?: Record<stri
async getScorecard() {
return opts.scorecard;
},
async getConfig(key: string) {
return opts.config?.[key] ?? null;
},
async executeRaw<T>(sql: string, params?: unknown[]): Promise<T[]> {
captured.push({ sql, params: params ?? [] });
return [];
@@ -244,36 +241,6 @@ describe('runPhaseCalibrationProfile — phase integration', () => {
expect(insert!.params[11]).toEqual(['over-confident-geography']); // active_bias_tags
});
test('#1726: calibration.user_holder config drives the holder when no explicit opt', async () => {
const { engine, captured } = buildMockEngine({
scorecard: ENOUGH_RESOLVED_SCORECARD,
config: { 'calibration.user_holder': 'alice-example' },
});
await runPhaseCalibrationProfile(buildCtx(engine), {
patternsGenerator: async () => ['You call early-stage tactics well — 8 of 10 held up.'],
biasTagsGenerator: async () => [],
voiceGateJudge: passJudge,
});
const insert = captured.find(c => c.sql.includes('INSERT INTO calibration_profiles'));
expect(insert).toBeDefined();
expect(insert!.params[1]).toBe('alice-example'); // holder from config
});
test('#1726: explicit holder opt wins over calibration.user_holder config', async () => {
const { engine, captured } = buildMockEngine({
scorecard: ENOUGH_RESOLVED_SCORECARD,
config: { 'calibration.user_holder': 'alice-example' },
});
await runPhaseCalibrationProfile(buildCtx(engine), {
holder: 'charlie-example',
patternsGenerator: async () => ['You call early-stage tactics well — 8 of 10 held up.'],
biasTagsGenerator: async () => [],
voiceGateJudge: passJudge,
});
const insert = captured.find(c => c.sql.includes('INSERT INTO calibration_profiles'));
expect(insert!.params[1]).toBe('charlie-example');
});
test('default model is a provider-prefixed id, persisted to model_id (#2451)', async () => {
const { engine, captured } = buildMockEngine({ scorecard: ENOUGH_RESOLVED_SCORECARD });
const patternsGenerator: PatternStatementsGenerator = async () => [
-106
View File
@@ -1,106 +0,0 @@
// #2109 — gbrain-base-v2's unify-types retypes meeting pages to `note`
// with frontmatter.legacy_type='meeting'. extract-timeline-from-meetings
// used to hardcode type='meeting' and silently scan 0 meetings on migrated
// brains. These tests fail without the legacy_type fallback in both SQL
// sites (meeting walk + attended-edge join).
import { afterAll, beforeAll, beforeEach, describe, expect, it } from 'bun:test';
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { resetPgliteState } from './helpers/reset-pglite.ts';
import { extractTimelineFromMeetings } from '../src/core/extract-timeline-from-meetings.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);
});
async function insertPage(opts: {
slug: string;
type: string;
title: string;
effectiveDate?: string;
legacyType?: string;
}): Promise<number> {
const frontmatterLiteral = opts.legacyType
? `'{"legacy_type": "${opts.legacyType}"}'::jsonb`
: `'{}'::jsonb`;
const rows = await engine.executeRaw<{ id: number }>(
`INSERT INTO pages (slug, source_id, type, title, compiled_truth, timeline, effective_date, frontmatter)
VALUES ($1, 'default', $2, $3, '', '', $4, ${frontmatterLiteral})
RETURNING id`,
[opts.slug, opts.type, opts.title, opts.effectiveDate ?? null],
);
return rows[0]!.id;
}
describe('extractTimelineFromMeetings — legacy_type fallback (#2109)', () => {
it('scans pages retyped to note with legacy_type=meeting and walks their attended edges', async () => {
const meetingId = await insertPage({
slug: 'meetings/2026-01-05',
type: 'note', // post-unify-types shape on a gbrain-base-v2 brain
legacyType: 'meeting',
title: 'Weekly sync',
effectiveDate: '2026-01-05',
});
const personId = await insertPage({
slug: 'people/alice-example',
type: 'person',
title: 'Alice Example',
});
await engine.executeRaw(
`INSERT INTO links (from_page_id, to_page_id, link_type) VALUES ($1, $2, 'attended')`,
[meetingId, personId],
);
const result = await extractTimelineFromMeetings(engine);
expect(result.meetings_scanned).toBe(1);
expect(result.entries_created).toBe(1);
expect(result.entities_touched).toBe(1);
expect(result.batch_errors).toBe(0);
});
it('still scans pre-unify pages with type=meeting (v1 behavior preserved)', async () => {
const meetingId = await insertPage({
slug: 'meetings/2026-02-01',
type: 'meeting',
title: 'Board prep',
effectiveDate: '2026-02-01',
});
const personId = await insertPage({
slug: 'people/charlie-example',
type: 'person',
title: 'Charlie Example',
});
await engine.executeRaw(
`INSERT INTO links (from_page_id, to_page_id, link_type) VALUES ($1, $2, 'attended')`,
[meetingId, personId],
);
const result = await extractTimelineFromMeetings(engine);
expect(result.meetings_scanned).toBe(1);
expect(result.entries_created).toBe(1);
});
it('does not scan unrelated note pages without legacy_type=meeting', async () => {
await insertPage({
slug: 'notes/random',
type: 'note',
title: 'Random note',
effectiveDate: '2026-03-01',
});
const result = await extractTimelineFromMeetings(engine);
expect(result.meetings_scanned).toBe(0);
expect(result.entries_created).toBe(0);
});
});
-13
View File
@@ -152,19 +152,6 @@ describe('list_schema_packs', () => {
expect(result.installed).toContain('mine');
});
});
it('reports the full bundled registry, not a hand-copied subset (#1726)', async () => {
await withEnv({ GBRAIN_HOME: tmpDir }, async () => {
const { BUNDLED_PACKS } = await import('../src/core/schema-pack/load-active.ts');
const result = await operationsByName.list_schema_packs!.handler(ctxOf(), {}) as { bundled: string[] };
expect(result.bundled.slice().sort()).toEqual([...BUNDLED_PACKS].sort());
// The lens packs that declare extract_atoms/synthesize_concepts phases
// were the ones dropped by the frozen 2-pack literal.
for (const name of ['gbrain-creator', 'gbrain-everything', 'gbrain-base-v2']) {
expect(result.bundled).toContain(name);
}
});
});
});
// ── schema_stats ───────────────────────────────────────────────────────
+154
View File
@@ -0,0 +1,154 @@
import { describe, expect, test } from 'bun:test';
import { referenceExclusionSql, REFERENCE_FRONTMATTER_KEY } from '../src/core/reference-flag.ts';
import { applyReferenceFrontmatter } from '../src/commands/reference.ts';
describe('referenceExclusionSql', () => {
test('bare pages (no alias)', () => {
expect(referenceExclusionSql()).toBe(`(frontmatter->>'reference') IS DISTINCT FROM 'true'`);
});
test('aliased', () => {
expect(referenceExclusionSql('p')).toBe(`(p.frontmatter->>'reference') IS DISTINCT FROM 'true'`);
});
test('key constant', () => {
expect(REFERENCE_FRONTMATTER_KEY).toBe('reference');
});
});
describe('applyReferenceFrontmatter', () => {
const page = `---\ntitle: Andy Grove\ntype: person\ntags: []\n---\n\n# Andy Grove\n\nBody.`;
test('adds reference: true to an existing frontmatter block', () => {
const out = applyReferenceFrontmatter(page, true);
expect(out).toContain('reference: true');
expect(out).toContain('type: person'); // other keys preserved
expect(out).toContain('# Andy Grove'); // body preserved
});
test('is idempotent — does not duplicate the key', () => {
const once = applyReferenceFrontmatter(page, true);
const twice = applyReferenceFrontmatter(once, true);
expect(twice).toBe(once);
expect(twice.match(/reference: true/g)).toHaveLength(1);
});
test('replaces a stale reference: false with true', () => {
const off = `---\ntype: person\nreference: false\n---\n\nBody.`;
const out = applyReferenceFrontmatter(off, true);
expect(out).toContain('reference: true');
expect(out).not.toContain('reference: false');
});
test('--unset removes the key', () => {
const on = applyReferenceFrontmatter(page, true);
const off = applyReferenceFrontmatter(on, false);
expect(off).not.toContain('reference:');
expect(off).toContain('type: person');
});
test('--unset on a page without the key is a no-op', () => {
expect(applyReferenceFrontmatter(page, false)).toBe(page);
});
test('setting on a frontmatter-less page prepends a block', () => {
const raw = '# Just a heading\n\nNo frontmatter here.';
const out = applyReferenceFrontmatter(raw, true);
expect(out.startsWith('---\nreference: true\n---\n')).toBe(true);
expect(out).toContain('# Just a heading');
});
test('preserves body containing YAML-special chars', () => {
const tricky = `---\ntype: person\n---\n\nText with $& and $1 literals.`;
const out = applyReferenceFrontmatter(tricky, true);
expect(out).toContain('Text with $& and $1 literals.');
expect(out).toContain('reference: true');
});
});
// ── e2e: getHealth exemption + (source_id, slug)-scoped JSONB write ─────────
import { afterAll, beforeAll } from 'bun:test';
import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { runReference } from '../src/commands/reference.ts';
import { withEnv } from './helpers/with-env.ts';
describe('reference flag e2e (PGLite)', () => {
let engine: PGLiteEngine;
let brainDir: string;
beforeAll(async () => {
engine = new PGLiteEngine();
await engine.connect({ database_url: '' });
await engine.initSchema();
brainDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gbrain-ref-'));
fs.mkdirSync(path.join(brainDir, 'people'), { recursive: true });
fs.writeFileSync(
path.join(brainDir, 'people/andy-grove.md'),
'---\ntitle: Andy Grove\ntype: person\n---\n\n# Andy Grove\n',
'utf8',
);
await engine.executeRaw(
`INSERT INTO sources (id, name, local_path, config, created_at)
VALUES ('src-a', 'a', $1, '{}'::jsonb, now()), ('src-b', 'b', NULL, '{}'::jsonb, now())`,
[brainDir],
);
// Same slug in BOTH sources — the write must only touch src-a.
await engine.putPage('people/andy-grove', {
type: 'person', title: 'Andy Grove', compiled_truth: 'canon figure',
}, { sourceId: 'src-a' });
await engine.putPage('people/andy-grove', {
type: 'person', title: 'Andy Grove', compiled_truth: 'other-source twin',
}, { sourceId: 'src-b' });
// A normal contact WITH a timeline entry, so coverage has a live numerator.
const contact = await engine.putPage('people/alice-example', {
type: 'person', title: 'Alice Example', compiled_truth: 'real contact',
}, { sourceId: 'src-a' });
await engine.executeRaw(
`INSERT INTO timeline_entries (page_id, date, summary) VALUES ($1, '2026-01-01', 'met')`,
[contact.id],
);
});
afterAll(async () => {
await engine.disconnect();
fs.rmSync(brainDir, { recursive: true, force: true });
});
test('runReference scopes the JSONB write to the resolved (source_id, slug)', async () => {
await withEnv({ GBRAIN_SOURCE: undefined }, () =>
runReference(engine, ['people/andy-grove', '--brain', brainDir]));
const rows = await engine.executeRaw<{ source_id: string; ref: string | null }>(
`SELECT source_id, frontmatter->>'reference' AS ref FROM pages WHERE slug = 'people/andy-grove' ORDER BY source_id`,
);
expect(rows).toEqual([
{ source_id: 'src-a', ref: 'true' },
{ source_id: 'src-b', ref: null }, // twin in the other source untouched
]);
// Durable half: frontmatter on disk got the flag too.
expect(fs.readFileSync(path.join(brainDir, 'people/andy-grove.md'), 'utf8'))
.toContain('reference: true');
});
test('getHealth exempts reference pages from timeline/link coverage', async () => {
const health = await engine.getHealth();
// 3 person pages; the 2 reference-less twins would drag coverage to 1/3.
// With the src-a twin marked reference, denominator = 2 (alice + src-b twin).
expect(health.timeline_coverage).toBeCloseTo(0.5);
});
test('unset restores the page to a normal counted entity', async () => {
await withEnv({ GBRAIN_SOURCE: undefined }, () =>
runReference(engine, ['people/andy-grove', '--unset', '--brain', brainDir]));
const rows = await engine.executeRaw<{ ref: string | null }>(
`SELECT frontmatter->>'reference' AS ref FROM pages WHERE slug = 'people/andy-grove' AND source_id = 'src-a'`,
);
expect(rows[0].ref).toBeNull();
const health = await engine.getHealth();
expect(health.timeline_coverage).toBeCloseTo(1 / 3);
});
});
@@ -1,40 +0,0 @@
// #2117 — gbrain-base-v2 shipped with no `phases:` declaration and zero
// link_types[].inference regexes, so extract_atoms was silently pack-gated
// off and extract-ner returned pack_unavailable on the bundled default pack.
// These assertions fail against the pre-fix yaml.
import { describe, expect, it } from 'bun:test';
import { join } from 'node:path';
import { loadPackFromFile } from '../src/core/schema-pack/loader.ts';
import { linkTypesUndeclared } from '../src/core/schema-pack/lint-rules.ts';
const V2_PATH = join(import.meta.dir, '..', 'src', 'core', 'schema-pack', 'base', 'gbrain-base-v2.yaml');
describe('gbrain-base-v2 capability parity (#2117)', () => {
const manifest = loadPackFromFile(V2_PATH);
it('declares the extract_atoms cycle phase', () => {
expect(manifest.phases ?? []).toContain('extract_atoms');
});
it('ships at least one link_type inference regex so extract-ner is not pack_unavailable', () => {
// Mirrors the extract-ner hasRegex predicate exactly.
const hasRegex = manifest.link_types.some(
(lt) => lt.inference && typeof lt.inference === 'object' && 'regex' in lt.inference,
);
expect(hasRegex).toBe(true);
});
it('ports the v1 inference verbs it declares link types for', () => {
const withRegex = manifest.link_types
.filter((lt) => lt.inference?.regex)
.map((lt) => lt.name)
.sort();
expect(withRegex).toEqual(['founded', 'invested_in', 'works_at']);
});
it('inference rules pass the undeclared-page-type lint (no meeting-bound inference)', async () => {
const issues = await linkTypesUndeclared(manifest);
expect(issues).toEqual([]);
});
});