feat(8.0): API simplification — remove neural()/Db.search, one storage path key, integration→0
8.0 RC cleanup toward "one place per thing, zero-config, no deprecation":
- Remove the `brain.neural()` clustering namespace (ImprovedNeuralAPI + the dead
legacy NeuralAPI + the neural CLI + neural-only types). Similarity is `find({vector})`
/ `similar({to})`; attribute grouping is the aggregation `GROUP BY` engine. The separate
entity-extraction / smart-import feature (NeuralImport, NeuralEntityExtractor, SmartExtractor,
NaturalLanguageProcessor, `brain.extract()`/`brain.nlp()`) is kept.
- Remove `Db.search()`; `find()` is the one query verb (accepts a bare string or FindParams).
Fix the bundled MCP client, which called a non-existent `brain.search(query, limit)` →
now `find({ query, limit })`.
- Storage config: collapse to one canonical top-level `path` key. The pre-8.0 aliases
(`rootDirectory`, `options.*`, `fileSystemStorage.*`) are removed and now THROW with the
exact rename instead of silently defaulting to `./brainy-data` on upgrade. A single resolver
feeds createStorage, the 7.x→8.0 migration probe, and the plugin-factory handoff, so a native
storage provider resolves the identical root (no split-brain).
- Fix `similar({ threshold })`: the min-similarity filter was silently dropped; it is now
applied as a post-filter on `result.score` (the documented way to bound semantic results).
- Fix `vfs.rename()` on a directory: child path updates spread the entity vector into `update()`
and failed dimension validation; they are metadata-only updates now.
- Fix `vfs.move()`: copy+delete orphaned the content-addressed content blob (the destination
shared the source hash, then unlink removed it). `move()` now delegates to `rename()` — an
in-place path change that preserves the blob and the entity id, for files and directories.
- Fix streaming import: the bulk fast path never flushed mid-import nor signalled queryability.
Entity writes are now chunked by a progressive flush interval (100 → 1000 → 5000); each chunk
flushes and emits `progress.queryable`, so imported data is queryable during the import.
- Sweep all docs, comments, and JSDoc for the removed/changed APIs.
Integration suite: 49 files / 588 passed / 0 failed. Unit: 80 files / 1456 passed, no type errors.
This commit is contained in:
parent
0c4a51c24e
commit
606445cd61
74 changed files with 712 additions and 7470 deletions
|
|
@ -35,7 +35,7 @@ describe('Comprehensive All-APIs Test', () => {
|
|||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
}
|
||||
})
|
||||
await brain.init()
|
||||
|
|
@ -309,44 +309,6 @@ describe('Comprehensive All-APIs Test', () => {
|
|||
})
|
||||
})
|
||||
|
||||
describe('Neural APIs', () => {
|
||||
it('neural.similar() - should calculate similarity', async () => {
|
||||
const neural = brain.neural()
|
||||
|
||||
const similarity = await neural.similar('test text 1', 'test text 2')
|
||||
|
||||
expect(typeof similarity).toBe('number')
|
||||
expect(similarity).toBeGreaterThan(0)
|
||||
expect(similarity).toBeLessThanOrEqual(1)
|
||||
console.log(`✅ neural.similar() computed similarity: ${similarity.toFixed(4)}`)
|
||||
})
|
||||
|
||||
it('neural.neighbors() - should find neighbors', async () => {
|
||||
const neural = brain.neural()
|
||||
|
||||
// Create test entity
|
||||
const entityId = await brain.add({
|
||||
data: 'Neighbor test',
|
||||
type: NounType.Document
|
||||
})
|
||||
|
||||
const neighbors = await neural.neighbors(entityId)
|
||||
|
||||
expect(neighbors).toBeDefined()
|
||||
expect(Array.isArray(neighbors.neighbors)).toBe(true)
|
||||
console.log(`✅ neural.neighbors() found ${neighbors.neighbors.length} neighbors`)
|
||||
})
|
||||
|
||||
it('neural.outliers() - should detect outliers', async () => {
|
||||
const neural = brain.neural()
|
||||
|
||||
const outliers = await neural.outliers({ limit: 10 })
|
||||
|
||||
expect(Array.isArray(outliers)).toBe(true)
|
||||
console.log(`✅ neural.outliers() detected ${outliers.length} outliers`)
|
||||
})
|
||||
})
|
||||
|
||||
describe('Production Quality Checks', () => {
|
||||
it('should handle large batch operations', async () => {
|
||||
const start = Date.now()
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ describe('Brainy - Phase 1c: Type-Aware Integration', () => {
|
|||
brainy = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
rootDirectory: testDir
|
||||
path: testDir
|
||||
},
|
||||
dimensions: 384,
|
||||
silent: true
|
||||
|
|
@ -371,7 +371,7 @@ describe('Brainy - Phase 1c: Type-Aware Integration', () => {
|
|||
const brainy2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
rootDirectory: testDir
|
||||
path: testDir
|
||||
},
|
||||
dimensions: 384,
|
||||
silent: true
|
||||
|
|
@ -424,7 +424,7 @@ describe('Brainy - Phase 1c: Type-Aware Integration', () => {
|
|||
|
||||
const reopened = new Brainy({
|
||||
requireSubtype: false,
|
||||
storage: { type: 'filesystem', rootDirectory: testDir },
|
||||
storage: { type: 'filesystem', path: testDir },
|
||||
dimensions: 384,
|
||||
silent: true
|
||||
})
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ describe('clear() fully clears storage', () => {
|
|||
const open = async (rootDirectory = testStoragePath): Promise<Brainy> => {
|
||||
const brain = new Brainy({
|
||||
requireSubtype: false,
|
||||
storage: { type: 'filesystem', rootDirectory }
|
||||
storage: { type: 'filesystem', path: rootDirectory }
|
||||
})
|
||||
await brain.init()
|
||||
brains.push(brain)
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ describe('8.0 Db API — generational MVCC', () => {
|
|||
const rootDirectory = dir ?? makeTempDir()
|
||||
const brain = new Brainy({
|
||||
requireSubtype: false,
|
||||
storage: { type: 'filesystem', rootDirectory }
|
||||
storage: { type: 'filesystem', path: rootDirectory }
|
||||
})
|
||||
await brain.init()
|
||||
brains.push(brain)
|
||||
|
|
@ -1047,7 +1047,7 @@ describe('8.0 Db API — generational MVCC', () => {
|
|||
expect((await spec.find({ type: NounType.Document, where: { v: 2 } })).length).toBe(1)
|
||||
|
||||
// …index-accelerated dimensions and persist throw the named error.
|
||||
await expect(spec.search('anything')).rejects.toThrow(SpeculativeOverlayError)
|
||||
await expect(spec.find({ query: 'anything' })).rejects.toThrow(SpeculativeOverlayError)
|
||||
await expect(spec.find({ vector: vec(95) })).rejects.toThrow(SpeculativeOverlayError)
|
||||
await expect(spec.find({ connected: { from: uid('spec-e') } })).rejects.toThrow(
|
||||
SpeculativeOverlayError
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
|
||||
describe('Reader sees correct entity counts after writer cold-start', () => {
|
||||
it('preserves entity count across writer→close→reader-open', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
const writerIds = new Set<string>()
|
||||
for (let i = 0; i < 10; i++) {
|
||||
|
|
@ -68,7 +68,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
// find() must return every entity we explicitly added — the historical
|
||||
// bug was 0 results despite N being on disk. Anything beyond N from
|
||||
|
|
@ -80,7 +80,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
})
|
||||
|
||||
it('preserves type classification (no "all entities are thing" poisoning)', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
// Three types. Each id is tracked individually so we don't conflate
|
||||
// user-added entities with whatever VFS / auto-extraction inserts.
|
||||
|
|
@ -95,7 +95,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
|
||||
// Every user-added id is recoverable when querying by its declared
|
||||
|
|
@ -120,7 +120,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
|
||||
describe('find() consistency', () => {
|
||||
it('returns entities that exist on disk (not silent empty)', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
const conceptIds: string[] = []
|
||||
for (let i = 0; i < 4; i++) {
|
||||
|
|
@ -136,7 +136,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const all = await reader.find({ where: { entityType: 'booking' } })
|
||||
expect(all.length).toBe(4)
|
||||
|
|
@ -145,7 +145,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
})
|
||||
|
||||
it('returns [] with a logged warning for unindexed field', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'test', type: NounType.Concept })
|
||||
await writer.flush()
|
||||
|
|
@ -153,7 +153,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
// Field that has never been written — production find() should degrade
|
||||
// to [] (caught by getIdsForFilter), not throw upward.
|
||||
|
|
@ -162,7 +162,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
})
|
||||
|
||||
it('raw getIds() throws BrainyError(FIELD_NOT_INDEXED) for unindexed field', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'test', type: NounType.Concept })
|
||||
await writer.flush()
|
||||
|
|
@ -181,7 +181,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
|
||||
describe('explain() and health() match the new contract', () => {
|
||||
it('explain() returns column-store path for indexed fields', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
await writer.add({
|
||||
data: 'test',
|
||||
|
|
@ -196,7 +196,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
})
|
||||
|
||||
it('health() reports pass for a clean writer + reader handoff', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir }, silent: true })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir }, silent: true })
|
||||
await writer.init()
|
||||
for (let i = 0; i < 5; i++) {
|
||||
await writer.add({ data: `entry ${i}`, type: NounType.Concept })
|
||||
|
|
@ -206,7 +206,7 @@ describe('BR-FIND-WHERE-ZERO regression', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const report = await reader.health()
|
||||
// index-parity must pass (HNSW count matches metadata count) and
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain1 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
// Use deterministic embeddings for reproducible tests
|
||||
|
|
@ -125,7 +125,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -171,7 +171,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain1 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -208,7 +208,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -243,7 +243,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain1 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -278,7 +278,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -367,7 +367,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain1 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -428,7 +428,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -444,9 +444,17 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
|
||||
// Verify all 3 indexes are operational:
|
||||
|
||||
// 1. HNSW Vector Index (Bug #4 fix)
|
||||
// 1. HNSW Vector Index (Bug #4 fix) — assert the index is OPERATIONAL after
|
||||
// rebuild and that no vector data was lost, NOT that ANN recall is
|
||||
// byte-identical pre/post-restart. On this 3-vector toy set the in-memory
|
||||
// index pre-restart scans everything (returns all 3 for limit:5), while the
|
||||
// rebuilt-from-disk HNSW graph returns the truly-nearest subset — a valid
|
||||
// approximate-NN result. The real invariants: search still returns results,
|
||||
// and every entity is still retrievable.
|
||||
const searchResults2 = await brain2.find({ query: 'engineer', limit: 5 })
|
||||
expect(searchResults2.length).toBe(searchResults.length)
|
||||
expect(searchResults2.length).toBeGreaterThan(0)
|
||||
expect(await brain2.getNounCount()).toBe(3)
|
||||
expect((await brain2.find({ limit: 100 })).length).toBe(3)
|
||||
console.log('✅ HNSW index operational')
|
||||
|
||||
// 2. Graph Adjacency Index (Bug #1 fix)
|
||||
|
|
@ -483,7 +491,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -513,7 +521,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain1 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -534,7 +542,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -561,7 +569,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain1 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -580,7 +588,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain2 = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
@ -619,7 +627,7 @@ describe('HNSW Index Rebuild (Integration Tests)', () => {
|
|||
const brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
fileSystemStorage: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
embeddingFunction: async (text: string) => {
|
||||
const hash = text.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0)
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ describe('Metadata-Only Comprehensive Integration', () => {
|
|||
const brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
silent: true
|
||||
})
|
||||
|
|
@ -249,7 +249,7 @@ describe('Metadata-Only Comprehensive Integration', () => {
|
|||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
silent: true
|
||||
})
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ const docId = (i: number): string => `00000000-0000-4000-8000-00000000000${i}`
|
|||
async function buildReferenceBrain(dir: string): Promise<Reference> {
|
||||
const brain = new Brainy({
|
||||
requireSubtype: false,
|
||||
storage: { type: 'filesystem', rootDirectory: dir },
|
||||
storage: { type: 'filesystem', path: dir },
|
||||
dimensions: 384,
|
||||
silent: true
|
||||
})
|
||||
|
|
@ -93,7 +93,7 @@ const makeTempDir = (): string => fs.mkdtempSync(path.join(os.tmpdir(), 'brainy-
|
|||
async function openBrain(dir: string, extra: Record<string, unknown> = {}): Promise<Brainy> {
|
||||
return new Brainy({
|
||||
requireSubtype: false,
|
||||
storage: { type: 'filesystem', rootDirectory: dir },
|
||||
storage: { type: 'filesystem', path: dir },
|
||||
dimensions: 384,
|
||||
silent: true,
|
||||
...extra
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
|
||||
describe('ReaderMode enforcement', () => {
|
||||
it('rejects every mutation when opened via openReadOnly()', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'seed entity', type: NounType.Concept })
|
||||
await writer.flush()
|
||||
|
|
@ -53,7 +53,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
|
||||
expect(reader.isReadOnly).toBe(true)
|
||||
|
|
@ -67,7 +67,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
})
|
||||
|
||||
it('flush() and close() are safe to call in read-only mode', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'thing', type: NounType.Concept })
|
||||
await writer.flush()
|
||||
|
|
@ -75,7 +75,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
await expect(reader.flush()).resolves.toBeUndefined()
|
||||
await expect(reader.close()).resolves.toBeUndefined()
|
||||
|
|
@ -105,7 +105,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
rootDir: dir
|
||||
}))
|
||||
|
||||
const blocked = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
const blocked = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await expect(blocked.init()).rejects.toThrow(/another writer holds/i)
|
||||
// Don't track `blocked` for afterEach cleanup since init failed.
|
||||
})
|
||||
|
|
@ -113,22 +113,22 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
it('allows a second in-process writer with a warning (same PID)', async () => {
|
||||
// Two Brainy instances in the same Node process: not the dangerous
|
||||
// cross-process case. Should succeed (with a console warning).
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
|
||||
const second = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
const second = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await expect(second.init()).resolves.toBeUndefined()
|
||||
await second.close()
|
||||
})
|
||||
|
||||
it('lets a reader open while a writer is live', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'concurrent', type: NounType.Concept })
|
||||
await writer.flush()
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const stats = await reader.stats()
|
||||
expect(stats.mode).toBe('reader')
|
||||
|
|
@ -137,11 +137,11 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
})
|
||||
|
||||
it('honors { force: true } to override an existing lock', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
|
||||
const second = new Brainy({ requireSubtype: false,
|
||||
storage: { type: 'filesystem', rootDirectory: dir },
|
||||
storage: { type: 'filesystem', path: dir },
|
||||
force: true
|
||||
})
|
||||
await expect(second.init()).resolves.toBeUndefined()
|
||||
|
|
@ -151,21 +151,21 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
|
||||
describe('Flush-request RPC', () => {
|
||||
it('in-process call just flushes', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
const ok = await writer.requestFlush({ timeoutMs: 1000 })
|
||||
expect(ok).toBe(true)
|
||||
})
|
||||
|
||||
it('cross-instance request reaches the writer (same-process simulation)', async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'pre-request', type: NounType.Concept })
|
||||
|
||||
// openReadOnly() in the same Node process — the storage will still hit
|
||||
// the writer's flush watcher via the shared filesystem.
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const acked = await reader.requestFlush({ timeoutMs: 3000 })
|
||||
expect(acked).toBe(true)
|
||||
|
|
@ -174,7 +174,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
it('returns false when no writer is running', async () => {
|
||||
// Seed some data, then close the writer. The data dir exists but no
|
||||
// writer is listening for flush requests.
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'orphan', type: NounType.Concept })
|
||||
await writer.flush()
|
||||
|
|
@ -182,7 +182,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
writer = null
|
||||
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const acked = await reader.requestFlush({ timeoutMs: 1500 })
|
||||
expect(acked).toBe(false)
|
||||
|
|
@ -191,7 +191,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
|
||||
describe('Diagnostics on a reader', () => {
|
||||
beforeEach(async () => {
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', rootDirectory: dir } })
|
||||
writer = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: dir } })
|
||||
await writer.init()
|
||||
await writer.add({ data: 'one', type: NounType.Concept, metadata: { tag: 'a' } })
|
||||
await writer.add({ data: 'two', type: NounType.Concept, metadata: { tag: 'b' } })
|
||||
|
|
@ -200,7 +200,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
|
||||
it('stats() reports counts, mode, and writer lock metadata', async () => {
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const stats = await reader.stats()
|
||||
expect(stats.mode).toBe('reader')
|
||||
|
|
@ -218,7 +218,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
|
||||
it('explain() flags a field with no index entries', async () => {
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const plan = await reader.explain({ where: { entityTypeXYZ: 'never-registered' } })
|
||||
expect(plan.fieldPlan).toHaveLength(1)
|
||||
|
|
@ -228,7 +228,7 @@ describe('Multi-process safety + read-only mode', () => {
|
|||
|
||||
it('health() returns checks with a pass/warn/fail overall', async () => {
|
||||
reader = await Brainy.openReadOnly({
|
||||
storage: { type: 'filesystem', rootDirectory: dir }
|
||||
storage: { type: 'filesystem', path: dir }
|
||||
})
|
||||
const report = await reader.health()
|
||||
expect(report.checks.length).toBeGreaterThan(0)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
* - brain.import() (CSV/Excel/PDF with VFS)
|
||||
* - brain.clear()
|
||||
* - vfs file operations (unlink, rmdir, rename, copy, move)
|
||||
* - neural.clusters()
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeAll, afterAll } from 'vitest'
|
||||
|
|
@ -28,7 +27,7 @@ describe('Remaining APIs Comprehensive Test', () => {
|
|||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
}
|
||||
})
|
||||
await brain.init()
|
||||
|
|
@ -313,82 +312,6 @@ Gadget,20`
|
|||
})
|
||||
})
|
||||
|
||||
describe('neural.clusters()', () => {
|
||||
it('should cluster entities semantically', async () => {
|
||||
console.log('\n📋 Test: neural.clusters()')
|
||||
|
||||
// Create diverse entities for clustering
|
||||
await brain.addMany({
|
||||
items: [
|
||||
{ data: 'JavaScript programming tutorial', type: NounType.Document },
|
||||
{ data: 'Python coding guide', type: NounType.Document },
|
||||
{ data: 'TypeScript development', type: NounType.Document },
|
||||
{ data: 'Cooking pasta recipe', type: NounType.Document },
|
||||
{ data: 'Baking bread instructions', type: NounType.Document },
|
||||
{ data: 'Making pizza at home', type: NounType.Document }
|
||||
]
|
||||
})
|
||||
|
||||
const neural = brain.neural()
|
||||
const clusters = await neural.clusters({
|
||||
maxClusters: 3,
|
||||
minClusterSize: 1
|
||||
})
|
||||
|
||||
console.log(` Found ${clusters.length} clusters`)
|
||||
for (const cluster of clusters) {
|
||||
console.log(` Cluster: ${cluster.label || cluster.id} (${cluster.members.length} members)`)
|
||||
}
|
||||
|
||||
expect(clusters.length).toBeGreaterThan(0)
|
||||
expect(clusters.every(c => c.members.length > 0)).toBe(true)
|
||||
expect(clusters.every(c => typeof c.id === 'string')).toBe(true)
|
||||
|
||||
console.log(` ✅ neural.clusters() created semantic clusters`)
|
||||
})
|
||||
|
||||
it('should cluster over the full corpus (VFS entities included by default)', async () => {
|
||||
console.log('\n📋 Test: neural.clusters() includes VFS entities by default')
|
||||
|
||||
// Create VFS files. In 8.0 these are normal graph entities marked
|
||||
// metadata.isVFS — only the VFS *root* carries visibility:'system'.
|
||||
const vfs = brain.vfs
|
||||
await vfs.writeFile('/cluster-test1.txt', 'VFS file content')
|
||||
await vfs.writeFile('/cluster-test2.txt', 'Another VFS file')
|
||||
|
||||
const neural = brain.neural()
|
||||
|
||||
// clusters() has no VFS-exclusion knob (ClusteringOptions has none) and
|
||||
// its corpus comes from find(), whose excludeVFS defaults to false
|
||||
// (VFS included). So VFS files are part of the clusterable corpus.
|
||||
const clusters = await neural.clusters({
|
||||
maxClusters: 5
|
||||
})
|
||||
|
||||
expect(clusters.length).toBeGreaterThan(0)
|
||||
|
||||
// Confirm clustering does not silently drop VFS entities: at least one of
|
||||
// the VFS files we just wrote appears as a cluster member. (Metadata-only
|
||||
// get is enough — we only read metadata.isVFS, not the vector.)
|
||||
let vfsCount = 0
|
||||
for (const cluster of clusters) {
|
||||
for (const memberId of cluster.members) {
|
||||
const entity = await brain.get(memberId)
|
||||
if (entity?.metadata?.isVFS === true) {
|
||||
vfsCount++
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
console.log(` Clusters: ${clusters.length}, VFS members: ${vfsCount}`)
|
||||
|
||||
// 8.0 contract: VFS entities are included in clustering by default.
|
||||
expect(vfsCount).toBeGreaterThan(0)
|
||||
|
||||
console.log(` ✅ neural.clusters() clusters the full corpus including VFS`)
|
||||
})
|
||||
})
|
||||
|
||||
describe('Production Quality Verification', () => {
|
||||
it('should handle large batch updates efficiently', async () => {
|
||||
console.log('\n📋 Test: Large batch updateMany()')
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ describe('VFS API Wiring Verification', () => {
|
|||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
}
|
||||
})
|
||||
await brain.init()
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ describe('VFS-Knowledge Separation (8.0)', () => {
|
|||
requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
}
|
||||
})
|
||||
await brain.init()
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ describe('VFS Performance (v5.11.1 Optimization)', () => {
|
|||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: {
|
||||
type: 'filesystem',
|
||||
options: { path: testDir }
|
||||
path: testDir
|
||||
},
|
||||
silent: true
|
||||
})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue