Compare commits

..

4 Commits

Author SHA1 Message Date
diegosouzapw
3c90c929bf fix(logs): preserve standalone detail token labels 2026-08-10 08:09:41 -03:00
diegosouzapw
fdc59323bd fix(logs): keep detail rendering independent of next-intl 2026-08-10 08:08:16 -03:00
diegosouzapw
9612b0d909 test(logs): use project alias in cache token coverage 2026-08-10 07:24:26 -03:00
diegosouzapw
e6a4dfc72b feat(logs): show cache read and write token counts (#9620) 2026-08-10 07:19:39 -03:00
7 changed files with 186 additions and 179 deletions

View File

@@ -0,0 +1,2 @@
- Show cache-read and cache-write token counts in request log rows and details when providers
report them.

View File

@@ -1 +0,0 @@
- fix(migrations): don't abort on fresh install with only the 001 seed (#9934)

View File

@@ -1045,35 +1045,13 @@ export function getDbInstance(): SqliteDatabase {
// This is needed so the migration runner skips the mass-migration safety abort
// that would otherwise trigger because heuristic seeding marks some migrations
// as applied, making the fresh DB look like a wiped existing DB (#1328).
// #9934: also classify as fresh a file that `omniroute setup` created with
// only the clipped skeleton schema (see the probe below) — even though the
// file exists, it has never had migrations run.
let isNewDb = !fs.existsSync(sqliteFile);
const isNewDb = !fs.existsSync(sqliteFile);
// Detect and handle old schema format — preserve data when possible (#146)
// Uses a single probe connection that becomes the real connection when possible.
if (fs.existsSync(sqliteFile)) {
try {
const probe = openSqliteDatabase(sqliteFile, { readonly: true });
// #9934: init asymmetry — bin/cli/sqlite.mjs::openOmniRouteDb (used by
// `omniroute setup`) creates storage.sqlite with only the partial inline
// schema (key_value + provider_connections) and never runs migrations.
// Purely file-existence-based freshness made that file look like an
// existing DB, so the first `serve` auto-seeded only the 001 marker and
// tripped the mass-migration safety abort on a brand-new install. A
// skeleton file has provider_connections but none of the tables the 001
// migration creates (combos) — treat it as fresh, not as a wiped DB.
const probeHasProviderConnections = !!probe
.prepare(
"SELECT name FROM sqlite_master WHERE type='table' AND name='provider_connections'"
)
.get();
const probeHasCombos = !!probe
.prepare("SELECT name FROM sqlite_master WHERE type='table' AND name='combos'")
.get();
if (probeHasProviderConnections && !probeHasCombos) {
isNewDb = true;
}
const hasOldSchema = probe
.prepare("SELECT name FROM sqlite_master WHERE type='table' AND name='schema_migrations'")
.get();

View File

@@ -922,26 +922,9 @@ export function runMigrations(db: SqliteAdapter, options?: { isNewDb?: boolean }
// interpolates this resolved value, so it auto-reflects any override.
const maxPendingMigrations = resolveMaxPendingMigrations();
// #9934: `omniroute setup`'s openOmniRouteDb writes a partial skeleton file
// (provider_connections + key_value) that has never had migrations run. When
// the first `serve` opens it and auto-seeds only the 001 marker, the applied
// set is exactly {001} — which would otherwise look like a wiped existing DB
// and trip this abort on a brand-new install. This is distinct from a real
// wiped/backup-restored database: that case has a non-trivial physical schema
// (baseline inference is non-null) and full data tables, so it still aborts.
// The 001-marker-only state on a provider_connections skeleton is the fresh
// auto-seed — let it through. A genuinely empty table is already exempt via
// `applied.size > 0`, and an upgraded DB has a non-trivial applied set.
const isFreshSeedOnly =
applied.size === 1 &&
applied.has("001") &&
inferPhysicalSchemaBaseline(db) === null &&
hasTable(db, "provider_connections");
if (
!isTestEnvironment &&
!isNewDb &&
!isFreshSeedOnly &&
process.env.DISABLE_SQLITE_AUTO_BACKUP !== "true" &&
maxPendingMigrations > 0 &&
applied.size > 0 &&

View File

@@ -95,6 +95,7 @@ const RequestLoggerV2 = forwardRef<RequestLoggerV2Handle, { initialSelectedId?:
(props, ref) => {
const { initialSelectedId } = props as any;
const t = useTranslations("requestLogger");
const tCache = useTranslations("cache");
const { emailsVisible } = useEmailPrivacyStore();
// Get translated status filters
@@ -1514,6 +1515,30 @@ const RequestLoggerV2 = forwardRef<RequestLoggerV2Handle, { initialSelectedId?:
<span className="text-emerald-700 dark:text-emerald-400">
{log.tokens?.out?.toLocaleString() || 0}
</span>
{log.tokens?.cacheRead != null && log.tokens.cacheRead > 0 && (
<>
<span className="mx-1 text-border">|</span>
<span className="text-text-muted">CR:</span>{" "}
<span
className="text-sky-700 dark:text-sky-400"
title={tCache("cachedTokensCol")}
>
{log.tokens.cacheRead.toLocaleString()}
</span>
</>
)}
{log.tokens?.cacheWrite != null && log.tokens.cacheWrite > 0 && (
<>
<span className="mx-1 text-border">|</span>
<span className="text-text-muted">CW:</span>{" "}
<span
className="text-amber-700 dark:text-amber-400"
title={tCache("cacheCreation")}
>
{log.tokens.cacheWrite.toLocaleString()}
</span>
</>
)}
{log.tokens?.compressed != null && log.tokens.compressed > 0 && (
<>
<span className="mx-1 text-border">|</span>

View File

@@ -1,138 +0,0 @@
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";
import { pathToFileURL } from "node:url";
import Database from "better-sqlite3";
import { resetDbInstance } from "../../src/lib/db/core.ts";
// Regression guard for #9934 — init asymmetry breaks a fresh install.
//
// `omniroute setup` (bin/cli/sqlite.mjs::openOmniRouteDb) creates
// storage.sqlite with the *partial* inline schema (key_value +
// provider_connections) but NEVER creates _omniroute_migrations and never runs
// migrations. That file flips the server's new-DB heuristic
// (src/lib/db/core.ts uses `!fs.existsSync(sqliteFile)`), so the first
// `omniroute serve` believes it is an existing DB, auto-seeds only the 001
// marker, and then trips the mass-migration safety abort because 139 pending
// migrations exceed the default threshold of 50 (#6260 gate).
//
// A DB whose ONLY applied migration is the 001 initial-schema auto-seed is a
// fresh install, not a wiped/backup-restored database — it must NOT abort.
const serial = { concurrency: false };
// Re-import a module so module-level env-derived constants (DATA_DIR,
// SQLITE_FILE) re-resolve after we set DATA_DIR. Static import cannot work
// here: the whole point is exercising the module-loading boundary.
async function importFresh(modulePath: string) {
const url = pathToFileURL(path.resolve(modulePath)).href;
return import(`${url}?test=${Date.now()}-${Math.random().toString(16).slice(2)}`);
}
// Simulate a production (non-test) process so the #6260 mass-migration safety
// gate is actually LIVE: under `node --test` the runner would be detected and
// the gate skipped, making the bug invisible.
function withNonTestEnvironment<R>(fn: () => R): R {
const originalNodeEnv = process.env.NODE_ENV;
const originalVitest = process.env.VITEST;
const originalDisableAutoBackup = process.env.DISABLE_SQLITE_AUTO_BACKUP;
const originalArgv = [...process.argv];
const originalExecArgv = [...process.execArgv];
delete process.env.NODE_ENV;
delete process.env.VITEST;
delete process.env.DISABLE_SQLITE_AUTO_BACKUP;
process.argv = process.argv.filter((arg) => !arg.includes("test"));
process.execArgv = process.execArgv.filter((arg) => !arg.includes("test"));
try {
return fn();
} finally {
process.argv = originalArgv;
process.execArgv = originalExecArgv;
if (originalNodeEnv === undefined) delete process.env.NODE_ENV;
else process.env.NODE_ENV = originalNodeEnv;
if (originalVitest === undefined) delete process.env.VITEST;
else process.env.VITEST = originalVitest;
if (originalDisableAutoBackup === undefined) delete process.env.DISABLE_SQLITE_AUTO_BACKUP;
else process.env.DISABLE_SQLITE_AUTO_BACKUP = originalDisableAutoBackup;
}
}
function cleanupGlobalDb() {
try {
const g = globalThis as Record<string, { open?: boolean; close?: () => void }>;
if (g.__omnirouteDb?.open) g.__omnirouteDb.close?.();
} catch {
/* ignore */
}
delete (globalThis as Record<string, unknown>).__omnirouteDb;
}
test.after(() => {
cleanupGlobalDb();
resetDbInstance();
});
test(
"fresh `omniroute setup` DB (only the 001 seed) survives first serve without mass-migration abort (#9934)",
serial,
async () => {
const dataDir = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-9934-"));
const originalDataDir = process.env.DATA_DIR;
process.env.DATA_DIR = dataDir;
try {
// Step 1 — mimic `omniroute setup`: the CLI opens the DB, writes the
// partial inline schema (key_value + provider_connections) and closes it,
// WITHOUT running migrations or creating _omniroute_migrations.
const cli = await importFresh("bin/cli/sqlite.mjs");
const setup = await cli.openOmniRouteDb();
assert.ok(fs.existsSync(setup.dbPath), "setup created storage.sqlite");
setup.db.close();
const onDisk = new Database(setup.dbPath, { readonly: true });
try {
const hasMigrationTable = !!onDisk
.prepare("SELECT name FROM sqlite_master WHERE type='table' AND name=?")
.get("_omniroute_migrations");
assert.equal(
hasMigrationTable,
false,
"setup must NOT pre-create the migrations tracking table (bug premise)"
);
} finally {
onDisk.close();
}
// Step 2 — mimic the first `omniroute serve`: the real server opens the
// same DB, auto-seeds only the 001 marker and runs migrations. Under a
// live (non-test) safety gate this must NOT throw.
const core = await importFresh("src/lib/db/core.ts");
cleanupGlobalDb();
resetDbInstance();
let db: { prepare?: (sql: string) => { get: () => { maxV: number } | undefined } };
assert.doesNotThrow(() => {
withNonTestEnvironment(() => {
db = core.getDbInstance();
});
}, "first serve must not abort on a fresh setup DB that only has the 001 seed (#9934)");
// Prove the fresh DB actually got migrated past 001 to the latest version.
const maxRow = db.prepare(
"SELECT MAX(CAST(version AS INTEGER)) AS maxV FROM _omniroute_migrations"
).get();
assert.ok(
(maxRow?.maxV ?? 0) > 1,
`expected migrations beyond 001 to run, got max=${maxRow?.maxV}`
);
} finally {
if (originalDataDir === undefined) delete process.env.DATA_DIR;
else process.env.DATA_DIR = originalDataDir;
fs.rmSync(dataDir, { recursive: true, force: true });
}
}
);

View File

@@ -0,0 +1,158 @@
// @vitest-environment jsdom
import React, { act } from "react";
import { createRoot, type Root } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
vi.mock("next-intl", () => ({
useTranslations: (namespace?: string) => (key: string) =>
namespace === "cache"
? ({ cachedTokensCol: "Cache Read", cacheCreation: "Cache Write" }[key] ?? key)
: key,
}));
vi.mock("next/navigation", () => ({
useRouter: () => ({ push: vi.fn(), replace: vi.fn(), refresh: vi.fn() }),
}));
vi.mock("@/store/emailPrivacyStore", () => ({
default: () => ({ emailsVisible: true }),
}));
const RequestLoggerV2 = (await import("@/shared/components/RequestLoggerV2")).default;
const RequestLoggerDetail = (await import("@/shared/components/RequestLoggerDetail")).default;
let container: HTMLElement;
let root: Root;
const populatedLog = {
id: "log-cache",
status: 200,
method: "POST",
path: "/v1/chat/completions",
model: "gpt-cache",
provider: "openai",
timestamp: "2026-08-10T12:00:00.000Z",
duration: 1_000,
tokens: {
in: 1_000,
out: 250,
cacheRead: 800,
cacheWrite: 120,
reasoning: 50,
compressed: 20,
},
};
const noop = () => {};
async function render(component: React.ReactNode) {
await act(async () => {
root.render(component);
});
}
beforeEach(() => {
container = document.createElement("div");
document.body.appendChild(container);
root = createRoot(container);
});
afterEach(async () => {
await act(async () => {
root.unmount();
});
container.remove();
vi.unstubAllGlobals();
});
describe("request log cache token metrics (#9620)", () => {
it("renders cache read/write beside the existing row token metrics", async () => {
const emptyCacheLog = {
...populatedLog,
id: "log-no-cache",
model: "gpt-no-cache",
timestamp: "2026-08-10T11:59:00.000Z",
tokens: { ...populatedLog.tokens, cacheRead: null, cacheWrite: 0 },
};
vi.stubGlobal(
"fetch",
vi.fn(async (input: RequestInfo | URL) => {
const url = String(input);
if (url.startsWith("/api/usage/call-logs")) {
return Response.json([populatedLog, emptyCacheLog]);
}
if (url.startsWith("/api/provider-nodes")) return Response.json({ nodes: [] });
if (url.startsWith("/api/logs/detail")) return Response.json({ enabled: false });
return Response.json({});
})
);
await render(<RequestLoggerV2 />);
await act(async () => {
await Promise.resolve();
});
const row = Array.from(container.querySelectorAll("tbody tr")).find((candidate) =>
candidate.textContent?.includes("gpt-cache")
);
expect(row?.textContent).toContain("TI: 1,000");
expect(row?.textContent).toContain("TO: 250");
expect(row?.textContent).toContain("CR: 800");
expect(row?.textContent).toContain("CW: 120");
expect(row?.textContent).toContain("↓20");
const emptyRow = Array.from(container.querySelectorAll("tbody tr")).find((candidate) =>
candidate.textContent?.includes("gpt-no-cache")
);
expect(emptyRow?.textContent).toContain("TI: 1,000");
expect(emptyRow?.textContent).toContain("TO: 250");
expect(emptyRow?.textContent).not.toContain("CR:");
expect(emptyRow?.textContent).not.toContain("CW:");
});
it("distinguishes cache read from cache write in the detail view", async () => {
await render(
<RequestLoggerDetail
log={populatedLog}
detail={populatedLog}
loading={false}
debugEnabled={false}
onClose={noop}
onCopy={async () => true}
/>
);
const inputGroup = container.querySelector('[data-testid="token-group-input"]');
const outputGroup = container.querySelector('[data-testid="token-group-output"]');
expect(inputGroup?.textContent).toContain("Total In: 1,000");
expect(inputGroup?.textContent).toContain("Cache Read: 800");
expect(inputGroup?.textContent).toContain("Cache Write: 120");
expect(inputGroup?.textContent).toContain("Compressed:");
expect(outputGroup?.textContent).toContain("Total Out: 250");
expect(outputGroup?.textContent).toContain("Reasoning: 50");
});
it("handles historical null and zero cache values without inventing usage", async () => {
const emptyCacheLog = {
...populatedLog,
id: "log-no-cache",
tokens: { ...populatedLog.tokens, cacheRead: null, cacheWrite: 0 },
};
await render(
<RequestLoggerDetail
log={emptyCacheLog}
detail={emptyCacheLog}
loading={false}
debugEnabled={false}
onClose={noop}
onCopy={async () => true}
/>
);
const inputGroup = container.querySelector('[data-testid="token-group-input"]');
expect(inputGroup?.textContent).toContain("Cache Read: N/A");
expect(inputGroup?.textContent).toContain("Cache Write: 0");
expect(inputGroup?.textContent).toContain("Total In: 1,000");
});
});