Skip to content

chore: Switch rate limit key to client_ip #36606

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 30, 2024
Merged

chore: Switch rate limit key to client_ip #36606

merged 1 commit into from
Sep 30, 2024

Conversation

nidhi-nair
Copy link
Contributor

@nidhi-nair nidhi-nair commented Sep 30, 2024 •
edited by coderabbitai bot
Loading

Description

Remote IP points to the node IP so requests get rate limited in totality. Client IP allows to differentiate by end machine. For probes, client IP will still be node.

Summary by CodeRabbit

  • New Features

    • Enhanced SSL certificate handling with fallback options.
    • Improved rate limiting configuration for better request management.
    • Conditional logic for custom domain binding and HTTP to HTTPS redirection.

  • Bug Fixes

    • Improved error handling for reading configuration files.

  • Documentation

    • Updated metadata handling in the index.html file for better integration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024 •
edited
Loading

Walkthrough

The changes in this pull request focus on enhancing the configuration of the Caddy web server, specifically regarding SSL certificate management and rate limiting. The logic for SSL certificates has been refined to prioritize custom certificates while providing a fallback to Let's Encrypt. Additionally, the rate limiting mechanism has been updated to improve request identification. The Caddyfile generation now includes conditional logic for custom domains and HTTP to HTTPS redirection, alongside updates to the finalizeIndexHtml function for better error handling and environment variable integration.

Changes

Files Change Summary
deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs Updates to SSL certificate handling, rate limiting adjustments, and enhancements to Caddyfile generation. The finalizeIndexHtml function now includes improved error handling and reads additional environment variables.

Possibly related PRs

  • chore: change caddy admin interface #36291: The changes in this PR also modify the caddy-reconfigure.mjs file, specifically related to the Caddy web server configuration, which aligns with the main PR's focus on enhancing Caddy's settings.

Suggested labels

skip-changelog, DevOps Pod

Suggested reviewers

  • sharat87
  • ApekshaBhosale

Poem

In the realm of code, changes take flight,
Caddy's SSL shines, oh what a sight!
Rate limits refined, requests now align,
Custom domains dance, all in good time.
With error logs bright, our path is clear,
Cheers to the code, let's give a cheer! 🎉

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 73d3960 and 30a2329.

📒 Files selected for processing (1)
  • deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (1 hunks)
🔇 Additional comments (1)
deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (1)

149-149: Well done updating the rate limiting key to {http.request.client_ip}

By changing the rate limiting key to {http.request.client_ip}, you're effectively enhancing the granularity of rate limiting. This will allow the server to distinguish requests from different clients more accurately, improving overall performance and security.

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>, please review it.
    • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Sep 30, 2024
@nidhi-nair nidhi-nair merged commit ba1cc28 into release Sep 30, 2024
16 checks passed
@nidhi-nair nidhi-nair deleted the chore/rate-limit-key-client-ip branch September 30, 2024 07:13
@coderabbitai coderabbitai bot mentioned this pull request Oct 28, 2024
Closed
@coderabbitai coderabbitai bot mentioned this pull request Nov 15, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sharat87 sharat87 Awaiting requested review from sharat87 sharat87 is a code owner

@pratapaprasanna pratapaprasanna Awaiting requested review from pratapaprasanna pratapaprasanna is a code owner

1 more reviewer

@ApekshaBhosale ApekshaBhosale ApekshaBhosale approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nidhi-nair @ApekshaBhosale