brainy/tests/integration/clear-vfs.test.ts
David Snelling 9e307e457f 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:49:43 -07:00

228 lines
7.8 KiB
TypeScript

/**
* Integration tests for clear() VFS reinitialization fix (v7.3.1)
*
* Bug report: a consumer team reported that brain.clear() breaks VFS operations.
* 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.
*
* Fix: Reset VFS state in clear() following the checkout() pattern.
*
* 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 () => {
const brain = new Brainy({ storage: { type: 'memory' } })
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()
const brain = new Brainy({
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 () => {
const brain = new Brainy({ storage: { type: 'memory' } })
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 () => {
const brain = new Brainy({ storage: { type: 'memory' } })
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 () => {
const brain = new Brainy({ storage: { type: 'memory' } })
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 () => {
const brain = new Brainy({ storage: { type: 'memory' } })
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 () => {
const brain = new Brainy({ storage: { type: 'memory' } })
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)
}
})
})