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

Đang mở
#10,697 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@effect-bot đang làm issue này rồi.

Từ ngày 17/11/2026.

  • #10713 của @effect-bot — đã merge

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
16.7k
Fork
808
Merge trung bình
20 giờ 31 phút
Pull request đã merge (30 ngày)
733

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Effect-TS/effect

Tất cả issue của Effect-TS/effect

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.