Skip to content

Rate limits that allow for bursts and protect sensitive endpoints#42

Merged
duckduckgrayduck merged 2 commits into
masterfrom
rate_limits
Jun 15, 2026
Merged

Rate limits that allow for bursts and protect sensitive endpoints#42
duckduckgrayduck merged 2 commits into
masterfrom
rate_limits

Conversation

@duckduckgrayduck

Copy link
Copy Markdown
Contributor

This creates some rate limits for endpoints especially sensitive to scripts where the user has set no rate limiting of their own that use our official libraries. We should set a good example of rate limiting by doing it for them in the client. The only thing that doesn't use the client because it is hosted on s3.documentcloud.org (this is for fetching assets of public documents) has to be configured in a separate rate limiter in documents.py. I feel that this is an acceptable tradeoff. I have tried these locally and believe they offer a good balance for someone wanting to do a small workflow quickly, but won't affect our services long term. This uses the token-bucket library: https://pypi.org/project/token-bucket/

python-muckrock will receive the same update.

I noticed that there was a custom user agent set for calls to s3.documentcloud.org, this also sets that to the one we should use from the client.

Comment thread .github/workflows/main.yml Outdated

@mitchelljkotler mitchelljkotler left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would also be good to have some tests for the new rate limiting behavior

Comment thread documentcloud/documents.py Outdated
Comment thread documentcloud/client.py Outdated
Comment thread documentcloud/client.py Outdated
Comment thread documentcloud/documents.py Outdated
Comment thread setup.py Outdated
@duckduckgrayduck duckduckgrayduck merged commit f2e1ba0 into master Jun 15, 2026
4 checks passed
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.

3 participants