Reject ratelimit configs that are missing required values. #8575
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
|
Issues linked to changelog: |
elcasteel
added
the
work in progress
github-actions
bot
added
the
keep pr updated
|
Visit the preview URL for this PR (updated for commit ace47d0): https://gloo-edge--pr8575-rlc-nil-check-ijvtnfyq.web.app (expires Mon, 21 Aug 2023 20:14:25 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 77c2b86e287749579b7ff9cadb81e099042ef677 |
davidjumani
previously approved these changes
Aug 14, 2023
jbohanon
approved these changes
Aug 14, 2023
elcasteel
removed
the
work in progress
elcasteel
added a commit
that referenced
this pull request
Aug 15, 2023
* plugin updates and test * gofmt * review comments, do not append invalid action to returned list * link to envoy docs in changelog
elcasteel
added a commit
that referenced
this pull request
Aug 15, 2023
…PR action (#8582) * Reject ratelimit configs that are missing required values. (#8575) * plugin updates and test * gofmt * review comments, do not append invalid action to returned list * link to envoy docs in changelog * Fix solo-apis action and small addition to rlc translation fix. (#8581) * update changelog
sheidkamp
pushed a commit
that referenced
this pull request
Aug 22, 2023
…PR action (#8582) * Reject ratelimit configs that are missing required values. (#8575) * plugin updates and test * gofmt * review comments, do not append invalid action to returned list * link to envoy docs in changelog * Fix solo-apis action and small addition to rlc translation fix. (#8581) * update changelog
sheidkamp
pushed a commit
that referenced
this pull request
Aug 22, 2023
* plugin updates and test * gofmt * review comments, do not append invalid action to returned list * link to envoy docs in changelog
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.
Description
Add checks for the presence of the required fields for ratelimit actions (spelled out here: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#config-route-v3-ratelimit-action) in the rate limit plugins. Reject the config if they are empty instead of letting Envoy fail.
This change will also require updates in solo-projects and should not merge until those changes are tested
API changes
The proto is already annotated to require these fields but we don't pass that through to our CRDs.
Docs changes
Docs show that these fields are required based on proto, and this change is enforcing the requirements.
Context
I ran across this reproducing a different ratelimit translation issue and decided it was worth fixing.
Testing steps
Added unit test.
Manual testing and e2e test will happen on solo-projects PR.
Notes for reviewers
You can use the envoy docs for ratelimit actions to verify that I got everything: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/route/v3/route_components.proto#config-route-v3-ratelimit-action
Checklist: