Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 224 additions & 0 deletions src/codex/quota-rejection.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
import { readBoundedResponseBody } from "../lib/bounded-body";

const RESET_ELIGIBLE_CODE_VALUES = [
"usage_limit_exceeded",
"insufficient_quota",
] as const;

export type CodexResetEligibleExhaustionCode =
(typeof RESET_ELIGIBLE_CODE_VALUES)[number];

export type CodexPreStreamRejectionKind =
| "reset-eligible-exhaustion"
| "generic-rate-limit"
| "unverified-billing-or-quota"
| "transient-server-error"
| "authentication-error"
| "permission-error"
| "other";

export interface CodexPreStreamRejection {
kind: CodexPreStreamRejectionKind;
status: number;
alternateRetryEligible: boolean;
resetCreditEligible: boolean;
semanticCode?: CodexResetEligibleExhaustionCode;
}

const RESET_ELIGIBLE_CODES: ReadonlySet<string> = new Set(RESET_ELIGIBLE_CODE_VALUES);

const TRANSIENT_SERVER_STATUSES = new Set([500, 502, 503, 504, 520, 521, 522]);
const JSON_NUMBER_PATTERN = /-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?/y;

function rejection(
status: number,
kind: CodexPreStreamRejectionKind,
options: {
alternateRetryEligible?: boolean;
semanticCode?: CodexResetEligibleExhaustionCode;
} = {},
): CodexPreStreamRejection {
return {
kind,
status,
alternateRetryEligible: options.alternateRetryEligible === true,
resetCreditEligible: options.semanticCode !== undefined,
...(options.semanticCode ? { semanticCode: options.semanticCode } : {}),
};
}

function hasOwnField(container: Record<string, unknown>, field: string): boolean {
return Object.prototype.hasOwnProperty.call(container, field);
}

type JsonScanResult = {
next: number;
duplicate: boolean;
};

function skipJsonWhitespace(text: string, index: number): number {
while (index < text.length && /[\t\n\r ]/.test(text[index] ?? "")) index += 1;
return index;
}

function scanJsonStringEnd(text: string, index: number): number {
if (text[index] !== '"') throw new SyntaxError("expected JSON string");
for (let cursor = index + 1; cursor < text.length; cursor += 1) {
const char = text[cursor];
if (char === '"') return cursor + 1;
if (char === "\\") cursor += 1;
}
throw new SyntaxError("unterminated JSON string");
}

function scanJsonValue(text: string, index: number): JsonScanResult {
const start = skipJsonWhitespace(text, index);
if (text[start] === "{") return scanJsonObject(text, start);
if (text[start] === "[") return scanJsonArray(text, start);
if (text[start] === '"') return { next: scanJsonStringEnd(text, start), duplicate: false };

for (const literal of ["true", "false", "null"]) {
if (text.startsWith(literal, start)) {
return { next: start + literal.length, duplicate: false };
}
}
JSON_NUMBER_PATTERN.lastIndex = start;
const number = JSON_NUMBER_PATTERN.exec(text);
if (!number) throw new SyntaxError("expected JSON value");
return { next: start + number[0].length, duplicate: false };
}

function scanJsonObject(text: string, index: number): JsonScanResult {
const keys = new Set<string>();
let duplicate = false;
let cursor = skipJsonWhitespace(text, index + 1);
if (text[cursor] === "}") return { next: cursor + 1, duplicate: false };

while (cursor < text.length) {
const keyEnd = scanJsonStringEnd(text, cursor);
const key = JSON.parse(text.slice(cursor, keyEnd)) as unknown;
if (typeof key !== "string") throw new SyntaxError("invalid JSON object key");
if (keys.has(key)) duplicate = true;
keys.add(key);

cursor = skipJsonWhitespace(text, keyEnd);
if (text[cursor] !== ":") throw new SyntaxError("expected JSON object colon");
const value = scanJsonValue(text, cursor + 1);
duplicate ||= value.duplicate;
cursor = skipJsonWhitespace(text, value.next);
if (text[cursor] === "}") return { next: cursor + 1, duplicate };
if (text[cursor] !== ",") throw new SyntaxError("expected JSON object separator");
cursor = skipJsonWhitespace(text, cursor + 1);
}
throw new SyntaxError("unterminated JSON object");
}

function scanJsonArray(text: string, index: number): JsonScanResult {
let duplicate = false;
let cursor = skipJsonWhitespace(text, index + 1);
if (text[cursor] === "]") return { next: cursor + 1, duplicate: false };

while (cursor < text.length) {
const value = scanJsonValue(text, cursor);
duplicate ||= value.duplicate;
cursor = skipJsonWhitespace(text, value.next);
if (text[cursor] === "]") return { next: cursor + 1, duplicate };
if (text[cursor] !== ",") throw new SyntaxError("expected JSON array separator");
cursor = skipJsonWhitespace(text, cursor + 1);
}
throw new SyntaxError("unterminated JSON array");
}

function isUnsafeJsonDocument(text: string): boolean {
try {
const result = scanJsonValue(text, 0);
return result.duplicate || skipJsonWhitespace(text, result.next) !== text.length;
} catch {
// Scanner disagreement is untrusted input, just like JSON.parse failure.
return true;
}
}

function exactResetEligibleCode(
container: Record<string, unknown>,
): CodexResetEligibleExhaustionCode | undefined {
const hasCode = hasOwnField(container, "code");
const hasType = hasOwnField(container, "type");
if (!hasCode && !hasType) return undefined;

const code = hasCode ? container.code : undefined;
const type = hasType ? container.type : undefined;
if ((hasCode && typeof code !== "string") || (hasType && typeof type !== "string")) {
return undefined;
}
if (hasCode && hasType && code !== type) return undefined;

const value = hasCode ? code : type;
if (typeof value !== "string") return undefined;
return RESET_ELIGIBLE_CODES.has(value as CodexResetEligibleExhaustionCode)
? value as CodexResetEligibleExhaustionCode
: undefined;
}

