rubis/apps/api/app/exceptions/handler.ts
ordinarthur f33b2dd319
All checks were successful
Build & Deploy Web / build-and-deploy (push) Successful in 1m9s
Build & Deploy API / build-and-deploy (push) Successful in 2m2s
feat(observability): Sentry monitoring API + Web (ADR-024)
Intégration Sentry SaaS pour error monitoring + replay sur les 2 apps.

API (apps/api) :
- start/sentry.ts : init au plus tôt dans bin/server.ts (avant Ignitor)
  pour capturer les erreurs de bootstrap. No-op si SENTRY_DSN_API absent.
- app/exceptions/handler.ts:report : captureException sur les 5xx avec
  tags { url, method, status } et user.id (PII minimisée). 4xx filtrés
  par beforeSend dans start/sentry.ts (validation, auth invalide = bruit).
- start/env.ts : SENTRY_DSN_API + APP_VERSION optionnels.
- bin/server.ts : import #start/sentry en 1er.
- @sentry/node + @sentry/profiling-node ajoutés au package.json.

Web (apps/web) :
- src/lib/sentry.ts : init au plus tôt dans main.tsx, BrowserTracing +
  Replay (0% session, 100% sur erreur — économie quota free tier).
  maskAllText + blockAllMedia pour privacy par défaut.
- src/lib/auth.ts : Sentry.setUser({ id }) au login, setUser(null) au
  logout (corrélation cross-stack des erreurs front avec un user).
