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

Enable rate limiting in socks by default #1272

Merged
merged 1 commit into from
Mar 28, 2024
Merged

Conversation

dydxwill
Copy link
Contributor

Changelist

Enable rate limiting in socks by default

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Walkthrough

The recent update introduces a significant change to the rate-limiting functionality by altering the default state of the RATE_LIMIT_ENABLED configuration parameter. Previously set to false, this parameter now defaults to true, ensuring that rate limiting is enabled by default. This change aims to enhance the system's stability and performance by preventing excessive requests from overwhelming the service.

Changes

File Path Change Summary
.../socks/src/config.ts The RATE_LIMIT_ENABLED configuration parameter's default value has been changed from false to true.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@dydxwill dydxwill merged commit 16bc93a into main Mar 28, 2024
11 checks passed
@dydxwill dydxwill deleted the wl/change_default_rl_socks branch March 28, 2024 18:16
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3555a49 and c16dd32.
Files selected for processing (1)
  • indexer/services/socks/src/config.ts (1 hunks)
Path instructions used (1)
indexer/services/socks/src/config.ts (1)

/
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments (2)
indexer/services/socks/src/config.ts (2)
  • 36-36: The change to default RATE_LIMIT_ENABLED to true aligns with the PR's objective. Ensure that all dependent services and configurations are updated to accommodate this change.
Verification successful

The change to default RATE_LIMIT_ENABLED to true is consistently applied across both the socks and comlink services and is accounted for in the tests of the comlink service. This suggests that the change aligns with the PR's objective and is likely to be well-integrated across the affected parts of the codebase. Ensure that all dependent configurations and services are updated to accommodate this change, as it appears they are prepared for it.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Search for files that might depend on RATE_LIMIT_ENABLED setting. Expecting list of dependent files.
rg --type ts 'RATE_LIMIT_ENABLED'

Length of output: 580

* 36-36: Ensure the default values for rate limiting settings (`RATE_LIMIT_SUBSCRIBE_POINTS`, `RATE_LIMIT_SUBSCRIBE_DURATION_MS`, `RATE_LIMIT_PING_POINTS`, `RATE_LIMIT_PING_DURATION_MS`, `RATE_LIMIT_INVALID_MESSAGE_POINTS`, `RATE_LIMIT_INVALID_MESSAGE_DURATION_MS`) are based on empirical data or testing to balance preventing abuse and allowing legitimate use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants