Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 fix QS.decode: properly account for strictNullHandling when allowEmptyLists #21

Merged
merged 1 commit into from
Jul 16, 2024

Conversation

techouse
Copy link
Owner

Description

Fix QS.decode output when both strictNullHandling and allowEmptyLists are set to true.

Fixes ljharb/qs#510

Type of change

Please delete options that are not relevant.

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

How Has This Been Tested?

Added new tests.

Checklist:

  • 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
  • Any dependent changes have been merged and published in downstream modules

@techouse techouse added the bug Something isn't working label Jul 16, 2024
@techouse techouse self-assigned this Jul 16, 2024
Copy link

coderabbitai bot commented Jul 16, 2024

Walkthrough

The changes address a bug in the decode method when both strictNullHandling and allowEmptyArrays options are enabled. The modification ensures correct handling and assignment of empty arrays under these conditions. Additionally, new test cases were added to verify the encoding and decoding behaviours when these options are set to true.

Changes

File Change Summary
lib/src/extensions/decode.dart Modified conditional logic to correctly handle strictNullHandling and allowEmptyArrays.
test/unit/decode_test.dart Added test case for decoding with strictNullHandling and allowEmptyArrays options.
test/unit/encode_test.dart Added test case for encoding with strictNullHandling and allowEmptyArrays options.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant QS
    participant Decode
    
    User->>QS: Call decode with strictNullHandling and allowEmptyArrays
    QS->>Decode: Pass parameters
    Decode->>QS: Return empty list if criteria met
    QS->>User: Return parsed result
Loading

Assessment against linked issues

Objective Addressed Explanation
The parse method returns correct output when strictNullHandling and allowEmptyArrays are true (Issue #510)

Poem

In code where arrays were once a plight,
Now empty lists are handled right.
With tests to guide and changes clear,
Bugs and errors disappear.
For every check and null so strict,
A rabbit’s code, robust and quick! 🐇


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
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.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration 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.

@techouse techouse changed the title 🐛 fix decode: properly account for strictNullHandling when allowEmptyLists 🐛 fix QS.decode: properly account for strictNullHandling when allowEmptyLists Jul 16, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.39% (target: -1.00%) 100.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (887af0e) 643 628 97.67%
Head commit (bb04b62) 660 (+17) 642 (+14) 97.27% (-0.39%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#21) 2 2 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences


🚀 Don’t miss a bit, follow what’s new on Codacy.

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.66%. Comparing base (887af0e) to head (bb04b62).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #21   +/-   ##
=======================================
  Coverage   97.65%   97.66%           
=======================================
  Files          14       14           
  Lines         641      642    +1     
=======================================
+ Hits          626      627    +1     
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 887af0e and bb04b62.

Files selected for processing (3)
  • lib/src/extensions/decode.dart (1 hunks)
  • test/unit/decode_test.dart (1 hunks)
  • test/unit/encode_test.dart (1 hunks)
Additional comments not posted (3)
lib/src/extensions/decode.dart (1)

108-109: Review of new condition in _parseObject method.

The revised condition checks for both an empty string (leaf == '') and null values when strictNullHandling is set. This ensures that an empty list is created when these conditions are met, aligning with the expected behaviour described in the PR. This is a crucial fix for the issue described in the linked GitHub issue.

The use of a ternary operation here is appropriate and maintains readability while effectively handling multiple conditions. The logic appears sound and should correctly implement the desired functionality of handling empty lists and null values under specific settings.

test/unit/decode_test.dart (1)

263-277: Review of new test case for allowEmptyLists and strictNullHandling.

The test case correctly checks the functionality of decoding an empty list with both strictNullHandling and allowEmptyLists set to true. The expected output is an empty list, which aligns with the requirements specified in the linked issue.

This test case is well-constructed and directly addresses the bug described. It effectively verifies that the decode function now handles the specific case of an empty list correctly when both options are enabled. The use of const for DecodeOptions ensures that the options are immutable, which is good practice in test scenarios to prevent unintended side effects.

test/unit/encode_test.dart (1)

460-474: Correct implementation of test for handling empty lists with strictNullHandling and allowEmptyLists

This test case successfully verifies the expected behavior when both strictNullHandling and allowEmptyLists are enabled. The assertion checks that an empty list is encoded as testEmptyList[], which aligns with the expected output described in the linked issue (#510).

The test is well-structured and clearly expresses its intent, making it easy to understand the scenario being tested.

@techouse techouse merged commit d565c16 into main Jul 16, 2024
13 checks passed
@techouse techouse deleted the fix/qs-issue-510 branch July 16, 2024 21:22
techouse added a commit that referenced this pull request Jul 16, 2024
## 1.2.1

- [FIX] Fix `QS.decode` output when both `strictNullHandling` and `allowEmptyLists` are set to `true` ([#21](#21))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The parse method returns incorrect output when both strictNullHandling and allowEmptyArrays are set to true
1 participant