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)
82 lines
2.5 KiB
TypeScript
82 lines
2.5 KiB
TypeScript
/**
|
|
* Test for createEntities default value bug fix (v4.3.2)
|
|
*
|
|
* Bug: If createEntities was undefined, it defaulted to false
|
|
* Fix: Now defaults to true when undefined
|
|
*/
|
|
|
|
import { describe, it, expect, beforeEach } from 'vitest'
|
|
import { Brainy, NounType } from '../../src/index.js'
|
|
import * as fs from 'fs'
|
|
import * as path from 'path'
|
|
|
|
describe('createEntities Default Value (v4.3.2 Bug Fix)', () => {
|
|
let brain: Brainy
|
|
const testDir = './test-create-entities-default'
|
|
|
|
beforeEach(async () => {
|
|
// Clean up test directory
|
|
if (fs.existsSync(testDir)) {
|
|
fs.rmSync(testDir, { recursive: true })
|
|
}
|
|
|
|
brain = new Brainy({ requireSubtype: false,
|
|
storage: {
|
|
type: 'filesystem',
|
|
path: testDir
|
|
}
|
|
})
|
|
await brain.init()
|
|
})
|
|
|
|
afterEach(() => {
|
|
// Clean up test directory
|
|
if (fs.existsSync(testDir)) {
|
|
fs.rmSync(testDir, { recursive: true })
|
|
}
|
|
})
|
|
|
|
it('should create graph entities when createEntities is undefined (default behavior)', async () => {
|
|
// Create a minimal CSV to import
|
|
const csvContent = `Name,Type
|
|
Alice,person
|
|
Bob,person
|
|
New York,location`
|
|
|
|
const csvPath = path.join(testDir, 'test.csv')
|
|
fs.mkdirSync(testDir, { recursive: true })
|
|
fs.writeFileSync(csvPath, csvContent)
|
|
|
|
// Import WITHOUT specifying createEntities (should default to true)
|
|
const result = await brain.import(csvPath, {
|
|
vfsPath: '/imports/test',
|
|
groupBy: 'flat'
|
|
// NOTE: createEntities is NOT specified - should default to true
|
|
})
|
|
|
|
console.log('\n📊 Import Result:')
|
|
console.log(` Entities created: ${result.stats.graphNodesCreated}`)
|
|
console.log(` VFS files created: ${result.stats.vfsFilesCreated}`)
|
|
|
|
// Verify graph entities were created
|
|
expect(result.stats.graphNodesCreated).toBeGreaterThan(0)
|
|
|
|
// Verify we can query by type. The exact match-count varies with the
|
|
// import path's neural-extraction behavior; the bug this test guards
|
|
// against is "createEntities defaulted off and no graph entities were
|
|
// produced" — covered by the >0 assertions below.
|
|
const people = await brain.find({ type: NounType.Person, limit: 10 })
|
|
console.log(`\n🔍 Type Filtering:`)
|
|
console.log(` Person filter: ${people.length}`)
|
|
|
|
expect(people.length).toBeGreaterThan(0)
|
|
|
|
const locations = await brain.find({ type: NounType.Location, limit: 10 })
|
|
console.log(` Location filter: ${locations.length}`)
|
|
|
|
expect(locations.length).toBeGreaterThan(0)
|
|
|
|
console.log('\n✅ Graph entities created by default!')
|
|
})
|
|
|
|
})
|