feat(health): the gate reads the named report — reads refuse loudly, never rebuild; open serves before it returns; the ceremony door
All checks were successful
CI / Node 22 (push) Successful in 12m19s
CI / Node 24 (push) Successful in 12m16s
CI / Integration + conformance (Node 22) (push) Successful in 18m41s
CI / Bun (latest) (push) Successful in 12m20s

The read gate stops consulting the unnamed isReady() boolean: every provider
may expose healthReport() (sync, O(1), composed from exact ledgers —
HealthReport with a monotonic generation, per-invariant source
ledger|deep|unledgered, missing {count, sample}), and one readiness
authority (assessProviderHealth) derives the verdict. Unledgered families
are UNKNOWN — never healthy, never broken; a report that throws is a loud
not-ready, never a shrug. Reads at the four index choke points refuse with
the typed NotReady errors, narrated once per (provider, generation) — a
read NEVER starts a store walk:

- the first-read lazy build retires (open builds instead, regardless of
  size — the ≥10k deferral and the "lazy loading on first query" branch go;
  disableAutoRebuild is re-meant honestly in its docs);
- the verify*Live read-path rebuild triggers retire (refuse-or-serve);
- the read-time consistency probe that could launch a dark rebuild from an
  ordinary find() retires;
- repairIndex({ rebuild: ['metadata'|'graph'|'vector'] | 'all' }) is the
  one explicit door: rebuilds the named leg unconditionally and reports
  rebuilt per family; bare repairIndex() stays report-driven.

test(lifecycle): the biography lane — a store's whole life, refereed

tests/lifecycle/: an independent shadow model referees every read after
every chapter (founding, a working day, clean restart, crash, repair,
second life). Chapters 1-3 green. Chapters 4-6 assert the true contract and
are marked .fails as a release-blocking finding (the kill-matrix
convention): after a crash + adopt reopen the metadata index computes its
'catchup' watermark verdict and nothing consumes it — find() serves the
pre-crash index while canonical and counts recover. The catchup wiring is
the cure; a passing .fails will force the marker's removal. The lane runs
in the integration gate (config + coverage guard).
This commit is contained in:
David Snelling 2026-08-24 12:45:51 -07:00
parent a8b5ca0c8f
commit f8f64780b1
19 changed files with 2160 additions and 652 deletions

16
tests/lifecycle/README.md Normal file
View file

@ -0,0 +1,16 @@
# The Lifecycle Lane
One brain, driven through founding, a working day, a clean restart, a
crash, a repair, and a second life, checked chapter by chapter against an
independent shadow-model referee (`biographyHarness.ts`). It catches
COMPOSITION regressions unit tests miss — a store fine in one process but
broken across a restart/crash/repair. Runs on the plain JS engine, so it
gates every commit.
Run it: `npx vitest run tests/lifecycle --pool=forks`
A red names the chapter label, the id, and expected-vs-actual — diagnosable
from the message alone. `biography.test.ts` is split into two `it` blocks
(Ch1-3, then Ch4-6) purely for reporting; it is still ONE fixed-order story.
Chapters must never be reordered, skipped, or made conditional, and a
failing chapter's assertion must never be weakened to force green.

View file

