feat!: Add fixedWindow, tokenBucket, and slidingWindow primitives #171
Conversation
This file contains 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
feat!: Rework primitives to build rules with config & request details
|
Merging to
|
|
Closing in favor of #184 but this may be useful to review in the future if we need to wrap the rule creation in another factory. |
trunk-io bot
pushed a commit
that referenced
this pull request
Feb 6, 2024
Replaces #171 This adds the `fixedWindow`, `tokenBucket` and `slidingWindow` primitives. It keeps the `rateLimit()` primitive for backwards compatibility, but it is breaking because `protectSignup` was altered to require sliding window configurations. The changes were streamlined by putting `requested` into the `extra` field of the RequestDetails. This allowed us to keep the same structure for specifying our Rules. Draft because I need to add tests to maintain full test coverage and because it relies on #179, #180, #181, #182, and #183 (after which, I'll rebase all the cherry-picked commits out of this PR).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
feat!: Rework primitives to build rules with config & request details
This reworks Primitives to be a class that can construct a Rule based on a context + request details. This is due to including the
requestedtoken count on RateLimitRule, but it being passed as extra data toprotect().I think this API is good, but after completing it, I'm wondering if it is actually incorrect for the
requestedfield to be attached to the RateLimitRule in the protobuf. Perhaps it should just be stuffed into ourextrafield on the request. I want to think about it some more over the weekend, but this is a start.