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
This commit is contained in:
David Snelling 2026-06-08 12:34:05 -07:00
parent 34e8271c53
commit 9e307e457f
35 changed files with 819 additions and 154 deletions

View file

@ -55,6 +55,7 @@ import {
validateFindParams,
recordQueryPerformance
} from './utils/paramValidation.js'
import { findCallerLocation } from './utils/callerLocation.js'
import {
SaveNounMetadataOperation,
SaveNounOperation,
@ -2773,7 +2774,7 @@ export class Brainy<T = any> implements BrainyInterface<T> {
strict: boolean
}): string {
const typeLabel = opts.kind === 'noun' ? 'NounType' : 'VerbType'
const callSite = this.findCallerLocation()
const callSite = findCallerLocation()
const vocab = opts.rule?.values ? Array.from(opts.rule.values).join(', ') : null
let head: string
@ -2803,28 +2804,9 @@ export class Brainy<T = any> implements BrainyInterface<T> {
return [head, callerLine, guidance, docLink].filter(Boolean).join('\n')
}
/**
* Extract the first non-Brainy frame from the current stack so error messages
* can point at the consumer's call site instead of Brainy internals. Returns
* `null` if the stack isn't available (some runtimes) or only contains Brainy
* frames.
*/
private findCallerLocation(): string | null {
const stack = new Error().stack
if (!stack) return null
const lines = stack.split('\n').slice(1) // drop the `Error` line
for (const raw of lines) {
const line = raw.trim()
// Skip frames inside Brainy's own files. We don't want to point the user
// at `brainy.ts:XXXX` — they need their own call site.
if (line.includes('/src/brainy.ts') || line.includes('/dist/brainy.js')) continue
if (line.includes('enforceSubtypeOn') || line.includes('formatSubtypeError')) continue
if (line.includes('findCallerLocation')) continue
// Strip leading `at ` if present so the caller can format consistently.
return line.replace(/^at /, '')
}
return null
}
// findCallerLocation is now exported from src/utils/callerLocation.ts so
// both the subtype enforcement errors here and the query-limit warnings in
// paramValidation.ts can share it without re-importing brainy.ts.
/**
* Validate a metadata bag (or top-level field assignment) against any registered
@ -4163,9 +4145,10 @@ export class Brainy<T = any> implements BrainyInterface<T> {
// Step 2: Copy storage ref (COW layer - instant!)
await refManager.copyRef(currentBranch, branchName)
// CRITICAL FIX: Verify branch was actually created to prevent silent failures
// Without this check, fork() could complete successfully but branch wouldn't exist,
// causing subsequent checkout() calls to fail (see Workshop bug report).
// CRITICAL FIX: Verify branch was actually created to prevent silent failures.
// Without this check, fork() could complete successfully but the branch wouldn't
// exist on disk, causing subsequent checkout() calls to fail with a
// "Branch does not exist" error.
const verifyBranch = await refManager.getRef(branchName)
if (!verifyBranch) {
throw new Error(
@ -4553,7 +4536,7 @@ export class Brainy<T = any> implements BrainyInterface<T> {
* - Subsequent queries: Same as normal Brainy (uses rebuilt indexes)
* - Memory overhead: Snapshot has separate in-memory indexes
*
* Use case: Workshop app - render file tree at historical commit
* Use case: rendering a file tree (or any indexed view) at a historical commit
*
* @param commitId - Commit hash to snapshot from
* @returns Read-only Brainy instance with historical state
@ -5379,7 +5362,7 @@ export class Brainy<T = any> implements BrainyInterface<T> {
/**
* Extract entities from text (alias for extract())
* Added for API clarity and Workshop team request
* Added for API clarity `extractEntities()` reads more naturally at call sites
*
* Uses NeuralEntityExtractor with SmartExtractor ensemble (4-signal architecture):
* - ExactMatch (40%) - Dictionary lookups