Add rate_limits_hit
to QueryStats
type
#293
Merged
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.
FE-6078
Description
Update the
QueryStats
type to include therate_limits_hit
field, which is included in the response of throttling errors.Motivation and context
There is no issue with JavaScript populating stats with the
rate_limits_hit
response, but it is inaccessible to TypeScript users relying on our types.How was the change tested?
I extended a test that ensures the stats are propagated to query responses. Existing tests ensure that stats go to the right place for
ServiceErrors
. There are no existing integration tests that demonstrate stats actually come from the database, and none were added.Here are some screenshots of me triggering rate limiting with the raw responses
Read limit
Write limit
Compute limit
rate_limits_hit
is returned as an empty array on successful queriesChange types
Checklist:
rate_limits_hit
is already noted in the HTTP API docs.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.