mirror of
https://github.com/garrytan/gbrain.git
synced 2026-08-16 18:02:30 +00:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2247540b4f |
File diff suppressed because one or more lines are too long
@@ -85,10 +85,6 @@ 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
|
||||
|
||||
@@ -273,13 +273,6 @@ 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)
|
||||
|
||||
|
||||
@@ -1,62 +0,0 @@
|
||||
# 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`.
|
||||
@@ -268,18 +268,6 @@ 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)
|
||||
|
||||
@@ -270,11 +270,6 @@ 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`.
|
||||
|
||||
+1
-6
@@ -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', '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']);
|
||||
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']);
|
||||
// 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,11 +1652,6 @@ 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);
|
||||
|
||||
+42
-12
@@ -161,7 +161,7 @@ interface ResolveAIOptionsArgs {
|
||||
nonInteractive: boolean; // --non-interactive (forces D3 fail-loud, no picker)
|
||||
}
|
||||
|
||||
interface ResolvedAIOptions {
|
||||
export interface ResolvedAIOptions {
|
||||
embedding_model?: string;
|
||||
embedding_dimensions?: number;
|
||||
expansion_model?: string;
|
||||
@@ -170,6 +170,41 @@ interface ResolvedAIOptions {
|
||||
noEmbedding?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Seed init's AI options from persisted config, falling back to the raw env
|
||||
* vars when loadConfig() returned null (#1058). On a cold install (no
|
||||
* config.json AND no DATABASE_URL) loadConfig short-circuits BEFORE its env
|
||||
* merge, so GBRAIN_EMBEDDING_MODEL / GBRAIN_EMBEDDING_DIMENSIONS /
|
||||
* GBRAIN_EXPANSION_MODEL / GBRAIN_CHAT_MODEL were silently ignored by init
|
||||
* and Tier-3 detection auto-picked by API key instead. Exported for unit
|
||||
* tests (env injectable).
|
||||
*/
|
||||
export function seedAIOptionsFromConfig(
|
||||
cfg: GBrainConfig | null,
|
||||
env: NodeJS.ProcessEnv = process.env,
|
||||
): ResolvedAIOptions {
|
||||
const envDims = env.GBRAIN_EMBEDDING_DIMENSIONS
|
||||
? parseInt(env.GBRAIN_EMBEDDING_DIMENSIONS, 10)
|
||||
: NaN;
|
||||
const seed = cfg ?? {
|
||||
embedding_disabled: undefined,
|
||||
embedding_model: env.GBRAIN_EMBEDDING_MODEL,
|
||||
embedding_dimensions: Number.isFinite(envDims) ? envDims : undefined,
|
||||
expansion_model: env.GBRAIN_EXPANSION_MODEL,
|
||||
chat_model: env.GBRAIN_CHAT_MODEL,
|
||||
};
|
||||
const out: ResolvedAIOptions = {};
|
||||
if (seed.embedding_disabled) {
|
||||
out.noEmbedding = true;
|
||||
} else if (seed.embedding_model) {
|
||||
out.embedding_model = seed.embedding_model;
|
||||
if (seed.embedding_dimensions) out.embedding_dimensions = seed.embedding_dimensions;
|
||||
}
|
||||
if (seed.expansion_model) out.expansion_model = seed.expansion_model;
|
||||
if (seed.chat_model) out.chat_model = seed.chat_model;
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve AI provider options for `gbrain init`.
|
||||
*
|
||||
@@ -203,18 +238,13 @@ async function resolveAIOptions(opts: ResolveAIOptionsArgs): Promise<ResolvedAIO
|
||||
// user already opted into deferred mode.
|
||||
try {
|
||||
const { loadConfig } = await import('../core/config.ts');
|
||||
const cfg = loadConfig();
|
||||
if (cfg?.embedding_disabled) {
|
||||
out.noEmbedding = true;
|
||||
} else if (cfg?.embedding_model) {
|
||||
out.embedding_model = cfg.embedding_model;
|
||||
if (cfg.embedding_dimensions) out.embedding_dimensions = cfg.embedding_dimensions;
|
||||
}
|
||||
if (cfg?.expansion_model) out.expansion_model = cfg.expansion_model;
|
||||
if (cfg?.chat_model) out.chat_model = cfg.chat_model;
|
||||
// #1058: loadConfig() returns null on a cold install (no config.json AND
|
||||
// no DATABASE_URL) — before it ever reaches its env merge. The seed helper
|
||||
// falls back to the same GBRAIN_* env vars directly in that case.
|
||||
Object.assign(out, seedAIOptionsFromConfig(loadConfig()));
|
||||
} catch {
|
||||
// loadConfig throws when no brain configured — first-time install, fall
|
||||
// through to env detection.
|
||||
// loadConfig threw — treat as first-time install, fall through to env
|
||||
// detection.
|
||||
}
|
||||
|
||||
// --- Tier 1+2: explicit flags ---------------------------------------------
|
||||
|
||||
@@ -1,130 +0,0 @@
|
||||
// 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.');
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -18,7 +18,6 @@
|
||||
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 {
|
||||
@@ -121,8 +120,7 @@ export async function checkEntityLinkCoverage(
|
||||
engine,
|
||||
`SELECT COUNT(*) AS count FROM pages
|
||||
WHERE type IN ('person', 'company', 'organization', 'entity')
|
||||
AND deleted_at IS NULL
|
||||
AND ${referenceExclusionSql()}`,
|
||||
AND deleted_at IS NULL`,
|
||||
);
|
||||
|
||||
if (totalEntities === 0) {
|
||||
@@ -146,7 +144,6 @@ 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`,
|
||||
);
|
||||
@@ -218,8 +215,7 @@ export async function checkTimelineCoverage(
|
||||
engine,
|
||||
`SELECT COUNT(*) AS count FROM pages
|
||||
WHERE type IN ('person', 'company', 'organization', 'entity')
|
||||
AND deleted_at IS NULL
|
||||
AND ${referenceExclusionSql()}`,
|
||||
AND deleted_at IS NULL`,
|
||||
);
|
||||
|
||||
if (totalEntities === 0) {
|
||||
@@ -241,7 +237,6 @@ 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`,
|
||||
);
|
||||
|
||||
@@ -14,7 +14,6 @@
|
||||
// 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;
|
||||
|
||||
@@ -58,8 +57,7 @@ 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 ${referenceExclusionSql()}`,
|
||||
AND deleted_at IS NULL`,
|
||||
[],
|
||||
{ signal: controller.signal },
|
||||
),
|
||||
@@ -67,7 +65,6 @@ 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 },
|
||||
@@ -76,7 +73,6 @@ 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 },
|
||||
|
||||
+19
-3
@@ -332,6 +332,15 @@ export interface OperationContext {
|
||||
* remote/untrusted (defense in depth in case the type is bypassed via cast).
|
||||
*/
|
||||
remote: boolean;
|
||||
/**
|
||||
* Transport marker for auth-less remote surfaces (#1061). The stdio MCP
|
||||
* dispatch sets 'stdio' — it is deliberately `remote: true` (agent-facing,
|
||||
* untrusted) but has no per-token auth (local pipe), so identity ops like
|
||||
* whoami need a way to distinguish "known auth-less transport" from "a
|
||||
* transport bug forgot to thread ctx.auth". Trust decisions MUST NOT key
|
||||
* off this field — only `ctx.remote === false` grants trust.
|
||||
*/
|
||||
transport?: 'stdio';
|
||||
/**
|
||||
* Subagent runtime context (v0.16+). Set by the subagent tool dispatcher when
|
||||
* dispatching an op as a tool call from an LLM loop. Used to enforce per-op
|
||||
@@ -3713,9 +3722,10 @@ const whoami: Operation = {
|
||||
'Introspect the calling identity. Returns one of three transport shapes: ' +
|
||||
'{transport: "oauth", client_id, client_name, scopes, expires_at}, ' +
|
||||
'{transport: "legacy", token_name, scopes, expires_at: null}, or ' +
|
||||
'{transport: "local", scopes: []}. Throws unknown_transport when the ' +
|
||||
'context is ambiguous (remote=true without auth) — fail-closed posture ' +
|
||||
'mirroring the v0.26.9 trust-boundary contract.',
|
||||
'{transport: "local", scopes: []}, or {transport: "stdio", scopes: []} ' +
|
||||
'for the auth-less stdio MCP pipe. Throws unknown_transport when the ' +
|
||||
'context is ambiguous (remote=true without auth and no transport marker) ' +
|
||||
'— fail-closed posture mirroring the v0.26.9 trust-boundary contract.',
|
||||
params: {},
|
||||
scope: 'read',
|
||||
handler: async (ctx) => {
|
||||
@@ -3727,6 +3737,12 @@ const whoami: Operation = {
|
||||
if (ctx.remote === false) {
|
||||
return { transport: 'local', scopes: [] };
|
||||
}
|
||||
// #1061: stdio MCP is remote/untrusted by design but has no per-token
|
||||
// auth (local pipe) — a known transport, not a bug. Report it instead of
|
||||
// throwing. Empty scopes: nothing here may be used to gate anything.
|
||||
if (!ctx.auth && ctx.transport === 'stdio') {
|
||||
return { transport: 'stdio', scopes: [] };
|
||||
}
|
||||
if (!ctx.auth) {
|
||||
throw new OperationError(
|
||||
'unknown_transport',
|
||||
|
||||
@@ -23,7 +23,6 @@ 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';
|
||||
@@ -5203,7 +5202,6 @@ 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,
|
||||
|
||||
@@ -5320,12 +5320,7 @@ 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,
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
// 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'`;
|
||||
}
|
||||
@@ -32,6 +32,12 @@ export interface DispatchOpts {
|
||||
remote?: boolean;
|
||||
/** Override the default stderr logger (e.g. CLI uses console.* directly). */
|
||||
logger?: OperationContext['logger'];
|
||||
/**
|
||||
* #1061: transport marker for auth-less remote surfaces. The stdio MCP
|
||||
* server passes 'stdio' so identity ops (whoami) can report the transport
|
||||
* instead of throwing unknown_transport. Never used for trust decisions.
|
||||
*/
|
||||
transport?: OperationContext['transport'];
|
||||
/**
|
||||
* v0.28: per-token allow-list for the takes.holder field. Threaded by
|
||||
* the HTTP/stdio transport from `access_tokens.permissions.takes_holders`.
|
||||
@@ -203,6 +209,7 @@ export function buildOperationContext(
|
||||
logger: opts.logger || stderrLogger,
|
||||
dryRun: !!params.dry_run,
|
||||
remote: opts.remote ?? true,
|
||||
transport: opts.transport,
|
||||
takesHoldersAllowList: opts.takesHoldersAllowList,
|
||||
// v0.34 D4: sourceId is REQUIRED at the type level. Auto-fill 'default'
|
||||
// for single-source brains and any caller who didn't resolve a sourceId.
|
||||
|
||||
@@ -42,6 +42,10 @@ export async function startMcpServer(engine: BrainEngine) {
|
||||
// `gbrain call <op>` (sets remote=false in src/cli.ts).
|
||||
return dispatchToolCall(engine, name, params, {
|
||||
remote: true,
|
||||
// #1061: mark the transport so whoami can report {transport: 'stdio'}
|
||||
// instead of throwing unknown_transport. Trust posture unchanged —
|
||||
// stdio stays remote/untrusted.
|
||||
transport: 'stdio',
|
||||
takesHoldersAllowList: ['world'],
|
||||
// v0.31: source defaults to 'default' for stdio (no per-token scope).
|
||||
// Operators who want a different source on stdio MCP should set
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
*/
|
||||
|
||||
import { describe, test, expect } from 'bun:test';
|
||||
import { groupReadyByProvider, findEnvKeyTypos } from '../src/commands/init.ts';
|
||||
import { groupReadyByProvider, findEnvKeyTypos, seedAIOptionsFromConfig } from '../src/commands/init.ts';
|
||||
|
||||
describe('groupReadyByProvider — embedding touchpoint', () => {
|
||||
test('OPENAI_API_KEY alone → openai is ready', async () => {
|
||||
@@ -149,3 +149,47 @@ describe('findEnvKeyTypos', () => {
|
||||
expect(got.find(t => t.userSet === 'COMPLETELY_UNRELATED_KEY')).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('seedAIOptionsFromConfig — #1058 cold-install env fallback', () => {
|
||||
test('null config (no config.json, no DATABASE_URL) falls back to GBRAIN_* env vars', () => {
|
||||
const got = seedAIOptionsFromConfig(null, {
|
||||
GBRAIN_EMBEDDING_MODEL: 'voyage:voyage-3-large',
|
||||
GBRAIN_EMBEDDING_DIMENSIONS: '1024',
|
||||
GBRAIN_EXPANSION_MODEL: 'openai:gpt-5-mini',
|
||||
GBRAIN_CHAT_MODEL: 'anthropic:claude-sonnet-4-6',
|
||||
});
|
||||
expect(got.embedding_model).toBe('voyage:voyage-3-large');
|
||||
expect(got.embedding_dimensions).toBe(1024);
|
||||
expect(got.expansion_model).toBe('openai:gpt-5-mini');
|
||||
expect(got.chat_model).toBe('anthropic:claude-sonnet-4-6');
|
||||
});
|
||||
|
||||
test('null config + no env vars → empty seed (Tier-3 detection takes over)', () => {
|
||||
const got = seedAIOptionsFromConfig(null, {});
|
||||
expect(got).toEqual({});
|
||||
});
|
||||
|
||||
test('persisted config wins (loadConfig already merged env when non-null)', () => {
|
||||
const got = seedAIOptionsFromConfig(
|
||||
{ engine: 'pglite', embedding_model: 'openai:text-embedding-3-small', embedding_dimensions: 1536 } as any,
|
||||
{ GBRAIN_EMBEDDING_MODEL: 'voyage:voyage-3-large' },
|
||||
);
|
||||
expect(got.embedding_model).toBe('openai:text-embedding-3-small');
|
||||
expect(got.embedding_dimensions).toBe(1536);
|
||||
});
|
||||
|
||||
test('embedding_disabled sentinel honored on re-init', () => {
|
||||
const got = seedAIOptionsFromConfig({ engine: 'pglite', embedding_disabled: true } as any, {});
|
||||
expect(got.noEmbedding).toBe(true);
|
||||
expect(got.embedding_model).toBeUndefined();
|
||||
});
|
||||
|
||||
test('non-numeric GBRAIN_EMBEDDING_DIMENSIONS ignored, model still seeds', () => {
|
||||
const got = seedAIOptionsFromConfig(null, {
|
||||
GBRAIN_EMBEDDING_MODEL: 'voyage:voyage-3-large',
|
||||
GBRAIN_EMBEDDING_DIMENSIONS: 'not-a-number',
|
||||
});
|
||||
expect(got.embedding_model).toBe('voyage:voyage-3-large');
|
||||
expect(got.embedding_dimensions).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,154 +0,0 @@
|
||||
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);
|
||||
});
|
||||
});
|
||||
@@ -94,6 +94,35 @@ describe('whoami op contract', () => {
|
||||
expect(result.expires_at).toBeNull();
|
||||
});
|
||||
|
||||
// #1061: stdio MCP is remote/untrusted by design but has no per-token auth
|
||||
// (local pipe). The stdio dispatch marks ctx.transport='stdio'; whoami
|
||||
// reports it instead of throwing unknown_transport.
|
||||
test('stdio transport (remote=true, no auth, transport marker) reports stdio', async () => {
|
||||
const result = (await whoami.handler(
|
||||
ctxWith({ remote: true, auth: undefined, transport: 'stdio' }),
|
||||
{},
|
||||
)) as any;
|
||||
expect(result.transport).toBe('stdio');
|
||||
expect(result.scopes).toEqual([]);
|
||||
});
|
||||
|
||||
test('stdio marker does not mask real auth (auth still wins)', async () => {
|
||||
const result = (await whoami.handler(
|
||||
ctxWith({
|
||||
remote: true,
|
||||
transport: 'stdio',
|
||||
auth: {
|
||||
token: 'gbrain_at_xxx',
|
||||
clientId: 'gbrain_cl_abc',
|
||||
scopes: ['read'],
|
||||
expiresAt: 1,
|
||||
} as AuthInfo,
|
||||
}),
|
||||
{},
|
||||
)) as any;
|
||||
expect(result.transport).toBe('oauth');
|
||||
});
|
||||
|
||||
// Q3: ambiguous transport — fail-closed. The footgun this guards against
|
||||
// is a future transport that lands without threading auth, where a buggy
|
||||
// caller might trust whoami's output to gate sensitive ops.
|
||||
|
||||
Reference in New Issue
Block a user