Disable decodeDotInKeys by default to restore previous behavior

[wwaaijer-exh]

Fixes #500.

Restores the default behavior as it was before v6.12.0.

All test cases with encoded dots explicitly set the relevant options, so the default behavior was not tested.
Added an extra test case for this.

Summary by CodeRabbit

• New Features
  • Changed the default behavior for parsing keys with dots in query strings to improve clarity and predictability.
• Tests
  • Added a new test case to ensure reliable parsing of keys with dots.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes involve modifying the default behavior of the decodeDotInKeys setting in the qs library, switching it from true to false. Additionally, a new test case was added to ensure the correct handling of keys with dots in query strings.

Changes

File	Change Summary
lib/parse.js	Default value of decodeDotInKeys changed from true to false.
test/parse.js	Added test case for decoding keys with dots in query strings.

Assessment against linked issues

Objective	Addressed	Explanation
Disable decodeDotInKeys by default (#500)	✅
Resolve inconsistencies in qs.stringify() and qs.parse() handling JSON structures (#471)	❌	The changes focus on the handling of dots in keys, not on JSON structure inconsistencies.

Possibly related issues

• qs.stringify(json) and qs.parse(json) Results are inconsistent with expectations #471: This issue discusses inconsistencies in handling JSON structures. Although the current changes do not address this directly, it highlights potential areas in parsing and serialization that might overlap with JSON structure handling.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between fd3cd7a and 7e18298.

Files selected for processing (2)

• lib/parse.js (1 hunks)
• test/parse.js (1 hunks)

Additional comments not posted (1)

lib/parse.js (1)

17-17: Change to set decodeDotInKeys to false aligns with the PR's objective to revert its default behavior. Ensure all dependent parsing functions respect this new default.

Verification successful

The script results show that decodeDotInKeys is used in several critical places within lib/parse.js. Most uses appear to correctly handle the change from true to false. However, the relationship between allowDots and decodeDotInKeys needs further investigation to ensure that the new default value does not adversely affect the behavior of allowDots.

---

The investigation into the interaction between allowDots and decodeDotInKeys shows that the change in the default value of decodeDotInKeys to false is handled appropriately. The logic correctly falls back to the default value of allowDots when decodeDotInKeys is false, which is consistent with the intended functionality of the code. This ensures that the behavior of allowDots remains predictable and aligned with the new default settings.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for all occurrences of `decodeDotInKeys` in the `lib` directory to ensure it's used correctly with the new default.
rg 'decodeDotInKeys' ./lib

Length of output: 702

---

---

Script:

#!/bin/bash
# Examine the logic related to `allowDots` and `decodeDotInKeys` to understand how the change in default value of `decodeDotInKeys` affects `allowDots`.
rg 'allowDots' ./lib/parse.js

Length of output: 305

---

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 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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