ResourceExhausted error code to HTTP 429 status code #270
Conversation
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
This was referenced Sep 14, 2020
thesilentg
suggested changes
Sep 15, 2020
docs/spec_v7.md
Outdated
| @@ -208,7 +208,7 @@ corresponding HTTP Status Code for the response. | |||
| | already_exists | 409 | An attempt to create an entity failed because one already exists. | |||
| | permission_denied | 403 | The caller does not have permission to execute the specified operation. It must not be used if the caller cannot be identified (use "unauthenticated" instead). | |||
| | unauthenticated | 401 | The request does not have valid authentication credentials for the operation. | |||
| | resource_exhausted | 403 | Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. | |||
| | resource_exhausted | 429 | Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. | |||
There was a problem hiding this comment.
Is it worth mentioning rate-limiting here?
There was a problem hiding this comment.
What about adding "exhausted or rate-limited"?
Some resource has been exhausted or rate-limited, perhaps a per-user quota, or perhaps the entire file system is out of space
protoc-gen-twirp/generator.go
Outdated
| t.P(` case 429, 502, 503, 504: // Too Many Requests, Bad Gateway, Service Unavailable, Gateway Timeout`) | ||
| t.P(` case 429: // Too Many Requests`) | ||
| t.P(` code = `, t.pkgs["twirp"], `.ResourceExhausted`) | ||
| t.P(` case 502, 503, 504: // Too Many Requests, Bad Gateway, Service Unavailable, Gateway Timeout`) |
There was a problem hiding this comment.
Remove "Too Many Requests" from this line
thesilentg
approved these changes
Sep 15, 2020
sagikazarmark
added a commit
to twirphp/twirp
that referenced
this pull request
Nov 1, 2021
Read more: - https://twitchtv.github.io/twirp/docs/spec_v7.html#differences-with-v5 - twitchtv/twirp#270 Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
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.
Followup after PR: #258
After all the analysis done in #258, we decided to re-map
ResourceExhaustedto 429Too Many Requests, instead of adding a new status code. See PR comments for more details.Backwards compatibility
This is a non-backwards compatible change, although it may only affect servers and their middleware; clients are not affected by the HTTP status code. Note that, since the update happens on the
twirppackage, the update takes effect when the package is updated.Backwards compatibility notes about changing the HTTP mapping code of resource_exhausted from
403to429:unavailable(see code). New clients will handle them asresource_exhausted.resource_exhaustedas 403, even if in the server it is mapped to 429 (the mapping is done in code).(✅ = it just works,⚠️ = corner cases may need attention, ❌ = code depending on previous behavior needs to be updated)
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.