Files
OmniRoute/tests/unit/api-key-reveal-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

167 lines
5.7 KiB
TypeScript

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";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-api-key-reveal-"));
process.env.DATA_DIR = TEST_DATA_DIR;
process.env.API_KEY_SECRET = "test-api-key-secret";
const core = await import("../../src/lib/db/core.ts");
const apiKeysDb = await import("../../src/lib/db/apiKeys.ts");
const featureFlagsDb = await import("../../src/lib/db/featureFlags.ts");
const listRoute = await import("../../src/app/api/keys/route.ts");
const revealRoute = await import("../../src/app/api/keys/[id]/reveal/route.ts");
const MACHINE_ID = "1234567890abcdef";
async function resetStorage() {
delete process.env.ALLOW_API_KEY_REVEAL;
delete process.env.INITIAL_PASSWORD;
core.resetDbInstance();
apiKeysDb.resetApiKeyState();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}
function maskKey(key) {
return key.slice(0, 8) + "****" + key.slice(-4);
}
test.beforeEach(async () => {
await resetStorage();
});
test.after(async () => {
delete process.env.ALLOW_API_KEY_REVEAL;
core.resetDbInstance();
apiKeysDb.resetApiKeyState();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
});
test("GET /api/keys stays masked even when reveal is enabled", async () => {
process.env.ALLOW_API_KEY_REVEAL = "true";
const created = await apiKeysDb.createApiKey("Primary Key", MACHINE_ID);
const response = await listRoute.GET(new Request("http://localhost/api/keys"));
const body = (await response.json()) as any;
assert.equal(response.status, 200);
assert.equal(body.allowKeyReveal, true);
assert.equal(Array.isArray(body.keys), true);
assert.equal(body.keys[0].key, maskKey(created.key));
});
test("GET /api/keys falls back to default pagination for invalid query params", async () => {
await apiKeysDb.createApiKey("Alpha", MACHINE_ID);
await apiKeysDb.createApiKey("Beta", MACHINE_ID);
const response = await listRoute.GET(
new Request("http://localhost/api/keys?limit=abc&offset=xyz")
);
const body = (await response.json()) as any;
assert.equal(response.status, 200);
assert.equal(body.allowKeyReveal, false);
assert.equal(body.total, 2);
assert.equal(body.keys.length, 2);
assert.equal(
body.keys.every((entry) => entry.key.includes("****")),
true
);
});
test("GET /api/keys returns 500 when key loading fails unexpectedly", async () => {
await apiKeysDb.createApiKey("Primary Key", MACHINE_ID);
const db = core.getDbInstance();
const originalPrepare = db.prepare.bind(db);
db.prepare = (sql, ...args) => {
if (typeof sql === "string" && sql.includes("SELECT * FROM api_keys")) {
throw new Error("db exploded");
}
return originalPrepare(sql, ...args);
};
apiKeysDb.resetApiKeyState();
try {
const response = await listRoute.GET(new Request("http://localhost/api/keys"));
const body = (await response.json()) as any;
assert.equal(response.status, 500);
assert.equal(body.error, "Failed to fetch keys");
} finally {
db.prepare = originalPrepare;
apiKeysDb.resetApiKeyState();
}
});
test("GET /api/keys/[id]/reveal rejects requests when reveal is disabled", async () => {
const created = await apiKeysDb.createApiKey("Primary Key", MACHINE_ID);
const request = new Request(`http://localhost/api/keys/${created.id}/reveal`);
const response = await revealRoute.GET(request, {
params: Promise.resolve({ id: created.id }),
});
const body = (await response.json()) as any;
assert.equal(response.status, 403);
assert.equal(body.error, "API key reveal is disabled");
});
test("GET /api/keys/[id]/reveal returns the full key when reveal is enabled", async () => {
process.env.ALLOW_API_KEY_REVEAL = "true";
const created = await apiKeysDb.createApiKey("Primary Key", MACHINE_ID);
const request = new Request(`http://localhost/api/keys/${created.id}/reveal`);
const response = await revealRoute.GET(request, {
params: Promise.resolve({ id: created.id }),
});
const body = (await response.json()) as any;
assert.equal(response.status, 200);
assert.equal(body.key, created.key);
});
test("GET /api/keys/[id]/reveal honors the ALLOW_API_KEY_REVEAL feature flag override", async () => {
featureFlagsDb.setFeatureFlagOverride("ALLOW_API_KEY_REVEAL", "true");
const created = await apiKeysDb.createApiKey("Primary Key", MACHINE_ID);
const request = new Request(`http://localhost/api/keys/${created.id}/reveal`);
const response = await revealRoute.GET(request, {
params: Promise.resolve({ id: created.id }),
});
const body = (await response.json()) as any;
assert.equal(response.status, 200);
assert.equal(body.key, created.key);
});
test("GET /api/keys/[id]/reveal returns 404 for unknown keys even when reveal is enabled", async () => {
process.env.ALLOW_API_KEY_REVEAL = "true";
const request = new Request("http://localhost/api/keys/missing/reveal");
const response = await revealRoute.GET(request, {
params: Promise.resolve({ id: "missing" }),
});
const body = (await response.json()) as any;
assert.equal(response.status, 404);
assert.equal(body.error, "Key not found");
});
test("GET /api/keys/[id]/reveal returns 500 when params resolution fails", async () => {
process.env.ALLOW_API_KEY_REVEAL = "true";
const request = new Request("http://localhost/api/keys/broken/reveal");
const response = await revealRoute.GET(request, {
params: Promise.reject(new Error("params exploded")),
});
const body = (await response.json()) as any;
assert.equal(response.status, 500);
assert.equal(body.error, "Failed to reveal key");
});