Files
OmniRoute/tests/unit/codex-scope-cooldown-clear-12817.test.ts
Bob.Hou bfbd090a96 fix(codex): lift nested child cooldowns on parent clear and on snapshot headroom (#12951)
Validado numa worktree combinada com a onda de persistência desta leva sobre `release/v3.8.51`: check-file-size e check-changelog-integrity OK, typecheck:core limpo, check-api-typecheck OK (289). Revalidei o head atual mergeado com o tip: typecheck:core limpo e **36/36** entre `db-rate-limit-guard` e as suítes desta PR.

Levantar o cooldown do escopo pai sem deixar os filhos aninhados presos é o miolo — um cooldown órfão em filho é invisível no dashboard e mantém a conexão fora de rota sem explicação.

**Nota de coordenação:** o `setConnectionRateLimitUntil` colidiu com o #12788 (guard contra timestamp não-finito ou já expirado), que mergeei nesta mesma onda. Eu tinha resolvido a integração na minha worktree, mas ao empurrar o push foi rejeitado — você já tinha empurrado `441fd44`, `f853ba5` e `af2ed01` com a integração feita, e a sua ordenação é equivalente à minha. Descartei a minha e mantive a sua; o crédito é seu inteiro. Fica o registro de que push rejeitado não é erro leve: se eu tivesse mergeado sem reler, teria levado a branch errada.
2026-09-10 08:15:57 -03:00

450 lines
16 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 "path";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-codex-clear-12817-"));
process.env.DATA_DIR = TEST_DATA_DIR;
process.env.API_KEY_SECRET = process.env.API_KEY_SECRET || "codex-clear-12817-secret";
const core = await import("../../src/lib/db/core.ts");
const providersDb = await import("../../src/lib/db/providers.ts");
const rateLimit = await import("../../src/lib/db/providers/rateLimit.ts");
const codexAccount = await import("../../open-sse/services/codexAccount/index.ts");
const quotaSnapshots = await import("../../src/lib/db/quotaSnapshots.ts");
const quotaCache = await import("../../src/domain/quotaCache.ts");
async function resetStorage(): Promise<void> {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}
interface SeededConnection {
id: string;
providerSpecificData: Record<string, unknown>;
}
async function seedCodexConnection(): Promise<SeededConnection> {
return providersDb.createProviderConnection({
provider: "codex",
authType: "oauth",
name: "codex-clear-12817",
email: "codex-clear-12817@example.com",
apiKey: "codex-clear-12817-key",
accessToken: "codex-clear-12817-access",
refreshToken: "codex-clear-12817-refresh",
providerSpecificData: {
unrelated: { retained: true },
},
}) as unknown as Promise<SeededConnection>;
}
async function seedGlmConnection(): Promise<SeededConnection> {
return providersDb.createProviderConnection({
provider: "glm",
authType: "apikey",
name: "glm-clear-12817",
apiKey: "glm-clear-12817-key",
providerSpecificData: {
leftover: "keep-me",
},
}) as unknown as Promise<SeededConnection>;
}
async function readConnection(id: string): Promise<Record<string, unknown>> {
const connection = await providersDb.getProviderConnectionById(id);
assert.ok(connection);
return connection as unknown as Record<string, unknown>;
}
function psd(connection: Record<string, unknown>): Record<string, unknown> {
return (connection.providerSpecificData ?? {}) as Record<string, unknown>;
}
function futureIso(ms: number): string {
return new Date(Date.now() + ms).toISOString();
}
function quotaHeaders(resetAt5h: string, resetAt7d: string, usage5h = "10") {
return {
"x-codex-5h-usage": usage5h,
"x-codex-5h-limit": "100",
"x-codex-5h-reset-at": resetAt5h,
"x-codex-7d-usage": "10",
"x-codex-7d-limit": "100",
"x-codex-7d-reset-at": resetAt7d,
};
}
async function persistBothChildCooldowns(id: string): Promise<{
codexUntil: string;
sparkUntil: string;
}> {
const codexUntil = futureIso(60_000);
const sparkUntil = futureIso(120_000);
await codexAccount.persistCodexChildCooldown({
connectionId: id,
model: "gpt-5.5",
rateLimitedUntil: codexUntil,
});
await codexAccount.persistCodexChildCooldown({
connectionId: id,
model: "gpt-5.3-codex-spark",
rateLimitedUntil: sparkUntil,
});
return { codexUntil, sparkUntil };
}
test.beforeEach(resetStorage);
test.after(() => {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
});
test("#12817 PUT rateLimitedUntil:null also drops nested Codex child cooldowns", async () => {
const connection = await seedCodexConnection();
const { sparkUntil } = await persistBothChildCooldowns(connection.id);
await providersDb.updateProviderConnection(connection.id, {
rateLimitedUntil: futureIso(90_000),
});
const before = await readConnection(connection.id);
assert.equal(
codexAccount.getCodexChildCooldown(before as never, "gpt-5.3-codex-spark"),
sparkUntil
);
await providersDb.updateProviderConnection(connection.id, { rateLimitedUntil: null });
const after = await readConnection(connection.id);
const data = psd(after);
assert.equal(after.rateLimitedUntil, undefined);
assert.equal(data.codexScopeRateLimitedUntil, undefined);
assert.equal(data.codexScopeRateLimitSource, undefined);
assert.deepEqual(data.unrelated, { retained: true });
assert.equal(codexAccount.getCodexChildCooldown(after as never, "gpt-5.5"), null);
assert.equal(codexAccount.getCodexChildCooldown(after as never, "gpt-5.3-codex-spark"), null);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12817 PUT rateLimitedUntil:\"\" also drops nested Codex child cooldowns", async () => {
const connection = await seedCodexConnection();
await persistBothChildCooldowns(connection.id);
await providersDb.updateProviderConnection(connection.id, {
rateLimitedUntil: futureIso(90_000),
});
await providersDb.updateProviderConnection(connection.id, { rateLimitedUntil: "" });
const after = await readConnection(connection.id);
const data = psd(after);
assert.equal(after.rateLimitedUntil, undefined);
assert.equal(data.codexScopeRateLimitedUntil, undefined);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12817 clearConnectionRateLimit strips nested Codex child cooldowns", async () => {
const connection = await seedCodexConnection();
await persistBothChildCooldowns(connection.id);
rateLimit.setConnectionRateLimitUntil(connection.id, Date.now() + 90_000);
rateLimit.clearConnectionRateLimit(connection.id);
const after = await readConnection(connection.id);
const data = psd(after);
assert.equal(after.rateLimitedUntil, undefined);
assert.equal(data.codexScopeRateLimitedUntil, undefined);
assert.equal(data.codexScopeRateLimitSource, undefined);
assert.deepEqual(data.unrelated, { retained: true });
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12817 CAS error-clear also strips nested Codex child cooldowns", async () => {
const connection = await seedCodexConnection();
await persistBothChildCooldowns(connection.id);
const until = futureIso(90_000);
await providersDb.updateProviderConnection(connection.id, {
testStatus: "unavailable",
lastError: "429",
lastErrorAt: new Date().toISOString(),
lastErrorType: "rate_limit_exceeded",
rateLimitedUntil: until,
});
const before = await readConnection(connection.id);
const applied = await providersDb.clearConnectionErrorIfUnchanged(connection.id, {
testStatus: (before.testStatus as string) ?? null,
lastErrorAt: (before.lastErrorAt as string) ?? null,
rateLimitedUntil: (before.rateLimitedUntil as string) ?? null,
});
assert.equal(applied, true);
const after = await readConnection(connection.id);
assert.equal(after.testStatus, "active");
assert.equal(psd(after).codexScopeRateLimitedUntil, undefined);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12817 a successful quota observation clears that child's leftover cooldown", async () => {
const connection = await seedCodexConnection();
const reset5h = futureIso(60_000);
const reset7d = futureIso(600_000);
await persistBothChildCooldowns(connection.id);
await codexAccount.persistCodexChildQuotaResponse({
connectionId: connection.id,
model: "gpt-5.5",
headers: quotaHeaders(reset5h, reset7d, "95"),
status: 429,
});
await codexAccount.persistCodexChildQuotaResponse({
connectionId: connection.id,
model: "gpt-5.5",
headers: quotaHeaders(reset5h, reset7d, "10"),
status: 200,
});
const after = await readConnection(connection.id);
const data = psd(after);
const until = data.codexScopeRateLimitedUntil as Record<string, unknown> | undefined;
const exhausted = data.codexExhaustedWindowByScope as Record<string, unknown> | undefined;
assert.equal(until?.codex, undefined);
assert.equal(typeof until?.spark, "string");
assert.equal(exhausted?.codex, undefined);
assert.deepEqual(data.unrelated, { retained: true });
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.3-codex-spark"), true);
});
test("#12817 clearing a non-Codex cooldown leaves providerSpecificData alone", async () => {
const connection = await seedGlmConnection();
await providersDb.updateProviderConnection(connection.id, {
rateLimitedUntil: futureIso(90_000),
});
await providersDb.updateProviderConnection(connection.id, { rateLimitedUntil: null });
const after = await readConnection(connection.id);
assert.equal(after.rateLimitedUntil, undefined);
assert.equal(psd(after).leftover, "keep-me");
});
test("#12860 saveQuotaSnapshot with headroom lifts fallback-sourced scope cooldown", async () => {
const connection = await seedCodexConnection();
await persistBothChildCooldowns(connection.id);
const before = await readConnection(connection.id);
assert.ok(codexAccount.getCodexChildCooldown(before as never, "gpt-5.5"));
quotaSnapshots.saveQuotaSnapshot({
provider: "codex",
connection_id: connection.id,
window_key: "primary",
remaining_percentage: 100,
is_exhausted: 0,
next_reset_at: futureIso(3600_000),
window_duration_ms: 18_000_000,
raw_data: null,
});
const after = await readConnection(connection.id);
const data = psd(after);
const until = data.codexScopeRateLimitedUntil as Record<string, unknown> | undefined;
assert.equal(until?.codex, undefined);
assert.equal(typeof until?.spark, "string");
assert.equal(codexAccount.getCodexChildCooldown(after as never, "gpt-5.5"), null);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12860 saveQuotaSnapshot with headroom does NOT lift authoritative quota_reset cooldown", async () => {
const connection = await seedCodexConnection();
const reset5h = futureIso(120_000);
const reset7d = futureIso(600_000);
await codexAccount.persistCodexChildQuotaResponse({
connectionId: connection.id,
model: "gpt-5.5",
headers: quotaHeaders(reset5h, reset7d, "95"),
status: 429,
});
const before = await readConnection(connection.id);
assert.ok(codexAccount.getCodexChildCooldown(before as never, "gpt-5.5"));
quotaSnapshots.saveQuotaSnapshot({
provider: "codex",
connection_id: connection.id,
window_key: "session",
remaining_percentage: 100,
is_exhausted: 0,
next_reset_at: futureIso(3600_000),
window_duration_ms: 18_000_000,
raw_data: null,
});
const after = await readConnection(connection.id);
const data = psd(after);
const until = data.codexScopeRateLimitedUntil as Record<string, unknown> | undefined;
assert.equal(typeof until?.codex, "string");
assert.ok(codexAccount.getCodexChildCooldown(after as never, "gpt-5.5"));
});
test("#12860 saveQuotaSnapshot does NOT lift scope cooldown if another window for that scope is still exhausted", async () => {
const connection = await seedCodexConnection();
await codexAccount.persistCodexChildCooldown({
connectionId: connection.id,
model: "gpt-5.5",
rateLimitedUntil: futureIso(120_000),
});
// Weekly window is currently exhausted (0% remaining)
quotaSnapshots.saveQuotaSnapshot({
provider: "codex",
connection_id: connection.id,
window_key: "weekly",
remaining_percentage: 0,
is_exhausted: 1,
next_reset_at: futureIso(7200_000),
window_duration_ms: 604_800_000,
raw_data: null,
});
// Session window reports 100% headroom, but weekly is still exhausted
quotaSnapshots.saveQuotaSnapshot({
provider: "codex",
connection_id: connection.id,
window_key: "session",
remaining_percentage: 100,
is_exhausted: 0,
next_reset_at: futureIso(3600_000),
window_duration_ms: 18_000_000,
raw_data: null,
});
let mid = await readConnection(connection.id);
assert.ok(codexAccount.getCodexChildCooldown(mid as never, "gpt-5.5"));
// Now weekly also recovers to 100% headroom
quotaSnapshots.saveQuotaSnapshot({
provider: "codex",
connection_id: connection.id,
window_key: "weekly",
remaining_percentage: 100,
is_exhausted: 0,
next_reset_at: futureIso(7200_000),
window_duration_ms: 604_800_000,
raw_data: null,
});
let after = await readConnection(connection.id);
assert.equal(codexAccount.getCodexChildCooldown(after as never, "gpt-5.5"), null);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12860 saveQuotaSnapshot for spark scope with headroom lifts only spark cooldown", async () => {
const connection = await seedCodexConnection();
await persistBothChildCooldowns(connection.id);
quotaSnapshots.saveQuotaSnapshot({
provider: "codex",
connection_id: connection.id,
window_key: "gpt_5_3_codex_spark_session",
remaining_percentage: 100,
is_exhausted: 0,
next_reset_at: futureIso(3600_000),
window_duration_ms: 18_000_000,
raw_data: null,
});
const after = await readConnection(connection.id);
const data = psd(after);
const until = data.codexScopeRateLimitedUntil as Record<string, unknown> | undefined;
assert.equal(typeof until?.codex, "string");
assert.equal(until?.spark, undefined);
assert.ok(codexAccount.getCodexChildCooldown(after as never, "gpt-5.5"));
assert.equal(codexAccount.getCodexChildCooldown(after as never, "gpt-5.3-codex-spark"), null);
});
test("#12860 setQuotaCache with fresh usage headroom lifts fallback-sourced scope cooldown", async () => {
const connection = await seedCodexConnection();
await persistBothChildCooldowns(connection.id);
const before = await readConnection(connection.id);
assert.ok(codexAccount.getCodexChildCooldown(before as never, "gpt-5.5"));
quotaCache.setQuotaCache(connection.id, "codex", {
session: {
used: 0,
total: 100,
remainingPercentage: 100,
resetAt: futureIso(3600_000),
},
});
const after = await readConnection(connection.id);
const data = psd(after);
const until = data.codexScopeRateLimitedUntil as Record<string, unknown> | undefined;
assert.equal(until?.codex, undefined);
assert.equal(typeof until?.spark, "string");
assert.equal(codexAccount.getCodexChildCooldown(after as never, "gpt-5.5"), null);
assert.equal(codexAccount.isCodexChildUnavailable(after as never, "gpt-5.5"), false);
});
test("#12860 quota_reset cooldown that just elapsed is still held by the skew grace window", async () => {
const connection = await seedCodexConnection();
// Reset deadline sits 5s in the past — inside the 30s clock-skew grace, so a
// fast local clock must not lift an upstream-authoritative cooldown early.
const justElapsed = new Date(Date.now() - 5_000).toISOString();
await providersDb.updateProviderConnection(connection.id, {
providerSpecificData: {
codexScopeRateLimitedUntil: { codex: justElapsed },
codexScopeRateLimitSource: { codex: "quota_reset" },
},
});
const lifted = providersDb.liftCodexScopeCooldownOnHeadroom(connection.id, "codex");
assert.equal(lifted, false);
const after = await readConnection(connection.id);
const until = psd(after).codexScopeRateLimitedUntil as Record<string, unknown> | undefined;
assert.equal(until?.codex, justElapsed);
});
test("#12860 quota_reset cooldown past the skew grace window is lifted", async () => {
const connection = await seedCodexConnection();
const wellElapsed = new Date(Date.now() - 120_000).toISOString();
await providersDb.updateProviderConnection(connection.id, {
providerSpecificData: {
codexScopeRateLimitedUntil: { codex: wellElapsed },
codexScopeRateLimitSource: { codex: "quota_reset" },
},
});
const lifted = providersDb.liftCodexScopeCooldownOnHeadroom(connection.id, "codex");
assert.equal(lifted, true);
const after = await readConnection(connection.id);
assert.equal(psd(after).codexScopeRateLimitedUntil, undefined);
});
test("#12860 hasCodexScopeCooldown short-circuits the snapshot scan when nothing is parked", async () => {
const connection = await seedCodexConnection();
assert.equal(providersDb.hasCodexScopeCooldown(connection.id, "codex"), false);
await codexAccount.persistCodexChildCooldown({
connectionId: connection.id,
model: "gpt-5.5",
rateLimitedUntil: futureIso(120_000),
});
assert.equal(providersDb.hasCodexScopeCooldown(connection.id, "codex"), true);
assert.equal(providersDb.hasCodexScopeCooldown(connection.id, "spark"), false);
const glm = await seedGlmConnection();
assert.equal(providersDb.hasCodexScopeCooldown(glm.id, "codex"), false);
assert.equal(providersDb.hasCodexScopeCooldown("does-not-exist", "codex"), false);
});