Files
gbrain/test/write-through.test.ts
T
Garry TanandClaude Fable 5 7efb5ca982 fix(facts,serve,jobs): fence into canonical source_path, reap PID-1 orphans, wait out dead supervisor locks, merge fence on write-through
Four adversarially-verified backlog items, one unit:

- #2722 fence-write derived the target file from the slug alone, so a page
  imported from a spaced filename (`10 People/Jane Doe.md`, slug
  `10-people/jane-doe`) got a parallel hyphen-path stub instead of its
  canonical file. `resolveFenceFilePath` now consults `pages.source_path`
  (markdown-only, containment-checked) with the slug-derived path as the
  new-page fallback; `forgetFactInFence` shares the same resolver so
  forgets strike through the same file the write deposited into.
  Secondarily, a freshly stub-created page is unlinked when the DB stamp
  fails, so transient DB errors can't leave phantom entity pages.

- #2443 gbrain as a container entrypoint (PID 1) never reaped re-parented
  orphan grandchildren; zombie `git` processes accumulated until the
  cgroup pids limit starved fork. `installPid1OrphanReaper` (no-op unless
  PID 1 on Linux) sweeps /proc for Z-state children and reaps pids seen in
  two consecutive sweeps via libc waitpid(WNOHANG) — the two-sweep gate
  avoids racing the runtime's own per-child reaping. Deploy docs now
  recommend `docker run --init` / tini as the primary setup.

- #2308 supervisor start was one-shot on the queue DB lock: a recreated
  container (new hostname) exited LOCK_HELD inside the previous holder's
  TTL window and nothing retried. `acquireSupervisorDbLockWithWait` polls
  the acquire while the holder is provably dead (same-host dead PID, or a
  heartbeat that never advances) and still fails fast on a genuinely live
  holder, bounded by TTL + steal grace.

- #2839 `writePageThrough` atomically rewrote `<slug>.md` from the DB row
  with no page lock, clobbering `## Facts` fence rows deposited on disk
  since the last import (the DB body lags fence writes). The read-merge-
  rename now runs under `withPageLock(slug)` and merges the on-disk fence
  (union by row_num, disk wins) before rendering over the file.

Fixes #2722
Fixes #2443
Fixes #2308
Fixes #2839

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-21 15:06:46 -07:00

269 lines
11 KiB
TypeScript

