fix: Rate limiting key should respect load balancers

[sharat87]

This PR changes the key used for rate limiting so that it includes any Forwarded or X-Forwarded-For headers, so that rate-limiting counter respects any load balancers that are running on top of Appsmith container.

/test sanity

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11855493733
Commit: af2d760
Cypress dashboard.
Tags: @tag.Sanity
Spec:

---

Fri, 15 Nov 2024 12:04:04 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• New Features

  • Enhanced rate limiting configuration for improved performance with load balancers.
  • Adjusted handling of custom domains for better certificate management.

• Bug Fixes

  • Improved error handling by removing unnecessary headers to enhance security and response consistency.

• Documentation

  • Updated internal logic for generating server configurations, ensuring clarity in server setup.

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the configuration and logic of a Caddy server in the caddy-reconfigure.mjs file. Key modifications include an updated rate limiting configuration that accounts for load balancers, refined error handling to improve security, and adjustments to custom domain handling based on the presence of custom certificates. Additionally, the generation of the Caddyfile has been structured within a template, while the existing logic for processing the info.json file remains unchanged.

Changes

File Path	Change Summary
deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs	- Updated rate limiting configuration to utilize Forwarded, X-Forwarded-For, and remote_host headers. - Refined error handling by removing Server and Cache-Control headers. - Adjusted custom domain handling based on custom certificate presence. - Encapsulated Caddyfile generation within a structured template while retaining finalizeIndexHtml function logic.

Possibly related PRs

• fix: remove cache control headers for requests handled with an error in Caddy #36590: Modifies the error handling section in caddy-reconfigure.mjs to remove both the Server and Cache-Control headers.
• chore: Switch rate limit key to client_ip #36606: Updates the rate limiting key in caddy-reconfigure.mjs, directly related to the changes in this PR.
• fix: caddy partial metrics #36376: Adds a metrics directive in caddy-reconfigure.mjs, relevant to the overall configuration of the Caddy server.

Suggested reviewers

• pratapaprasanna
• ApekshaBhosale

🎉 In the realm of code, changes unfold,
With Caddy's new logic, brave and bold.
Rate limits refined, headers cast away,
Security strengthened, come what may!
Custom domains now find their place,
In this structured template, we embrace! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7f2c4c6 and af2d760.

📒 Files selected for processing (1)

• deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (1 hunks)