fix: Skip CSRF check if there's JSON content type

[sharat87]

Description

Automation

/test sanity

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

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

• Yes
• No

Summary by CodeRabbit

This update enhances the handling of API interactions involving JSON data, resulting in a more seamless integration experience. The system now applies streamlined processing for JSON requests, reducing unnecessary verifications and improving overall performance and responsiveness for API-based communications.

• New Features
  • Improved processing for JSON API requests for smoother and more efficient communications.

[coderabbitai]

Walkthrough

The changes add a new check in the matches method of the CsrfConfigCE class. Before evaluating any existing header-based conditions, the method now checks if the request's content type is APPLICATION_JSON. If true, it returns ServerWebExchangeMatcher.MatchResult.notMatch(), effectively bypassing CSRF validation for JSON requests. No changes were made to the declarations of exported or public entities.

Changes

File Path	Change Summary
app/.../CsrfConfigCE.java	Added a conditional check in the matches method to bypass CSRF validations for requests with APPLICATION_JSON content type.

Sequence Diagram(s)

sequenceDiagram
    participant Req as Request
    participant Cfg as CsrfConfigCE
    Req->>Cfg: Call matches(request)
    alt Content-Type is APPLICATION_JSON
        Cfg-->>Req: Return notMatch()
    else Other Content-Types
        Cfg->>Cfg: Evaluate existing header and GET checks
        Cfg-->>Req: Return appropriate match result
    end

Loading

Suggested labels

Bug, ok-to-test

Suggested reviewers

• nidhi-nair
• trishaanand
• pratapaprasanna

Poem

In the code, a new check is found,
Where JSON requests gracefully abound.
CSRF steps aside with a clever nod,
Letting API calls smoothly trod.
Celebrate this change with a digital cheer 🚀
And a sprinkle of code magic we hold dear!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5537ea8 and 4a9993c.

📒 Files selected for processing (1)

• app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/ce/CsrfConfigCE.java (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: server-unit-tests / server-unit-tests
• GitHub Check: server-spotless / spotless-check

🔇 Additional comments (2)

app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/ce/CsrfConfigCE.java (2)

8-8: Added import for MediaType to support the new content type check.

This import is necessary for the new JSON content type validation added below.

---

89-92: Good security enhancement for JSON requests.

The added check correctly bypasses CSRF validation for JSON content types, which is aligned with security best practices. JSON requests are typically not vulnerable to CSRF attacks since:

1. HTML form submissions (the primary CSRF vector) cannot use JSON content types
2. Cross-origin JSON requests must pass CORS preflight checks in modern browsers

The implementation uses proper type checking with equalsTypeAndSubtype() rather than string comparison, which is robust against content type variations.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.