Files
OmniRoute/open-sse/executors/tinycmsDomMocks.ts
Diego Rodrigues de Sa e Souza 4d1282be31 fix(sse): restore maxQueueDepth=0 as unbounded, sanitize refusals at the write, drain the 09-18 base-reds (#14101)
* fix(quality): drain the 09-18 base-reds, part 1 — thinking gate parity, inventory, webpack externals

Reproduced on the clean tip 7cc454d9 before touching anything.

Five of the failures trace to one commit, #12905 (b7192b72): it gated
thinking-block emission on `requestedThinking === true` in the streaming
translator, while its own non-streaming path documents `undefined` as the
legacy caller shape that keeps "always a thinking block". The two paths
disagreed on the same input, and the streaming side also synthesized the
reasoning into a TEXT block for that legacy shape. chatCore always resolves a
boolean, so production never sends `undefined` — but every direct caller and
the older #5786 suites do. Aligned the streaming gate to the documented
tri-state: `false` suppresses, `true` and `undefined` relay, and the fix-B text
synthesis fires only on an explicit opt-out. The #12905 test that asserted
suppression used a bare createState() (`undefined`) to mean "client did not
request thinking"; it now passes `requestedThinking: false`, which is what that
sentence resolves to in production. The whole thinking family — dsml, adapter,
translator, non-stream parity, #13620, #5786, markdown boundary — is 77/77.

#12864 added requestRejectedFailure.ts with a getProviderConnectionById read
that seeds the refusal streak across restarts; inventoried as a connection
state read next to the family-cooldown site it resembles.

#13909 made machineToken.ts import ./dataPaths; the isolated webpack compile has
no repo tree, so it joins the sibling externals.

The free-tier budget card SVG was one wave behind again (482 -> 491 models).

Refs #13866

* fix(sse): restore maxQueueDepth=0 as unbounded, sanitize refusals at the write, drain the rest

Part 2 of the 09-18 base-red drain. Two of the remaining failures were not
stale tests but production defects the tests had caught.

#12911 taught accountSemaphore to read `maxQueueSize: 0` as "reject when the
slot is busy", which is what its Codex WS lease wants. But chatCore forwards
`resilienceSettings.requestQueue.maxQueueDepth` into that option, and that
setting's documented default since #6593 is `0 = disabled`. Under default
settings every request that found its account slot occupied was answered
429 "Semaphore queue full (0)" instead of waiting — the managed-lease routing
test saw exactly that. `0` (and any non-positive value) is unbounded again;
the lease gets an explicit `failFast` option and its four tests stay green, so
the #12911 behaviour is preserved where it was meant to apply. A contract test
pins the #6593 semantics on the semaphore itself.

#12864 moved two providerFailure persistence branches out of chatCore into
requestRejectedFailure.ts and the sanitization did not travel with them: three
`lastError` writes stored the message as received. The only caller already
hands in the projected persistentMessage, so nothing leaks today, but a
persistence branch must be safe at its own write (docs/security/
ERROR_SANITIZATION.md) rather than trust whoever calls it. The module now
sanitizes on entry, and the public-boundary guard — which caught this by
counting sanitized writes in chatCore and coming up two short — covers the
extracted module too, verified by mutating one write back to raw.

The rest are tests that had fallen behind legitimate changes:

- #12905 inserted `requestedThinking` as the 14th positional argument of
  createSSETransformStreamWithLogger; two tests passed customToolNames or the
  buffer budget at their old positions. Both production callers were already
  correct.
- #12754 added a per-connection reset-card fetch after the quota fetch; the
  spacing test now marks a chunk at the quota request only.
- #13910 renamed `error` to `errorMetadata` in the timeout classification; the
  probe matches the identifier with a backreference and still fails when
  BodyTimeoutError is removed from both sites.

Refs #13866

* fix(test): pin the opt-out thinking cases to requestedThinking=false; keep acquireMany under the complexity ceiling

The #12905 gate-restore suite encoded 'requestedThinking absent' as opt-out, the
same undefined-means-false shape its non-streaming twin documents the other way
and that the two-month-old #5786 suites contradict. The three opt-out cases now
set the flag explicitly, which is what chatCore resolves for an opted-out
client; the two opt-in cases already did. Both suites pass together (27/27).

The failFast branch pushed acquireMany over the complexity ceiling it already
sat on; the admission policy (fail-fast / bounded / unbounded queue) moves to
findQueueRejection() and the new-code ratchet is back at its base.

Refs #13866

* fix(test): suspend the #14110 redaction assertion inline; refresh the budget card

The 57 commits merged since the previous validation moved two things.

#13295 changed how an unknown-root path with an ambiguous tail is answered:
where `Provider failed at /custom/internal secret directory` used to become
`Provider failed at <path>` it now ships verbatim. The #12506 boundary guard
caught it. Two candidate fixes were tried and each breaks one of the two live
contracts — #12506's fail-closed swallow, or #13144's rule that a route in
prose must survive — so the choice is the owner's (#14110). The one contested
assertion is suspended inline with the exact line and the issue; the other
nine stay active. The isolated-child harness requires tests == pass, which is
why it is a comment and not a todo.

The free-tier budget card was one wave behind again (491 -> 489 models).

Refs #13866, #14110

* fix(providers): type the TinyCMS DOM stub global as a loose record

#13957 typed the mock global as `typeof globalThis & Record<string, unknown>`.
The api-route typecheck loads lib.dom, so that intersection carries the real
Window / HTMLCanvasElement / document signatures — every stub assignment fails
against a DOM constructor, and `delete g.window` narrows the object to
`never` (13 diagnostics, the API Route Typecheck base-red on the tip). The
function exists to overwrite those globals with stubs; it is now typed as the
plain record it manipulates. 29/29 tinycms tests unchanged.

Refs #13866

* fix(test): pin the last opt-out thinking sibling to requestedThinking=false

translator-reasoning-gate-502-repro is the third #12905 test that encoded a bare
state as opt-out; the previous sweep matched files by glob and missed it. The
family is now enumerated by grep on requestedThinking (7 files) plus the two
pre-#12905 suites: 83/83 together.

Refs #13866
2026-09-18 13:58:56 -03:00

206 lines
6.7 KiB
TypeScript

// Runtime DOM shims for the TinyCMS wasm-bindgen glue (browser-targeted Rust).
// These are NOT test-only mocks — the WASM module reaches canvas APIs through
// generated JS that expects `window`, `document`, `HTMLCanvasElement`, and
// `CanvasRenderingContext2D` in Node.
//
// Deliberately NOT a module-load side effect: importing this file must not leak
// `global.window` into unrelated tests or Next.js SSR. Call `setupDomMocks()`
// (or the with-* wrappers) around WASM init / payload generation.
//
// Why this is load-bearing for the OmniRoute process:
// Next.js SSR uses `typeof window !== "undefined"` as a browser check and then
// `getLocationOrigin()` does `const { protocol, hostname, port } = window.location`.
// The previous shim did `g.window = g` (alias window to the Node global) without
// installing `location`. After TinyCMS ran once, every route crashed with
// `TypeError: Cannot destructure property 'protocol' of 'window.location' as it
// is undefined` until the process restarted.
//
// Belt-and-suspenders:
// 1. Never alias `window` to the Node global. Use a dedicated stub object.
// 2. Always attach a Location-shaped object (`protocol`, `hostname`, `port`,
// `href`, `origin`, …) so even a leftover `window` cannot poison Next.
// 3. Production callers restore via `withTinyCmsDomMocks*` so a successful
// TinyCMS request does not leave `window` installed for the process lifetime.
export type DomMockRestore = () => void;
export type SafeLocation = {
href: string;
origin: string;
protocol: string;
host: string;
hostname: string;
port: string;
pathname: string;
search: string;
hash: string;
assign: () => void;
reload: () => void;
replace: () => void;
toString: () => string;
};
type WindowStub = {
location: SafeLocation;
document?: unknown;
window?: WindowStub;
self?: WindowStub;
};
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null;
}
function locationIsUsable(value: unknown): value is SafeLocation {
if (!isRecord(value)) return false;
return typeof value.protocol === "string" && typeof value.hostname === "string";
}
function createSafeLocation(): SafeLocation {
const location: SafeLocation = {
href: "http://localhost/",
origin: "http://localhost",
protocol: "http:",
host: "localhost",
hostname: "localhost",
port: "",
pathname: "/",
search: "",
hash: "",
assign() {},
reload() {},
replace() {},
toString() {
return location.href;
},
};
return location;
}
function ensureUsableLocation(target: Record<string, unknown>, key: "location"): void {
if (!locationIsUsable(target[key])) {
target[key] = createSafeLocation();
}
}
export function setupDomMocks(): DomMockRestore {
if (typeof global === "undefined") return () => {};
// A loose record on purpose: intersecting with `typeof globalThis` pulls the
// DOM lib types in (Window, HTMLCanvasElement, document...) so every stub
// assignment below fails against the real constructor signatures, and the
// `delete g.window` narrows `g` to `never` (13 diagnostics under the api
// typecheck, which loads lib.dom). This function exists to overwrite those
// globals with stubs; it must not be typed as if they were the real ones.
const g = global as unknown as Record<string, unknown>;
const hadWindow = "window" in g;
const hadWindowCtor = "Window" in g;
const hadCanvasElement = "HTMLCanvasElement" in g;
const hadCanvasContext = "CanvasRenderingContext2D" in g;
const hadDocument = "document" in g;
const hadGlobalLocation = "location" in g;
const existingWindow = isRecord(g.window) ? g.window : undefined;
// Historical toxic alias from older OmniRoute builds: `g.window = g`.
// Never keep that alias — Next SSR treats any `window` as a browser and
// then destructures `window.location`.
const windowWasGlobalAlias = g.window === g;
if (!g.Window) g.Window = function Window() {};
if (!g.HTMLCanvasElement) g.HTMLCanvasElement = function HTMLCanvasElement() {};
if (!g.CanvasRenderingContext2D) {
g.CanvasRenderingContext2D = function CanvasRenderingContext2D() {};
}
if (!g.document) {
g.document = {
createElement(tag: string) {
if (tag === "canvas") {
const canvas = {
width: 100,
height: 100,
getContext(type: string) {
if (type === "2d") {
const ctx = {
fillStyle: "",
font: "",
fillRect() {},
fillText() {},
toDataURL() {
return "data:image/png;base64,MOCK_DATA";
},
};
Object.setPrototypeOf(
ctx,
(g.CanvasRenderingContext2D as { prototype: object }).prototype
);
return ctx;
}
return null;
},
toDataURL() {
return "data:image/png;base64,MOCK_DATA";
},
};
Object.setPrototypeOf(canvas, (g.HTMLCanvasElement as { prototype: object }).prototype);
return canvas;
}
return null;
},
};
}
if (windowWasGlobalAlias) {
delete g.window;
}
if (!g.window) {
const stubWindow: WindowStub = {
location: createSafeLocation(),
document: g.document,
};
stubWindow.window = stubWindow;
stubWindow.self = stubWindow;
g.window = stubWindow;
Object.setPrototypeOf(stubWindow, (g.Window as { prototype: object }).prototype);
} else if (existingWindow && existingWindow !== g) {
// Heal a leftover dedicated window so Next `getLocationOrigin` can
// destructure even if this process already had a stub.
ensureUsableLocation(existingWindow, "location");
if (g.document && existingWindow.document == null) {
existingWindow.document = g.document;
}
}
return () => {
if (!hadWindow || windowWasGlobalAlias) {
delete g.window;
} else if (isRecord(g.window)) {
// A leftover `window` stays installed: never strip `location` off it.
ensureUsableLocation(g.window, "location");
}
if (!hadGlobalLocation) delete g.location;
if (!hadWindowCtor) delete g.Window;
if (!hadCanvasElement) delete g.HTMLCanvasElement;
if (!hadCanvasContext) delete g.CanvasRenderingContext2D;
if (!hadDocument) delete g.document;
};
}
export function withTinyCmsDomMocks<T>(fn: () => T): T {
const restore = setupDomMocks();
try {
return fn();
} finally {
restore();
}
}
export async function withTinyCmsDomMocksAsync<T>(fn: () => Promise<T>): Promise<T> {
const restore = setupDomMocks();
try {
return await fn();
} finally {
restore();
}
}