feat(iroh-relay): expose Bucket rate-limit primitive#4231
Closed
veeso wants to merge 1 commit into
Closed
Conversation
Embedders that mount the relay protocol via custom HTTP servers (e.g. axum integration in holochain/kitsune2) cannot use the existing RateLimited<S: AsyncRead> wrapper because their stream layer is already WS-framed by the time the relay handler runs. Exposing Bucket lets these embedders apply iroh's bucket semantics at the frame layer. Visibility-only change: Bucket struct, Bucket::new and Bucket::consume become pub. Fields stay private. InvalidBucketConfig was already pub. Adds rustdocs to satisfy deny(missing_docs). No behavior change.
Member
|
Hi, this looks reasonable. I'm a little wary with exposing so-far internal APIs without having a clear idea how it's being used - could you give a short example where in your relay embedding you'd use this? We recently merged an integration test for embedding iroh-relay in axum. Could you maybe add the bucketing to the example? If not feasable, maybe you could post an example here so that I can see how it's being used. |
Author
|
Hello, we are using this in this PR on our relay server for rate limiting: holochain/kitsune2#533 at |
Contributor
|
need to land this for the release so created #4242 |
dignifiedquire
added a commit
that referenced
this pull request
May 7, 2026
> Updated version of #4231 Embedders that mount the relay protocol via custom HTTP servers (e.g. axum integration in holochain/kitsune2) cannot use the existing RateLimited<S: AsyncRead> wrapper because their stream layer is already WS-framed by the time the relay handler runs. Exposing Bucket lets these embedders apply iroh's bucket semantics at the frame layer. Visibility-only change: Bucket struct, Bucket::new and Bucket::consume become pub. Fields stay private. InvalidBucketConfig was already pub. Adds rustdocs to satisfy deny(missing_docs). No behavior change. Co-authored-by: Christian Visintin <christian.visintin@veeso.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Embedders that mount the relay protocol via custom HTTP servers (e.g. axum integration in holochain/kitsune2) cannot use the existing RateLimited<S: AsyncRead> wrapper because their stream layer is already WS-framed by the time the relay handler runs. Exposing Bucket lets these embedders apply Iroh's bucket semantics at the frame layer.
Visibility-only change:
Bucketstruct,Bucket::new, andBucket::consumebecomepub. Fields stay private. InvalidBucketConfig was already pub. Adds rustdocs to satisfy deny(missing_docs).No behavior change.
Breaking Changes
No, just promoting visibility.
Notes & open questions
Change checklist