feat(errors): platform-wide request ids + error codes + admin inspector
End-to-end error-handling overhaul. A user hitting any failure now sees
a plain-text message + stable error code + reference id. A super admin
can paste the id into /admin/errors/<id> for the full request shape,
sanitized body, error stack, and a heuristic likely-cause hint.
REQUEST CONTEXT (AsyncLocalStorage)
- src/lib/request-context.ts mints a per-request frame carrying
requestId + portId + userId + method + path + start timestamp.
- withAuth wraps every authenticated handler in runWithRequestContext
and accepts an upstream X-Request-Id header (validated shape) or
generates a fresh UUID. The id ALWAYS leaves on the X-Request-Id
response header, including early-return 401/403/4xx paths.
- Pino logger reads from the same context via mixin — every log
line emitted during the request automatically carries the ids
with no per-call threading.
ERROR CODE REGISTRY
- src/lib/error-codes.ts defines stable DOMAIN_REASON codes with
HTTP status + plain-text user-facing message (no jargon, written
for the rep on the phone with a customer).
- New CodedError class wraps a registered code + optional
internalMessage (admin-only — never sent to client).
- Existing AppError subclasses got plain-text default rewrites so
legacy throw sites improve immediately without migration.
- High-impact services migrated to specific codes:
expenses (RECEIPT_REQUIRED, INVOICE_LINKED), interest-berths
(CROSS_PORT_LINK_REJECTED), berth-pdf (PDF_MAGIC_BYTE / PDF_EMPTY /
PDF_TOO_LARGE / VERSION_ALREADY_CURRENT), recommender
(INTEREST_PORT_MISMATCH).
ERROR ENVELOPE
- errorResponse always sets X-Request-Id header + requestId field.
- 5xx responses include a "Quote error ID …" friendly line.
- 4xx kept clean (validation, permission, not-found don't pollute
the inspector — they're already in audit log).
PERSISTENCE (error_events table, migration 0040)
- One row per 5xx, keyed on requestId, with method/path/status/error
name+message/stack head (4KB cap)/sanitized body excerpt (1KB cap;
password/token/secret/etc keys redacted)/duration/IP/UA/metadata.
- captureErrorEvent extracts Postgres SQLSTATE/severity/cause.code
so the classifier can recognize FK / unique / NOT NULL / schema-
drift violations.
- Failure to persist is logged-not-thrown.
LIKELY-CULPRIT CLASSIFIER (src/lib/error-classifier.ts)
- 4-pass heuristic (first match wins):
1. Postgres SQLSTATE → human reason (23503 FK, 23505 unique,
42703 schema drift, 53300 connection limit, …)
2. Error class name (AbortError, TimeoutError, FetchError,
ZodError)
3. Stack-path patterns (/lib/storage/, /lib/email/, documenso,
openai|claude, /queue/workers/)
4. Free-text message keywords (econnrefused, rate limit, timeout,
unauthorized|invalid api key)
- Returns { label, hint, subsystem } for the inspector badge.
CLIENT SIDE
- apiFetch throws structured ApiError with message + code + requestId
+ details + retryAfter.
- toastError() helper renders the standard 3-line toast:
plain message / Error code: X / Reference ID: Y [Copy ID].
ADMIN INSPECTOR
- /<port>/admin/errors lists captured 5xx with status badge + path +
likely-culprit badge + truncated message + reference id. Filter by
status code; auto-refresh via TanStack Query.
- /<port>/admin/errors/<requestId> deep-dive: request shape, full
error name+message+stack, sanitized body excerpt, raw metadata,
registered-code lookup (so admin can compare to what user saw),
likely-culprit hint with subsystem tag.
- /<port>/admin/errors/codes is the in-app code reference page —
every registered code grouped by domain prefix, searchable, with
HTTP status + user message inline. Linked from inspector header
so admins can flip to it while triaging.
- Permission: admin.view_audit_log. Super admins see all ports;
regular admins port-scoped.
- system-monitoring dashboard now surfaces error_events alongside
permission_denied audit + queue failed jobs (RecentError gains
source: 'request' variant).
DOCS
- docs/error-handling.md walks through coded errors, plain-text
message guidelines, client toasting, admin inspector usage,
persistence rules, classifier internals, pruning, and the
legacy → CodedError migration path.
MIGRATION SAFETY
- Audit confirmed all 41 migrations (0000-0040) apply cleanly in
journal order against an empty DB. 0040 references ports(id)
which exists from 0000. 0035/0038 don't deadlock under sequential
psql -f. Removed redundant idx_ds_sent_by from 0038 (created in
0037).
Tests: 1168/1168 vitest passing. tsc clean.
- security-error-responses tests updated for plain-text messages
+ new optional response keys (code/requestId/message).
- berth-pdf-versions tests assert stable error codes via
toMatchObject({ code }) rather than message regex.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
import { db } from '@/lib/db';
|
||||
import { auditLogs } from '@/lib/db/schema';
|
||||
import { auditLogs, errorEvents } from '@/lib/db/schema';
|
||||
import { redis } from '@/lib/redis';
|
||||
import { minioClient } from '@/lib/minio/index';
|
||||
import { getQueue, QUEUE_CONFIGS, type QueueName } from '@/lib/queue';
|
||||
@@ -56,10 +56,17 @@ export interface ConnectionStatus {
|
||||
|
||||
export interface RecentError {
|
||||
id: string;
|
||||
source: 'audit' | 'queue';
|
||||
source: 'audit' | 'queue' | 'request';
|
||||
message: string;
|
||||
timestamp: Date;
|
||||
metadata?: Record<string, unknown>;
|
||||
/** Set for `source: 'request'` rows so the UI can deep-link to
|
||||
* /admin/errors/<requestId>. */
|
||||
requestId?: string;
|
||||
/** Set for `source: 'request'` rows. */
|
||||
statusCode?: number;
|
||||
/** Set for `source: 'request'` rows. */
|
||||
errorCode?: string | null;
|
||||
}
|
||||
|
||||
// ─── Timeout helper ───────────────────────────────────────────────────────────
|
||||
@@ -364,8 +371,42 @@ export async function getRecentErrors(limit = 20): Promise<RecentError[]> {
|
||||
.filter((r): r is PromiseFulfilledResult<RecentError[]> => r.status === 'fulfilled')
|
||||
.flatMap((r) => r.value);
|
||||
|
||||
// Captured 5xx requests from the per-request error_events table —
|
||||
// this is the deepest source: full stack head + body excerpt + path.
|
||||
// The dedicated /admin/errors page paginates this; here we surface
|
||||
// the most recent for the dashboard.
|
||||
const requestErrorRows = await db
|
||||
.select({
|
||||
requestId: errorEvents.requestId,
|
||||
statusCode: errorEvents.statusCode,
|
||||
method: errorEvents.method,
|
||||
path: errorEvents.path,
|
||||
errorName: errorEvents.errorName,
|
||||
errorMessage: errorEvents.errorMessage,
|
||||
metadata: errorEvents.metadata,
|
||||
createdAt: errorEvents.createdAt,
|
||||
})
|
||||
.from(errorEvents)
|
||||
.orderBy(desc(errorEvents.createdAt))
|
||||
.limit(limit);
|
||||
|
||||
const requestErrors: RecentError[] = requestErrorRows.map((row) => {
|
||||
const meta = (row.metadata as Record<string, unknown>) ?? {};
|
||||
return {
|
||||
id: row.requestId,
|
||||
source: 'request' as const,
|
||||
message:
|
||||
`${row.method} ${row.path} → ${row.statusCode} ${row.errorMessage ?? row.errorName ?? ''}`.trim(),
|
||||
timestamp: row.createdAt,
|
||||
metadata: meta,
|
||||
requestId: row.requestId,
|
||||
statusCode: row.statusCode,
|
||||
errorCode: typeof meta.code === 'string' ? meta.code : null,
|
||||
};
|
||||
});
|
||||
|
||||
// Merge and sort combined list by timestamp descending
|
||||
const combined = [...auditResults, ...queueErrors].sort(
|
||||
const combined = [...auditResults, ...queueErrors, ...requestErrors].sort(
|
||||
(a, b) => b.timestamp.getTime() - a.timestamp.getTime(),
|
||||
);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user