Files
OmniRoute/tests/unit/web-tools-contract-7679.test.ts
Diego Rodrigues de Sa e Souza 7d57d9f4a1 fix(providers): retire common ChatGPT Web provider (#11754)
Rebased onto the current release/v3.8.51 tip as part of a combined provider-retirement/provenance merge batch (Designer Web, Felo Web, Runtime, GPL-derived removal, Qwen Web already landed). Large conflict set (this is the biggest PR in the batch — the common ChatGPT Web provider touches chat, images, count-tokens, session leases, and combos). Conflicts resolved:

- `open-sse/config/providers/registry/chatgpt-web/*`, `open-sse/executors/chatgpt-web*`, `open-sse/handlers/imageGeneration/providers/chatgptWeb.ts`, and their tests: kept deleted, matching the PR's stated scope.
- `open-sse/config/providers/registry/minimax/web/index.ts`, `open-sse/handlers/imageGeneration/providers/geminiWeb.ts`, `open-sse/executors/gemini-web.ts`'s stale image-mode branch: base-drift collisions against already-merged sibling retirements (#11691, #11708) — kept deleted / dropped the dead code, since this PR's own branch forked before those merged.
- `src/shared/constants/reservedProviderPrefixes.ts`, `open-sse/executors/index.ts`, `executorProxy.ts`, `virtualFactory.ts`, `autoStrategy.ts`, `src/lib/db/providers.ts`, `src/sse/handlers/chat.ts`: combined the Designer + Runtime (Felo/Qwen) + common-ChatGPT-Web retirement guard calls at each shared chokepoint — compute-once-then-OR pattern, consistent with prior combinations in this batch.
- `src/sse/services/model.ts` / `src/sse/handlers/chatHelpers.ts`: adopted this PR's new `getModelInfoOrRetirementResponse()` central wrapper (a real improvement over ad-hoc try/catch), and extended it to also catch the Designer + Runtime retirement errors it didn't originally cover, so the consolidation doesn't regress the other two mechanisms.
- `src/app/api/v1/images/edits/route.ts`: this PR moved the retirement check earlier (before `enforceApiKeyPolicy`) but left the old later call+catch block in place from base drift — removed the now-redundant duplicate `resolveImageRouteModel()` call and merged the Designer catch into the earlier one.
- `open-sse/config/imageRegistry.ts`, `tests/snapshots/executors/executor-map.json` (`keyCount` recomputed to 133), `tests/snapshots/provider/translate-path.json`: same "both sides inserted a different retired provider at the same slot" pattern — resolved by dropping both.
- `tests/unit/chatcore-executor-proxy.test.ts`, `provider-node-reserved-prefix.test.ts`, `combo-auto-candidate-expansion.test.ts`, `messages-count-tokens-route.test.ts`, `virtual-auto-combo.test.ts`: split into independent per-mechanism test blocks (established pattern); `virtual-auto-combo.test.ts`'s old "includes cookie web-session providers" positive-inclusion test (which used chatgpt-web as its example) was retired along with the provider and replaced by this PR's negative-exclusion test for the same slot.
- `docs/architecture/ARCHITECTURE.md`, `CODEBASE_DOCUMENTATION.md` (+ 4 i18n mirrors), `README.md`, `FREE-TIERS-GUIDE.md`, `docs/diagrams/free-tier-budget.svg`, `docs/screenshots/free-tier-budget-card.svg`, `docs/reference/PROVIDER_REFERENCE.md`: recomputed every stale count from the real merged state — 104 executors (`countFiles` gate logic), 351 providers (regenerated via `gen:provider-reference`), 152/351 `hasFree` entries, 445/438/7 free-tier catalog rows, 13 ToS-avoid providers, budget-card regenerated via its real generator script. One doc conflict (`oauth/` module list) needed picking HEAD's side specifically — theirs still listed the already-removed `raycast` module instead of the real `openference`.
- `config/quality/test-masking-allowlist.json`: additive merge of the PR's 17 `_deletedWithReplacement` entries alongside the batch's existing ones (one real duplicate-key mistake in my first pass, caught and fixed via a `object_pairs_hook` duplicate-key check before finalizing).

Also fixed two real, unrelated-to-my-merge issues surfaced by the focused suite:
- `tests/unit/resolve-web-provider-host.test.ts`: the PR's own test had a typo — it asserted `perplexity-web`'s resolved host as `"perplexity.ai"`, but the provider's registered `website` is `"https://www.perplexity.ai"` and the resolver returns the URL's `host` verbatim (no www-stripping), so the correct value is `"www.perplexity.ai"` (consistent with the same test's own `url` assertion).
- `tests/unit/hard-session-lease-bypass-inventory.test.ts`: this golden call-site inventory was already stale on the pristine post-#11713 tip (confirmed via a throwaway probe worktree) — `src/lib/db/providers.ts`'s 3 connection-fallback sites and a third `src/app/api/providers/route.ts` site were never added to the golden list by the earlier-merged #11698/#11720 PRs. Updated it to the real current inventory (dated inline comments explain each delta and which PR introduced it), plus this PR's own legitimate deltas (image-edits duplicate-call removal, `ChatGptWebExecutor.execute()` site removed).

Focused suite green (433/433 across executor-proxy, reserved-prefix, hard-session-lease-bypass-inventory, resolve-web-provider-host, retirement/runtime-block/source-retirement/management-retirement/image-handler-retirement, migration-168, combo-auto-candidate-expansion, virtual-auto-combo, executor-map-golden and siblings), plus `typecheck:core`, `check-file-size`, and `check-changelog-integrity` clean. Thanks for the thorough provenance-hold retirement work — appreciated.
2026-08-28 06:52:46 -03:00

180 lines
6.9 KiB
TypeScript

// Tool contract serialization for web-cookie model adapters (#7679).
//
// Some web-cookie models ignore the injected `<tool>` pseudo-contract
// and replies in prose claiming tools are unavailable. This test covers the
// nonce-bound serialization that clearly describes client-side tools and places
// the full contract at the tail of the effective message list.
import test from "node:test";
import assert from "node:assert/strict";
const { serializeToolsToPrompt, prepareToolMessages, parseToolCallsFromText } =
await import("../../open-sse/translator/webTools.ts");
const WEATHER_TOOL = {
type: "function",
function: {
name: "get_weather",
description: "Get the current weather for a location",
parameters: {
type: "object",
properties: { location: { type: "string" } },
required: ["location"],
},
},
};
const SEARCH_TOOL = {
type: "function",
function: {
name: "search_web",
description: "Search the web for current information",
parameters: {
type: "object",
properties: { query: { type: "string" } },
required: ["query"],
},
},
};
const TOOLS = [WEATHER_TOOL, SEARCH_TOOL];
// ─── serializeToolsToPrompt — hardened variant ───────────────────────────────
test("serializeToolsToPrompt states that client tools are available (#7679)", () => {
const result = serializeToolsToPrompt(TOOLS);
assert.match(result, /never claim they are unavailable/);
});
test("serializeToolsToPrompt includes the nonce-bound invocation contract (#7679)", () => {
const result = serializeToolsToPrompt(TOOLS);
assert.match(result, /secret binding "_nonce"/);
});
test("serializeToolsToPrompt contains tool names from the input (#7679)", () => {
const result = serializeToolsToPrompt(TOOLS);
assert.match(result, /get_weather/);
assert.match(result, /search_web/);
});
test("serializeToolsToPrompt contains the tag format example (#7679)", () => {
const result = serializeToolsToPrompt(TOOLS);
assert.match(result, /<tool>\{"name": "<tool_name>"/);
});
test("serializeToolsToPrompt returns empty string for empty tools (#7679)", () => {
assert.equal(serializeToolsToPrompt([]), "");
});
test("serializeToolsToPrompt returns empty string for null/undefined tools (#7679)", () => {
assert.equal(serializeToolsToPrompt(null), "");
assert.equal(serializeToolsToPrompt(undefined), "");
});
// ─── serializeToolsToPrompt — backward compatibility ─────────────────────────
test("serializeToolsToPrompt uses the client-tool contract (#7679)", () => {
const result = serializeToolsToPrompt(TOOLS);
assert.match(result, /client application provides tools/);
assert.match(result, /These client tools ARE available/);
});
// ─── prepareToolMessages — hardened variant ──────────────────────────────────
test("prepareToolMessages appends the full contract after client messages (#7679)", () => {
const body = { tools: TOOLS };
const messages = [{ role: "user", content: "What is the weather?" }];
const result = prepareToolMessages(body, messages);
assert.equal(result.hasTools, true);
assert.ok(Array.isArray(result.effectiveMessages));
assert.equal(result.effectiveMessages.length, 2);
const sysMsg = result.effectiveMessages[1];
assert.equal(sysMsg.role, "system");
assert.match(String(sysMsg.content), /never claim they are unavailable/);
assert.match(String(sysMsg.content), /secret binding "_nonce"/);
});
test("prepareToolMessages adds the client-tool contract (#7679)", () => {
const body = { tools: TOOLS };
const messages = [{ role: "user", content: "hi" }];
const result = prepareToolMessages(body, messages);
assert.equal(result.hasTools, true);
const sysMsg = result.effectiveMessages[1];
assert.equal(sysMsg.role, "system");
assert.match(String(sysMsg.content), /These client tools ARE available/);
});
test("prepareToolMessages with no tools returns hasTools: false (#7679)", () => {
const body = {};
const messages = [{ role: "user", content: "hi" }];
const result = prepareToolMessages(body, messages);
assert.equal(result.hasTools, false);
assert.equal(result.effectiveMessages.length, 1);
});
// ─── parseToolCallsFromText — compatibility with hardened instruction text ───
test("parseToolCallsFromText correctly extracts response <tool> blocks (#7679)", () => {
const text = [
"Let me look up the weather in Tokyo.",
'<tool>{"name":"get_weather","arguments":{"location":"Tokyo"}}</tool>',
"",
'And now search the web: <tool>{"name":"search_web","arguments":{"query":"latest news 2026"}}</tool>',
].join("\n");
const result = parseToolCallsFromText(text, "call", TOOLS);
assert.ok(result.toolCalls !== null, "tool calls should be parsed");
assert.equal(result.toolCalls.length, 2, "should find two tool calls");
assert.equal(result.toolCalls[0].function.name, "get_weather");
assert.equal(result.toolCalls[0].type, "function");
assert.deepEqual(JSON.parse(result.toolCalls[0].function.arguments), {
location: "Tokyo",
});
assert.equal(result.toolCalls[1].function.name, "search_web");
assert.deepEqual(JSON.parse(result.toolCalls[1].function.arguments), {
query: "latest news 2026",
});
// Assert the actual tool call <tool> blocks are stripped from the content.
// Only the response text remains; both tool-call blocks are stripped.
assert.doesNotMatch(result.content, /<tool>\{"name":"get_weather"/);
assert.doesNotMatch(result.content, /<tool>\{"name":"search_web"/);
assert.match(result.content, /Let me look up/);
assert.doesNotMatch(result.content, /get_weather/);
assert.doesNotMatch(result.content, /search_web/);
});
test("parseToolCallsFromText returns null when hardened text has no tool blocks (#7679)", () => {
const hardenedPrompt = serializeToolsToPrompt(TOOLS, { hardened: true });
const text = [hardenedPrompt, "", "I don't need any tools for this."].join("\n");
const result = parseToolCallsFromText(text, "call", TOOLS);
assert.equal(result.toolCalls, null, "no tool calls when no <tool> blocks present");
assert.match(result.content, /I don't need any tools/);
});
test("parseToolCallsFromText handles <tool> blocks line-boundary crossing in hardened text (#7679)", () => {
// Some high-performance lanes may emit the tool block adjacent to explanatory text
// with no preceding newline
const text = [
'I will use the weather tool. <tool>{"name":"get_weather","arguments":{"location":"Paris"}}</tool>',
"I hope this helps.",
].join("\n");
const result = parseToolCallsFromText(text, "call", TOOLS);
assert.ok(result.toolCalls !== null);
assert.equal(result.toolCalls.length, 1);
assert.equal(result.toolCalls[0].function.name, "get_weather");
assert.deepEqual(JSON.parse(result.toolCalls[0].function.arguments), {
location: "Paris",
});
});