Brainy 8.0 makes subtype required by default on every public write path
(`add`, `addMany`, `update`, `relate`, `relateMany`, `updateRelation`,
import). Per the locked C-1 contract, every entity and relation gets a
non-empty subtype string by the time the storage layer sees it.
OPT-OUT REMAINS FULLY SUPPORTED
The runtime flag is still consumer-controlled. Three opt-out paths
cover migration / legacy fixtures / typed escape:
- `new Brainy({ requireSubtype: false })` — last-resort: turn off the
contract entirely. Recommended only for migration windows or test
fixtures that legitimately can't supply a subtype.
- `new Brainy({ requireSubtype: { except: [NounType.Thing, ...] } })` —
per-type allowlist: strict everywhere except the listed types.
- `brain.requireSubtype(type, options)` — per-type registration with
optional vocabulary. Composes with the brain-wide flag.
Default is now `true`. Opt-out is explicit and documented; nothing
silently degrades.
TEST SWEEP
Bulk-applied `requireSubtype: false` to every `new Brainy({...})` call
site across 120 test files. Three sed patterns covered the shapes:
- `new Brainy({` → `new Brainy({ requireSubtype: false,`
- `new Brainy<T>({` → `new Brainy<T>({ requireSubtype: false,`
- `new Brainy()` → `new Brainy({ requireSubtype: false })`
tests/helpers/test-factory.ts → createTestConfig() defaults
`requireSubtype: false` so test files using the helper inherit the
opt-out without per-site edits.
The test sites that DO exercise subtype semantics (the
subtype-and-facets suite, the strict-mode-self-test suite, the verb-
subtype-and-enforcement suite, etc.) already pass real subtypes — they
were the 7.30.x acceptance tests for this contract. Those tests
continue to pass unchanged.
CHANGES
src/brainy.ts
- normalizeConfig() — `requireSubtype` default `false` → `true`.
Comment refreshed to document the three opt-out paths.
tests/* (120 files)
- Bulk-edited brain construction sites. No functional test changes; the
opt-out preserves the test author's original intent.
tests/helpers/test-factory.ts
- createTestConfig() base config gains `requireSubtype: false`.
NO-OP for consumers who were already passing subtype on every write.
For consumers who weren't, the upgrade path is one of the three opt-out
forms above. Migration recipe documented in 8.0 release notes (next
commit).
VERIFICATION
- npx tsc --noEmit: clean
- npm test: 1408 / 1409 (same pre-existing race-condition outstanding;
no other regressions from the flip)
141 lines
4.8 KiB
TypeScript
141 lines
4.8 KiB
TypeScript
/**
|
|
* Regression test: VFS data persists across restart (close + reopen)
|
|
*
|
|
* Verifies the fix for GraphAdjacencyIndex.flush() and LSMTree.get()
|
|
* which previously caused graph relationships to be lost on restart
|
|
* because LSM MemTables were never flushed to SSTables on close.
|
|
*/
|
|
import { describe, it, expect } from 'vitest'
|
|
import { Brainy } from '../../src/brainy.js'
|
|
import { VerbType } from '../../src/types/graphTypes.js'
|
|
import { mkdirSync, rmSync } from 'fs'
|
|
|
|
describe('VFS restart persistence', () => {
|
|
it('entities and relationships survive close + reopen', async () => {
|
|
const dir = '/tmp/brainy-restart-fix-' + Date.now()
|
|
mkdirSync(dir, { recursive: true })
|
|
|
|
let entityId: string | undefined
|
|
const rootId = '00000000-0000-0000-0000-000000000000'
|
|
|
|
try {
|
|
// === SESSION 1: Write data ===
|
|
let brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'filesystem', rootDirectory: dir },
|
|
disableAutoRebuild: true,
|
|
plugins: [],
|
|
silent: true,
|
|
})
|
|
await brain.init()
|
|
|
|
await brain.vfs.writeFile('/chapter-1.txt', 'Once upon a time...')
|
|
|
|
entityId = await brain.vfs.resolvePathToId('/chapter-1.txt')
|
|
expect(entityId).toBeTruthy()
|
|
|
|
// Verify within same session — entity, readdir, and relations
|
|
const entity1 = await brain.get(entityId!)
|
|
expect(entity1).not.toBeNull()
|
|
|
|
const entries1 = await brain.vfs.readdir('/')
|
|
expect(entries1.length).toBeGreaterThan(0)
|
|
|
|
// In-session getRelations: root should have Contains relationship to the file
|
|
const relations1 = await brain.getRelations({ from: rootId, type: VerbType.Contains })
|
|
expect(relations1.length).toBeGreaterThan(0)
|
|
|
|
await brain.close()
|
|
|
|
// === SESSION 2: Read data after restart ===
|
|
brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'filesystem', rootDirectory: dir },
|
|
disableAutoRebuild: true,
|
|
plugins: [],
|
|
silent: true,
|
|
})
|
|
await brain.init()
|
|
|
|
// Entity should be retrievable
|
|
const entity2 = await brain.get(entityId!)
|
|
expect(entity2).not.toBeNull()
|
|
|
|
// Root entity should exist
|
|
const rootEntity = await brain.get(rootId)
|
|
expect(rootEntity).not.toBeNull()
|
|
|
|
// readdir should return the file
|
|
const entries2 = await brain.vfs.readdir('/')
|
|
expect(entries2.length).toBeGreaterThan(0)
|
|
expect(entries2).toContain('chapter-1.txt')
|
|
|
|
// getRelations should find the Contains relationship
|
|
const relations2 = await brain.getRelations({ from: rootId, type: VerbType.Contains })
|
|
expect(relations2.length).toBeGreaterThan(0)
|
|
|
|
await brain.close()
|
|
} finally {
|
|
try { rmSync(dir, { recursive: true }) } catch {}
|
|
}
|
|
})
|
|
|
|
it('multiple files and subdirectories survive restart', async () => {
|
|
const dir = '/tmp/brainy-restart-multi-' + Date.now()
|
|
mkdirSync(dir, { recursive: true })
|
|
|
|
const rootId = '00000000-0000-0000-0000-000000000000'
|
|
|
|
try {
|
|
// === SESSION 1: Write multiple files ===
|
|
let brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'filesystem', rootDirectory: dir },
|
|
disableAutoRebuild: true,
|
|
plugins: [],
|
|
silent: true,
|
|
})
|
|
await brain.init()
|
|
|
|
await brain.vfs.writeFile('/readme.txt', 'Project readme')
|
|
await brain.vfs.writeFile('/docs/guide.txt', 'User guide')
|
|
await brain.vfs.writeFile('/docs/api.txt', 'API reference')
|
|
|
|
const entries1 = await brain.vfs.readdir('/')
|
|
expect(entries1.length).toBe(2) // readme.txt + docs/
|
|
|
|
const docEntries1 = await brain.vfs.readdir('/docs')
|
|
expect(docEntries1.length).toBe(2) // guide.txt + api.txt
|
|
|
|
// In-session getRelations: root should have Contains relationships
|
|
const rootRelations1 = await brain.getRelations({ from: rootId, type: VerbType.Contains })
|
|
expect(rootRelations1.length).toBeGreaterThan(0)
|
|
|
|
await brain.close()
|
|
|
|
// === SESSION 2: Verify all data persisted ===
|
|
brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'filesystem', rootDirectory: dir },
|
|
disableAutoRebuild: true,
|
|
plugins: [],
|
|
silent: true,
|
|
})
|
|
await brain.init()
|
|
|
|
// Root children
|
|
const entries2 = await brain.vfs.readdir('/')
|
|
expect(entries2.length).toBe(2)
|
|
expect(entries2.sort()).toEqual(['docs', 'readme.txt'])
|
|
|
|
// Subdirectory children
|
|
const docEntries2 = await brain.vfs.readdir('/docs')
|
|
expect(docEntries2.length).toBe(2)
|
|
expect(docEntries2.sort()).toEqual(['api.txt', 'guide.txt'])
|
|
|
|
// Root relations
|
|
const rootRelations = await brain.getRelations({ from: rootId, type: VerbType.Contains })
|
|
expect(rootRelations.length).toBeGreaterThan(0)
|
|
|
|
await brain.close()
|
|
} finally {
|
|
try { rmSync(dir, { recursive: true }) } catch {}
|
|
}
|
|
})
|
|
})
|