Files
OmniRoute/tests/unit/estimateSizeFast.test.ts
Diego Rodrigues de Sa e Souza e117249baa cherry-pick(pr-9738): feat(logging): make the chat-log truncation limit configurable, bumped default 128x (#9863)
* feat(logging): make the chat-log truncation limit configurable, bumped default 128x

The 8KB cap on logged request/response bodies
(open-sse/handlers/chatCore/logTruncation.ts::truncateForLog()) was
hardcoded — trivially exceeded by any real multi-turn agentic
conversation, meaning the dashboard's "Full Conversation" panel could
only ever show a placeholder instead of the actual messages for nearly
every logged row of any conversation with real substance.

- Added CHAT_LOG_MAX_BODY_KB env var (src/lib/logEnv.ts::
  getChatLogMaxBodyBytes()), default 1024 KB (1MB) — a 128x bump from
  the old hardcoded 8KB — following the same configurable-limit pattern
  as the sibling CHAT_LOG_TEXT_LIMIT/CHAT_LOG_ARRAY_TAIL_ITEMS/etc. vars.
- Documented in .env.example and docs/reference/ENVIRONMENT.md.

estimateSizeFast() (open-sse/utils/estimateSize.ts) has been
substantially rewritten upstream since this bug was first found (now an
iterative Frame-based walker with a separate node-visit budget, not the
simple stack loop originally patched) — re-implemented the fix against
the current algorithm rather than porting the old diff: the byte
early-exit was unconditionally the module-level ESTIMATE_SIZE_BYTE_LIMIT
(256 KiB) with no way for a caller to raise it, so any caller comparing
against a bigger configured threshold could never see a size above
~256 KiB — every payload between 256 KiB and the caller's real limit
looked "under threshold" and truncation never fired, the opposite of
intended. Added an optional byteLimit parameter (default unchanged at
ESTIMATE_SIZE_BYTE_LIMIT, so isSmallEnoughForSemanticCache's existing
behavior is untouched) threaded through both the byte-check early-exit
and the node-budget-exhaustion fail-closed fallback, with
truncateForLog() now passing its own configured getChatLogMaxBodyBytes()
value through.

* feat(dashboard): show conversation session tag in request detail metadata

Adds a "Conversation" field to the request detail panel's metadata
grid (after "Combo"), showing the request's conversation id
(sessionTag) for quick reference/copy.

---------

Co-authored-by: Markus Hartung <mail@hartmark.se>
2026-08-09 09:53:21 -03:00

247 lines
9.0 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
const {
estimateSizeFast,
isSmallEnoughForSemanticCache,
ESTIMATE_SIZE_BYTE_LIMIT,
ESTIMATE_SIZE_NODE_BUDGET,
} = await import("../../open-sse/utils/estimateSize.ts");
test("estimateSizeFast returns 0 for null/undefined", () => {
assert.equal(estimateSizeFast(null), 0);
assert.equal(estimateSizeFast(undefined), 0);
});
test("estimateSizeFast counts string lengths", () => {
assert.equal(estimateSizeFast("hello"), 5);
assert.equal(estimateSizeFast(""), 0);
});
test("estimateSizeFast counts numbers as 8 bytes", () => {
assert.equal(estimateSizeFast(42), 8);
assert.equal(estimateSizeFast(0), 8);
assert.equal(estimateSizeFast(3.14), 8);
});
test("estimateSizeFast counts booleans as 4 bytes", () => {
assert.equal(estimateSizeFast(true), 4);
assert.equal(estimateSizeFast(false), 4);
});
test("estimateSizeFast walks arrays recursively", () => {
const arr = ["abc", "de", 42];
assert.equal(estimateSizeFast(arr), 3 + 2 + 8); // 13
});
test("estimateSizeFast walks objects recursively", () => {
const obj = { a: "hello", b: 42 };
assert.equal(estimateSizeFast(obj), 5 + 8); // 13
});
test("estimateSizeFast walks nested structures", () => {
const nested = { messages: [{ role: "user", content: "hi" }] };
// role=4, content=2
assert.equal(estimateSizeFast(nested), 4 + 2); // 6
});
test("estimateSizeFast handles circular references without infinite loop", () => {
const circular: Record<string, unknown> = { a: "test" };
circular.self = circular; // Create circular ref
// Should not hang — WeakSet skips already-visited objects
const result = estimateSizeFast(circular);
assert.equal(result, 4); // Only "test" (4) counted; circular ref skipped
});
test("estimateSizeFast handles deeply nested circular refs", () => {
const a: Record<string, unknown> = { val: "x" };
const b: Record<string, unknown> = { ref: a };
a.back = b;
const result = estimateSizeFast({ root: a });
assert.equal(result, 1); // "x" = 1
});
test("estimateSizeFast early-exits at 262144 bytes (256KB)", () => {
// Create a string > 256KB
const bigStr = "x".repeat(300_000);
const result = estimateSizeFast(bigStr);
assert.ok(result >= 262144, `Should early-exit, got ${result}`);
});
/**
* Real bug: the byte early-exit was unconditionally ESTIMATE_SIZE_BYTE_LIMIT
* (256 KiB) with no way for a caller to raise it, so any caller comparing
* against a bigger configured threshold (e.g. logTruncation.ts's
* getChatLogMaxBodyBytes(), default 1 MiB) could never see a size above
* ~256 KiB — every payload up to their real threshold looked "under
* threshold" and truncation never fired for anything between 256 KiB and
* the caller's actual limit, silently letting oversized bodies through.
*/
test("estimateSizeFast respects a caller-supplied byteLimit above the 256KB default", () => {
const oneMiB = 1024 * 1024;
// Multiple 200KB elements: the 2nd element alone already crosses the
// default 256KB limit, so a hardcoded-256KB implementation early-exits
// there and never accumulates the 3rd/4th elements — only a truly
// caller-configurable limit reports the full, accurate total.
const payload = Array.from({ length: 4 }, () => "x".repeat(200_000));
const trueTotal = payload.reduce((sum, s) => sum + s.length, 0);
const withDefaultLimit = estimateSizeFast(payload);
assert.ok(
withDefaultLimit < trueTotal,
`sanity: default 256KB limit must early-exit before the true total, got ${withDefaultLimit}`
);
const withCustomLimit = estimateSizeFast(payload, oneMiB);
assert.equal(
withCustomLimit,
trueTotal,
"must report the true accumulated size instead of early-exiting at the default 256KB"
);
assert.ok(withCustomLimit <= oneMiB, "payload must be recognized as under the caller's own limit");
});
test("estimateSizeFast node-budget fail-closed return respects a caller-supplied byteLimit", () => {
const oneMiB = 1024 * 1024;
const hugeSparseArray = new Proxy([] as unknown[], {
get(target, prop, receiver) {
if (prop === "length") return 5_000_000;
if (typeof prop === "string" && /^[0-9]+$/.test(prop)) return null;
return Reflect.get(target, prop, receiver);
},
});
const result = estimateSizeFast(hugeSparseArray, oneMiB);
assert.ok(
result > oneMiB,
`node-budget exhaustion must fail closed above the CALLER's limit (${oneMiB}), not the default 256KB — got ${result}`
);
});
test("estimateSizeFast checks byte limit after numbers and booleans", () => {
const almostForNumber = "x".repeat(ESTIMATE_SIZE_BYTE_LIMIT - 4);
const withNumber = estimateSizeFast([almostForNumber, 1]);
assert.ok(
withNumber > ESTIMATE_SIZE_BYTE_LIMIT,
`number contribution must trip byte limit, got ${withNumber}`
);
// boolean is 4 bytes: start 3 under the limit so adding true exceeds (not merely equals).
const almostForBool = "x".repeat(ESTIMATE_SIZE_BYTE_LIMIT - 3);
const withBool = estimateSizeFast([almostForBool, true]);
assert.ok(
withBool > ESTIMATE_SIZE_BYTE_LIMIT,
`boolean contribution must trip byte limit, got ${withBool}`
);
});
test("estimateSizeFast handles mixed object/array nesting", () => {
const data = {
choices: [
{
delta: { content: "Hello world" },
index: 0,
},
],
};
// content=11, index=8 (number), delta keys: content+delta=7, choices=8
const result = estimateSizeFast(data);
assert.ok(result > 0);
assert.ok(result < 100);
});
test("estimateSizeFast does not count keys, only values", () => {
// Object with long keys but short values
const obj = { aLongKeyName: "x", anotherLongKeyName: "y" };
assert.equal(estimateSizeFast(obj), 2); // "x" + "y"
});
test("isSmallEnoughForSemanticCache returns true for small payloads", () => {
assert.ok(isSmallEnoughForSemanticCache({ msg: "hi" }));
});
test("isSmallEnoughForSemanticCache returns false for huge payloads", () => {
const huge = { data: "x".repeat(300_000) };
assert.ok(!isSmallEnoughForSemanticCache(huge));
});
test("isSmallEnoughForSemanticCache handles circular refs gracefully", () => {
const circular: Record<string, unknown> = {};
circular.self = circular;
// Should not hang; estimateSizeFast has WeakSet protection
const result = isSmallEnoughForSemanticCache(circular);
assert.equal(result, true); // 0 bytes < 256KB
});
test("estimateSizeFast handles Map-like objects (no infinite loop on iterables)", () => {
const map = new Map<string, unknown>([["key", "value"]]);
// Maps are objects but have no enumerable own properties via for-in
const result = estimateSizeFast(map);
assert.ok(typeof result === "number");
});
/**
* Mutation-sensitive bound: a huge logical length with null/empty-object elements
* must not pre-touch every index or allocate all references. Node-budget exhaustion
* fails closed above 256 KiB so semantic-cache/admission never treat it as small.
*/
test("estimateSizeFast node budget fails closed on huge sparse null array without full traversal", () => {
let elementAccesses = 0;
const sparseNulls = new Proxy([] as unknown[], {
get(target, prop, receiver) {
if (prop === "length") return 5_000_000;
if (prop === Symbol.iterator) {
throw new Error("iterator must not be used");
}
if (typeof prop === "string" && /^[0-9]+$/.test(prop)) {
elementAccesses += 1;
return null;
}
return Reflect.get(target, prop, receiver);
},
});
const result = estimateSizeFast(sparseNulls);
assert.ok(
result > ESTIMATE_SIZE_BYTE_LIMIT,
`node-budget exhaustion must return >256KiB, got ${result}`
);
assert.ok(
elementAccesses <= ESTIMATE_SIZE_NODE_BUDGET + 8,
`must not access far beyond node budget; accesses=${elementAccesses}`
);
assert.ok(elementAccesses > 100, `expected many bounded visits, got ${elementAccesses}`);
assert.equal(isSmallEnoughForSemanticCache(sparseNulls), false);
});
test("estimateSizeFast node budget fails closed on empty-object / getter proxy array", () => {
let elementAccesses = 0;
let farGetterHits = 0;
const emptyObjectArray = new Proxy([] as unknown[], {
get(target, prop, receiver) {
if (prop === "length") return 2_000_000;
if (typeof prop === "string" && /^[0-9]+$/.test(prop)) {
const index = Number(prop);
elementAccesses += 1;
if (index >= ESTIMATE_SIZE_NODE_BUDGET) {
farGetterHits += 1;
}
// Fresh empty object per access — old impl would stack-push every reference.
return {};
}
return Reflect.get(target, prop, receiver);
},
});
const result = estimateSizeFast(emptyObjectArray);
assert.ok(result > ESTIMATE_SIZE_BYTE_LIMIT, `expected fail-closed, got ${result}`);
assert.ok(
elementAccesses <= ESTIMATE_SIZE_NODE_BUDGET + 8,
`accesses must stay near node budget; got ${elementAccesses}`
);
assert.equal(
farGetterHits,
0,
`entries beyond the node budget must not be touched; far hits=${farGetterHits}`
);
assert.equal(isSmallEnoughForSemanticCache(emptyObjectArray), false);
});