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)
90 lines
3.1 KiB
TypeScript
90 lines
3.1 KiB
TypeScript
/**
|
|
* Diagnostic: Check if isVFS flag is actually being stored
|
|
*/
|
|
|
|
import { describe, it, expect, beforeAll, afterAll } from 'vitest'
|
|
import { Brainy } from '../../src/brainy.js'
|
|
import { NounType } from '../../src/types/graphTypes.js'
|
|
import * as fs from 'fs'
|
|
import * as path from 'path'
|
|
|
|
describe('isVFS Flag Diagnostic', () => {
|
|
const testDir = path.join(process.cwd(), 'test-isvfs-diagnostic')
|
|
let brain: Brainy
|
|
|
|
beforeAll(async () => {
|
|
if (fs.existsSync(testDir)) {
|
|
fs.rmSync(testDir, { recursive: true, force: true })
|
|
}
|
|
fs.mkdirSync(testDir, { recursive: true })
|
|
|
|
brain = new Brainy({ requireSubtype: false,
|
|
storage: {
|
|
type: 'filesystem',
|
|
options: { path: testDir }
|
|
}
|
|
})
|
|
await brain.init()
|
|
})
|
|
|
|
afterAll(() => {
|
|
if (fs.existsSync(testDir)) {
|
|
fs.rmSync(testDir, { recursive: true, force: true })
|
|
}
|
|
})
|
|
|
|
it('should show what entities are created', async () => {
|
|
// Create VFS file
|
|
const vfs = brain.vfs
|
|
await vfs.init()
|
|
await vfs.writeFile('/test.txt', 'Hello World')
|
|
|
|
// Get ALL entities
|
|
console.log('\n📋 All entities in database:')
|
|
const allEntities = await brain.find({ limit: 100, includeVFS: true })
|
|
console.log(` Total: ${allEntities.length}`)
|
|
|
|
for (const entity of allEntities) {
|
|
console.log(`\n Entity: ${entity.id}`)
|
|
console.log(` Type: ${entity.type}`)
|
|
console.log(` Metadata keys: ${Object.keys(entity.metadata || {}).join(', ')}`)
|
|
if (entity.metadata?.path) {
|
|
console.log(` Path: ${entity.metadata.path}`)
|
|
}
|
|
if (entity.metadata?.vfsType) {
|
|
console.log(` VfsType: ${entity.metadata.vfsType}`)
|
|
}
|
|
if (entity.metadata?.isVFS !== undefined) {
|
|
console.log(` isVFS: ${entity.metadata.isVFS}`)
|
|
}
|
|
if (entity.metadata?.name) {
|
|
console.log(` Name: ${entity.metadata.name}`)
|
|
}
|
|
}
|
|
|
|
// Try different queries
|
|
console.log('\n\n📋 Query 1: brain.find({ limit: 100 }) [default, no includeVFS]')
|
|
const query1 = await brain.find({ limit: 100 })
|
|
console.log(` Results: ${query1.length}`)
|
|
|
|
console.log('\n📋 Query 2: brain.find({ limit: 100, includeVFS: true })')
|
|
const query2 = await brain.find({ limit: 100, includeVFS: true })
|
|
console.log(` Results: ${query2.length}`)
|
|
|
|
console.log('\n📋 Query 3: brain.find({ where: { isVFS: true } })')
|
|
const query3 = await brain.find({ where: { isVFS: true }, limit: 100 })
|
|
console.log(` Results: ${query3.length}`)
|
|
|
|
console.log('\n📋 Query 4: brain.find({ where: { path: "/test.txt" } })')
|
|
const query4 = await brain.find({ where: { path: '/test.txt' }, limit: 100 })
|
|
console.log(` Results: ${query4.length}`)
|
|
|
|
console.log('\n📋 Query 5: brain.find({ type: NounType.Document })')
|
|
const query5 = await brain.find({ type: NounType.Document, limit: 100 })
|
|
console.log(` Results: ${query5.length}`)
|
|
|
|
console.log('\n📋 Query 6: brain.find({ type: NounType.Document, includeVFS: true })')
|
|
const query6 = await brain.find({ type: NounType.Document, includeVFS: true, limit: 100 })
|
|
console.log(` Results: ${query6.length}`)
|
|
})
|
|
})
|