Tratamento de Erros

Padrões de Tratamento de Erros

Padrões consistentes e robustos de tratamento de erros para aplicações de produção.

Quando Ativar

• Projetando tipos de erro ou hierarquias de exceção para um novo módulo ou serviço
• Adicionando lógica de retentativa ou circuit breakers para dependências externas não confiáveis
• Revisando endpoints de API quanto à falta de tratamento de erros
• Implementando mensagens de erro e feedback voltados ao usuário
• Depurando falhas em cascata ou erros engolidos silenciosamente

Princípios Fundamentais

1. Falhe rápida e ruidosamente — exiba erros no limite onde ocorrem; não os enterre
2. Erros tipados em vez de mensagens de string — erros são valores de primeira classe com estrutura
3. Mensagens do usuário ≠ mensagens do desenvolvedor — mostre texto amigável aos usuários, registre o contexto completo no servidor
4. Nunca engula erros silenciosamente — todo bloco catch deve tratar, relançar ou registrar
5. Erros fazem parte do seu contrato de API — documente todo código de erro que um cliente pode receber

TypeScript / JavaScript

Classes de Erro Tipadas

// Defina uma hierarquia de erros para seu domínio
export class AppError extends Error {
  constructor(
    message: string,
    public readonly code: string,
    public readonly statusCode: number = 500,
    public readonly details?: unknown,
  ) {
    super(message)
    this.name = this.constructor.name
    // Mantém a cadeia de protótipo correta em JavaScript ES5 transpilado.
    // Necessário para que verificações `instanceof` (ex.: `error instanceof NotFoundError`)
    // funcionem corretamente ao estender a classe Error nativa.
    Object.setPrototypeOf(this, new.target.prototype)
  }
}

export class NotFoundError extends AppError {
  constructor(resource: string, id: string) {
    super(`${resource} não encontrado: ${id}`, 'NOT_FOUND', 404)
  }
}

export class ValidationError extends AppError {
  constructor(message: string, details: { field: string; message: string }[]) {
    super(message, 'VALIDATION_ERROR', 422, details)
  }
}

export class UnauthorizedError extends AppError {
  constructor(reason = 'Autenticação necessária') {
    super(reason, 'UNAUTHORIZED', 401)
  }
}

export class RateLimitError extends AppError {
  constructor(public readonly retryAfterMs: number) {
    super('Limite de taxa excedido', 'RATE_LIMITED', 429)
  }
}

Padrão de Resultado (estilo sem lançamento)

Para operações onde a falha é esperada e comum (análise sintática, chamadas externas):

type Result<T, E = AppError> =
  | { ok: true; value: T }
  | { ok: false; error: E }

function ok<T>(value: T): Result<T> {
  return { ok: true, value }
}

function err<E>(error: E): Result<never, E> {
  return { ok: false, error }
}

// Uso
async function fetchUser(id: string): Promise<Result<User>> {
  try {
    const user = await db.users.findUnique({ where: { id } })
    if (!user) return err(new NotFoundError('User', id))
    return ok(user)
  } catch (e) {
    return err(new AppError('Erro de banco de dados', 'DB_ERROR'))
  }
}

const result = await fetchUser('abc-123')
if (!result.ok) {
  // TypeScript sabe que result.error está aqui
  logger.error('Falha ao buscar usuário', { error: result.error })
  return
}
// TypeScript sabe que result.value está aqui
console.log(result.value.email)

Manipulador de Erro de API (Next.js / Express)

import { NextRequest, NextResponse } from 'next/server'

function handleApiError(error: unknown): NextResponse {
  // Erro de aplicação conhecido
  if (error instanceof AppError) {
    return NextResponse.json(
      {
        error: {
          code: error.code,
          message: error.message,
          ...(error.details ? { details: error.details } : {}),
        },
      },
      { status: error.statusCode },
    )
  }

  // Erro de validação Zod
  if (error instanceof z.ZodError) {
    return NextResponse.json(
      {
        error: {
          code: 'VALIDATION_ERROR',
          message: 'Falha na validação da requisição',
          details: error.issues.map(i => ({
            field: i.path.join('.'),
            message: i.message,
          })),
        },
      },
      { status: 422 },
    )
  }

  // Erro inesperado — registre detalhes, retorne mensagem genérica
  console.error('Erro inesperado:', error)
  return NextResponse.json(
    { error: { code: 'INTERNAL_ERROR', message: 'Ocorreu um erro inesperado' } },
    { status: 500 },
  )
}

export async function POST(req: NextRequest) {
  try {
    // ... lógica do manipulador
  } catch (error) {
    return handleApiError(error)
  }
}

Error Boundary do React

import { Component, ErrorInfo, ReactNode } from 'react'

interface Props {
  fallback: ReactNode
  onError?: (error: Error, info: ErrorInfo) => void
  children: ReactNode
}

interface State {
  hasError: boolean
  error: Error | null
}

export class ErrorBoundary extends Component<Props, State> {
  state: State = { hasError: false, error: null }

  static getDerivedStateFromError(error: Error): State {
    return { hasError: true, error }
  }

  componentDidCatch(error: Error, info: ErrorInfo) {
    this.props.onError?.(error, info)
    console.error('Erro não tratado no React:', error, info)
  }

  render() {
    if (this.state.hasError) return this.props.fallback
    return this.props.children
  }
}

// Uso
<ErrorBoundary fallback={<p>Algo deu errado. Por favor, recarregue.</p>}>
  <MyComponent />
</ErrorBoundary>

Python

Hierarquia de Exceção Personalizada

