brainy/tests/manual/simple-vfs-filter-test.test.ts

101 lines
3.4 KiB
TypeScript
Raw Normal View History

/**
* Simple VFS filtering test
*/
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('Simple VFS Filter Test', () => {
const testDir = path.join(process.cwd(), 'test-simple-vfs-filter')
let brain: Brainy
beforeAll(async () => {
if (fs.existsSync(testDir)) {
fs.rmSync(testDir, { recursive: true, force: true })
}
fs.mkdirSync(testDir, { recursive: true })
feat(8.0)!: flip requireSubtype default to true (BRAINY-8.0-SUBTYPE-CONTRACT § C-1) 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)
2026-06-09 14:58:25 -07:00
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 demonstrate VFS filtering', async () => {
console.log('\n=== TEST START ===\n')
// 1. Create knowledge entity
console.log('1. Creating knowledge entity...')
const knowledgeId = await brain.add({
data: 'Knowledge document',
type: NounType.Document,
metadata: { title: 'Knowledge' }
})
console.log(` Created: ${knowledgeId}`)
// 2. Create VFS file
console.log('\n2. Creating VFS file...')
2025-11-02 11:38:12 -08:00
const vfs = brain.vfs
await vfs.init()
await vfs.writeFile('/test.txt', 'VFS file')
console.log(' VFS file created')
// 3. Query all (should exclude VFS)
console.log('\n3. Query: brain.find({}) [excludes VFS by default]')
const all = await brain.find({ limit: 100 })
console.log(` Results: ${all.length}`)
for (const r of all) {
console.log(` - ${r.id}, type: ${r.type}, isVFS: ${r.metadata?.isVFS}, title: ${r.metadata?.title}`)
}
// 4. Query all with VFS
console.log('\n4. Query: brain.find({ includeVFS: true })')
const allWithVFS = await brain.find({ includeVFS: true, limit: 100 })
console.log(` Results: ${allWithVFS.length}`)
for (const r of allWithVFS) {
console.log(` - ${r.id}, type: ${r.type}, isVFS: ${r.metadata?.isVFS}, path: ${r.metadata?.path || 'n/a'}`)
}
// 5. Query by type (should exclude VFS)
console.log('\n5. Query: brain.find({ type: NounType.Document }) [excludes VFS]')
const docs = await brain.find({ type: NounType.Document, limit: 100 })
console.log(` Results: ${docs.length}`)
for (const r of docs) {
console.log(` - ${r.id}, type: ${r.type}, isVFS: ${r.metadata?.isVFS}`)
}
// 6. Query by type with VFS
console.log('\n6. Query: brain.find({ type: NounType.Document, includeVFS: true })' )
const docsWithVFS = await brain.find({ type: NounType.Document, includeVFS: true, limit: 100 })
console.log(` Results: ${docsWithVFS.length}`)
for (const r of docsWithVFS) {
console.log(` - ${r.id}, type: ${r.type}, isVFS: ${r.metadata?.isVFS}, path: ${r.metadata?.path || 'n/a'}`)
}
console.log('\n=== TEST END ===\n')
// Assertions
expect(all.length).toBe(1) // Only knowledge entity
expect(all.some(r => r.id === knowledgeId)).toBe(true)
expect(allWithVFS.length).toBeGreaterThanOrEqual(2) // Knowledge + VFS entities
expect(docs.length).toBe(1) // Only knowledge entity
expect(docs.some(r => r.id === knowledgeId)).toBe(true)
expect(docsWithVFS.length).toBeGreaterThanOrEqual(2) // Knowledge + VFS file (both documents)
})
})