2026-01-16 17:04:09 -08:00
|
|
|
/**
|
|
|
|
|
* Integration tests for clear() VFS reinitialization fix (v7.3.1)
|
|
|
|
|
*
|
fix: recalibrate find({ limit }) cap + two-tier enforcement + caller location
Brainy 7.30.0 introduced a memory-derived synchronous cap on `find({ limit })`
to prevent OOM. The cap was sound in intent but ~4x too conservative in
calibration: assumed 100 KB per result while typical entity footprint is 7-10 KB
(384-dim float32 vector ≈ 1.5 KB + standard fields + metadata). On a 900 MB
free-memory box the cap derived to 9000 — breaking common safety-cap patterns
like `find({ type, where, limit: 10_000 })` that typically return 10-500
entities. Surfaced as a runtime regression with cascading 500s degrading
production dashboards.
Three concurrent fixes:
A. RECALIBRATE THE FORMULA
- src/utils/paramValidation.ts:175,196,212 — the three memory-derived priorities
(reservedQueryMemory / containerMemory / freeMemory) all divided by
100 * 1024 * 1024 (100 KB per result, ~10-15x over conservative). Replaced
with a new MAX_LIMIT_KB_PER_RESULT = 25 constant that matches observed
entity size.
- Result: 4 GB container cap goes 10_000 → 40_000; 2 GB cap goes 5_000 →
20_000; 900 MB free-memory cap goes 9_000 → ~36_000. 100k hard ceiling
unchanged. `maxQueryLimit` / `reservedQueryMemory` constructor overrides
unchanged in behavior.
B. TWO-TIER ENFORCEMENT (warn-then-throw)
- Below cap (limit <= maxLimit): silent pass, unchanged.
- Soft tier (maxLimit < limit <= 2 * maxLimit): NEW — one-time warning per
call site (dedup keyed on caller stack frame + limit value), query
proceeds. Pre-7.30.2 code that relied on the cap silently allowing typical
safety-cap limits keeps working; the warning teaches the recipe so consumers
can fix it intentionally.
- Hard tier (limit > 2 * maxLimit): throw with the same teaching message
format. Real OOM territory; the cap stops being a recommendation and becomes
a guardrail.
- The 2x soft margin absorbs typical safety-cap patterns (limit: 10_000
against a 9 K-cap box) without disabling OOM protection. Real OOM territory
on a JS in-memory brain is hundreds of thousands of results, not 10x the
safety cap.
C. IMPROVED ERROR / WARNING MESSAGE
- Same shape as the 7.30.1 enforcement-error messages: state the problem,
name the three escape valves (maxQueryLimit / reservedQueryMemory /
pagination), include caller location, link to docs.
- Extracted findCallerLocation() helper from brainy.ts to a new
src/utils/callerLocation.ts so both the subtype enforcement (7.30.1) and
the limit enforcement (7.30.2) share one implementation without circular
imports.
DOCS
- New docs/guides/find-limits.md (public: true) — full reference: why the cap
exists, the four memory sources the auto-config considers, the three escape
valves with when-to-use-which guidance, and an explicit "pagination is the
future-proof pattern" callout (8.0 may tighten the cap further; pagination
keeps working unchanged).
- docs/api/README.md find() entry gets a one-paragraph `limit` tip + pointer
to the new guide.
- RELEASES.md v7.30.2 entry.
TESTS
- New tests/integration/find-limits.test.ts (9 tests): below-cap silent pass;
soft-tier warns once per call site (dedup verified by exercising same vs.
different source lines via wrapper closures); soft-tier message format
(names all three escape valves + docs link); soft-tier message includes
caller location; hard-tier throws; hard-tier message format same as
soft-tier; consumer maxQueryLimit override raises the cap and shifts both
tiers accordingly; pre-7.30.2 regression scenario explicitly covered.
- tests/unit/utils/memoryLimits.test.ts — 4 tests updated for the recalibrated
cap values (hardcoded expected numbers bumped 4x to match new 25 KB/result
assumption).
- tests/unit/utils/paramValidation.test.ts — auto-limit test extended to cover
the three-tier semantics (below-cap pass / soft-tier silent / hard-tier
throw).
- Existing suites unchanged: subtype-and-facets 26/26, verb-subtype-and-
enforcement 30/30, strict-mode-self-test 13/13. Unit 1468/1468.
CORTEX COMPATIBILITY
- Zero Cortex changes required. Every change is JS-side: formula recalibration
runs in ValidationConfig.constructor(), two-tier enforcement runs in
validateFindParams(), both fire before any storage / index / Cortex call.
- The new guide notes that Brainy 8.0's Datomic-style Db.find() may tighten
per-call limits to keep snapshot semantics cheap; pagination remains the
pattern that's guaranteed to keep working.
REPO-WIDE CLEANUP
Brainy is the only Soulcraft project that is open source. This commit also
scrubs closed-source product names and product-specific class/field references
from every tracked file in the repo (src/, docs/, tests/, RELEASES.md,
CHANGELOG.md). Consumer-reported bugs, regression scenarios, and release
notes now refer to "a consumer", "a downstream application", "a production
deployment", or "an internal report" — never to the named product. Two
product-named test files renamed to neutral diagnostic names. CLAUDE.md gains
a project-level guard rule documenting the policy and an example list of the
identifiers that may not appear in tracked code.
Verification
- npx tsc --noEmit: clean
- npm test: 1468 / 1468 unit
- All four integration subtype + verb + strict + find-limits suites: 78/78
- npm run build: clean
- Closed-source product reference audit: clean
2026-06-08 12:34:05 -07:00
|
|
|
* Bug report: a consumer team reported that brain.clear() breaks VFS operations.
|
2026-01-16 17:04:09 -08:00
|
|
|
* After calling clear(), VFS operations fail with:
|
|
|
|
|
* "Error: Source entity 00000000-0000-0000-0000-000000000000 not found"
|
|
|
|
|
*
|
|
|
|
|
* Root cause: clear() deleted the VFS root entity but didn't reset/reinitialize
|
|
|
|
|
* the VFS instance. The VFS remained in memory pointing to the deleted root.
|
|
|
|
|
*
|
2026-06-11 08:37:26 -07:00
|
|
|
* Fix: clear() resets the in-memory VFS instance so the next VFS operation
|
|
|
|
|
* lazily reinitializes against a fresh root entity.
|
2026-01-16 17:04:09 -08:00
|
|
|
*
|
|
|
|
|
* These tests verify:
|
|
|
|
|
* 1. VFS operations work after clear() without instance recreation
|
|
|
|
|
* 2. clear() works when VFS was never used
|
|
|
|
|
* 3. VFS root entity is properly reinitialized
|
|
|
|
|
* 4. Old VFS data is actually deleted
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import { describe, it, expect } from 'vitest'
|
|
|
|
|
import { Brainy } from '../../src/brainy.js'
|
|
|
|
|
import * as fs from 'fs'
|
|
|
|
|
|
|
|
|
|
describe('VFS operations after clear() (v7.3.1 fix)', () => {
|
|
|
|
|
// Use unique paths per test to avoid filesystem conflicts
|
|
|
|
|
const getTestPath = () => `./test-clear-vfs-${Date.now()}-${Math.random().toString(36).slice(2)}`
|
|
|
|
|
|
|
|
|
|
// Helper to clean up brain and storage after each test
|
|
|
|
|
async function cleanup(brain: Brainy | null, storagePath?: string) {
|
|
|
|
|
try {
|
|
|
|
|
if (brain) {
|
|
|
|
|
await brain.close()
|
|
|
|
|
}
|
|
|
|
|
} catch (e) {
|
|
|
|
|
// Ignore close errors
|
|
|
|
|
}
|
|
|
|
|
try {
|
|
|
|
|
if (storagePath && fs.existsSync(storagePath)) {
|
|
|
|
|
await fs.promises.rm(storagePath, { recursive: true, force: true })
|
|
|
|
|
}
|
|
|
|
|
} catch (e) {
|
|
|
|
|
// Ignore cleanup errors
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
it('should allow VFS operations after brain.clear() without recreation (memory)', async () => {
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' } })
|
2026-01-16 17:04:09 -08:00
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Use VFS before clear
|
|
|
|
|
await brain.vfs.writeFile('/test.txt', Buffer.from('hello'))
|
|
|
|
|
const contentBefore = await brain.vfs.readFile('/test.txt')
|
|
|
|
|
expect(contentBefore.toString()).toBe('hello')
|
|
|
|
|
|
|
|
|
|
// Clear all data
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// VFS should work immediately without needing instance recreation
|
|
|
|
|
await brain.vfs.writeFile('/after-clear.txt', Buffer.from('world'))
|
|
|
|
|
const contentAfter = await brain.vfs.readFile('/after-clear.txt')
|
|
|
|
|
expect(contentAfter.toString()).toBe('world')
|
|
|
|
|
|
|
|
|
|
// Original file should not exist
|
|
|
|
|
await expect(brain.vfs.readFile('/test.txt')).rejects.toThrow()
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should allow VFS operations after brain.clear() without recreation (filesystem)', async () => {
|
|
|
|
|
const testPath = getTestPath()
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false,
|
2026-01-16 17:04:09 -08:00
|
|
|
storage: { type: 'filesystem', path: testPath }
|
|
|
|
|
})
|
|
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Use VFS before clear
|
|
|
|
|
await brain.vfs.writeFile('/test.txt', Buffer.from('hello'))
|
|
|
|
|
const contentBefore = await brain.vfs.readFile('/test.txt')
|
|
|
|
|
expect(contentBefore.toString()).toBe('hello')
|
|
|
|
|
|
|
|
|
|
// Clear all data
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// VFS should work immediately without needing instance recreation
|
|
|
|
|
await brain.vfs.writeFile('/after-clear.txt', Buffer.from('world'))
|
|
|
|
|
const contentAfter = await brain.vfs.readFile('/after-clear.txt')
|
|
|
|
|
expect(contentAfter.toString()).toBe('world')
|
|
|
|
|
|
|
|
|
|
// Original file should not exist
|
|
|
|
|
await expect(brain.vfs.readFile('/test.txt')).rejects.toThrow()
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain, testPath)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should handle clear() when VFS was never used', async () => {
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' } })
|
2026-01-16 17:04:09 -08:00
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Add regular entities, don't use VFS
|
|
|
|
|
await brain.add({ data: 'test', type: 'concept' })
|
|
|
|
|
expect((await brain.find({ type: 'concept' })).length).toBe(1)
|
|
|
|
|
|
|
|
|
|
// Clear should not throw even if VFS was never accessed
|
|
|
|
|
await expect(brain.clear()).resolves.not.toThrow()
|
|
|
|
|
|
|
|
|
|
// Entities should be cleared
|
|
|
|
|
expect((await brain.find({ type: 'concept' })).length).toBe(0)
|
|
|
|
|
|
|
|
|
|
// VFS should work after clear even though it wasn't used before
|
|
|
|
|
await brain.vfs.writeFile('/new.txt', Buffer.from('content'))
|
|
|
|
|
const content = await brain.vfs.readFile('/new.txt')
|
|
|
|
|
expect(content.toString()).toBe('content')
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should reinitialize VFS root entity after clear', async () => {
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' } })
|
2026-01-16 17:04:09 -08:00
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Create directory structure
|
|
|
|
|
await brain.vfs.mkdir('/projects', { recursive: true })
|
|
|
|
|
await brain.vfs.writeFile('/projects/index.js', Buffer.from('console.log("hi")'))
|
|
|
|
|
|
|
|
|
|
// Verify VFS root exists
|
|
|
|
|
const rootBefore = await brain.vfs.stat('/')
|
|
|
|
|
expect(rootBefore.isDirectory()).toBe(true)
|
|
|
|
|
|
|
|
|
|
// Verify directory structure exists
|
|
|
|
|
const dirBefore = await brain.vfs.stat('/projects')
|
|
|
|
|
expect(dirBefore.isDirectory()).toBe(true)
|
|
|
|
|
|
|
|
|
|
// Clear
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// VFS root should be recreated
|
|
|
|
|
const rootAfter = await brain.vfs.stat('/')
|
|
|
|
|
expect(rootAfter.isDirectory()).toBe(true)
|
|
|
|
|
|
|
|
|
|
// Old directory should not exist
|
|
|
|
|
await expect(brain.vfs.stat('/projects')).rejects.toThrow()
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should work across multiple clear() cycles', async () => {
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' } })
|
2026-01-16 17:04:09 -08:00
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Cycle 1
|
|
|
|
|
await brain.vfs.writeFile('/cycle1.txt', Buffer.from('cycle1'))
|
|
|
|
|
expect((await brain.vfs.readFile('/cycle1.txt')).toString()).toBe('cycle1')
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// Cycle 2
|
|
|
|
|
await brain.vfs.writeFile('/cycle2.txt', Buffer.from('cycle2'))
|
|
|
|
|
expect((await brain.vfs.readFile('/cycle2.txt')).toString()).toBe('cycle2')
|
|
|
|
|
await expect(brain.vfs.readFile('/cycle1.txt')).rejects.toThrow()
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// Cycle 3
|
|
|
|
|
await brain.vfs.writeFile('/cycle3.txt', Buffer.from('cycle3'))
|
|
|
|
|
expect((await brain.vfs.readFile('/cycle3.txt')).toString()).toBe('cycle3')
|
|
|
|
|
await expect(brain.vfs.readFile('/cycle1.txt')).rejects.toThrow()
|
|
|
|
|
await expect(brain.vfs.readFile('/cycle2.txt')).rejects.toThrow()
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should preserve VFS functionality with nested directories after clear', async () => {
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' } })
|
2026-01-16 17:04:09 -08:00
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Create complex structure before clear
|
|
|
|
|
await brain.vfs.mkdir('/a/b/c', { recursive: true })
|
|
|
|
|
await brain.vfs.writeFile('/a/b/c/deep.txt', Buffer.from('deep content'))
|
|
|
|
|
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// Create new complex structure after clear
|
|
|
|
|
await brain.vfs.mkdir('/x/y/z', { recursive: true })
|
|
|
|
|
await brain.vfs.writeFile('/x/y/z/new-deep.txt', Buffer.from('new deep content'))
|
|
|
|
|
const content = await brain.vfs.readFile('/x/y/z/new-deep.txt')
|
|
|
|
|
expect(content.toString()).toBe('new deep content')
|
|
|
|
|
|
|
|
|
|
// Old structure should not exist
|
|
|
|
|
await expect(brain.vfs.stat('/a')).rejects.toThrow()
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should work with concurrent VFS and regular entity operations after clear', async () => {
|
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
|
|
|
const brain = new Brainy({ requireSubtype: false, storage: { type: 'memory' } })
|
2026-01-16 17:04:09 -08:00
|
|
|
try {
|
|
|
|
|
await brain.init()
|
|
|
|
|
|
|
|
|
|
// Mix VFS and regular entities before clear
|
|
|
|
|
await brain.vfs.writeFile('/config.json', Buffer.from('{"version": 1}'))
|
|
|
|
|
await brain.add({ data: 'user data', type: 'person' })
|
|
|
|
|
|
|
|
|
|
await brain.clear()
|
|
|
|
|
|
|
|
|
|
// Both should work after clear
|
|
|
|
|
await brain.vfs.writeFile('/config.json', Buffer.from('{"version": 2}'))
|
|
|
|
|
await brain.add({ data: 'new user data', type: 'person' })
|
|
|
|
|
|
|
|
|
|
const vfsContent = await brain.vfs.readFile('/config.json')
|
|
|
|
|
expect(vfsContent.toString()).toBe('{"version": 2}')
|
|
|
|
|
|
|
|
|
|
const entities = await brain.find({ type: 'person' })
|
|
|
|
|
expect(entities.length).toBe(1)
|
|
|
|
|
} finally {
|
|
|
|
|
await cleanup(brain)
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
})
|