Files
OmniRoute/tests/unit/cli-logs-route.test.ts
Diego Rodrigues de Sa e Souza 3d4f3e4960 test(infra): retry recursive temp-dir removal instead of failing a shard on ENOTEMPTY (#11966) (#11968)
* test(infra): retry recursive temp-dir removal instead of failing a shard on ENOTEMPTY (#11966)

Two shards on release/v3.8.51 went red in one day with the same signature —
"ENOTEMPTY, Directory not empty: /tmp/omniroute-<test>-XXXXXX" — from
combo-same-provider-cascade (Unit Tests fast-path 4/4, on a PR that touches only
.github/) and auth-policy-embeddings-webfetch-7785 (the 20k-test TIA step). Both pass
alone and on re-run: the cleanup races something still writing into the directory
(SQLite WAL/-shm checkpoint, a worker, the backup) and under a loaded hosted runner
the window opens. 1154 test files do their own cleanup with
fs.rmSync(dir, { recursive: true, force: true }); 57 already asked for retries.

One-shot codemod (scripts/ad-hoc/codemod-rm-maxretries.mjs, kept for the record):
every rm / rmSync / rmdirSync option object with `recursive: true` and no
`maxRetries` gains `maxRetries: 5, retryDelay: 100` — Node itself then retries
ENOTEMPTY/EBUSY/EPERM for up to ~0.5 s before giving up. 2243 call sites in 1292
files under tests/, the shared tests/_setup/isolateDataDir.ts exit hook included.
Only the option object changes: no call site, assertion or import is touched.

Validation: prettier and ESLint (with the frozen suppressions) clean on all 1292
files; a random 20-file sample runs green (quota-redis-store hangs identically on
the untouched tree — it needs a Redis on localhost, an environment matter). The
four unit shards on this PR are the full run.

* fix(quality): let check-forgotten-sibling-tests read a 1,000-file diff

The gate shells out to `git diff` through execFileSync with Node's default 1 MB
maxBuffer; the 1,292-file codemod in this PR is the first diff large enough to
overflow it, and the gate died with `spawnSync git ENOBUFS` before comparing
anything. 64 MB is far above any real PR and costs nothing when unused.
2026-08-29 01:17:40 -03:00

217 lines
7.5 KiB
TypeScript

/**
* Tests for /api/cli-tools/logs route (fix #2756).
*
* Verifies:
* - GET returns 200 with valid JSON array body.
* - `filter` param filters log lines by text.
* - Error responses do NOT leak stack traces (hard rule #12).
* - log-streamer.ts points to the correct URL (/api/cli-tools/logs).
* - Non-numeric `limit` param does NOT bypass the 2000-entry cap.
*/
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 { updateSettings } from "../../src/lib/db/settings";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-cli-logs-route-"));
process.env.DATA_DIR = TEST_DATA_DIR;
// Write a small pino-format log file before route is imported
const logDir = path.join(process.cwd(), "logs", "application");
fs.mkdirSync(logDir, { recursive: true });
const logPath = path.join(logDir, "app.log");
process.env.APP_LOG_FILE_PATH = logPath;
const now = Date.now();
const lines = [
JSON.stringify({ level: 30, msg: "provider connected", component: "router", time: now }),
JSON.stringify({ level: 40, msg: "rate limit hit", component: "rateLimit", time: now }),
JSON.stringify({ level: 20, msg: "debug trace output", component: "debug", time: now }),
"not-valid-json-should-be-skipped",
];
fs.writeFileSync(logPath, lines.join("\n") + "\n", "utf-8");
const { GET } = await import("../../src/app/api/cli-tools/logs/route.ts");
test.before(async () => {
await updateSettings({ requireLogin: false });
});
test.after(async () => {
await updateSettings({ requireLogin: true });
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
try {
fs.unlinkSync(logPath);
} catch {
// best effort
}
});
// Helper — make a request; auth passes because requireLogin is set to false in test.before
function makeReq(queryString = "") {
const url = `http://localhost/api/cli-tools/logs${queryString ? `?${queryString}` : ""}`;
return new Request(url);
}
test("GET /api/cli-tools/logs returns 200 with JSON array when log file exists", async () => {
const res = await GET(makeReq());
assert.equal(res.status, 200);
const body = await res.json();
assert.ok(Array.isArray(body), "body should be an array");
assert.ok(body.length >= 3, `expected at least 3 entries, got ${body.length}`);
});
test("GET /api/cli-tools/logs respects filter param", async () => {
const res = await GET(makeReq("filter=rateLimit"));
assert.equal(res.status, 200);
const body = await res.json();
assert.ok(Array.isArray(body));
// Only the "rate limit hit" entry matches component=rateLimit
assert.ok(
body.every((e: { component?: string; msg?: string }) => {
const comp = (e.component || "").toLowerCase();
const msg = (e.msg || "").toLowerCase();
return comp.includes("ratelimit") || msg.includes("ratelimit") || comp.includes("rate");
}),
"filter should restrict results to matching component/message"
);
});
test("GET /api/cli-tools/logs returns empty array when log file does not exist", async () => {
const origPath = process.env.APP_LOG_FILE_PATH;
process.env.APP_LOG_FILE_PATH = "/tmp/omniroute-nonexistent-cli-logs-test.log";
const res = await GET(makeReq());
assert.equal(res.status, 200);
const body = await res.json();
assert.ok(Array.isArray(body));
assert.equal(body.length, 0);
process.env.APP_LOG_FILE_PATH = origPath;
});
test("GET /api/cli-tools/logs error response does not leak stack traces (hard rule #12)", async () => {
// Simulate an internal error path by temporarily breaking the log path to a dir
const origPath = process.env.APP_LOG_FILE_PATH;
// Point to a directory so readFileSync throws
process.env.APP_LOG_FILE_PATH = TEST_DATA_DIR;
const res = await GET(makeReq());
// Should respond with 500 or empty (route may handle gracefully), but must NOT leak stack
const text = await res.text();
assert.ok(!text.includes(" at "), "Response must not contain stack trace frames");
process.env.APP_LOG_FILE_PATH = origPath;
});
test("GET /api/cli-tools/logs limit=abc does not bypass the 2000-entry cap", async () => {
// Write more than 2000 entries so we can verify the cap is applied
const manyLines: string[] = [];
for (let i = 0; i < 2100; i++) {
manyLines.push(JSON.stringify({ level: 30, msg: `entry ${i}`, component: "test", time: now }));
}
const origPath = process.env.APP_LOG_FILE_PATH;
const bigLogPath = path.join(logDir, "big.log");
fs.writeFileSync(bigLogPath, manyLines.join("\n") + "\n", "utf-8");
process.env.APP_LOG_FILE_PATH = bigLogPath;
try {
const res = await GET(makeReq("limit=abc"));
assert.equal(res.status, 200);
const body = await res.json();
assert.ok(Array.isArray(body), "body should be an array");
// Non-numeric limit must fall back to default (500), not bypass the cap with NaN
assert.ok(
body.length <= 500,
`Non-numeric limit=abc should fall back to default 500, got ${body.length}`
);
} finally {
process.env.APP_LOG_FILE_PATH = origPath;
fs.unlinkSync(bigLogPath);
}
});
test("log-streamer.ts calls /api/cli-tools/logs (correct URL, not the missing route)", async () => {
const { createLogStream } = await import("../../src/lib/cli-helper/log-streamer.ts");
// Inspect the source to verify the URL used; we mock fetch to capture it
const captured: string[] = [];
const origFetch = globalThis.fetch;
globalThis.fetch = (async (url: string) => {
captured.push(typeof url === "string" ? url : String(url));
// Return a mock Response with a body so the stream doesn't error immediately
return new Response(
new ReadableStream({
start(c) {
c.close();
},
}),
{ status: 200 }
);
}) as typeof fetch;
try {
const { stream, stop } = createLogStream({ baseUrl: "http://localhost:20128" });
const reader = stream.getReader();
// Consume until done (mock stream closes immediately)
await reader.read().catch(() => {});
stop();
} finally {
globalThis.fetch = origFetch;
}
assert.ok(captured.length > 0, "fetch should have been called");
assert.ok(
captured.some((u) => u.includes("/api/cli-tools/logs")),
`Expected /api/cli-tools/logs in fetched URL, got: ${captured[0]}`
);
assert.ok(
!captured.some((u) => u.includes("/api/logs/console")),
"log-streamer should not call /api/logs/console"
);
});
test("log-streamer forwards auth headers to fetch (regression: 401 against authed servers)", async () => {
const { createLogStream } = await import("../../src/lib/cli-helper/log-streamer.ts");
let capturedInit: RequestInit | undefined;
const origFetch = globalThis.fetch;
globalThis.fetch = (async (_url: string, init?: RequestInit) => {
capturedInit = init;
return new Response(
new ReadableStream({
start(c) {
c.close();
},
}),
{ status: 200 }
);
}) as typeof fetch;
try {
const { stream, stop } = createLogStream({
baseUrl: "http://localhost:20128",
headers: { authorization: "Bearer test-token" },
});
const reader = stream.getReader();
await reader.read().catch(() => {});
stop();
} finally {
globalThis.fetch = origFetch;
}
assert.ok(capturedInit, "fetch should receive an init object");
const headers = new Headers(capturedInit!.headers);
assert.equal(
headers.get("authorization"),
"Bearer test-token",
"createLogStream must forward the provided auth headers to fetch"
);
});