🐛 fix decode: properly account for strict_null_handling when allow_empty_lists

[techouse]

Description

Fix decode output when both strict_null_handling and allow_empty_lists 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

Summary by CodeRabbit

• New Features

  • Improved list handling functionality with new strict_null_handling option.

• Tests

  • Added tests for decoding and encoding with empty lists and strict null handling.

[coderabbitai]

Walkthrough

The changes address an issue where the parse method returns incorrect output when both strictNullHandling and allowEmptyArrays are set to true. Specifically, the _parse_object function in decode.py is updated to handle empty lists correctly under these conditions. New test cases are added to cover this scenario in both encoding and decoding.

Changes

Files	Change Summary
src/qs_codec/decode.py	Added a conditional check in _parse_object function to handle strict null handling and empty lists.
tests/unit/decode_test.py	Added test_allow_empty_lists_and_strict_null_handling to test decoding behavior with new conditions.
tests/unit/encode_test.py	Added test_empty_list_with_strict_null_handling to verify encoding behavior with strict null handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant QSCodec
    participant DecodeOptions

    Client->>QSCodec: Call parse method with strictNullHandling and allowEmptyArrays
    QSCodec->>DecodeOptions: Check options.strict_null_handling and leaf is None
    DecodeOptions-->>QSCodec: Return true
    QSCodec-->>Client: Return empty list

Loading

Assessment against linked issues

Objective	Addressed	Explanation
The parse method should correctly handle cases where both strictNullHandling and allowEmptyArrays are set to true. (#510)	✅

Poem

In code where lists and nulls entwine,
A rabbit's touch makes all things fine.
With careful checks, the flow is clear,
Empty lists, no nulls appear.
The tests confirm what's rightly done,
In parsing, we have now won.
🐇✨

---

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

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ -0.10% (target: -1.00%)	✅ 100.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (bf2863f)	709	686	96.76%
Head commit (0e45224)	1374 (+665)	1328 (+642)	96.65% (-0.10%)

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 (#5)	1	1	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}

[coderabbitai]

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 bf2863f and 0e45224.

Files selected for processing (3)

• src/qs_codec/decode.py (1 hunks)
• tests/unit/decode_test.py (1 hunks)
• tests/unit/encode_test.py (1 hunks)

Additional comments not posted (3)

src/qs_codec/decode.py (1)

132-132: Review the handling of empty lists in _parse_object.

The added condition options.allow_empty_lists and (leaf == "" or (options.strict_null_handling and leaf is None)) correctly implements the logic to handle empty lists when both strict_null_handling and allow_empty_lists are enabled. This change aligns with the PR objectives and linked issue requirements.

tests/unit/decode_test.py (1)

140-143: Review the new test method test_allow_empty_lists_and_strict_null_handling.

The test method correctly asserts that an empty list is returned when both strict_null_handling and allow_empty_lists are enabled, which matches the expected behavior described in the PR objectives and linked issue. This test is essential for validating the bug fix.

tests/unit/encode_test.py (1)

239-243: Review of new test method: test_empty_list_with_strict_null_handling

This test method correctly verifies the behavior of the encode function when handling empty lists with both strict_null_handling and allow_empty_lists set to True. The assertion checks that the output is "testEmptyList[]", which aligns with the expected behavior described in the PR summary and linked issue.

The test is well-structured and follows the conventions used in the rest of the test suite. It's good to see that the test parameters (strict_null_handling and allow_empty_lists) are explicitly set, which ensures clarity and correctness in what the test is intended to validate.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.75%. Comparing base (bf2863f) to head (0e45224).

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #5   +/-   ##
=======================================
  Coverage   96.75%   96.75%           
=======================================
  Files          16       16           
  Lines         709      709           
=======================================
  Hits          686      686           
  Misses         23       23           

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