mirror of
https://github.com/Nezumi-2711/9router.git
synced 2026-09-22 20:00:47 +00:00
fix(headroom): clarify token diagnostics vs provider billing
Distinguish Headroom-reported token deltas from outbound payload size, scrub credentials in logs, and warn on phantom savings when compressed JSON barely shrinks. Refs #1998 Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Sutarto Jordan Chrisfivo
committed by
decolua
decolua
co-authored by
Cursor
Cursor
parent
c7933de79c
commit
fb543a1f39
@@ -0,0 +1,253 @@
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
|
||||
const { executeMock } = vi.hoisted(() => ({
|
||||
executeMock: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock("../../open-sse/executors/index.js", () => ({
|
||||
getExecutor: () => ({
|
||||
noAuth: true,
|
||||
execute: executeMock,
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("../../open-sse/utils/requestLogger.js", () => ({
|
||||
createRequestLogger: async () => ({
|
||||
logClientRawRequest: vi.fn(),
|
||||
logRawRequest: vi.fn(),
|
||||
logTargetRequest: vi.fn(),
|
||||
logProviderResponse: vi.fn(),
|
||||
logConvertedResponse: vi.fn(),
|
||||
logError: vi.fn(),
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("../../open-sse/utils/stream.js", () => ({
|
||||
COLORS: { red: "", reset: "" },
|
||||
createPassthroughStreamWithLogger: vi.fn(() => new TransformStream()),
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/usageDb.js", () => ({
|
||||
trackPendingRequest: vi.fn(),
|
||||
appendRequestLog: vi.fn(async () => {}),
|
||||
saveRequestDetail: vi.fn(async () => {}),
|
||||
}));
|
||||
|
||||
const { handleChatCore } = await import("../../open-sse/handlers/chatCore.js");
|
||||
|
||||
describe("handleChatCore Headroom diagnostics", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
global.fetch = vi.fn(async (url) => {
|
||||
if (String(url).includes("/v1/compress")) {
|
||||
throw Object.assign(new Error("connect ECONNREFUSED 127.0.0.1:8787"), { code: "ECONNREFUSED" });
|
||||
}
|
||||
throw new Error(`unexpected fetch: ${url}`);
|
||||
});
|
||||
executeMock.mockResolvedValue({
|
||||
response: new Response(JSON.stringify({
|
||||
id: "chatcmpl-test",
|
||||
object: "chat.completion",
|
||||
choices: [{ message: { role: "assistant", content: "ok" }, finish_reason: "stop", index: 0 }],
|
||||
}), { status: 200, headers: { "content-type": "application/json" } }),
|
||||
url: "https://api.openai.com/v1/chat/completions",
|
||||
headers: {},
|
||||
transformedBody: null,
|
||||
});
|
||||
});
|
||||
|
||||
it("logs why Headroom was skipped on chat completions", async () => {
|
||||
const log = { debug: vi.fn(), info: vi.fn(), warn: vi.fn() };
|
||||
|
||||
await handleChatCore({
|
||||
body: { model: "gpt-4o", stream: false, messages: [{ role: "user", content: "hello" }] },
|
||||
modelInfo: { provider: "openai", model: "gpt-4o" },
|
||||
credentials: { apiKey: "test-key", providerSpecificData: {} },
|
||||
log,
|
||||
connectionId: "test-conn",
|
||||
headroomEnabled: true,
|
||||
headroomUrl: "http://localhost:8787",
|
||||
headroomCompressUserMessages: false,
|
||||
rtkEnabled: false,
|
||||
cavemanEnabled: false,
|
||||
ponytailEnabled: false,
|
||||
clientRawRequest: {
|
||||
endpoint: "/v1/chat/completions",
|
||||
body: {},
|
||||
headers: { accept: "application/json" },
|
||||
},
|
||||
});
|
||||
|
||||
expect(log.warn).toHaveBeenCalledWith(
|
||||
"HEADROOM",
|
||||
expect.stringContaining("skipped: request failed")
|
||||
);
|
||||
expect(log.warn).toHaveBeenCalledWith(
|
||||
"HEADROOM",
|
||||
expect.stringContaining("ECONNREFUSED")
|
||||
);
|
||||
expect(log.warn).toHaveBeenCalledWith(
|
||||
"HEADROOM",
|
||||
expect.stringContaining("http://localhost:8787/v1/compress")
|
||||
);
|
||||
});
|
||||
|
||||
it("scrubs credentials and query strings from Headroom fetch errors", async () => {
|
||||
const log = { debug: vi.fn(), info: vi.fn(), warn: vi.fn() };
|
||||
|
||||
global.fetch = vi.fn(async () => {
|
||||
throw new Error("failed to fetch https://user:secret@example.com:8787/proxy/v1/compress?token=abc123");
|
||||
});
|
||||
|
||||
await handleChatCore({
|
||||
body: { model: "gpt-4o", stream: false, messages: [{ role: "user", content: "hello" }] },
|
||||
modelInfo: { provider: "openai", model: "gpt-4o" },
|
||||
credentials: { apiKey: "test-key", providerSpecificData: {} },
|
||||
log,
|
||||
connectionId: "test-conn",
|
||||
headroomEnabled: true,
|
||||
headroomUrl: "https://user:secret@example.com:8787/proxy?token=abc123",
|
||||
headroomCompressUserMessages: false,
|
||||
rtkEnabled: false,
|
||||
cavemanEnabled: false,
|
||||
ponytailEnabled: false,
|
||||
clientRawRequest: {
|
||||
endpoint: "/v1/chat/completions",
|
||||
body: {},
|
||||
headers: { accept: "application/json" },
|
||||
},
|
||||
});
|
||||
|
||||
const logs = JSON.stringify(log.warn.mock.calls);
|
||||
expect(logs).toContain("https://example.com:8787/proxy/v1/compress");
|
||||
expect(logs).not.toContain("user");
|
||||
expect(logs).not.toContain("secret");
|
||||
expect(logs).not.toContain("abc123");
|
||||
});
|
||||
|
||||
it("masks credentials and query strings in Headroom endpoint diagnostics", async () => {
|
||||
const log = { debug: vi.fn(), info: vi.fn(), warn: vi.fn() };
|
||||
|
||||
await handleChatCore({
|
||||
body: { model: "gpt-4o", stream: false, messages: [{ role: "user", content: "hello" }] },
|
||||
modelInfo: { provider: "openai", model: "gpt-4o" },
|
||||
credentials: { apiKey: "test-key", providerSpecificData: {} },
|
||||
log,
|
||||
connectionId: "test-conn",
|
||||
headroomEnabled: true,
|
||||
headroomUrl: "https://user:secret@example.com:8787/proxy?token=abc123",
|
||||
headroomCompressUserMessages: false,
|
||||
rtkEnabled: false,
|
||||
cavemanEnabled: false,
|
||||
ponytailEnabled: false,
|
||||
clientRawRequest: {
|
||||
endpoint: "/v1/chat/completions",
|
||||
body: {},
|
||||
headers: { accept: "application/json" },
|
||||
},
|
||||
});
|
||||
|
||||
const logs = JSON.stringify(log.warn.mock.calls);
|
||||
expect(global.fetch).toHaveBeenCalledWith(
|
||||
"https://user:secret@example.com:8787/proxy/v1/compress?token=abc123",
|
||||
expect.any(Object)
|
||||
);
|
||||
expect(logs).toContain("https://example.com:8787/proxy/v1/compress");
|
||||
expect(logs).not.toContain("user");
|
||||
expect(logs).not.toContain("secret");
|
||||
expect(logs).not.toContain("abc123");
|
||||
});
|
||||
|
||||
it("sends Headroom-compressed messages to the provider executor", async () => {
|
||||
const log = { debug: vi.fn(), info: vi.fn(), warn: vi.fn() };
|
||||
const original = "very large context that should be replaced";
|
||||
const compressed = "compressed context";
|
||||
|
||||
global.fetch = vi.fn(async (url) => {
|
||||
if (String(url).includes("/v1/compress")) {
|
||||
return new Response(JSON.stringify({
|
||||
messages: [{ role: "user", content: compressed }],
|
||||
tokens_before: 100,
|
||||
tokens_after: 10,
|
||||
tokens_saved: 90,
|
||||
}), { status: 200, headers: { "content-type": "application/json" } });
|
||||
}
|
||||
throw new Error(`unexpected fetch: ${url}`);
|
||||
});
|
||||
|
||||
await handleChatCore({
|
||||
body: { model: "gpt-4o", stream: false, messages: [{ role: "user", content: original }] },
|
||||
modelInfo: { provider: "openai", model: "gpt-4o" },
|
||||
credentials: { apiKey: "test-key", providerSpecificData: {} },
|
||||
log,
|
||||
connectionId: "test-conn",
|
||||
headroomEnabled: true,
|
||||
headroomUrl: "http://localhost:8787",
|
||||
headroomCompressUserMessages: false,
|
||||
rtkEnabled: false,
|
||||
cavemanEnabled: false,
|
||||
ponytailEnabled: false,
|
||||
clientRawRequest: {
|
||||
endpoint: "/v1/chat/completions",
|
||||
body: {},
|
||||
headers: { accept: "application/json" },
|
||||
},
|
||||
});
|
||||
|
||||
expect(executeMock).toHaveBeenCalledWith(expect.objectContaining({
|
||||
body: expect.objectContaining({
|
||||
messages: [{ role: "user", content: compressed }],
|
||||
}),
|
||||
}));
|
||||
expect(JSON.stringify(executeMock.mock.calls[0][0].body)).not.toContain(original);
|
||||
expect(log.info).toHaveBeenCalledWith("HEADROOM", expect.stringContaining("reported token delta=90 before=100 after=10"));
|
||||
expect(log.info).toHaveBeenCalledWith("HEADROOM", expect.stringContaining("body="));
|
||||
expect(log.info).toHaveBeenCalledWith("HEADROOM", expect.stringContaining("messages="));
|
||||
|
||||
const logs = JSON.stringify([...log.info.mock.calls, ...log.warn.mock.calls]);
|
||||
expect(logs).not.toContain("saved");
|
||||
expect(logs).not.toContain(original);
|
||||
});
|
||||
|
||||
it("warns when Headroom reports savings but outbound body barely shrinks", async () => {
|
||||
const log = { debug: vi.fn(), info: vi.fn(), warn: vi.fn() };
|
||||
const original = "x".repeat(1000);
|
||||
const nearlySame = "x".repeat(990);
|
||||
|
||||
global.fetch = vi.fn(async (url) => {
|
||||
if (String(url).includes("/v1/compress")) {
|
||||
return new Response(JSON.stringify({
|
||||
messages: [{ role: "user", content: nearlySame }],
|
||||
tokens_before: 1000,
|
||||
tokens_after: 100,
|
||||
tokens_saved: 900,
|
||||
}), { status: 200, headers: { "content-type": "application/json" } });
|
||||
}
|
||||
throw new Error(`unexpected fetch: ${url}`);
|
||||
});
|
||||
|
||||
await handleChatCore({
|
||||
body: { model: "gpt-4o", stream: false, messages: [{ role: "user", content: original }] },
|
||||
modelInfo: { provider: "openai", model: "gpt-4o" },
|
||||
credentials: { apiKey: "test-key", providerSpecificData: {} },
|
||||
log,
|
||||
connectionId: "test-conn",
|
||||
headroomEnabled: true,
|
||||
headroomUrl: "http://localhost:8787",
|
||||
headroomCompressUserMessages: false,
|
||||
rtkEnabled: false,
|
||||
cavemanEnabled: false,
|
||||
ponytailEnabled: false,
|
||||
clientRawRequest: {
|
||||
endpoint: "/v1/chat/completions",
|
||||
body: {},
|
||||
headers: { accept: "application/json" },
|
||||
},
|
||||
});
|
||||
|
||||
expect(log.warn).toHaveBeenCalledWith(
|
||||
"HEADROOM",
|
||||
expect.stringContaining("reported token delta, but outbound JSON shrank <5%; provider may bill near-original payload")
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -66,8 +66,8 @@ describe("compressWithHeadroom", () => {
|
||||
});
|
||||
|
||||
describe("formatHeadroomLog", () => {
|
||||
it("formats savings", () => {
|
||||
it("formats reported token deltas without implying provider billing savings", () => {
|
||||
expect(formatHeadroomLog({ tokens_before: 100, tokens_after: 25, tokens_saved: 75 }))
|
||||
.toBe("saved 75 tokens / 100 (75.0%) after=25");
|
||||
.toBe("reported token delta=75 before=100 after=25 (75.0%)");
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user