fix: getQueryParamsFromString function updated to use URLSearchParams

AmanAgarwal041 commented 6 days ago

Description

Earlier we were escaping some special characters using replace method in getQueryParamsFromString function in getQueryParamsObject.ts file, which was throwing error when we had new line in the url string. Hence, updated the function to use URLSearchParams which parses the search string and then we return the json using Object.fromEntries function. Also added a jest test case for the same.

Fixes #37080
or
Fixes Issue URL

[!WARNING]
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.JS, @tag.Binding, @tag.Widget"

:mag: Cypress test results

[!TIP] 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11910084861 Commit: 25b09fc1a5615f57b838d89a3196fd58e750fe15 Cypress dashboard. Tags: @tag.JS, @tag.Binding, @tag.Widget Spec:
Tue, 19 Nov 2024 11:28:02 UTC

Communication

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

[ ] Yes
[ ] No

Summary by CodeRabbit

New Features
- Introduced a new test suite to validate the behavior of query parameter processing, ensuring correct handling of newline characters.
Bug Fixes
- Improved the implementation of the query parameter parsing function, enhancing reliability and simplifying the process.
Tests
- Added a test case to confirm the proper decoding of parameters and retention of values in the output object.

coderabbitai[bot] commented 6 days ago

Walkthrough

The changes involve the addition of a new test suite for the getQueryParamsFromString function and a significant update to its implementation. The function now uses the URLSearchParams API for parsing query parameters instead of manual string manipulation. The new implementation simplifies the process while maintaining error handling. The test suite verifies the function's behavior with query strings containing newline characters.

Changes

File Path	Change Summary
app/client/src/utils/getQueryParamsObject.test.ts	Added a new test suite for `getQueryParamsFromString`, including a test for handling newline characters in query strings.
app/client/src/utils/getQueryParamsObject.ts	Updated `getQueryParamsFromString` to use `URLSearchParams` for parsing query parameters, simplifying the implementation while keeping the function signature unchanged.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure query parameters are retained during navigation (37080)	✅
Fix issues related to branch changes in edit mode (37080)	❌	The changes do not directly address branch navigation issues.

Possibly related PRs

#36938: This PR modifies the navigateToApplication function to include branch parameters in URLs, which relates to the handling of query parameters similar to the changes made in the getQueryParamsFromString function in the main PR.

Suggested labels

Bug, Medium, Needs Triaging, Framework Functions, ok-to-test, Query & JS Pod, Datasources

Suggested reviewers

ankitakinger

🎉 In code we trust, with tests we play,
New paths we forge, come what may!
Parameters parsed, no more fuss,
With each change, we build and discuss!
So here’s to the tests, both bright and bold,
In our code’s embrace, new stories unfold! 🚀

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

AmanAgarwal041 commented 6 days ago

/build-deploy-preview

github-actions[bot] commented 6 days ago

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

github-actions[bot] commented 6 days ago

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

appsmithorg / appsmith