Expose an error's HTTP status and Resend error name on `Resend::Error`

Abierto Apto para principiantes
#266 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 5 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
ruby

Línea de trabajo

Empieza por lib/resend/errors.rb y lib/resend/request.rb; después, revisa las pruebas existentes para la inicialización de errores y Request#handle_error!. El issue propone exponer el estado HTTP y conservar el nombre del error de la respuesta, manteniendo la compatibilidad con las llamadas existentes al constructor; decide si se deben incluir las asignaciones opcionales de clases de error. El trabajo estará completo cuando los llamadores puedan leer los detalles de error añadidos y las pruebas cubran el manejo de errores existente y el nuevo.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

A caller can't tell apart the errors the gem raises as the same class without reaching into the exception's internals. Resend::Error is given the response's HTTP status and keeps it in @code, but defines no reader for it. Request#handle_error! keeps the response's message and drops its name (invalid_idempotent_request, concurrent_idempotent_requests, …) entirely.

lib/resend/errors.rb:

attr_reader :headers

def initialize(msg, code = nil, headers = {})
  super(msg)
  @code = code      # stored, but there's no reader
  @headers = headers
end

lib/resend/request.rb:

def handle_error!(data, resp = nil)
  code = data[:statusCode]
  body = data[:message]   # data[:name] isn't kept
  # ...
  error_class = Resend::Error::ERRORS[code] || Resend::Error
  raise error_class.new(body, code, headers)
end
Where it bites

ERRORS has no entry for 409 or for 502–504, so each of those raises the base Resend::Error, with nothing public to tell them apart:

  • The four 409s call for different handling. The error reference documents concurrent_idempotent_requests (try again later, with the same key), invalid_idempotent_request (change the key or the payload), resource_locked and forge_not_enabled. A caller sending with an idempotency_key and retrying after a timeout has to know which one it got: retrying under the same key is right for the first and refused for 24 hours for the second.
  • A 502, 503 or 504 with a JSON body raises the same base class as those 409s, so a transient outage can't be told from a refusal no retry fixes. (A body that isn't JSON becomes InternalServerError through check_json!.)

Today the only ways to tell are error.instance_variable_get(:@code) and matching error.message, whose wording isn't a contract.

For comparison

resend-node answers every error with { message, statusCode, name } (ErrorResponse in src/interfaces.ts), name typed against the documented codes.

Possible directions
  1. attr_reader :code on Resend::Error, returning the status it's already given. Additive.
  2. Keep the response's name on the error, say as attr_reader :name, matching resend-node's field, passed by handle_error! as a new optional argument so existing Resend::Error.new(msg, code, headers) calls keep working.
  3. Optionally, classes for the statuses that fall through today: a ConflictError for 409, and 502–504 mapped to ServerError subclasses.

1 and 2 are the smallest change and would be enough on their own.

Lenguaje dominante
Ruby
Estrellas
55
Forks
12
Merge medio
4 d 2 h
PR fusionados (30 d)
1

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de resend/resend-ruby

Todos los issues de resend/resend-ruby

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.