2026-01-26 17:16:18 -08:00
|
|
|
/**
|
|
|
|
|
* Hybrid Search COW Integration Tests (v7.7.0)
|
|
|
|
|
*
|
|
|
|
|
* Verifies that hybrid search works correctly with:
|
|
|
|
|
* - fork() - COW branching
|
|
|
|
|
* - asOf() - Historical queries
|
|
|
|
|
* - VFS entities
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import { describe, it, expect, beforeEach, afterEach } from 'vitest'
|
|
|
|
|
import { Brainy } from '../../src/brainy'
|
|
|
|
|
import { NounType } from '../../src/types/graphTypes'
|
|
|
|
|
import * as fs from 'fs'
|
|
|
|
|
import * as path from 'path'
|
|
|
|
|
import * as os from 'os'
|
|
|
|
|
|
|
|
|
|
describe('Hybrid Search with COW (v7.7.0)', () => {
|
|
|
|
|
let brain: Brainy<any>
|
|
|
|
|
let testDir: string
|
|
|
|
|
|
|
|
|
|
beforeEach(async () => {
|
|
|
|
|
// Use filesystem storage for COW support
|
|
|
|
|
testDir = path.join(os.tmpdir(), `brainy-cow-test-${Date.now()}`)
|
|
|
|
|
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,
|
2026-01-26 17:16:18 -08:00
|
|
|
storage: {
|
|
|
|
|
type: 'filesystem',
|
|
|
|
|
options: { basePath: testDir }
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
await brain.init()
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
afterEach(async () => {
|
|
|
|
|
await brain.close()
|
|
|
|
|
// Cleanup test directory
|
|
|
|
|
try {
|
|
|
|
|
fs.rmSync(testDir, { recursive: true, force: true })
|
|
|
|
|
} catch (e) {
|
|
|
|
|
// Ignore cleanup errors
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
describe('fork() compatibility', () => {
|
|
|
|
|
it('should perform hybrid search in forked brain', async () => {
|
|
|
|
|
// Add entity to main branch
|
|
|
|
|
const mainId = await brain.add({
|
|
|
|
|
data: 'Python programming language tutorial',
|
|
|
|
|
type: NounType.Document,
|
|
|
|
|
metadata: { branch: 'main' }
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Commit main branch
|
|
|
|
|
await brain.commit({ message: 'Add Python doc' })
|
|
|
|
|
|
|
|
|
|
// Fork
|
|
|
|
|
const fork = await brain.fork('feature-branch')
|
|
|
|
|
|
|
|
|
|
// Add entity to fork
|
|
|
|
|
const forkId = await fork.add({
|
|
|
|
|
data: 'JavaScript programming guide',
|
|
|
|
|
type: NounType.Document,
|
|
|
|
|
metadata: { branch: 'feature' }
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Hybrid search in fork should find both
|
|
|
|
|
const forkResults = await fork.find({
|
|
|
|
|
query: 'programming',
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
expect(forkResults.length).toBeGreaterThanOrEqual(2)
|
|
|
|
|
expect(forkResults.some(r => r.id === mainId)).toBe(true)
|
|
|
|
|
expect(forkResults.some(r => r.id === forkId)).toBe(true)
|
|
|
|
|
|
|
|
|
|
// Hybrid search in main should only find main entity
|
|
|
|
|
const mainResults = await brain.find({
|
|
|
|
|
query: 'programming',
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
expect(mainResults.some(r => r.id === mainId)).toBe(true)
|
|
|
|
|
// Fork entity should NOT be visible in main
|
|
|
|
|
expect(mainResults.some(r => r.id === forkId)).toBe(false)
|
|
|
|
|
|
|
|
|
|
await fork.close()
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should support text-only search in forked brain', async () => {
|
|
|
|
|
await brain.add({
|
|
|
|
|
data: 'exact keyword match test',
|
|
|
|
|
type: NounType.Document,
|
|
|
|
|
metadata: { test: true }
|
|
|
|
|
})
|
|
|
|
|
await brain.commit({ message: 'Add test doc' })
|
|
|
|
|
|
|
|
|
|
const fork = await brain.fork('text-search-test')
|
|
|
|
|
|
|
|
|
|
const results = await fork.find({
|
|
|
|
|
query: 'exact keyword',
|
|
|
|
|
searchMode: 'text',
|
|
|
|
|
limit: 5
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
expect(results.length).toBeGreaterThan(0)
|
|
|
|
|
await fork.close()
|
|
|
|
|
})
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
describe('VFS compatibility', () => {
|
|
|
|
|
it('should include VFS file content in hybrid search', async () => {
|
|
|
|
|
// Write a file via VFS
|
|
|
|
|
const vfs = brain.vfs
|
|
|
|
|
await vfs.writeFile('/docs/readme.txt', 'This is a readme file with important information')
|
|
|
|
|
|
|
|
|
|
// Search should find VFS content
|
|
|
|
|
const results = await brain.find({
|
|
|
|
|
query: 'readme important',
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// VFS entities should appear in results
|
|
|
|
|
expect(results.length).toBeGreaterThan(0)
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should exclude VFS with excludeVFS flag in hybrid search', async () => {
|
|
|
|
|
// Add regular entity
|
|
|
|
|
const entityId = await brain.add({
|
|
|
|
|
data: 'regular document about readme files',
|
|
|
|
|
type: NounType.Document,
|
|
|
|
|
metadata: { source: 'api' }
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Write VFS file
|
|
|
|
|
await brain.vfs.writeFile('/readme.md', 'VFS readme content')
|
|
|
|
|
|
|
|
|
|
// Search with excludeVFS should only find regular entity
|
|
|
|
|
const results = await brain.find({
|
|
|
|
|
query: 'readme',
|
|
|
|
|
excludeVFS: true,
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
expect(results.some(r => r.id === entityId)).toBe(true)
|
|
|
|
|
// VFS entities should be excluded
|
|
|
|
|
expect(results.every(r => !r.metadata?.vfsType)).toBe(true)
|
|
|
|
|
})
|
|
|
|
|
})
|
|
|
|
|
})
|