chore: Strict request JSON check

[sharat87]

Currently, if the incoming request body contains fields that aren't recognized by the backend, we just ignore them, and deserialize what we can. This has lead to subtle bugs and wasted a lot of developer time in the past, and added little value in return.

Most recently, with application creation, now fixed in #33722.

Another one, for action creation, client sends this in eventData field of the request body:

But the class defined for eventData is this:

Clearly isn't working.

This PR enabled the FAIL_ON_UNKNOWN_PROPERTIES setting only for the deserialization of HTTP request payloads. It shouldn't have impact on other deserializations like those for Git, and those that load resource files. Primarily to limit the scope.

This should also bring in some much-needed type strictness to the client as well. So far, server has been lax in accepting just any fields in the incoming request body, so client was able to afford being lax about the object that was sent up.

Previously attempted at #33724.

Automation

/test sanity

🔍 Cypress test results

Warning

Tests have not run on the HEAD 1ac44e0 yet

---

Sat, 08 Feb 2025 01:21:41 UTC

Communication

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

• Yes
• No

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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.

[github-actions]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

[github-actions]

This PR has been closed because of inactivity.

[github-actions]

Failed server tests

• com.appsmith.server.git.ops.GitDiscardTests#discardChanges_whenCancelledMidway_discardsSuccessfully
• com.appsmith.server.git.ops.GitDiscardTests#discardChanges_whenUpstreamChangesAvailable_discardsSuccessfully
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testConvertArtifactJsonToGitResourceMap_whenArtifactIsFullyPopulated_returnsCorrespondingResourceMap(ExchangeJsonContext)[1]
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testConvertGitResourceMapToArtifactExchangeJson_whenArtifactIsFullyPopulated_returnsCorrespondingJson(ExchangeJsonContext)[1]
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testSerializeArtifactExchangeJson_whenArtifactIsFullyPopulated_returnsCorrespondingBaseRepoPath(ExchangeJsonContext)[1]

[github-actions]

Failed server tests

• com.appsmith.server.git.ops.GitDiscardTests#discardChanges_whenCancelledMidway_discardsSuccessfully
• com.appsmith.server.git.ops.GitDiscardTests#discardChanges_whenUpstreamChangesAvailable_discardsSuccessfully
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testConvertArtifactJsonToGitResourceMap_whenArtifactIsFullyPopulated_returnsCorrespondingResourceMap(ExchangeJsonContext)[1]
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testConvertGitResourceMapToArtifactExchangeJson_whenArtifactIsFullyPopulated_returnsCorrespondingJson(ExchangeJsonContext)[1]
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testSerializeArtifactExchangeJson_whenArtifactIsFullyPopulated_returnsCorrespondingBaseRepoPath(ExchangeJsonContext)[1]

[github-actions]

This PR has been closed because of inactivity.

[github-actions]

Failed server tests

• com.appsmith.server.git.ops.GitDiscardTests#discardChanges_whenCancelledMidway_discardsSuccessfully
• com.appsmith.server.git.ops.GitDiscardTests#discardChanges_whenUpstreamChangesAvailable_discardsSuccessfully
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testConvertArtifactJsonToGitResourceMap_whenArtifactIsFullyPopulated_returnsCorrespondingResourceMap(ExchangeJsonContext)[1]
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testConvertGitResourceMapToArtifactExchangeJson_whenArtifactIsFullyPopulated_returnsCorrespondingJson(ExchangeJsonContext)[1]
• com.appsmith.server.git.resourcemap.ExchangeJsonConversionTests#testSerializeArtifactExchangeJson_whenArtifactIsFullyPopulated_returnsCorrespondingBaseRepoPath(ExchangeJsonContext)[1]

[github-actions]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.