Update the QueryStats type to include the rate_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 queries
Change types
[x] Bug fix (non-breaking change that fixes an issue)
[ ] New feature (non-breaking change that adds functionality)
[ ] Breaking change (backwards-incompatible fix or feature)
Checklist:
[x] My code follows the code style of this project.
[ ] My change requires a change to Fauna documentation.
rate_limits_hit is already noted in the HTTP API docs.
[ ] My change requires a change to the README, and I have updated it accordingly.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
FE-6078
Description
Update the
QueryStatstype to include therate_limits_hitfield, which is included in the response of throttling errors.Motivation and context
There is no issue with JavaScript populating stats with the
rate_limits_hitresponse, 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_hitis returned as an empty array on successful queriesChange types
Checklist:
rate_limits_hitis 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.