function structuredResetEligibleCode(payload: unknown): CodexResetEligibleExhaustionCode | undefined {
if (!payload || typeof payload !== "object" || Array.isArray(payload)) return undefined;
const root = payload as Record<string, unknown>;
const hasRootDiscriminator = hasOwnField(root, "code") || hasOwnField(root, "type");

if (!hasOwnField(root, "error")) return exactResetEligibleCode(root);
if (hasRootDiscriminator) return undefined;

const nested = root.error;
if (!nested || typeof nested !== "object" || Array.isArray(nested)) return undefined;
return exactResetEligibleCode(nested as Record<string, unknown>);
}

async function resetEligibleCodeFromResponse(
response: Response,
signal?: AbortSignal,
): Promise<CodexResetEligibleExhaustionCode | undefined> {
try {
const body = await readBoundedResponseBody(response.clone(), { signal, fatalUtf8: true });
if (!body.displaySafe || body.truncated || !body.text.trim()) return undefined;
const payload = JSON.parse(body.text) as unknown;
// JSON.parse silently keeps the last duplicate key, making contradictory
// payloads order-dependent. Reject any duplicate at any object depth.
if (isUnsafeJsonDocument(body.text)) return undefined;
return structuredResetEligibleCode(payload);
} catch {
// Classification must fail closed. A malformed, oversized, consumed, or
// cancelled body cannot authorize an irreversible reset-credit operation.
return undefined;
}
}

/**
* Classify an upstream Codex rejection before any response event is exposed.
*
* Only an exact structured exhaustion code on HTTP 429/402 is reset-eligible.
* Status alone and message text are intentionally insufficient. The broad
* alternate-account retry remains eligible for 429/402 to preserve #584.
*/
export async function classifyCodexPreStreamRejection(
response: Response,
options: { signal?: AbortSignal } = {},
): Promise<CodexPreStreamRejection> {
const status = response.status;
if (status === 401) return rejection(status, "authentication-error");
if (status === 403) return rejection(status, "permission-error");
if (TRANSIENT_SERVER_STATUSES.has(status)) return rejection(status, "transient-server-error");
if (status !== 429 && status !== 402) return rejection(status, "other");

const semanticCode = await resetEligibleCodeFromResponse(response, options.signal);
if (semanticCode) {
return rejection(status, "reset-eligible-exhaustion", {
alternateRetryEligible: true,
semanticCode,
});
}
return rejection(
status,
status === 429 ? "generic-rate-limit" : "unverified-billing-or-quota",
{ alternateRetryEligible: true },
);
Comment thread
luvs01 marked this conversation as resolved.
}
14 changes: 10 additions & 4 deletions src/lib/bounded-body.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ export const BOUNDED_BODY_TIMEOUT_MS = 5_000;
export interface BoundedBodyOptions {
/** Abort the read with this signal. Its reason is rethrown by identity. */
signal?: AbortSignal;
/**
* Reject the returned promise with TypeError on malformed or truncated UTF-8
* instead of replacing invalid bytes, including during timeout-path flushes.
* Reader cancellation and lock release still run. Defaults to false.
*/
fatalUtf8?: boolean;
/**
* Byte ceiling for retained body data. Defaults to BOUNDED_BODY_MAX_BYTES (64 KiB),
* which suits error bodies; callers materializing whole success payloads (e.g. a
Expand Down Expand Up @@ -75,8 +81,8 @@ function cancelWithoutWaiting(reader: ReadableStreamDefaultReader<Uint8Array>, r
}
}

function decodeUtf8(chunks: readonly Uint8Array[]): string {
const decoder = new TextDecoder();
function decodeUtf8(chunks: readonly Uint8Array[], fatal: boolean): string {
const decoder = new TextDecoder("utf-8", { fatal });
let text = "";
for (const chunk of chunks) text += decoder.decode(chunk, { stream: true });
// Flush an incomplete trailing UTF-8 sequence deterministically.
Expand Down Expand Up @@ -158,7 +164,7 @@ export async function readBoundedResponseBody(
"TimeoutError",
);
return {
text: decodeUtf8([retained.subarray(0, retainedBytes)]),
text: decodeUtf8([retained.subarray(0, retainedBytes)], options.fatalUtf8 === true),
truncated: true,
timedOut: true,
totalTimedOut: outcome === TOTAL_TIMEOUT,
Expand All @@ -171,7 +177,7 @@ export async function readBoundedResponseBody(
const { value, done } = outcome as ReadableStreamReadResult<Uint8Array>;
if (done) {
return {
text: decodeUtf8([retained.subarray(0, retainedBytes)]),
text: decodeUtf8([retained.subarray(0, retainedBytes)], options.fatalUtf8 === true),
truncated: false,
timedOut: false,
totalTimedOut: false,
Expand Down
4 changes: 2 additions & 2 deletions src/server/responses/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,8 @@ async function shouldRetryCodexPoolAccountModel400(
}

/** Pre-stream quota/billing rejections that warrant one alternate-account attempt (#584). */
function shouldRetryCodexPoolAccountQuota(response: Response): boolean {
return response.status === 429 || response.status === 402;
export function shouldRetryCodexPoolAccountQuota(response: Response): boolean {
return response.status === 402 || response.status === 429;
}

interface CodexPoolAccountRetryArgs {
Expand Down
Loading
Loading