David Snelling
780fb6444b
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)
84 lines
2.4 KiB
TypeScript
84 lines
2.4 KiB
TypeScript
/**
|
|
* VFS Initialization Tests
|
|
*
|
|
* Tests v5.1.0+ auto-initialization behavior
|
|
*/
|
|
|
|
import { describe, it, expect } from 'vitest'
|
|
import { VirtualFileSystem } from '../../src/vfs/index.js'
|
|
import { Brainy } from '../../src/brainy.js'
|
|
|
|
describe('VFS Initialization', () => {
|
|
|
|
describe('Auto-Initialization (v5.1.0+)', () => {
|
|
it('should auto-initialize VFS during brain.init()', async () => {
|
|
const brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'memory' },
|
|
silent: true
|
|
})
|
|
await brain.init()
|
|
|
|
const vfs = brain.vfs
|
|
|
|
// VFS is ready to use immediately after brain.init()
|
|
await vfs.writeFile('/test.txt', 'Hello World')
|
|
const content = await vfs.readFile('/test.txt')
|
|
expect(content.toString()).toBe('Hello World')
|
|
|
|
await brain.close()
|
|
})
|
|
|
|
it('should automatically create root directory on brain.init()', async () => {
|
|
const brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'memory' },
|
|
silent: true
|
|
})
|
|
await brain.init()
|
|
|
|
const vfs = brain.vfs
|
|
|
|
// Root directory exists after brain.init()
|
|
expect(await vfs.exists('/')).toBe(true)
|
|
|
|
// Root is a directory
|
|
const stats = await vfs.stat('/')
|
|
expect(stats.isDirectory()).toBe(true)
|
|
|
|
// Can list root directory
|
|
const entries = await vfs.readdir('/')
|
|
expect(Array.isArray(entries)).toBe(true)
|
|
|
|
await brain.close()
|
|
})
|
|
|
|
it('should handle nested directories after brain.init()', async () => {
|
|
const brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'memory' },
|
|
silent: true
|
|
})
|
|
await brain.init()
|
|
|
|
const vfs = brain.vfs
|
|
|
|
// Create nested structure
|
|
await vfs.mkdir('/documents')
|
|
await vfs.writeFile('/documents/readme.txt', 'Important info')
|
|
await vfs.mkdir('/documents/reports')
|
|
await vfs.writeFile('/documents/reports/q1.txt', 'Q1 Report')
|
|
|
|
// Verify structure
|
|
const rootEntries = await vfs.readdir('/')
|
|
expect(rootEntries).toContain('documents')
|
|
|
|
const docEntries = await vfs.readdir('/documents')
|
|
expect(docEntries).toContain('readme.txt')
|
|
expect(docEntries).toContain('reports')
|
|
|
|
const reportEntries = await vfs.readdir('/documents/reports')
|
|
expect(reportEntries).toContain('q1.txt')
|
|
|
|
await brain.close()
|
|
})
|
|
|
|
})
|
|
})
|