/**
* Shared write-through helper tests (src/core/write-through.ts).
*
* Covers the skip/error branches and the atomic-write guarantee. The helper is
* the canonical disk sink shared by `put_page` and `gbrain brainstorm/lsd
* --save`, extracted from the v0.38 put_page write-through and upgraded to write
* atomically (.tmp + rename).
*/
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import * as fs from 'node:fs';
import * as path from 'node:path';
import * as os from 'node:os';
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { resetPgliteState } from './helpers/reset-pglite.ts';
import { resetGateway } from '../src/core/ai/gateway.ts';
import { writePageThrough } from '../src/core/write-through.ts';
import { importFromContent } from '../src/core/import-file.ts';
import { serializePageToMarkdown, resolvePageFilePath } from '../src/core/markdown.ts';
let engine: PGLiteEngine;
let tmpRoot: string;
let brainDir: string;
beforeAll(async () => {
engine = new PGLiteEngine();
await engine.connect({});
await engine.initSchema();
});
afterAll(async () => {
await engine.disconnect();
resetGateway();
});
beforeEach(async () => {
await resetPgliteState(engine);
resetGateway();
tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'gbrain-wt-helper-'));
brainDir = path.join(tmpRoot, 'brain');
fs.mkdirSync(brainDir, { recursive: true });
});
afterEach(() => {
fs.rmSync(tmpRoot, { recursive: true, force: true });
});
async function seedPage(slug: string): Promise<void> {
await importFromContent(engine, slug, `---\ntitle: T\ntype: note\n---\n\n# Body ${slug}\n`, {
noEmbed: true,
sourceId: 'default',
sourcePath: `${slug}.md`,
});
}
function walkFiles(dir: string): string[] {
const out: string[] = [];
const walk = (d: string) => {
for (const e of fs.readdirSync(d, { withFileTypes: true })) {
const p = path.join(d, e.name);
if (e.isDirectory()) walk(p);
else out.push(p);
}
};
walk(dir);
return out;
}
describe('writePageThrough', () => {
test('writes the file rendered from the saved row; no .tmp leftover', async () => {
await engine.setConfig('sync.repo_path', brainDir);
const slug = 'wiki/ideas/2026-01-01-lsd-foo-abc123';
await seedPage(slug);
const res = await writePageThrough(engine, slug, {
sourceId: 'default',
frontmatterOverrides: { source_kind: 'lsd' },
});
expect(res.written).toBe(true);
const expectedPath = resolvePageFilePath(brainDir, slug, 'default');
expect(res.path).toBe(expectedPath);
expect(fs.existsSync(expectedPath)).toBe(true);
// Content is the canonical serialization of the saved row (the file is
// rendered FROM the row, so the sinks can't diverge).
const page = await engine.getPage(slug, { sourceId: 'default' });
const tags = await engine.getTags(slug, { sourceId: 'default' });
const expected = serializePageToMarkdown(page!, tags, {
frontmatterOverrides: { source_kind: 'lsd' },
});
expect(fs.readFileSync(expectedPath, 'utf8')).toBe(expected);
// Atomic write left no temp sibling.
const dir = path.dirname(expectedPath);
expect(fs.readdirSync(dir).some((f) => f.includes('.tmp.'))).toBe(false);
});
test('no sync.repo_path → skipped no_repo_configured', async () => {
await engine.setConfig('sync.repo_path', '');
const slug = 'wiki/ideas/x-1';
await seedPage(slug);
const res = await writePageThrough(engine, slug);
expect(res).toEqual({ written: false, skipped: 'no_repo_configured' });
});
test('sync.repo_path is a file, not a directory → skipped repo_not_found', async () => {
const fileAsRepo = path.join(tmpRoot, 'not-a-dir');
fs.writeFileSync(fileAsRepo, 'x');
await engine.setConfig('sync.repo_path', fileAsRepo);
const slug = 'wiki/ideas/x-2';
await seedPage(slug);
const res = await writePageThrough(engine, slug);
expect(res).toEqual({ written: false, skipped: 'repo_not_found' });
});
test('row missing → skipped page_not_found_after_write', async () => {
await engine.setConfig('sync.repo_path', brainDir);
const res = await writePageThrough(engine, 'wiki/ideas/does-not-exist');
expect(res).toEqual({ written: false, skipped: 'page_not_found_after_write' });
});
test('[REGRESSION #2018] default page (null local_path) in a multi-source brain → skipped, no leak into a sibling source repo', async () => {
// A sibling federated source with its OWN working tree.
const siblingDir = path.join(tmpRoot, 'housefax');
fs.mkdirSync(siblingDir, { recursive: true });
await engine.executeRaw(
`INSERT INTO sources (id, name, local_path, config) VALUES ('housefax', 'Housefax', $1, '{}'::jsonb)`,
[siblingDir],
);
// The leak trigger: global sync.repo_path points at the sibling's tree
// while the default source (re-seeded by resetPgliteState) has no
// local_path of its own.
await engine.setConfig('sync.repo_path', siblingDir);
const slug = 'internal/cross-cutting-note';
await seedPage(slug); // sourceId 'default'
const res = await writePageThrough(engine, slug, { sourceId: 'default' });
expect(res).toEqual({ written: false, skipped: 'source_repo_belongs_to_other_source' });
// The sibling source's repo stays clean — the whole point of #2018.
expect(walkFiles(siblingDir).some((f) => f.endsWith('.md'))).toBe(false);
});
test('[#2018] page assigned to a source with its own local_path writes to that tree root, not the global path', async () => {
const alphaDir = path.join(tmpRoot, 'alpha-repo');
fs.mkdirSync(alphaDir, { recursive: true });
const globalDir = path.join(tmpRoot, 'global-repo');
fs.mkdirSync(globalDir, { recursive: true });
await engine.executeRaw(
`INSERT INTO sources (id, name, local_path, config) VALUES ('alpha', 'Alpha', $1, '{}'::jsonb)`,
[alphaDir],
);
// Must NOT be used — the assigned source has its own tree.
await engine.setConfig('sync.repo_path', globalDir);
const slug = 'notes/alpha-thing';
await importFromContent(engine, slug, `---\ntitle: T\ntype: note\n---\n\n# Body\n`, {
noEmbed: true,
sourceId: 'alpha',
sourcePath: `${slug}.md`,
});
const res = await writePageThrough(engine, slug, { sourceId: 'alpha' });
expect(res.written).toBe(true);
// File at the source's tree ROOT, never nested under `.sources/<id>/`.
expect(res.path).toBe(path.join(alphaDir, `${slug}.md`));
expect(fs.existsSync(path.join(alphaDir, `${slug}.md`))).toBe(true);
// The global repo path is untouched.
expect(walkFiles(globalDir).some((f) => f.endsWith('.md'))).toBe(false);
});
test('[REGRESSION] mkdir ENOTDIR (parent is a file) → error, no partial .md, no .tmp', async () => {
await engine.setConfig('sync.repo_path', brainDir);
// Block the `wiki/` directory by putting a FILE named "wiki" under the repo,
// so `mkdir -p <repo>/wiki/ideas` throws ENOTDIR deterministically.
fs.writeFileSync(path.join(brainDir, 'wiki'), 'blocker');
const slug = 'wiki/ideas/blocked-1';
await seedPage(slug);
const res = await writePageThrough(engine, slug, { sourceId: 'default' });
expect(res.written).toBe(false);
expect(typeof res.error).toBe('string');
const files = walkFiles(brainDir);
expect(files.some((f) => f.endsWith('.md'))).toBe(false);
expect(files.some((f) => f.includes('.tmp.'))).toBe(false);
});
});
// #2839: writePageThrough renders from the DB row, but fence writers
// (writeFactsToFence / forget) edit the on-disk `## Facts` fence FIRST and the
// DB body only catches up on the next sync. The write-through must merge those
// on-disk fence rows back instead of silently clobbering them.
describe('writePageThrough — facts fence preservation (#2839)', () => {
test('preserves on-disk fence rows the DB body has not caught up with', async () => {
await engine.setConfig('sync.repo_path', brainDir);
const slug = 'people/carol';
await seedPage(slug);
// First write-through creates the file from the row.
const first = await writePageThrough(engine, slug, { sourceId: 'default' });
expect(first.written).toBe(true);
const filePath = first.path!;
// Simulate a fence write landing on disk after the last import.
const { upsertFactRow } = await import('../src/core/facts-fence.ts');
const { body: withFence } = upsertFactRow(fs.readFileSync(filePath, 'utf8'), {
claim: 'Deposited via fence write',
kind: 'fact',
confidence: 1.0,
visibility: 'world',
notability: 'high',
validFrom: '2026-01-01',
source: 'test',
});
fs.writeFileSync(filePath, withFence, 'utf8');
// A put_page-style write-through re-renders from the (lagging) DB row...
const second = await writePageThrough(engine, slug, { sourceId: 'default' });
expect(second.written).toBe(true);
// ...but the fence row deposited on disk survives.
const after = fs.readFileSync(filePath, 'utf8');
expect(after).toContain('Deposited via fence write');
expect(after).toContain('## Facts');
});
});
describe('mergeDiskFactsFence (#2839)', () => {
const row = (rowNum: number, claim: string) =>
`| ${rowNum} | ${claim} | fact | 1.0 | world | high | 2026-01-01 | | test | |`;
const fence = (rows: string[]) => [
'<!--- gbrain:facts:begin -->',
'| # | claim | kind | confidence | visibility | notability | valid_from | valid_until | source | context |',
'|---|---|---|---|---|---|---|---|---|---|',
...rows,
'<!--- gbrain:facts:end -->',
].join('\n');
test('unions rows by row_num, disk wins collisions', async () => {
const { mergeDiskFactsFence } = await import('../src/core/write-through.ts');
const rendered = `# Page\n\n## Facts\n\n${fence([row(1, 'old claim one')])}\n`;
const disk = `# Page\n\n## Facts\n\n${fence([row(1, 'edited claim one'), row(2, 'new disk-only claim')])}\n`;
const merged = mergeDiskFactsFence(rendered, disk);
expect(merged).toContain('edited claim one');
expect(merged).toContain('new disk-only claim');
expect(merged).not.toContain('old claim one');
});
test('appends a fence section when the rendered body has none', async () => {
const { mergeDiskFactsFence } = await import('../src/core/write-through.ts');
const rendered = '# Page\n\nBody only.\n';
const disk = `# Page\n\n## Facts\n\n${fence([row(1, 'disk fact')])}\n`;
const merged = mergeDiskFactsFence(rendered, disk);
expect(merged).toContain('Body only.');
expect(merged).toContain('## Facts');
expect(merged).toContain('disk fact');
});
test('no-op when the disk body has no fence', async () => {
const { mergeDiskFactsFence } = await import('../src/core/write-through.ts');
const rendered = '# Page\n\nRendered.\n';
expect(mergeDiskFactsFence(rendered, '# Page\n\nNo fence here.\n')).toBe(rendered);
});
});