@ -0,0 +1,429 @@
/**
* @module tests/lifecycle/biography
* @description THE LIFECYCLE LANE see `tests/lifecycle/README.md` for what
* this proves and how to run it. One scenario, "the working store": a single
* brain driven through founding, a working day, a clean restart, a crash, a
* repair, and a second life, verified chapter by chapter against an
* independent shadow-model referee (`biographyHarness.ts`).
*
* Split into two `it` blocks so a currently-failing later chapter (see the
* second block's header comment a live engine finding, not a defect in
* this lane) never hides the earlier chapters' passing coverage. The two
* blocks share one brain's directory and one shadow model, run in the SAME
* fixed order the single scenario always has (`describe.sequential` below
* exists to say so explicitly, though vitest's own default is sequential
* within a file) this is a split for REPORTING clarity, not a reordering
* or conditional skip of any chapter.
*/
import { describe, it, expect } from 'vitest'
import * as fs from 'node:fs'
import { NounType, VerbType } from '../../src/types/graphTypes.js'
import type { Brainy } from '../../src/brainy.js'
import type { AddParams, RelateParams, UpdateParams, UpdateRelationParams } from '../../src/index.js'
import { abandonAsCrashed, makeTempDir, openBrain, uid } from '../helpers/durabilityKillMatrix.js'
import {
createModel,
getCanonicalCountsFor,
modelAdd,
modelDelete,
modelRelate,
modelUpdate,
modelUpdateRelation,
recordVfsFileWrite,
snapshotVfsBaseline,
verifyChapter,
type HubCheck,
type ShadowModel
} from './biographyHarness.js'
const STATUSES = ['active', 'pending', 'closed', 'archived'] as const
/** Cycle a status value to the next one in the fixed rotation used so
* Ch2's 40 updates provably MOVE entities across find() buckets rather than
* risking a no-op reassignment of the same value. */
function nextStatus(current: unknown): (typeof STATUSES)[number] {
const currentStr = typeof current === 'string' ? current : STATUSES[0]
const idx = STATUSES.indexOf(currentStr as (typeof STATUSES)[number])
return STATUSES[(idx < 0 ? 0 : idx + 1) % STATUSES.length]
}
// ---------------------------------------------------------------------------
// Shared biography state — set up by the first `it`, consumed by the second.
// The two blocks are one continuous story told in two named pieces; nothing
// here resets or diverges between them.
// ---------------------------------------------------------------------------
let dir: string
let model: ShadowModel
let brain: Brainy
let hubs: HubCheck[]
let employees: string[]
let customers: string[]
let invoices: string[]
let tasks: string[]
let projects: string[]
let nonHub: string[]
// ---- Wrappers: every call to the real brain updates the shadow model in
// the same statement, so the two can never drift apart by construction.
// Defined once, closing over the `let` bindings above so both `it` blocks
// (and any future reopen inside them) operate on the current brain/model.
async function doAdd(label: string, params: Omit<AddParams, 'id'>): Promise<string> {
const id = uid(label)
await brain.add({ ...params, id })
modelAdd(model, id, {
type: params.type,
subtype: params.subtype,
metadata: params.metadata ?? {},
visibility: params.visibility
})
return id
}
async function doUpdate(id: string, patch: Omit<UpdateParams, 'id'>): Promise<void> {
await brain.update({ ...patch, id })
modelUpdate(model, id, { metadata: patch.metadata, merge: patch.merge, visibility: patch.visibility })
}
async function doRemove(id: string): Promise<void> {
await brain.remove(id)
modelDelete(model, id)
}
async function doRelate(params: RelateParams): Promise<string> {
const id = await brain.relate(params)
modelRelate(model, id, {
from: params.from,
to: params.to,
type: params.type,
subtype: params.subtype,
metadata: params.metadata
})
return id
}
async function doUpdateRelation(id: string, patch: Omit<UpdateRelationParams, 'id'>): Promise<void> {
await brain.updateRelation({ ...patch, id })
modelUpdateRelation(model, id, { metadata: patch.metadata, merge: patch.merge })
}
async function doVfsWrite(path: string, content: string): Promise<void> {
await brain.vfs.writeFile(path, content)
recordVfsFileWrite(model)
}
describe.sequential('lifecycle — the working store', () => {
it(
'Ch1 FOUNDING -> Ch2 A WORKING DAY -> Ch3 CLEAN RESTART: every read serves truth',
async () => {
process.env.BRAINY_DETERMINISTIC_EMBEDDINGS = 'true'
dir = makeTempDir()
model = createModel()
// logAuthority: 'adopt' from the first open, mirrored across every
// reopen — see write-flow-production-shape.test.ts, which the later
// crash chapter's at-ack law is pinned against.
brain = await openBrain(dir, { logAuthority: 'adopt' })
// =================================================================
// CHAPTER 1 — FOUNDING
// =================================================================
// Baseline MUST be snapshotted before any biography act — it is the
// VFS root's own system-tier footprint, measured, never hardcoded.
await snapshotVfsBaseline(brain, model)
employees = []
for (let i = 0; i < 20; i++) {
employees.push(
await doAdd(`emp-${i}`, {
data: `employee record ${i}`,
type: NounType.Person,
subtype: 'employee',
metadata: { status: STATUSES[i % STATUSES.length], department: ['engineering', 'sales', 'support'][i % 3] }
})
)
}
customers = []
for (let i = 0; i < 20; i++) {
customers.push(
await doAdd(`cust-${i}`, {
data: `customer record ${i}`,
type: NounType.Person,
subtype: 'customer',
metadata: { status: STATUSES[i % STATUSES.length], tier: i % 2 === 0 ? 'gold' : 'standard' }
})
)
}
invoices = []
for (let i = 0; i < 30; i++) {
invoices.push(
await doAdd(`inv-${i}`, {
data: `invoice record ${i}`,
type: NounType.Document,
subtype: 'invoice',
metadata: { status: STATUSES[i % STATUSES.length], amount: 100 + i * 17 }
})
)
}
tasks = []
for (let i = 0; i < 25; i++) {
tasks.push(
await doAdd(`task-${i}`, {
data: `task record ${i}`,
type: NounType.Task,
subtype: 'milestone',
metadata: { status: STATUSES[i % STATUSES.length], priority: (i % 5) + 1 }
})
)
}
projects = []
for (let i = 0; i < 25; i++) {
projects.push(
await doAdd(`proj-${i}`, {
data: `project record ${i}`,
type: NounType.Project,
metadata: { status: STATUSES[i % STATUSES.length], budget: 1000 * (i + 1) }
})
)
}
expect(employees.length + customers.length + invoices.length + tasks.length + projects.length).toBe(120)
// Five hubs (proj-0..proj-4) fan out to tasks (Contains) and employees
// (WorksWith); a residual band of invoice->customer RelatedTo edges is
// unrelated to any hub. Hubs are never touched again for the rest of
// the biography, so they stay valid adjacency samples in every chapter.
const hubIds = projects.slice(0, 5)
for (let h = 0; h < 5; h++) {
for (let k = 0; k < 15; k++) {
const taskIdx = (h * 5 + k) % tasks.length
await doRelate({ from: hubIds[h], to: tasks[taskIdx], type: VerbType.Contains, subtype: 'delivers' })
}
for (let k = 0; k < 10; k++) {
const empIdx = (h * 4 + k) % employees.length
await doRelate({ from: hubIds[h], to: employees[empIdx], type: VerbType.WorksWith })
}
}
for (let j = 0; j < 25; j++) {
await doRelate({ from: invoices[j], to: customers[j % customers.length], type: VerbType.RelatedTo, subtype: 'billed-to' })
}
expect(model.relations.size).toBe(150)
// A handful of VFS files.
for (let i = 0; i < 5; i++) {
await doVfsWrite(`/report-${i}.txt`, `founding report ${i}`)
}
await brain.flush()
hubs = hubIds.map((id) => ({ id, typeFilters: [VerbType.Contains, VerbType.WorksWith] }))
await verifyChapter(brain, model, 'Ch1 FOUNDING', { hubs, bucketField: 'status' })
// =================================================================
// CHAPTER 2 — A WORKING DAY
// =================================================================
// Non-hub pool for every mutation below.
nonHub = [...employees, ...customers, ...invoices, ...tasks, ...projects.slice(5)]
// 40 updates that provably MOVE entities across find() status buckets.
const updateTargets = nonHub.slice(0, 40)
for (const id of updateTargets) {
const current = model.entities.get(id)!.metadata.status
await doUpdate(id, { metadata: { status: nextStatus(current) } })
}
// 10 visibility flips (public -> internal).
const visibilityTargets = nonHub.slice(40, 50)
for (const id of visibilityTargets) {
await doUpdate(id, { visibility: 'internal' })
}
// 15 deletes — some hub members (their edges cascade away), 3 of them
// earmarked for Ch6's resurrection.
const resurrectIds = [tasks[0], tasks[1], employees[0]]
const otherDeletes = [
tasks[2], tasks[3], tasks[4], tasks[5], tasks[6],
employees[1], employees[2], employees[3],
customers[0], customers[1], customers[2], customers[3]
]
const ch2DeleteTargets = [...resurrectIds, ...otherDeletes]
expect(ch2DeleteTargets.length).toBe(15)
for (const id of ch2DeleteTargets) {
await doRemove(id)
}
// 20 new adds.
const ch2NewTypes = [NounType.Person, NounType.Document, NounType.Task]
for (let i = 0; i < 20; i++) {
await doAdd(`ch2-new-${i}`, {
data: `working-day addition ${i}`,
type: ch2NewTypes[i % ch2NewTypes.length],
subtype: 'ad-hoc',
metadata: { status: STATUSES[i % STATUSES.length] }
})
}
// 10 updateRelation metadata patches — read AFTER the deletes above,
// so only relations the cascade left alive are ever targeted.
const survivingRelationIds = [...model.relations.keys()].slice(0, 10)
expect(survivingRelationIds.length).toBe(10)
for (const relId of survivingRelationIds) {
await doUpdateRelation(relId, { metadata: { reviewed: true } })
}
await brain.flush()
await verifyChapter(brain, model, 'Ch2 A WORKING DAY', { hubs, bucketField: 'status' })
// =================================================================
// CHAPTER 3 — CLEAN RESTART
// =================================================================
await brain.close()
brain = await openBrain(dir, { logAuthority: 'adopt' })
await verifyChapter(brain, model, 'Ch3 CLEAN RESTART', { hubs, bucketField: 'status' })
// Leave the brain closed and the directory intact for the next `it`
// (the biography continues there) — do NOT remove `dir` here.
await brain.close()
},
300000
)
/**
* Ch4 CRASH is a LIVE ENGINE FINDING, not a defect in this lane (see
* README.md and the project report this lane's build produced): after a
* crash (writes acked at commit but never flushed, the process abandoned
* exactly as `abandonAsCrashed` models, then reopened), canonical storage
* (`get()`), the vector index, and `getNounCount()`/`getCanonicalCounts()`
* all correctly recover every acked write but the METADATA INDEX behind
* `find({ where })` recovers NONE of the crash-window's acked writes
* (neither new adds nor metadata updates to pre-existing entities), even
* though `getIndexStatus()` reports `projections.metadata.synchronous:
* true`. `repairIndex()` cannot close the gap either: its own report names
* `provider:metadata` as `checked: false, skipped: "no
* validateInvariants/rebuild contract"`. The assertion below states the
* TRUE contract (find() must agree with get()) and is expected to fail
* against the current engine it must never be loosened to paper over
* this. Ch5/Ch6 are written in full below it and will start running the
* moment this gap is closed; they are not dead code, they are blocked code.
*/
// RELEASE-BLOCKING FINDING (the kill-matrix convention: assert the CONTRACT,
// mark `.fails`, never weaken): after a crash + adopt reopen, the JS metadata
// index computes its watermark verdict but nothing consumes 'catchup'
// (metadataIndex.ts loadWatermarkVerdict) — find() serves the pre-crash
// index while get()/counts recover. The catchup wiring is the cure; when it
// lands this `.fails` marker MUST be removed (vitest will force it: a
// passing `.fails` test is itself a failure).
it.fails(
'Ch4 CRASH -> Ch5 REPAIR -> Ch6 SECOND LIFE: continues the Ch3 store',
async () => {
try {
brain = await openBrain(dir, { logAuthority: 'adopt' })
// ===============================================================
// CHAPTER 4 — CRASH
// ===============================================================
const ch4Types = [NounType.Person, NounType.Document, NounType.Task, NounType.Project]
for (let i = 0; i < 10; i++) {
await doAdd(`ch4-new-${i}`, {
data: `crash-window addition ${i}`,
type: ch4Types[i % ch4Types.length],
metadata: { status: STATUSES[i % STATUSES.length] }
})
}
const ch4UpdateTargets = nonHub.slice(50, 55) // invoices[10..14] — untouched so far
for (const id of ch4UpdateTargets) {
await doUpdate(id, { metadata: { status: 'active' } })
}
// NO flush — abandon exactly the way process death would (the
// at-ack law: every write already awaited above must survive).
await abandonAsCrashed(brain)
brain = await openBrain(dir, { logAuthority: 'adopt' })
await verifyChapter(brain, model, 'Ch4 CRASH', { hubs, bucketField: 'status' })
// ===============================================================
// CHAPTER 5 — REPAIR
// ===============================================================
const report = await brain.repairIndex()
for (const family of report.families) {
const accounted =
family.checked === true || (family.checked === false && typeof family.skipped === 'string' && family.skipped.length > 0)
expect(
accounted,
`[Ch5 REPAIR] family '${family.family}' must be checked or explicitly skipped with a reason; got ${JSON.stringify(family)}`
).toBe(true)
}
// A healthy store: repair must change nothing the model doesn't
// already expect — verifyChapter against the UNCHANGED model proves it.
await verifyChapter(brain, model, 'Ch5 REPAIR', { hubs, bucketField: 'status' })
// ===============================================================
// CHAPTER 6 — SECOND LIFE
// ===============================================================
const ch6Types = [NounType.Person, NounType.Document, NounType.Task, NounType.Project]
for (let i = 0; i < 10; i++) {
await doAdd(`ch6-new-${i}`, {
data: `second-life addition ${i}`,
type: ch6Types[i % ch6Types.length],
metadata: { status: STATUSES[i % STATUSES.length] }
})
}
const ch6UpdateTargets = nonHub.slice(55, 65) // invoices[15..24] — untouched so far
expect(ch6UpdateTargets.every((id) => model.entities.get(id)!.alive)).toBe(true)
for (const id of ch6UpdateTargets) {
await doUpdate(id, { metadata: { status: 'closed' } })
}
const ch6DeleteTargets = nonHub
.slice(65, 90) // invoices[25..29] + tasks[0..19] (some already dead — filtered below)
.filter((id) => model.entities.get(id)!.alive)
.slice(0, 7)
expect(ch6DeleteTargets.length).toBe(7)
for (const id of ch6DeleteTargets) {
await doRemove(id)
}
// Resurrection: the SAME three ids Ch2 deleted, reinserted with
// BRAND-NEW metadata — the model expects the new metadata only.
await doAdd('task-0', { data: 'resurrected task 0', type: NounType.Task, subtype: 'milestone', metadata: { status: 'active', resurrected: true } })
await doAdd('task-1', { data: 'resurrected task 1', type: NounType.Task, subtype: 'milestone', metadata: { status: 'pending', resurrected: true } })
await doAdd('emp-0', { data: 'resurrected employee 0', type: NounType.Person, subtype: 'employee', metadata: { status: 'active', resurrected: true } })
expect(tasks[0]).toBe(uid('task-0')) // same id as Ch1/Ch2 — the resurrection-adjacent shape
await brain.close()
brain = await openBrain(dir, { logAuthority: 'adopt' })
await verifyChapter(brain, model, 'Ch6 SECOND LIFE', { hubs, bucketField: 'status' })
// Final, standalone getCanonicalCounts() exactness check (beyond
// verifyChapter's own (f) leg) — the whole ledger, in one shot.
const finalCounts = await getCanonicalCountsFor(brain)
const aliveEntities = [...model.entities.values()].filter((e) => e.alive)
const alivePublicEntities = aliveEntities.filter((e) => (e.visibility ?? 'public') === 'public')
const aliveVerbs = model.relations.size
expect(finalCounts, 'final getCanonicalCounts() exactness — Ch6 SECOND LIFE').toEqual({
nouns: {
counted: alivePublicEntities.length + model.vfsFileNouns,
all: aliveEntities.length + model.vfsFileNouns + model.vfsBaselineNouns
},
verbs: {
counted: aliveVerbs + model.vfsContainsVerbs,
all: aliveVerbs + model.vfsContainsVerbs + model.vfsBaselineVerbs
},
suspect: false
})
} finally {
await brain.close().catch(() => {})
// Best-effort, retried: a still-draining background persistence
// write (e.g. count/index write-through) can race a single rmSync
// and leave a partial directory behind — retry a couple of times
// rather than let this temp dir leak.
for (let attempt = 0; attempt < 3; attempt++) {
try {
fs.rmSync(dir, { recursive: true, force: true })
if (!fs.existsSync(dir)) break
} catch {
// ignore and retry
}
await new Promise((resolve) => setTimeout(resolve, 100))
}
}
},
300000
)
})

