2025-10-24 11:42:47 -07:00
|
|
|
/**
|
|
|
|
|
* Debug: Check metadata index for isVFS field
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
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('Metadata Index Debug', () => {
|
|
|
|
|
const testDir = path.join(process.cwd(), 'test-metadata-index-debug')
|
|
|
|
|
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,
|
2025-10-24 11:42:47 -07:00
|
|
|
storage: {
|
|
|
|
|
type: 'filesystem',
|
|
|
|
|
options: { path: testDir }
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
await brain.init()
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
afterAll(() => {
|
|
|
|
|
if (fs.existsSync(testDir)) {
|
|
|
|
|
fs.rmSync(testDir, { recursive: true, force: true })
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should index custom metadata fields', async () => {
|
|
|
|
|
// Add entity with custom metadata field
|
|
|
|
|
const entity1 = await brain.add({
|
|
|
|
|
data: 'Test entity with custom field',
|
|
|
|
|
type: NounType.Document,
|
|
|
|
|
metadata: {
|
|
|
|
|
customFlag: true,
|
|
|
|
|
customString: 'hello',
|
|
|
|
|
customNumber: 42
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
console.log('\n📋 Added entity:', entity1.id)
|
|
|
|
|
console.log(' Metadata:', entity1.metadata)
|
|
|
|
|
|
|
|
|
|
// Try to find by custom fields
|
|
|
|
|
console.log('\n📋 Query 1: where: { customFlag: true }')
|
|
|
|
|
const result1 = await brain.find({
|
|
|
|
|
where: { customFlag: true },
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
console.log(` Results: ${result1.length}`)
|
|
|
|
|
if (result1.length > 0) {
|
|
|
|
|
console.log(` Found: ${result1[0].id}`)
|
|
|
|
|
console.log(` Metadata.customFlag: ${result1[0].metadata?.customFlag}`)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
console.log('\n📋 Query 2: where: { customString: "hello" }')
|
|
|
|
|
const result2 = await brain.find({
|
|
|
|
|
where: { customString: 'hello' },
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
console.log(` Results: ${result2.length}`)
|
|
|
|
|
|
|
|
|
|
console.log('\n📋 Query 3: where: { customNumber: 42 }')
|
|
|
|
|
const result3 = await brain.find({
|
|
|
|
|
where: { customNumber: 42 },
|
|
|
|
|
limit: 10
|
|
|
|
|
})
|
|
|
|
|
console.log(` Results: ${result3.length}`)
|
|
|
|
|
|
|
|
|
|
// Check what fields are indexed
|
|
|
|
|
console.log('\n📋 Indexed fields:')
|
|
|
|
|
const fields = await brain.getFilterFields()
|
|
|
|
|
console.log(` ${fields.join(', ')}`)
|
|
|
|
|
|
|
|
|
|
expect(result1.length).toBeGreaterThan(0)
|
|
|
|
|
expect(result2.length).toBeGreaterThan(0)
|
|
|
|
|
expect(result3.length).toBeGreaterThan(0)
|
|
|
|
|
})
|
|
|
|
|
})
|