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)
77 lines
2.3 KiB
TypeScript
77 lines
2.3 KiB
TypeScript
/**
|
|
* Test to verify correct API parameter usage
|
|
* Reproduces Brain Cloud issue where 'filter' was used instead of 'where'
|
|
*/
|
|
|
|
import { describe, it, expect, beforeAll, afterAll } from 'vitest'
|
|
import { Brainy } from '../../src/index.js'
|
|
import { NounType } from '../../src/types/graphTypes.js'
|
|
|
|
describe('API Parameter Validation', () => {
|
|
let brain: Brainy
|
|
|
|
beforeAll(async () => {
|
|
brain = new Brainy({ requireSubtype: false,
|
|
storage: { type: 'memory' }
|
|
})
|
|
await brain.init()
|
|
|
|
// Add test data
|
|
await brain.add({
|
|
data: 'Alice',
|
|
type: NounType.Person,
|
|
metadata: { category: 'test-category', status: 'active' }
|
|
})
|
|
await brain.add({
|
|
data: 'Bob',
|
|
type: NounType.Person,
|
|
metadata: { category: 'other-category', status: 'active' }
|
|
})
|
|
await brain.add({
|
|
data: 'Charlie',
|
|
type: NounType.Person,
|
|
metadata: { category: 'test-category', status: 'inactive' }
|
|
})
|
|
})
|
|
|
|
it('should use "where" parameter for metadata filtering', async () => {
|
|
const results = await brain.find({
|
|
where: { category: 'test-category' },
|
|
limit: 10
|
|
})
|
|
|
|
expect(results).toHaveLength(2)
|
|
expect(results.map(r => r.entity.data).sort()).toEqual(['Alice', 'Charlie'])
|
|
})
|
|
|
|
it('should IGNORE unknown "filter" parameter (reproduces Brain Cloud bug)', async () => {
|
|
// This is what Brain Cloud was doing - using 'filter' instead of 'where'
|
|
const results = await brain.find({
|
|
filter: { category: 'test-category' } as any, // Wrong parameter!
|
|
limit: 10
|
|
})
|
|
|
|
// Should return ALL results because filter is ignored
|
|
expect(results.length).toBeGreaterThanOrEqual(2)
|
|
})
|
|
|
|
it('should demonstrate the difference between correct and incorrect API usage', async () => {
|
|
// CORRECT: Using 'where'
|
|
const correctResults = await brain.find({
|
|
where: { category: 'test-category' },
|
|
limit: 10
|
|
})
|
|
|
|
// INCORRECT: Using 'filter' (what Brain Cloud did)
|
|
const incorrectResults = await brain.find({
|
|
filter: { category: 'test-category' } as any,
|
|
limit: 10
|
|
})
|
|
|
|
// Correct usage filters results
|
|
expect(correctResults).toHaveLength(2)
|
|
|
|
// Incorrect usage returns more results (filter ignored)
|
|
expect(incorrectResults.length).toBeGreaterThan(correctResults.length)
|
|
})
|
|
})
|