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

feat(server): allow ratelimiting to be explicitly disabled #3757

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

iainsproat
Copy link
Contributor

@iainsproat iainsproat commented Jan 2, 2025

Description & motivation

We may wish to enable the rate limiter in some testing environments, and we may wish to disable the rate limiter in some non-testing environments (e.g. development).

The rate limiter was previously implied based on whether NODE_ENV is 'test', which may not be desired behaviour.

Changes:

  • allows rate limiter to be enabled or disabled explicitly via environment variable or helm chart.
  • introduces RATELIMITER_ENABLED boolean environment variable, default is true.
  • introduces helm chart parameter server.ratelimiting.enabled to configure the same, default is true.

To-do before merge:

Screenshots:

Validation of changes:

Checklist:

  • My pull request follows the guidelines in the Contributing guide?
  • My pull request does not duplicate any other open Pull Requests for the same update/change?
  • My commits are related to the pull request and do not amend unrelated code or documentation.
  • My code follows a similar style to existing code.
  • I have added appropriate tests.
  • I have updated or added relevant documentation.

References

- allows rate limiter to be enabled or disabled explicitly
- previously implied based on whether NODE_ENV is 'test', which may not be desired behaviour
- example .env file for testing now explicitly disables it
@iainsproat iainsproat marked this pull request as ready for review January 3, 2025 08:04
@iainsproat iainsproat requested a review from fabis94 January 3, 2025 08:04
@iainsproat iainsproat merged commit 457c532 into main Jan 3, 2025
26 of 28 checks passed
@iainsproat iainsproat deleted the iain/ratelimiter-can-be-explicitly-disabled branch January 3, 2025 08:24
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