brainy/tests/integration/vfs-import-verification.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

269 lines
9.6 KiB
TypeScript

/**
* VFS Import Verification Test
*
* This test verifies that brain.import() creates VFS entities correctly.
* Created to investigate a consumer's report of empty VFS after import.
*
* Expected behavior:
* 1. Import with vfsPath creates directory entities
* 2. VFS entities have vfsType metadata
* 3. Directory hierarchy is created with Contains relationships
* 4. getDirectChildren() returns imported files
*/
import { describe, it, expect, beforeEach } from 'vitest'
import { Brainy } from '../../src/brainy.js'
import * as XLSX from 'xlsx'
describe('VFS Import Verification (VFS import bug investigation)', () => {
let brain: Brainy
beforeEach(async () => {
brain = new Brainy({
storage: { type: 'memory' as const }
})
await brain.init()
})
it('should create VFS entities during import with vfsPath', async () => {
// Create test Excel file (matching the reported scenario)
const testData = [
{
'Term': 'Alice',
'Definition': 'A character from Wonderland',
'Type': 'Person',
'Related Terms': 'Wonderland'
},
{
'Term': 'Wonderland',
'Definition': 'A magical place',
'Type': 'Place',
'Related Terms': 'Alice'
}
]
const worksheet = XLSX.utils.json_to_sheet(testData)
const workbook = XLSX.utils.book_new()
XLSX.utils.book_append_sheet(workbook, worksheet, 'Glossary')
const buffer = XLSX.write(workbook, { type: 'buffer', bookType: 'xlsx' })
console.log('📥 Step 1: Import with VFS options...')
const result = await brain.import(buffer, {
format: 'excel',
vfsPath: '/imports/test-glossary',
groupBy: 'type',
preserveSource: true,
enableNeuralExtraction: true,
enableRelationshipInference: true
})
console.log('✅ Step 1 Complete:')
console.log(` - Format: ${result.format}`)
console.log(` - Entities extracted: ${result.stats.entitiesExtracted}`)
console.log(` - VFS files created: ${result.stats.vfsFilesCreated}`)
console.log(` - VFS root: ${result.vfs.rootPath}`)
console.log(` - VFS directories: ${result.vfs.directories.length}`)
console.log(` - VFS files: ${result.vfs.files.length}`)
// Verify import result
expect(result.format).toBe('excel')
expect(result.stats.entitiesExtracted).toBeGreaterThanOrEqual(2)
expect(result.stats.vfsFilesCreated).toBeGreaterThan(0)
expect(result.vfs.rootPath).toBe('/imports/test-glossary')
expect(result.vfs.directories.length).toBeGreaterThan(0)
expect(result.vfs.files.length).toBeGreaterThan(0)
console.log('\n🔍 Step 2: Check VFS entities in storage...')
// Check if VFS entities exist in storage
const allEntities = await brain.find({ limit: 1000 })
console.log(` - Total entities in brain: ${allEntities.length}`)
const vfsEntities = allEntities.filter(e =>
e.metadata?.vfsType && e.metadata?.path
)
console.log(` - Entities with vfsType: ${vfsEntities.length}`)
if (vfsEntities.length > 0) {
console.log(' ✅ VFS entities found!')
console.log(' Sample VFS entities:')
vfsEntities.slice(0, 5).forEach(e => {
console.log(` - ${e.metadata.path} (${e.metadata.vfsType})`)
})
} else {
console.log(' ❌ NO VFS entities found! This is the bug!')
}
// CRITICAL CHECK: VFS entities MUST exist
expect(vfsEntities.length).toBeGreaterThan(0)
console.log('\n📂 Step 3: Initialize VFS and query...')
// Get VFS instance
const vfs = brain.vfs
console.log(' - Got VFS instance')
// Initialize VFS
await vfs.init()
console.log(' - VFS initialized')
// Query root directory
const rootItems = await vfs.getDirectChildren('/')
console.log(` - Root items: ${rootItems.length}`)
if (rootItems.length > 0) {
console.log(' ✅ Root directory has items!')
rootItems.forEach(item => {
console.log(` - ${item.metadata.name} (${item.metadata.vfsType})`)
})
} else {
console.log(' ❌ Root directory is empty!')
}
// CRITICAL CHECK: Root MUST have items (at least /imports)
expect(rootItems.length).toBeGreaterThan(0)
// Check /imports directory
console.log('\n📂 Step 4: Check /imports directory...')
const importsItems = await vfs.getDirectChildren('/imports')
console.log(` - Items in /imports: ${importsItems.length}`)
if (importsItems.length > 0) {
console.log(' ✅ /imports has items!')
importsItems.forEach(item => {
console.log(` - ${item.metadata.name} (${item.metadata.vfsType})`)
})
} else {
console.log(' ❌ /imports is empty!')
}
// CRITICAL CHECK: /imports MUST have items (at least test-glossary)
expect(importsItems.length).toBeGreaterThan(0)
// Check import directory
console.log('\n📂 Step 5: Check /imports/test-glossary directory...')
const glossaryItems = await vfs.getDirectChildren('/imports/test-glossary')
console.log(` - Items in /imports/test-glossary: ${glossaryItems.length}`)
if (glossaryItems.length > 0) {
console.log(' ✅ Import directory has items!')
glossaryItems.forEach(item => {
console.log(` - ${item.metadata.name} (${item.metadata.vfsType})`)
})
} else {
console.log(' ❌ Import directory is empty!')
}
// CRITICAL CHECK: Import directory MUST have items
// Should have: Characters/, Places/, _source.xlsx, _metadata.json, _relationships.json
expect(glossaryItems.length).toBeGreaterThanOrEqual(3)
console.log('\n✅ ALL CHECKS PASSED! VFS import is working correctly.')
}, 60000) // 60s timeout
it('should work without manual vfs.init() after import (after refactor)', async () => {
// Create test data
const testData = [
{ 'Name': 'Test Entity', 'Type': 'Thing' }
]
const worksheet = XLSX.utils.json_to_sheet(testData)
const workbook = XLSX.utils.book_new()
XLSX.utils.book_append_sheet(workbook, worksheet, 'Data')
const buffer = XLSX.write(workbook, { type: 'buffer', bookType: 'xlsx' })
console.log('📥 Import with VFS...')
await brain.import(buffer, {
format: 'excel',
vfsPath: '/imports/test',
groupBy: 'type'
})
console.log('📂 Get VFS (should be initialized by import)...')
const vfs = brain.vfs
// AFTER REFACTOR: This should work without calling vfs.init()
// Because VFSStructureGenerator uses brain.vfs which caches the instance
console.log('🔍 Query root (without manual init)...')
try {
const items = await vfs.getDirectChildren('/')
console.log(` ✅ SUCCESS: Got ${items.length} items without manual init!`)
expect(items.length).toBeGreaterThan(0)
} catch (error: any) {
if (error.message.includes('not initialized')) {
console.log(' ❌ VFS not initialized - refactor not yet implemented')
console.log(' This test will pass after VFSStructureGenerator refactor')
// For now, manually init and verify it works
await vfs.init()
const items = await vfs.getDirectChildren('/')
expect(items.length).toBeGreaterThan(0)
} else {
throw error
}
}
}, 60000)
it('should match the reported scenario exactly', async () => {
// Replicate a consumer's exact scenario
const testData = [
{ 'Term': 'Westland', 'Definition': 'Ancient kingdom', 'Type': 'Place' },
{ 'Term': 'Capital City', 'Definition': 'Main city', 'Type': 'Place' },
{ 'Term': 'Royal Dynasty', 'Definition': 'Noble family', 'Type': 'Organization' }
]
const worksheet = XLSX.utils.json_to_sheet(testData)
const workbook = XLSX.utils.book_new()
XLSX.utils.book_append_sheet(workbook, worksheet, 'Glossary')
const buffer = XLSX.write(workbook, { type: 'buffer', bookType: 'xlsx' })
console.log('📥 Importing (the reported scenario)...')
const filename = 'Tales from Talifar Glossary.xlsx'
const timestamp = Date.now()
const result = await brain.import(buffer, {
vfsPath: `/imports/${filename}-${timestamp}`,
preserveSource: true,
groupBy: 'type',
enableNeuralExtraction: true,
enableRelationshipInference: true,
enableConceptExtraction: true
})
console.log('✅ Import result:')
console.log(` - Entities: ${result.stats.entitiesExtracted}`)
console.log(` - Graph nodes: ${result.stats.graphNodesCreated}`)
console.log(` - Graph edges: ${result.stats.graphEdgesCreated}`)
console.log(` - VFS files: ${result.stats.vfsFilesCreated}`)
// Consumer's check: Initialize VFS
console.log('\n📂 Initializing VFS (post-fix)...')
const vfs = brain.vfs
await vfs.init()
// a consumer's check: Query root
console.log('🔍 Querying root directory...')
const rootItems = await vfs.getDirectChildren('/')
console.log(` - Items in root: ${rootItems.length}`)
if (rootItems.length === 0) {
console.log(' ❌ BUG REPRODUCED: Empty root after import + init!')
// Debug: Check storage for VFS entities
const allEntities = await brain.find({ limit: 1000 })
const vfsEntities = allEntities.filter(e => e.metadata?.vfsType)
console.log(` Debug: ${vfsEntities.length} VFS entities in storage`)
if (vfsEntities.length === 0) {
console.log(' Root cause: Import did NOT create VFS entities!')
} else {
console.log(' Root cause: VFS entities exist but query returns empty!')
}
} else {
console.log(' ✅ Root has items (bug not reproduced)')
}
// This test will fail if the bug exists
expect(rootItems.length).toBeGreaterThan(0)
}, 60000)
})