fix: added escaping logic for html reserved characters

[NilanshBansal]

Description

This PR adds escaping logic for HTML reserved characters " and ". Both of these characters were getting unescaped to double quotes (") leading to a JSON parse error.
I have updated the code to escape these with a backslash before getting converted.
ref

PR fixes following issue(s)

Fixes #31056

Type of change

• Bug fix (non-breaking change which fixes an issue)

Testing

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration.
Delete anything that is not relevant

• Manual
• JUnit
• Jest
• Cypress

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• PR is being merged under a feature flag

QA activity:

• Speedbreak features have been covered
• Test plan covers all impacted features and areas of interest
• Test plan has been peer reviewed by project stakeholders and other QA members
• Manually tested functionality on DP
• We had an implementation alignment call with stakeholders post QA Round 2
• Cypress test cases have been added and approved by SDET/manual QA
• Added Test Plan Approved label after Cypress tests were reviewed
• Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

• New Features
  • Enhanced data handling to ensure JSON validity by escaping double quotes in certain outputs.
• Tests
  • Added test cases to verify the new escaping logic for JSON and HTML characters.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates introduced a new feature in the MustacheHelper class to enhance JSON validity by escaping double quotes in the rendered output. This addition aims to prevent errors when handling JSON data by ensuring that double quotes do not disrupt the JSON structure. Furthermore, the project's test suite has been expanded with new cases in MustacheHelperTest to verify the correct escaping of double quotes and the unescaping of HTML characters, ensuring the robustness of this new functionality.

Changes

File Path	Change Summary
.../helpers/MustacheHelper.java	Added functionality to escape double quotes in rendered output for JSON validity.
.../helpers/MustacheHelperTest.java	Introduced test cases for validating escaping logic for double quotes and unescaping HTML characters.

Assessment against linked issues

Objective	Addressed	Explanation
Bug Description: Error uploading attachment due to JSON parse error (#31056)	❌	The changes do not directly address the multipart data parsing issue described in the bug report.
Reproducible Steps: Issues with specific files causing upload error (#31056)	❌	The modifications in the PR focus on JSON string handling and do not tackle the file upload mechanism or multipart data parsing errors.
Environment: Production environment affected (#31056)	❌	While the changes may improve overall JSON handling, there is no direct correlation to resolving the production environment issue as it pertains to file uploads.
Version: Issue observed in v1.9.42 - SNAPSHOT (#31056)	❌	The PR does not specify adjustments to the file upload process or multipart handling that the version issue points to.

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>.
  • Generate unit-tests for this file.
• 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 from git 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.

[NilanshBansal]

/ok-to-test tags="@tag.All"

[github-actions]

Whoa, @tag.All spotted in your test suite! 🚀
While @tag.All is cool, like a catch-all net, why not try specific tags? 🏷️
Narrow down your suite with specific tags for quicker and more accurate tests! 🚀 Less waiting, more zipping through tests like a ninja!
Explore the tags documentation here

[github-actions]

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7906134761.
Workflow: Appsmith External Integration Test Workflow.
Tags: ``.

[github-actions]

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/7906134761.
Commit: ``.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

1. cypress/e2e/Regression/ServerSide/ApiTests/API_CurlPOSTImport_spec.js

2. cypress/e2e/Regression/ServerSide/ApiTests/CurlImportFlow_spec.js

To know the list of identified flaky tests - Refer here

[NilanshBansal]

/build-deploy-preview skip-tests=true

[github-actions]

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/7910866372.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 31133.
recreate: .

[github-actions]

Deploy-Preview-URL: https://ce-31133.dp.appsmith.com

[github-actions]

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/7906134761.
Commit: ``.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

1. cypress/e2e/Regression/ServerSide/ApiTests/API_CurlPOSTImport_spec.js

2. cypress/e2e/Regression/ServerSide/ApiTests/CurlImportFlow_spec.js

To know the list of identified flaky tests - Refer here