class AppError(Exception):
    """Erro base da aplicação."""
    def __init__(self, message: str, code: str, status_code: int = 500):
        super().__init__(message)
        self.code = code
        self.status_code = status_code

class NotFoundError(AppError):
    def __init__(self, resource: str, id: str):
        super().__init__(f"{resource} não encontrado: {id}", "NOT_FOUND", 404)

class ValidationError(AppError):
    def __init__(self, message: str, details: list[dict] | None = None):
        super().__init__(message, "VALIDATION_ERROR", 422)
        self.details = details or []

Manipulador Global de Exceção FastAPI

from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse

app = FastAPI()

@app.exception_handler(AppError)
async def app_error_handler(request: Request, exc: AppError) -> JSONResponse:
    return JSONResponse(
        status_code=exc.status_code,
        content={"error": {"code": exc.code, "message": str(exc)}},
    )

@app.exception_handler(Exception)
async def generic_error_handler(request: Request, exc: Exception) -> JSONResponse:
    # Registre detalhes completos, retorne mensagem genérica
    logger.exception("Erro inesperado", exc_info=exc)
    return JSONResponse(
        status_code=500,
        content={"error": {"code": "INTERNAL_ERROR", "message": "Ocorreu um erro inesperado"}},
    )

Go

Erros Sentinelas e Wrapping de Erros

package domain

import "errors"

// Erros sentinelas para verificação de tipo
var (
    ErrNotFound    = errors.New("não encontrado")
    ErrUnauthorized = errors.New("não autorizado")
    ErrConflict     = errors.New("conflito")
)

// Encapsule erros com contexto — nunca perca o original
func (r *UserRepository) FindByID(ctx context.Context, id string) (*User, error) {
    user, err := r.db.QueryRow(ctx, "SELECT * FROM users WHERE id = $1", id)
    if errors.Is(err, sql.ErrNoRows) {
        return nil, fmt.Errorf("usuário %s: %w", id, ErrNotFound)
    }
    if err != nil {
        return nil, fmt.Errorf("consultando usuário %s: %w", id, err)
    }
    return user, nil
}

// No nível do manipulador, desencapsule para determinar a resposta
func (h *Handler) GetUser(w http.ResponseWriter, r *http.Request) {
    user, err := h.service.GetUser(r.Context(), chi.URLParam(r, "id"))
    if err != nil {
        switch {
        case errors.Is(err, domain.ErrNotFound):
            writeError(w, http.StatusNotFound, "not_found", err.Error())
        case errors.Is(err, domain.ErrUnauthorized):
            writeError(w, http.StatusForbidden, "forbidden", "Acesso negado")
        default:
            slog.Error("erro inesperado", "err", err)
            writeError(w, http.StatusInternalServerError, "internal_error", "Ocorreu um erro inesperado")
        }
        return
    }
    writeJSON(w, http.StatusOK, user)
}

Retentativa com Backoff Exponencial

interface RetryOptions {
  maxAttempts?: number
  baseDelayMs?: number
  maxDelayMs?: number
  retryIf?: (error: unknown) => boolean
}

async function withRetry<T>(
  fn: () => Promise<T>,
  options: RetryOptions = {},
): Promise<T> {
  const {
    maxAttempts = 3,
    baseDelayMs = 500,
    maxDelayMs = 10_000,
    retryIf = () => true,
  } = options

  let lastError: unknown

  for (let attempt = 1; attempt <= maxAttempts; attempt++) {
    try {
      return await fn()
    } catch (error) {
      lastError = error
      if (attempt === maxAttempts || !retryIf(error)) throw error

      const jitter = Math.random() * baseDelayMs
      const delay = Math.min(baseDelayMs * 2 ** (attempt - 1) + jitter, maxDelayMs)
      await new Promise(resolve => setTimeout(resolve, delay))
    }
  }

  throw lastError
}

// Uso: repita erros de rede transitórios, não 4xx
const data = await withRetry(() => fetch('/api/data').then(r => r.json()), {
  maxAttempts: 3,
  retryIf: (error) => !(error instanceof AppError && error.statusCode < 500),
})

Mensagens de Erro Voltadas ao Usuário

Mapeie códigos de erro para mensagens legíveis por humanos. Mantenha detalhes técnicos fora do texto visível ao usuário.

const USER_ERROR_MESSAGES: Record<string, string> = {
  NOT_FOUND: 'O item solicitado não pôde ser encontrado.',
  UNAUTHORIZED: 'Faça login para continuar.',
  FORBIDDEN: 'Você não tem permissão para fazer isso.',
  VALIDATION_ERROR: 'Verifique sua entrada e tente novamente.',
  RATE_LIMITED: 'Muitas requisições. Aguarde um momento e tente novamente.',
  INTERNAL_ERROR: 'Algo deu errado em nosso sistema. Tente novamente mais tarde.',
}

export function getUserMessage(code: string): string {
  return USER_ERROR_MESSAGES[code] ?? USER_ERROR_MESSAGES.INTERNAL_ERROR
}

Lista de Verificação de Tratamento de Erros

Antes de mesclar qualquer código que envolva tratamento de erros:

• Todo bloco catch trata, relança ou registra — sem engolimento silencioso
• Erros de API seguem o envelope padrão { error: { code, message } }
• Mensagens voltadas ao usuário não contêm stack traces ou detalhes internos
• O contexto completo do erro é registrado no servidor
• Classes de erro personalizadas estendem uma base AppError com um campo code
• Funções assíncronas exibem erros para os chamadores — sem "fire-and-forget" sem fallback
• A lógica de retentativa apenas repete erros que podem ser repetidos (não erros 4xx do cliente)
• Componentes React são encapsulados em ErrorBoundary para erros de renderização