Files
OmniRoute/tests/unit/8488-capability-filter-fail-closed.test.ts
Paco Cartones e7b1448281 fix(combo): name output_tokens as the exclusion reason instead of structured output (#12374)
When every combo target is excluded because the request's max_tokens exceeds each target's known output limit, the terminal 400 now says so — requested max_tokens against the pool's highest known ceiling — instead of the unrelated "supports structured output for this request". Diagnostics (unmet, excluded[].reason, terminalReason) are unchanged; only the message for the output_tokens primary reason moves.

Validated in a combined worktree with all 25 PRs of this batch boarded together: typecheck:core clean, 443/443 node-runner tests plus 14/14 vitest across every test file the batch touches, and check-changelog-integrity, check:cycles (418 files), check:provider-consistency (272 REGISTRY entries, 355 canonical providers), check:docs-counts, check:docs-sync (42 locales) and check-file-size all green.

Thanks @pacocartones.
2026-09-02 03:12:22 -03:00

352 lines
11 KiB
TypeScript

/**
* #8488 — capability filters fail closed when every candidate is incompatible.
*/
import test from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-8488-compat-"));
process.env.DATA_DIR = TEST_DATA_DIR;
const core = await import("../../src/lib/db/core.ts");
const { saveModelsDevCapabilities } = await import("../../src/lib/modelsDevSync.ts");
const {
filterTargetsByRequestCompatibility,
describeCapabilityFilterExhaustion,
providerSupportsEmulatedToolCalling,
} = await import("../../open-sse/services/combo/comboStructure.ts");
const { resolveAutoStrategyOrder } =
await import("../../open-sse/services/combo/resolveAutoStrategy.ts");
const { handleComboChat } = await import("../../open-sse/services/combo.ts");
function capabilityEntry(limit_context: number, overrides: Record<string, unknown> = {}) {
return {
tool_call: null,
reasoning: null,
attachment: null,
structured_output: null,
temperature: null,
modalities_input: "[]",
modalities_output: "[]",
knowledge_cutoff: null,
release_date: null,
last_updated: null,
status: null,
family: null,
open_weights: null,
limit_context,
limit_input: null,
limit_output: null,
interleaved_field: null,
...overrides,
};
}
function target(provider: string, modelStr: string) {
return {
kind: "model" as const,
stepId: "s1",
executionKey: `${provider}>${modelStr}`,
modelStr,
provider,
providerId: null,
connectionId: null,
weight: 1,
label: null,
};
}
const log = {
info() {},
warn() {},
error() {},
debug() {},
};
test.beforeEach(() => {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
});
test.after(() => {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
});
test("#8488 filter: some tool-capable targets kept (unchanged)", () => {
saveModelsDevCapabilities({
openai: {
"with-tools": capabilityEntry(128000, { tool_call: true }),
"no-tools": capabilityEntry(128000, { tool_call: false }),
},
});
const kept = filterTargetsByRequestCompatibility(
[target("openai", "openai/with-tools"), target("openai", "openai/no-tools")],
{
messages: [{ role: "user", content: "hi" }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
log
);
assert.deepEqual(
kept.map((t) => t.modelStr),
["openai/with-tools"]
);
});
test("#8488 filter: zero tool-capable targets → empty (fail closed)", () => {
saveModelsDevCapabilities({
openai: {
"no-tools-a": capabilityEntry(128000, { tool_call: false }),
"no-tools-b": capabilityEntry(128000, { tool_call: false }),
},
});
const targets = [target("openai", "openai/no-tools-a"), target("openai", "openai/no-tools-b")];
const body = {
messages: [{ role: "user", content: "hi" }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
};
const kept = filterTargetsByRequestCompatibility(targets, body, log);
assert.equal(kept.length, 0);
const exhaustion = describeCapabilityFilterExhaustion(targets, body, "tools-combo");
assert.ok(exhaustion);
assert.match(exhaustion!.message, /supports tool calling/i);
assert.equal(exhaustion!.terminalReason, "capability_mismatch");
assert.ok(exhaustion!.excluded.some((e) => e.reason.includes("tools")));
});
test("#8488 filter: Gemini Web emulation stays eligible for tools (#5240)", () => {
// Registry honestly tags Gemini Web models toolCalling:false; the prompt
// shim is what makes tools work. Fail-closed must not hard-reject them.
assert.equal(providerSupportsEmulatedToolCalling("gemini-web"), true);
assert.equal(providerSupportsEmulatedToolCalling("gweb"), true);
assert.equal(providerSupportsEmulatedToolCalling("claude-web"), false); // toolCalling:"none"
assert.equal(providerSupportsEmulatedToolCalling("openai"), false);
const kept = filterTargetsByRequestCompatibility(
[
target("gemini-web", "gemini-web/gemini-3.1-pro"),
target("gemini-web", "gemini-web/gemini-3.7-flash"),
],
{
messages: [{ role: "user", content: "Use a tool." }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
log
);
assert.equal(kept.length, 2);
assert.deepEqual(
kept.map((t) => t.modelStr),
["gemini-web/gemini-3.1-pro", "gemini-web/gemini-3.7-flash"]
);
const exhaustion = describeCapabilityFilterExhaustion(
[
target("gemini-web", "gemini-web/gemini-3.1-pro"),
target("gemini-web", "gemini-web/gemini-3.7-flash"),
],
{
messages: [{ role: "user", content: "Use a tool." }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
"web-cookie-tools"
);
assert.equal(exhaustion, null, "emulation-capable pool must not report capability_mismatch");
});
test("#8488 auto: Gemini Web emulation survives tool pre-filter (#5240)", async () => {
const result = await resolveAutoStrategyOrder({
orderedTargets: [target("gemini-web", "gemini-web/gemini-3.1-pro")] as never,
body: {
messages: [{ role: "user", content: "hi" }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
combo: { id: "c1", name: "auto-web-cookie", config: {} } as never,
settings: null,
config: {},
relayOptions: null,
resilienceSettings: { quotaPreflight: { enabled: false } } as never,
log: log as never,
buildAutoCandidates: (async () => []) as never,
});
assert.ok(
!("earlyResponse" in result),
"must not 400 capability_mismatch for emulation providers"
);
if ("orderedTargets" in result) {
assert.equal(result.orderedTargets.length, 1);
assert.equal(result.orderedTargets[0].modelStr, "gemini-web/gemini-3.1-pro");
}
});
test("#8488 filter: opt-in compatFilterFailOpen restores full pool", () => {
saveModelsDevCapabilities({
openai: {
"no-tools-a": capabilityEntry(128000, { tool_call: false }),
"no-tools-b": capabilityEntry(128000, { tool_call: false }),
},
});
const kept = filterTargetsByRequestCompatibility(
[target("openai", "openai/no-tools-a"), target("openai", "openai/no-tools-b")],
{
messages: [{ role: "user", content: "hi" }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
log,
"Context-aware fallback",
{ failOpen: true }
);
assert.equal(kept.length, 2);
});
test("#8488 filter: vision with no confirmed target → empty (fail closed)", () => {
saveModelsDevCapabilities({
openai: {
"text-only": capabilityEntry(128000, { attachment: false, tool_call: true }),
},
});
const kept = filterTargetsByRequestCompatibility(
[target("openai", "openai/text-only")],
{
messages: [
{
role: "user",
content: [
{ type: "text", text: "see?" },
{ type: "image_url", image_url: { url: "https://example.com/a.png" } },
],
},
],
},
log
);
assert.equal(kept.length, 0);
});
test("#8488 auto: tool pre-filter fail closed returns early 400", async () => {
saveModelsDevCapabilities({
openai: {
"no-tools": capabilityEntry(128000, { tool_call: false }),
},
});
const result = await resolveAutoStrategyOrder({
orderedTargets: [target("openai", "openai/no-tools")] as never,
body: {
messages: [{ role: "user", content: "hi" }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
combo: { id: "c1", name: "auto-tools", config: {} } as never,
settings: null,
config: {},
relayOptions: null,
resilienceSettings: { quotaPreflight: { enabled: false } } as never,
log: log as never,
buildAutoCandidates: (async () => []) as never,
});
assert.ok("earlyResponse" in result);
if ("earlyResponse" in result) {
assert.equal(result.earlyResponse.status, 400);
const body = await result.earlyResponse.json();
assert.equal(body?.error?.code, "capability_mismatch");
assert.match(String(body?.error?.message || ""), /supports tool calling/i);
}
});
test("#8488 auto: tool pre-filter fail-open opt-in keeps full pool", async () => {
saveModelsDevCapabilities({
openai: {
"no-tools": capabilityEntry(128000, { tool_call: false }),
},
});
const result = await resolveAutoStrategyOrder({
orderedTargets: [target("openai", "openai/no-tools")] as never,
body: {
messages: [{ role: "user", content: "hi" }],
tools: [{ type: "function", function: { name: "lookup", parameters: {} } }],
},
combo: { id: "c1", name: "auto-tools-open", config: { compatFilterFailOpen: true } } as never,
settings: null,
config: { compatFilterFailOpen: true },
relayOptions: null,
resilienceSettings: { quotaPreflight: { enabled: false } } as never,
log: log as never,
buildAutoCandidates: (async () => []) as never,
});
assert.ok(!("earlyResponse" in result));
if ("orderedTargets" in result) {
assert.equal(result.orderedTargets.length, 1);
}
});
test("auto context estimate still dispatches when all known limits look too small", async () => {
saveModelsDevCapabilities({
openai: {
tiny: capabilityEntry(100, { tool_call: true }),
},
});
const hugePrompt = "x".repeat(4000); // ~1000 tokens at 4 chars/token
const dispatches: string[] = [];
const result = await handleComboChat({
body: { messages: [{ role: "user", content: hugePrompt }] },
combo: { id: "c1", name: "auto-ctx", strategy: "auto", models: ["openai/tiny"] },
handleSingleModel: async (_body, modelStr) => {
dispatches.push(modelStr);
return new Response(JSON.stringify({ choices: [{ message: { content: "ok" } }] }), {
status: 200,
headers: { "Content-Type": "application/json" },
});
},
isModelAvailable: async () => true,
log,
settings: null,
relayOptions: null,
allCombos: null,
});
assert.equal(result.status, 200);
assert.deepEqual(dispatches, ["openai/tiny"]);
});
test("#12229 exhaustion: output_tokens exclusion names max_tokens vs the model ceiling", () => {
saveModelsDevCapabilities({
claude: {
"claude-haiku-4-5-20251001": capabilityEntry(200000, {
tool_call: true,
structured_output: true,
limit_output: 64000,
}),
},
});
const targets = [target("claude", "claude/claude-haiku-4-5-20251001")];
const body = {
messages: [{ role: "user", content: "hoi wie ben je?" }],
max_tokens: 100000,
};
const exhaustion = describeCapabilityFilterExhaustion(targets, body, "hermes-main");
assert.ok(exhaustion);
assert.deepEqual(exhaustion!.unmet, ["output_tokens"]);
assert.equal(exhaustion!.excluded[0].reason, "output_tokens");
assert.equal(
exhaustion!.message,
"No target in combo hermes-main can produce the requested max_tokens=100000; the highest known output limit in the pool is 64000"
);
assert.doesNotMatch(exhaustion!.message, /structured output/i);
assert.equal(exhaustion!.terminalReason, "capability_mismatch");
});