`HttpClient.withRateLimiter`: let `RateLimiterError` be handled as an `HttpClientError`

Abierto
#10,697 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@effect-bot ya está trabajando en esto.

Desde el 17/11/2026.

  • #10713 de @effect-bot — fusionado

Evaluación

Este issue todavía no se ha evaluado.

Descripción

enhancement
What is the problem this feature would solve?

HttpClient.withRateLimiter adds RateLimiter.RateLimiterError to the client's error type, so the result isn't a plain HttpClient any more. To provide it as HttpClient.HttpClient again, the error has to be removed:

httpClient.pipe(
  HttpClient.withRateLimiter({
    limiter,
    key: 'orcid',
    algorithm: 'token-bucket',
    limit: 24,
    window: '1 second',
  }),
  HttpClient.catchTag('RateLimiterError', Effect.die),
)

The natural thing would be to turn it into an HttpClientError with a TransportError reason, so callers handle a failing limiter store (such as Redis being unavailable) like any other failed request. But TransportError needs the request, and HttpClient.catchTag's handler only receives the error, so dying is the only option.

HttpClient.transform does receive the request, but it only changes the response side. The RateLimiterError stays in the client's preprocess type, so the result still isn't assignable to HttpClient.

We're working around it by calling RateLimiter.sleep inside HttpClient.transform ourselves. That loses withRateLimiter's 429 retries and its handling of rate-limit headers.

What is the feature you are proposing to solve the problem?

Any of these would work:

  1. An option on withRateLimiter to fail with an HttpClientError (TransportError, with the RateLimiterError as its cause) instead of a RateLimiterError, so the result is a plain HttpClient.
  2. Pass the request to the handlers of HttpClient.catchTag, HttpClient.catchTags and HttpClient.catch, for example as a second argument.
  3. Make HttpClient.transform (or a variant of it) able to handle errors from the whole client, not just the response.

Option 1 fits best for HTTP clients. Option 2 would help with other errors added by client combinators too.

What alternatives have you considered?
  • HttpClient.catchTag('RateLimiterError', Effect.die): fine with RateLimiter.layerStoreMemory, which can't fail, but a store failure with layerStoreRedis becomes a defect.
  • RateLimiter.sleep inside HttpClient.transform, mapping the error with the request: works, but reimplements part of withRateLimiter and loses its 429 and header handling.

Version: effect 4.1.2

Lenguaje dominante
TypeScript
Estrellas
16.7k
Forks
808
Merge medio
20 h 31 min
PR fusionados (30 d)
733

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 Effect-TS/effect

Todos los issues de Effect-TS/effect

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.