Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rate_limits_hit to QueryStats type #293

Merged
merged 3 commits into from
Oct 28, 2024
Merged

Add rate_limits_hit to QueryStats type #293

merged 3 commits into from
Oct 28, 2024

Conversation

ptpaterson
Copy link
Contributor

@ptpaterson ptpaterson commented Oct 28, 2024

FE-6078

Description

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
image

Write limit
image

Compute limit
image

rate_limits_hit is returned as an empty array on successful queries
image

Change types

    • 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:

    • My code follows the code style of this project.
    • My change requires a change to Fauna documentation.
    • 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.

@ptpaterson ptpaterson requested a review from a team October 28, 2024 18:25
@ptpaterson ptpaterson changed the title Rate limits hit Add rate_limits_hit to QueryStats Oct 28, 2024
@ptpaterson ptpaterson changed the title Add rate_limits_hit to QueryStats Add rate_limits_hit to QueryStats type Oct 28, 2024
@ptpaterson ptpaterson merged commit d4e2e33 into main Oct 28, 2024
7 checks passed
@ptpaterson ptpaterson deleted the rate-limits-hit branch October 28, 2024 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants