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

オープン
#10,697 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@effect-bot がすでに取り組んでいます。

2026年11月17日 から。

  • #10713 @effect-bot による — マージ済み

評価

この issue はまだ評価されていません。

説明

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

主要言語
TypeScript
スター
16.7k
フォーク
808
平均マージ
20時間 31分
マージ済み PR(30日)
733

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Effect-TS/effect のほかの issue

Effect-TS/effect の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。