- src/main.tsx : ErrorBoundary autour de l'app avec FallbackError UX.
- vite.config.ts : @sentry/vite-plugin uploads les sourcemaps + les
  SUPPRIME du dist/ final (filesToDeleteAfterUpload) pour ne pas leak
  le code source via nginx en prod. Helper resolveAppVersion() pour
  injecter le sha git en dev (le shell n'étant pas évaluable dans .env).
- src/lib/env.ts : VITE_SENTRY_DSN_WEB + VITE_APP_VERSION optionnels.
- .env.development : VITE_SENTRY_DSN_WEB (préfixé correctement pour
  être exposé par Vite — l'ancienne SENTRY_DSN ne marchait pas).
- @sentry/react + @sentry/vite-plugin ajoutés au package.json.

CI Gitea :
- deploy-api.yml : kubectl set env APP_VERSION=${{ github.sha }}
  runtime → release Sentry trackable au commit pour l'API.
- deploy-web.yml : build-args VITE_SENTRY_DSN_WEB, VITE_APP_VERSION,
  SENTRY_AUTH_TOKEN, SENTRY_ORG injectés depuis les secrets Gitea.
- Dockerfile.web : ARG correspondants + propagation au stage build.

Privacy / sécurité (cf. ADR-024) :
- captureException tags : ctx.route?.pattern (pas l'URL réelle) →
  les codes OAuth (?code=...) et tokens de check-in n'apparaissent
  jamais dans les tags Sentry indexés.
- Sentry user context = user.id UUID seulement, pas d'email/nom.
- Sourcemaps en prod : uploadées à Sentry, supprimées du bundle.
- 4xx filtrées en amont (beforeSend) ET en aval (handler.ts:report).
- DSN public (by-design) commit-able, AUTH_TOKEN secret CI uniquement.

Sample rates (free tier 5K events / 50 replays par mois) :
- traces : 10% prod, 100% dev
- profiles : 100% (sampled par traces)
- replay session : 0% (économie quota)
- replay sur erreur : 100% (debug post-mortem)

Pré-requis runtime à configurer hors-repo :
- Secret K3s rubis-app-secrets : SENTRY_DSN_API
- Secrets Gitea Actions : SENTRY_DSN_WEB, SENTRY_AUTH_TOKEN, SENTRY_ORG

ADR-024 logué dans docs/decisions.md.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-08 13:38:12 +02:00

124 lines
4.4 KiB
TypeScript

import app from '@adonisjs/core/services/app'
import { type HttpContext, ExceptionHandler } from '@adonisjs/core/http'
import * as Sentry from '@sentry/node'
/**
* Exception handler API JSON-only. Normalise toutes les erreurs vers la
* shape `{ errors: [{ code, message, field? }] }` documentée dans
* backend.md §6.
*
* Conversions :
* - PG 23505 (unique violation) → 422 `duplicate` avec field extrait
* - E_INVALID_CREDENTIALS → 401 `invalid_credentials`
* - Vine validation errors → 422 (déjà géré par Adonis, on relaie)
* - Exception custom avec code & status → propage tel quel sous shape errors
* - Reste → fallback super.handle()
*/
export default class HttpExceptionHandler extends ExceptionHandler {
protected debug = !app.inProduction
async handle(error: unknown, ctx: HttpContext) {
if (!isObject(error)) return super.handle(error, ctx)
// Postgres unique violation → 422 propre (pas un 500 avec stack pg-protocol).
if (error.code === '23505') {
const detail = typeof error.detail === 'string' ? error.detail : ''
const fieldMatch = detail.match(/Key \(([^)]+)\)=/)
const field = fieldMatch?.[1]?.split(',')[0]?.trim()
ctx.response.status(422)
return ctx.response.json({
errors: [
{
code: 'duplicate',
message: 'Cette valeur existe déjà.',
field: field ?? undefined,
},
],
})
}
// Adonis auth — mauvais credentials. Le default est 400, on veut 401.
if (error.code === 'E_INVALID_CREDENTIALS') {
ctx.response.status(401)
return ctx.response.json({
errors: [
{
code: 'invalid_credentials',
message: 'Email ou mot de passe incorrect',
},
],
})
}
// Vine — validation errors. Adonis sort déjà des messages structurés,
// on les relaie en `errors[]`.
if (error.code === 'E_VALIDATION_ERROR' && Array.isArray(error.messages)) {
ctx.response.status(422)
return ctx.response.json({
errors: error.messages.map((m) => ({
code: 'validation_failed',
message: typeof m === 'object' && m && 'message' in m ? String(m.message) : '',
field: typeof m === 'object' && m && 'field' in m ? String(m.field) : undefined,
rule: typeof m === 'object' && m && 'rule' in m ? String(m.rule) : undefined,
})),
})
}
// Custom Exception levée par les controllers : on a `status` + `code`
// + `message`. On les passe en shape `errors[]`.
if (
typeof error.status === 'number' &&
typeof error.code === 'string' &&
typeof error.message === 'string' &&
error.status >= 400 &&
error.status < 600
) {
ctx.response.status(error.status)
return ctx.response.json({
errors: [
{
code: error.code,
message: error.message,
},
],
})
}
return super.handle(error, ctx)
}
async report(error: unknown, ctx: HttpContext) {
// Capture seulement les vraies erreurs serveur (pas les 4xx attendues
// type validation, auth invalide, etc. — déjà filtrées par beforeSend
// dans start/sentry.ts mais on garde une 2ème ligne de défense ici).
if (error instanceof Error) {
const status = (error as { status?: number }).status
const isServerError = !status || status >= 500
if (isServerError) {
// SÉCURITÉ : on log le PATTERN de la route ("/api/v1/checkin/:token/paid")
// et pas l'URL réelle, sinon les codes OAuth (?code=...) et les
// tokens de check-in (dans le path) fuiteraient dans les tags
// Sentry, qui sont indexés et consultables par toute l'équipe.
// ctx.request.url(false) strip la query string en fallback.
const route = (ctx as unknown as { route?: { pattern?: string } }).route
const safeUrl = route?.pattern ?? ctx.request.url(false)
Sentry.captureException(error, {
tags: {
url: safeUrl,
method: ctx.request.method(),
status: status?.toString() ?? '500',
},
user: ctx.auth?.user
? { id: String((ctx.auth.user as { id: unknown }).id) }
: undefined,
})
}
}
return super.report(error, ctx)
}
}
function isObject(v: unknown): v is Record<string, unknown> {
return v !== null && typeof v === 'object'
}