View file

@ -0,0 +1,389 @@
/**
* @module tests/lifecycle/biographyHarness
* @description The referee for the LIFECYCLE LANE (see `biography.test.ts`):
* a plain in-memory SHADOW MODEL of a brain's contents, updated by every act
* the biography performs (add/update/remove/relate/updateRelation/vfs writes),
* plus `verifyChapter()`, which asserts the live brain agrees with the model
* after every chapter. No engine code runs inside the model it is an
* independent ledger, not a mirror of the implementation under test.
*
* COUNT SEMANTICS this harness encodes (verified against the live engine,
* not assumed see the module-level comments below for how each was
* confirmed):
*
* - `getNounCount()` / `getVerbCount()` count PUBLIC-tier alive records only
* (visibility absent or `'public'`) `'internal'` and `'system'` are both
* excluded. `storage.getCanonicalCounts()` mirrors that same PUBLIC-only
* scalar as `counted`, and additionally reports `all` every tier,
* unfiltered as the coverage-ledger denominator (see
* tests/integration/canonical-count-ledger.test.ts).
* - `brain.vfs.writeFile()` for a brand-new file at a path directly under the
* VFS root creates exactly ONE new File noun plus ONE new `Contains` verb
* (root -> file), and BOTH are ordinary PUBLIC records (no visibility
* field is set) so they count toward `getNounCount()`/`getVerbCount()`
* as well as the canonical `all` scalars. Only the VFS ROOT entity itself
* is `'system'`-tier (created once, at `init()`, before any biography
* chapter runs) that lone record is the only hidden-tier footprint the
* model does not construct explicitly, so it is captured empirically via
* `snapshotVfsBaseline()` immediately after `init()` rather than hardcoded.
* - `related()` filters edges by the RELATION's own visibility tier, not by
* the visibility of the entities the edge connects flipping an entity to
* `'internal'` does not hide its edges from `related()`. This lane never
* sets relation visibility, so every relation the model tracks is exactly
* as reachable as its presence in `model.relations` implies.
* - `remove()` cascades: every relation touching the removed entity (as
* `from` or `to`) is hard-deleted along with it. The model mirrors this by
* deleting the relation entirely from `model.relations` (no relation
* "alive" flag presence in the map IS aliveness).
*/
import { expect } from 'vitest'
import type { Brainy } from '../../src/brainy.js'
import type { NounType, VerbType } from '../../src/types/graphTypes.js'
import type { EntityVisibility, StorageAdapter } from '../../src/coreTypes.js'
/**
* One entity's complete lifecycle-relevant state, as the biography's acts
* leave it. `alive: false` means the model believes the id has been removed
* the entry is KEPT (never deleted from the map) so `verifyChapter` can
* assert the negative half of the contract: a dead id must read as `null`.
*/
export interface ShadowEntity {
type: NounType
subtype?: string
metadata: Record<string, unknown>
visibility?: EntityVisibility
alive: boolean
}
/**
* One relation's complete lifecycle-relevant state. There is no `alive`
* flag here presence in {@link ShadowModel.relations} IS aliveness,
* mirroring the engine's hard delete of the canonical verb record on
* cascade (see the module header).
*/
export interface ShadowRelation {
from: string
to: string
type: VerbType
subtype?: string
metadata: Record<string, unknown>
}
/**
* The independent truth ledger the biography updates on every act it
* performs. `verifyChapter` checks the live brain against this never the
* other way around.
*/
export interface ShadowModel {
entities: Map<string, ShadowEntity>
relations: Map<string, ShadowRelation>
/**
* `getCanonicalCounts()` nouns.all / verbs.all captured right after
* `init()`, before chapter 1 the VFS root's own system-tier footprint.
* Set once via {@link snapshotVfsBaseline}; never hardcoded.
*/
vfsBaselineNouns: number
vfsBaselineVerbs: number
/**
* Public nouns/verbs created by `vfs.writeFile()` for a brand-new file at
* a flat top-level path: exactly one File noun + one Contains verb per
* call (see the module header). Bumped by {@link recordVfsFileWrite}.
*/
vfsFileNouns: number
vfsContainsVerbs: number
}
/** A fresh, empty shadow model — call once before chapter 1. */
export function createModel(): ShadowModel {
return {
entities: new Map(),
relations: new Map(),
vfsBaselineNouns: 0,
vfsBaselineVerbs: 0,
vfsFileNouns: 0,
vfsContainsVerbs: 0
}
}
/** Narrow, documented private-storage access (the same style already used by
* `tests/helpers/durabilityKillMatrix.ts`'s `storeOf()`), needed because
* `getCanonicalCounts()` lives on the storage adapter, not on `Brainy`. */
function storageOf(brain: Brainy): StorageAdapter {
return (brain as unknown as { storage: StorageAdapter }).storage
}
/** Public wrapper around the private-storage `getCanonicalCounts()` read, so
* callers never need their own private-access cast used internally by
* {@link snapshotVfsBaseline} and {@link verifyChapter}, and by
* `biography.test.ts` for its final standalone exactness check. */
export async function getCanonicalCountsFor(brain: Brainy): ReturnType<NonNullable<StorageAdapter['getCanonicalCounts']>> {
const storage = storageOf(brain)
if (!storage.getCanonicalCounts) {
throw new Error(
'lifecycle lane: the storage adapter under test has no getCanonicalCounts() — the canonical-count-exactness leg of this lane is unrepresentable without it.'
)
}
return storage.getCanonicalCounts()
}
/**
* Snapshot the VFS root's own hidden-tier footprint. Call exactly once,
* immediately after `init()` and before chapter 1 does anything this is
* the ONE baseline offset the model does not construct by hand (see the
* module header for why: the root is `'system'`-tier plumbing the biography
* never explicitly creates).
*/
export async function snapshotVfsBaseline(brain: Brainy, model: ShadowModel): Promise<void> {
const counts = await getCanonicalCountsFor(brain)
model.vfsBaselineNouns = counts.nouns.all
model.vfsBaselineVerbs = counts.verbs.all
}
/**
* Record one `brain.vfs.writeFile()` call for a brand-new file at a flat
* top-level path (no intermediate directories). Bumps both the noun and verb
* VFS counters by one, matching the engine's actual write path exactly (see
* the module header) never call this for an overwrite of an existing path,
* a nested path (which would also vivify intermediate directory nouns/edges,
* a different, unmodeled shape), or the biography loses its exactness.
*/
export function recordVfsFileWrite(model: ShadowModel): void {
model.vfsFileNouns += 1
model.vfsContainsVerbs += 1
}
/** Record a fresh `add()` (or a Ch6 resurrection `Map.set` fully replaces
* whatever a prior dead entry held, which is exactly the "new metadata only"
* contract a resurrection must honor). */
export function modelAdd(
model: ShadowModel,
id: string,
entity: { type: NounType; subtype?: string; metadata: Record<string, unknown>; visibility?: EntityVisibility }
): void {
model.entities.set(id, {
type: entity.type,
subtype: entity.subtype,
metadata: { ...entity.metadata },
visibility: entity.visibility,
alive: true
})
}
/** Record an `update()` merges metadata by default, matching the engine's
* `merge: true` default; pass `merge: false` to mirror a full replace. */
export function modelUpdate(
model: ShadowModel,
id: string,
patch: { metadata?: Record<string, unknown>; merge?: boolean; visibility?: EntityVisibility }
): void {
const existing = model.entities.get(id)
if (!existing || !existing.alive) {
throw new Error(`shadow model: update() targeted ${id}, which the model does not have alive — biography sequencing bug`)
}
if (patch.metadata) {
existing.metadata = patch.merge === false ? { ...patch.metadata } : { ...existing.metadata, ...patch.metadata }
}
if (patch.visibility !== undefined) {
existing.visibility = patch.visibility
}
}
/** Record a `remove()` marks the entity dead (entry retained, per
* {@link ShadowEntity}) and cascades: every relation touching it, in either
* direction, is hard-deleted from the model too (matching the engine). */
export function modelDelete(model: ShadowModel, id: string): void {
const existing = model.entities.get(id)
if (!existing || !existing.alive) {
throw new Error(`shadow model: remove() targeted ${id}, which the model does not have alive — biography sequencing bug`)
}
existing.alive = false
for (const [relId, rel] of model.relations) {
if (rel.from === id || rel.to === id) model.relations.delete(relId)
}
}
/** Record a `relate()` — `id` is the relation id the real call returned. */
export function modelRelate(
model: ShadowModel,
id: string,
relation: { from: string; to: string; type: VerbType; subtype?: string; metadata?: Record<string, unknown> }
): void {
model.relations.set(id, {
from: relation.from,
to: relation.to,
type: relation.type,
subtype: relation.subtype,
metadata: { ...(relation.metadata ?? {}) }
})
}
/** Record an `updateRelation()` metadata patch — merges by default. */
export function modelUpdateRelation(
model: ShadowModel,
id: string,
patch: { metadata?: Record<string, unknown>; merge?: boolean }
): void {
const existing = model.relations.get(id)
if (!existing) {
throw new Error(`shadow model: updateRelation() targeted ${id}, which the model does not have — biography sequencing bug`)
}
if (patch.metadata) {
existing.metadata = patch.merge === false ? { ...patch.metadata } : { ...existing.metadata, ...patch.metadata }
}
}
/** Order-independent structural equality for plain JSON-shaped metadata. */
function deepEqual(a: unknown, b: unknown): boolean {
if (a === b) return true
if (typeof a !== typeof b) return false
if (a === null || b === null) return a === b
if (typeof a !== 'object') return false
const aKeys = Object.keys(a as Record<string, unknown>)
const bKeys = Object.keys(b as Record<string, unknown>)
if (aKeys.length !== bKeys.length) return false
for (const k of aKeys) {
if (!deepEqual((a as Record<string, unknown>)[k], (b as Record<string, unknown>)[k])) return false
}
return true
}
/** One hub entity to sample for the `related()` adjacency check, plus the
* verb type(s) it is known (by biography construction) to have OUT-edges
* of, so the type-filtered variant is exercised too. */
export interface HubCheck {
id: string
typeFilters: VerbType[]
}
/** Options steering one `verifyChapter()` call. */
export interface VerifyOptions {
/** Hub entities to sample for the `related()` adjacency check. */
hubs: HubCheck[]
/** The metadata field `find()` bucket-checks against (a bare string field
* every alive entity may or may not carry distinct values present among
* ALIVE model entities are discovered automatically each call, so a
* chapter that moves entities across buckets is re-checked exactly). */
bucketField: string
}
/**
* Assert the live brain agrees with the model, in full, after one chapter.
* Every failure message names the chapter `label`, the id (where
* applicable), and expected-vs-actual a red here must be diagnosable from
* the assertion message alone, with no need to re-read this file.
*/
export async function verifyChapter(brain: Brainy, model: ShadowModel, label: string, opts: VerifyOptions): Promise<void> {
// (a) + (b): every alive entity reads back exactly as modeled; every dead
// entity reads as null.
for (const [id, entity] of model.entities) {
const live = await brain.get(id)
if (entity.alive) {
expect(live, `[${label}] alive entity ${id} (type=${entity.type}) must be readable via get(), got null`).not.toBeNull()
const e = live!
expect(e.type, `[${label}] entity ${id} .type mismatch: expected ${entity.type}, got ${e.type}`).toBe(entity.type)
expect(e.subtype, `[${label}] entity ${id} .subtype mismatch: expected ${JSON.stringify(entity.subtype)}, got ${JSON.stringify(e.subtype)}`).toBe(entity.subtype)
expect(
e.visibility,
`[${label}] entity ${id} .visibility mismatch: expected ${JSON.stringify(entity.visibility)}, got ${JSON.stringify(e.visibility)}`
).toBe(entity.visibility)
const metaMatches = deepEqual(e.metadata ?? {}, entity.metadata)
expect(
metaMatches,
`[${label}] entity ${id} .metadata mismatch: expected ${JSON.stringify(entity.metadata)}, got ${JSON.stringify(e.metadata)}`
).toBe(true)
} else {
expect(live, `[${label}] dead entity ${id} (type=${entity.type}) must read as null, got ${JSON.stringify(live)}`).toBeNull()
}
}
// (c) find({ where: { <bucketField>: value } }) returns exactly the
// model's matching alive set, per distinct value currently present.
const bucketValues = new Set<string>()
for (const entity of model.entities.values()) {
if (!entity.alive) continue
const v = entity.metadata[opts.bucketField]
if (typeof v === 'string') bucketValues.add(v)
}
for (const value of bucketValues) {
const expectedIds = [...model.entities.entries()]
.filter(([, e]) => e.alive && e.metadata[opts.bucketField] === value)
.map(([id]) => id)
.sort()
const results = await brain.find({
where: { [opts.bucketField]: value } as Record<string, unknown>,
includeInternal: true,
limit: 100000
})
const actualIds = results.map((r) => r.id).sort()
expect(
actualIds,
`[${label}] find({ where: { ${opts.bucketField}: ${JSON.stringify(value)} } }) mismatch: expected ${expectedIds.length} ids ${JSON.stringify(expectedIds)}, got ${actualIds.length} ids ${JSON.stringify(actualIds)}`
).toEqual(expectedIds)
}
// (d) related(id) / related(id, { type }) for the hub sample matches the
// model's adjacency exactly (out-edges — related(id) is shorthand for
// { from: id }).
for (const hub of opts.hubs) {
const expectedAll = [...model.relations.entries()]
.filter(([, r]) => r.from === hub.id)
.map(([id]) => id)
.sort()
const liveAll = await brain.related({ from: hub.id, limit: 100000 })
const actualAllIds = liveAll.map((r) => r.id).sort()
expect(
actualAllIds,
`[${label}] related(${hub.id}) mismatch: expected ${expectedAll.length} ids ${JSON.stringify(expectedAll)}, got ${actualAllIds.length} ids ${JSON.stringify(actualAllIds)}`
).toEqual(expectedAll)
for (const typeFilter of hub.typeFilters) {
const expectedTyped = [...model.relations.entries()]
.filter(([, r]) => r.from === hub.id && r.type === typeFilter)
.map(([id]) => id)
.sort()
const liveTyped = await brain.related({ from: hub.id, type: typeFilter, limit: 100000 })
const actualTypedIds = liveTyped.map((r) => r.id).sort()
expect(
actualTypedIds,
`[${label}] related(${hub.id}, { type: '${typeFilter}' }) mismatch: expected ${expectedTyped.length} ids ${JSON.stringify(expectedTyped)}, got ${actualTypedIds.length} ids ${JSON.stringify(actualTypedIds)}`
).toEqual(expectedTyped)
}
}
// (e) getNounCount() / getVerbCount(): PUBLIC-tier alive records
// (visibility absent/'public'; 'internal' and 'system' both excluded — see
// the module header) plus the VFS's own public contributions.
const alivePublicNouns = [...model.entities.values()].filter((e) => e.alive && (e.visibility ?? 'public') === 'public').length
const aliveVerbs = model.relations.size
const expectedNounCount = alivePublicNouns + model.vfsFileNouns
const expectedVerbCount = aliveVerbs + model.vfsContainsVerbs
expect(
await brain.getNounCount(),
`[${label}] getNounCount() mismatch: expected ${expectedNounCount} (alive public entities ${alivePublicNouns} + vfs file nouns ${model.vfsFileNouns})`
).toBe(expectedNounCount)
expect(
await brain.getVerbCount(),
`[${label}] getVerbCount() mismatch: expected ${expectedVerbCount} (alive relations ${aliveVerbs} + vfs contains verbs ${model.vfsContainsVerbs})`
).toBe(expectedVerbCount)
// (f) getCanonicalCounts(): ALL-visibility scalars (every tier) equal the
// model's alive totals including hidden tiers, plus the VFS's own
// contributions (both file nouns/verbs AND the once-measured root
// baseline). suspect must be false — every delete in this biography goes
// through brain.remove(), which always proves the record it decrements.
const ledger = await getCanonicalCountsFor(brain)
const aliveAllNouns = [...model.entities.values()].filter((e) => e.alive).length
const expectedNounsAll = aliveAllNouns + model.vfsFileNouns + model.vfsBaselineNouns
const expectedVerbsAll = aliveVerbs + model.vfsContainsVerbs + model.vfsBaselineVerbs
expect(
ledger.nouns.all,
`[${label}] getCanonicalCounts().nouns.all mismatch: expected ${expectedNounsAll} (alive incl. internal ${aliveAllNouns} + vfs file nouns ${model.vfsFileNouns} + vfs root baseline ${model.vfsBaselineNouns})`
).toBe(expectedNounsAll)
expect(
ledger.verbs.all,
`[${label}] getCanonicalCounts().verbs.all mismatch: expected ${expectedVerbsAll} (alive relations ${aliveVerbs} + vfs contains verbs ${model.vfsContainsVerbs} + vfs root baseline ${model.vfsBaselineVerbs})`
).toBe(expectedVerbsAll)
expect(ledger.nouns.counted, `[${label}] getCanonicalCounts().nouns.counted mismatch (should mirror getNounCount())`).toBe(expectedNounCount)
expect(ledger.verbs.counted, `[${label}] getCanonicalCounts().verbs.counted mismatch (should mirror getVerbCount())`).toBe(expectedVerbCount)
expect(ledger.suspect, `[${label}] getCanonicalCounts().suspect must be false — every delete in this biography proves its record`).toBe(false)
}