OmniRoute/tests/unit/claude-code-compatible-request.test.ts
Diego Rodrigues de Sa e Souza 0cd388efb8
Release v3.7.4 (#1730)
* chore(release): v3.7.4 — version bump, openapi and changelog sync

* fix: preserve previous_response_id and conversation_id fields on empty input array (#1729)

* fix: bypass UI validation block for optional API keys and fix string fallback typing (#1721)

* fix(proxy): disable HTTP keep-alive and pipelining in Undici proxy dispatcher to prevent socket hang up

* feat(proxy): implement bulk proxy import via pipe-delimited parser with update-or-create logic

* docs: update changelog for v3.7.4 fixes and proxy features

* test: update responses store expectations for empty input arrays

* feat(pwa): add fullscreen installable PWA with manifest, service worker, and cross-platform app icons. (#1728)

Integrated into release/v3.7.4

* Fix image provider validation and Stability image requests (#1726)

Integrated into release/v3.7.4

* docs: add PR 1726 and PR 1728 to v3.7.4 changelog

* fix(security): replace insecure Math.random with crypto.getRandomValues for fallback UUID generation

* fix(migrations): intercept 007 migration to use IF NOT EXISTS logic on fresh installs

Fixes #1733

* test: fix typescript compilation errors in unit tests

* fix(db): reconcile legacy reasoning cache migration

* chore(release): bump to v3.7.4 — changelog, docs, version sync

* fix(cc-compatible): preserve Claude Code system skeleton (#1740)

Integrated into release/v3.7.4

* docs(changelog): update for PR #1740 merge

* docs(changelog): include workflow updates

* fix(db): reconcile legacy reasoning cache migration (#1734)

Integrated into release/v3.7.4

* Add endpoint tunnel visibility settings (#1743)

Integrated into release/v3.7.4

* Normalize max reasoning effort for Codex routing (#1744)

Integrated into release/v3.7.4

* Fix Claude Code gateway config helper (#1745)

Integrated into release/v3.7.4

* Refresh CLI fingerprint provider profiles (#1746)

Integrated into release/v3.7.4

* Integrated into release/v3.7.4 (PR #1742)

* docs(changelog): update for PRs 1742-1746

---------

Co-authored-by: diegosouzapw <diegosouzapw@users.noreply.github.com>
Co-authored-by: Yash Ghule <y.ghule77@gmail.com>
Co-authored-by: backryun <bakryun0718@proton.me>
Co-authored-by: dhaern <manker_lol@hotmail.com>
Co-authored-by: Randi <55005611+rdself@users.noreply.github.com>
Co-authored-by: Duncan L <leungd@gmail.com>
2026-04-28 20:46:25 -03:00

402 lines
14 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
const {
CLAUDE_CODE_COMPATIBLE_DEFAULT_MAX_TOKENS,
stripClaudeCodeCompatibleEndpointSuffix,
joinBaseUrlAndPath,
joinClaudeCodeCompatibleUrl,
resolveClaudeCodeCompatibleSessionId,
resolveClaudeCodeCompatibleEffort,
resolveClaudeCodeCompatibleMaxTokens,
buildClaudeCodeCompatibleRequest,
} = await import("../../open-sse/services/claudeCodeCompatible.ts");
const { getModelsByProviderId } = await import("../../open-sse/config/providerModels.ts");
function getClaudeEffortFixtures() {
const claudeModels = getModelsByProviderId("claude");
const xhighModel = claudeModels.find((model) => model.supportsXHighEffort === true);
const standardModel = claudeModels.find((model) => model.supportsXHighEffort === false);
assert.ok(xhighModel, "expected at least one Claude model with xhigh support");
assert.ok(standardModel, "expected at least one Claude model without xhigh support");
return { xhighModel, standardModel };
}
test("Claude Code compatible URL helpers cover empty values, version trimming and legacy session headers", () => {
assert.equal(stripClaudeCodeCompatibleEndpointSuffix(""), "");
assert.equal(
stripClaudeCodeCompatibleEndpointSuffix("https://api.example.com/v1/messages"),
"https://api.example.com"
);
assert.equal(
joinBaseUrlAndPath("https://api.example.com/v1", "v1/messages"),
"https://api.example.com/v1/messages"
);
assert.equal(
joinClaudeCodeCompatibleUrl("https://api.example.com/v1/messages", "models"),
"https://api.example.com/models"
);
assert.equal(
resolveClaudeCodeCompatibleSessionId({ "x-omniroute-session": " session-from-proxy " }),
"session-from-proxy"
);
});
test("Claude Code compatible effort and max token helpers cover priority fallbacks", () => {
const { xhighModel, standardModel } = getClaudeEffortFixtures();
assert.equal(resolveClaudeCodeCompatibleEffort({ reasoning_effort: "medium" }), "medium");
assert.equal(resolveClaudeCodeCompatibleEffort({ reasoning: { effort: "none" } }), "low");
assert.equal(
resolveClaudeCodeCompatibleEffort({ output_config: { effort: "xhigh" } }, null, xhighModel.id),
"xhigh"
);
assert.equal(
resolveClaudeCodeCompatibleEffort(
{ output_config: { effort: "xhigh" } },
null,
standardModel.id
),
"high"
);
assert.equal(
resolveClaudeCodeCompatibleEffort({ output_config: { effort: "unexpected" } }),
"high"
);
assert.equal(resolveClaudeCodeCompatibleMaxTokens({ max_completion_tokens: "17" }), 17);
assert.equal(
resolveClaudeCodeCompatibleMaxTokens({ max_output_tokens: -1 }, { max_tokens: 9 }),
9
);
assert.equal(resolveClaudeCodeCompatibleMaxTokens({}, { max_output_tokens: "31.9" }), 31);
assert.equal(
resolveClaudeCodeCompatibleMaxTokens({}, {}),
CLAUDE_CODE_COMPATIBLE_DEFAULT_MAX_TOKENS
);
});
test("buildClaudeCodeCompatibleRequest promotes source system/developer messages into top-level Claude system blocks", () => {
const payload = buildClaudeCodeCompatibleRequest({
sourceBody: {
messages: [
{ role: "system", content: "system note" },
{ role: "developer", content: [{ type: "text", text: "developer note" }] },
{ role: "assistant", content: [{ type: "text", text: "draft answer" }] },
{ role: "tool", content: "ignored" },
],
tools: [
null,
{
type: "function",
function: {
name: "lookup_account",
description: "Find account data",
parameters: { type: "object" },
defer_loading: true,
},
},
],
tool_choice: { type: "function", function: { name: "lookup_account" } },
reasoning: { effort: "disabled" },
max_completion_tokens: 19,
},
normalizedBody: {
messages: [
{ role: "assistant", content: [{ type: "text", text: "draft answer" }] },
{ role: "model", content: { text: "alternate answer" } },
{ role: "system", content: "system note" },
{ role: "developer", content: [{ type: "text", text: "developer note" }] },
{ role: "tool", content: "ignored" },
],
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.deepEqual(payload.messages, [
{
role: "user",
content: [{ type: "text", text: "draft answer" }],
},
]);
assert.equal(payload.system.length, 3);
assert.match((payload as any).system[0].text, /Claude Agent SDK/);
assert.equal(payload.system[1].text, "system note");
assert.equal(payload.system[2].text, "developer note");
assert.equal(payload.tools.length, 1);
assert.deepEqual(payload.tools[0], {
name: "lookup_account",
description: "Find account data",
input_schema: { type: "object", properties: {} },
defer_loading: true,
});
assert.deepEqual(payload.tool_choice, { type: "tool", name: "lookup_account" });
assert.equal(payload.output_config.effort, "low");
assert.equal(payload.max_tokens, 19);
});
test("buildClaudeCodeCompatibleRequest prefers existing Claude top-level system over extracted source messages", () => {
const payload = buildClaudeCodeCompatibleRequest({
sourceBody: {
system: [{ type: "text", text: "top-level system" }],
messages: [
{ role: "system", content: "stale system message" },
{ role: "user", content: "hello" },
],
},
normalizedBody: {
messages: [
{ role: "system", content: "stale system message" },
{ role: "user", content: "hello" },
],
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.equal(payload.system.length, 2);
assert.match((payload.system[0] as any).text, /Claude Agent SDK/);
assert.equal((payload.system[1] as any).text, "top-level system");
assert.deepEqual(payload.messages, [
{ role: "user", content: [{ type: "text", text: "hello" }] },
]);
});
test("buildClaudeCodeCompatibleRequest does not duplicate an existing default system skeleton", () => {
const payload = buildClaudeCodeCompatibleRequest({
claudeBody: {
system: [
{
type: "text",
text: "You are a Claude agent, built on Anthropic's Claude Agent SDK.",
},
],
messages: [{ role: "user", content: "hello" }],
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.equal(payload.system.length, 1);
assert.match((payload.system[0] as any).text, /Claude Agent SDK/);
});
test("buildClaudeCodeCompatibleRequest covers Claude-native bodies and cache-control stripping", () => {
const stripped = buildClaudeCodeCompatibleRequest({
claudeBody: {
system: [{ type: "text", text: "sys", cache_control: { type: "ephemeral" } }],
messages: [
{
role: "assistant",
content: [{ type: "text", text: "prefill", cache_control: { type: "ephemeral" } }],
},
{
role: "user",
content: [
{ type: "text", text: "ask", cache_control: { type: "ephemeral" } },
{
type: "image",
source: { type: "base64", media_type: "image/png", data: "abc" },
cache_control: { type: "ephemeral" },
},
],
},
{
role: "assistant",
content: [{ type: "text", text: "tail", cache_control: { type: "ephemeral" } }],
},
],
tools: [
{ name: "toolA", input_schema: { type: "object" }, cache_control: { type: "ephemeral" } },
],
thinking: { type: "enabled", budget_tokens: 12 },
output_config: { format: "compact" },
metadata: { foo: "bar" },
},
model: "claude-sonnet-4-6",
preserveCacheControl: false,
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
stream: true,
sessionId: "explicit-session",
});
const preserved = buildClaudeCodeCompatibleRequest({
claudeBody: {
system: [{ type: "text", text: "sys", cache_control: { type: "ephemeral" } }],
messages: [
{
role: "assistant",
content: [{ type: "text", text: "prefill", cache_control: { type: "ephemeral" } }],
},
{
role: "user",
content: [{ type: "text", text: "ask", cache_control: { type: "ephemeral" } }],
},
],
tools: [
{ name: "toolA", input_schema: { type: "object" }, cache_control: { type: "ephemeral" } },
],
},
model: "claude-sonnet-4-6",
preserveCacheControl: true,
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.equal(stripped.stream, true);
assert.equal((JSON as any).parse(stripped.metadata.user_id).session_id, "explicit-session");
assert.equal(stripped.messages.at(-1).role, "user");
assert.equal((stripped as any).system[0].cache_control, undefined);
assert.match((stripped.system[0] as any).text, /Claude Agent SDK/);
assert.equal((stripped.system[1] as any).text, "sys");
assert.equal((stripped as any).messages[0].content[0].cache_control, undefined);
assert.equal(stripped.tools[0].cache_control, undefined);
assert.deepEqual(stripped.thinking, { type: "enabled", budget_tokens: 12 });
assert.deepEqual(stripped.output_config, { effort: "high", format: "compact" });
assert.equal(stripped.metadata.foo, "bar");
assert.match((preserved.system[0] as any).text, /Claude Agent SDK/);
assert.equal((preserved.system[0] as any).cache_control, undefined);
(assert as any).deepEqual((preserved.system[1] as any).cache_control, { type: "ephemeral" });
(assert as any).equal((preserved.messages[0].content[0] as any).cache_control.type, "ephemeral");
assert.equal((preserved.tools[0].cache_control as any).type, "ephemeral");
});
test("buildClaudeCodeCompatibleRequest keeps the next user message anchored by matching tool_result after assistant tool_use", () => {
const payload = buildClaudeCodeCompatibleRequest({
claudeBody: {
messages: [
{
role: "assistant",
content: [
{ type: "text", text: "Calling tool" },
{ type: "tool_use", id: "toolu_123", name: "Bash", input: { command: "pwd" } },
],
},
{
role: "user",
content: [
{
type: "tool_result",
tool_use_id: "toolu_123",
content: [{ type: "text", text: "/tmp" }],
},
],
},
{
role: "user",
content: [{ type: "text", text: "Continue" }],
},
],
tools: [{ name: "Bash", input_schema: { type: "object", properties: {} } }],
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.equal(payload.messages.length, 2);
assert.equal(payload.messages[0].role, "assistant");
assert.equal((payload.messages[0].content[1] as any).type, "tool_use");
assert.equal(payload.messages[1].role, "user");
assert.equal((payload.messages[1].content[0] as any).type, "tool_result");
assert.equal((payload.messages[1].content[0] as any).tool_use_id, "toolu_123");
assert.equal((payload.messages[1].content[1] as any).type, "text");
assert.equal((payload.messages[1].content[1] as any).text, "Continue");
});
test("buildClaudeCodeCompatibleRequest preserves trailing assistant tool_use message awaiting next tool_result", () => {
const payload = buildClaudeCodeCompatibleRequest({
claudeBody: {
messages: [
{
role: "user",
content: [{ type: "text", text: "Run pwd" }],
},
{
role: "assistant",
content: [
{ type: "tool_use", id: "toolu_pending", name: "Bash", input: { command: "pwd" } },
],
},
],
tools: [{ name: "Bash", input_schema: { type: "object", properties: {} } }],
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.equal(payload.messages.length, 2);
assert.equal(payload.messages[1].role, "assistant");
assert.equal((payload.messages[1].content[0] as any).type, "tool_use");
assert.equal((payload.messages[1].content[0] as any).id, "toolu_pending");
});
test("buildClaudeCodeCompatibleRequest omits tool choice when there are no tools", () => {
const payload = buildClaudeCodeCompatibleRequest({
normalizedBody: {
messages: [{ role: "user", content: "hello" }],
tool_choice: "required",
reasoning_effort: "high",
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.equal(payload.tools.length, 0);
assert.equal("tool_choice" in payload, false);
assert.equal(payload.output_config.effort, "high");
(assert as any).equal(payload.system.length, 1);
assert.match((payload as any).system[0].text, /Claude Agent SDK/);
});
test("buildClaudeCodeCompatibleRequest covers string system input, non-array Claude fields and tool choice variants", () => {
const anyChoice = buildClaudeCodeCompatibleRequest({
normalizedBody: {
messages: [{ role: "user", content: "hello" }],
tools: [
{
name: "direct_tool",
input_schema: { type: "object", properties: { q: { type: "string" } } },
},
{
type: "function",
function: {
name: "missing_description",
parameters: { type: "object", properties: { x: { type: "string" } } },
},
},
{ type: "function", function: { parameters: { type: "object" } } },
],
tool_choice: { type: "any" },
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
const stringSystem = buildClaudeCodeCompatibleRequest({
claudeBody: {
system: " custom system ",
messages: "not-an-array",
tools: "not-an-array",
thinking: "disabled",
},
model: "claude-sonnet-4-6",
cwd: "/tmp/claude-code-compatible",
now: new Date("2026-01-02T12:00:00.000Z"),
});
assert.deepEqual(anyChoice.tool_choice, { type: "any" });
assert.equal((anyChoice as any).tools.length, 2);
assert.equal((anyChoice.tools[0].input_schema as any).properties.q.type, "string");
assert.equal(anyChoice.tools[1].description, "");
assert.equal(stringSystem.messages.length, 0);
assert.equal(stringSystem.tools.length, 0);
assert.equal(stringSystem.system.at(-1).text, "custom system");
});