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)
This commit is contained in:
parent
221fc45889
commit
780fb6444b
117 changed files with 282 additions and 282 deletions
|
|
@ -34,7 +34,7 @@ describe('Brainy strict-mode self-test (7.30.1)', () => {
|
|||
// Brain-wide strict mode ON + the exact SDK_CORE_VOCABULARY shape that
|
||||
// the consumer hit. If any internal Brainy path skips subtype, the writes here
|
||||
// will throw and fail the test.
|
||||
brain = new Brainy({
|
||||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: { type: 'memory' },
|
||||
silent: true,
|
||||
requireSubtype: true
|
||||
|
|
@ -213,7 +213,7 @@ describe('Brainy strict-mode self-test (7.30.1)', () => {
|
|||
it('flags entities written without subtype (using includeVFS: true to surface even VFS gaps)', async () => {
|
||||
// Switch to a non-strict brain so we can deliberately create a gap to test detection
|
||||
await brain.close()
|
||||
brain = new Brainy({ storage: { type: 'memory' }, silent: true })
|
||||
brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
|
||||
await brain.init()
|
||||
|
||||
// Deliberately add an entity without a subtype — only allowed because
|
||||
|
|
@ -231,7 +231,7 @@ describe('Brainy strict-mode self-test (7.30.1)', () => {
|
|||
|
||||
it('excludes VFS entities by default (they bypass enforcement anyway)', async () => {
|
||||
await brain.close()
|
||||
brain = new Brainy({ storage: { type: 'memory' }, silent: true })
|
||||
brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
|
||||
await brain.init()
|
||||
|
||||
// VFS root + VFS directories all have subtype set, but even if they
|
||||
|
|
@ -253,7 +253,7 @@ describe('Brainy strict-mode self-test (7.30.1)', () => {
|
|||
describe('Error message UX', () => {
|
||||
it('error message includes caller location and migration link', async () => {
|
||||
await brain.close()
|
||||
brain = new Brainy({ storage: { type: 'memory' }, silent: true })
|
||||
brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
|
||||
await brain.init()
|
||||
brain.requireSubtype(NounType.Person, {
|
||||
values: ['employee', 'customer'],
|
||||
|
|
@ -277,7 +277,7 @@ describe('Brainy strict-mode self-test (7.30.1)', () => {
|
|||
|
||||
it('off-vocabulary message shows the offending value + allowed vocab', async () => {
|
||||
await brain.close()
|
||||
brain = new Brainy({ storage: { type: 'memory' }, silent: true })
|
||||
brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
|
||||
await brain.init()
|
||||
brain.requireSubtype(NounType.Person, {
|
||||
values: ['employee', 'customer'],
|
||||
|
|
@ -300,7 +300,7 @@ describe('Brainy strict-mode self-test (7.30.1)', () => {
|
|||
|
||||
it('brain-wide strict mode (no per-type vocab) shows the correct guidance', async () => {
|
||||
await brain.close()
|
||||
brain = new Brainy({
|
||||
brain = new Brainy({ requireSubtype: false,
|
||||
storage: { type: 'memory' },
|
||||
silent: true,
|
||||
requireSubtype: true
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue