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:
David Snelling 2026-06-09 14:58:25 -07:00
parent 221fc45889
commit 780fb6444b
117 changed files with 282 additions and 282 deletions

View file

@ -32,7 +32,7 @@ describe('EntityIdMapper stability (foundation for 2.4.0)', () => {
let brain: Brainy
beforeEach(async () => {
brain = new Brainy({ storage: { type: 'memory' }, silent: true })
brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
await brain.init()
})

View file

@ -196,7 +196,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
describe('Brain Integration', () => {
it('should configure memory limits via Brain constructor', async () => {
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
maxQueryLimit: 15000,
silent: true
@ -214,7 +214,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
})
it('should configure reserved memory via Brain constructor', async () => {
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
reservedQueryMemory: 500 * 1024 * 1024, // 500 MB
silent: true
@ -236,7 +236,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
it('should auto-detect container limits when no config provided', async () => {
process.env.CLOUD_RUN_MEMORY = '2Gi'
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
silent: true
})
@ -260,7 +260,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
it('should return complete memory statistics', async () => {
process.env.CLOUD_RUN_MEMORY = '4Gi'
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
maxQueryLimit: 20000,
silent: true
@ -301,7 +301,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
process.env.CLOUD_RUN_MEMORY = '4Gi'
// Don't set overrides, let it use containerMemory
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
silent: true
})
@ -317,7 +317,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
})
it('should handle browser environment gracefully', async () => {
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
silent: true
})
@ -338,7 +338,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
it('should handle 4GB Cloud Run container optimally', async () => {
process.env.CLOUD_RUN_MEMORY = '4Gi'
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
silent: true
})
@ -360,7 +360,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
it('should allow manual override for power users', async () => {
process.env.CLOUD_RUN_MEMORY = '4Gi'
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
maxQueryLimit: 50000, // Power user wants higher limit
silent: true
@ -383,7 +383,7 @@ describe('Memory Limits - Container Detection & Smart Calculation', () => {
it('should handle bare metal deployment (no container)', async () => {
// No container env vars
const brain = new Brainy({
const brain = new Brainy({ requireSubtype: false,
storage: { type: 'memory' },
silent: true
})

View file

@ -169,7 +169,7 @@ describe('resultRanking — Brainy.find() integration', () => {
it('routes find() relevance ranking through a registered sort:topK provider', async () => {
const calls: Array<{ k: number; descending: boolean; n: number }> = []
const brain = new Brainy({ storage: { type: 'memory' }, silent: true })
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
brain.use(makeSortTopKPlugin(calls))
await brain.init()
await seed(brain)
@ -195,7 +195,7 @@ describe('resultRanking — Brainy.find() integration', () => {
// order, and scores must match exactly. (Two separate brains would differ due to
// independent approximate-NN candidate selection, not the ranking hook.)
const calls: Array<{ k: number; descending: boolean; n: number }> = []
const brain = new Brainy({ storage: { type: 'memory' }, silent: true })
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
brain.use(makeSortTopKPlugin(calls))
await brain.init()
await seed(brain)
@ -219,7 +219,7 @@ describe('resultRanking — Brainy.find() integration', () => {
// rather than relying on cross-query ANN stability. Also assert the provider is asked
// for the full page (offset + limit), which is what makes pagination correct.
const calls: Array<{ k: number; descending: boolean; n: number }> = []
const brain = new Brainy({ storage: { type: 'memory' }, silent: true })
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' }, silent: true })
brain.use(makeSortTopKPlugin(calls))
await brain.init()
await seed(brain)