Skip to content

Handle setting RichMultiString keys to null#1791

Merged
myieye merged 3 commits into
developfrom
1783-cant-download-fruit-project
Jul 1, 2025
Merged

Handle setting RichMultiString keys to null#1791
myieye merged 3 commits into
developfrom
1783-cant-download-fruit-project

Conversation

@myieye

@myieye myieye commented Jun 30, 2025

Copy link
Copy Markdown
Collaborator

Resolves #1783

Thoughts and questions:

  • It's not clear to me if we have "replace with empty string" ops in prod. Currently for both multi-strings and rich-multi-strings, empty values' keys always just get removed on deserialization.
  • It's sort of breaking the .NET contract to remove keys on a set, but it keeps our model/behaviour more consistent. Converting nulls to empty rich-strings would be comparably weird.
  • Add operations have the same problem, but...there are probably no changes out there that would trip over that. Should we extend those methods to cover the null-case too anyway?

@myieye myieye requested a review from hahn-kev June 30, 2025 15:52
@coderabbitai

coderabbitai Bot commented Jun 30, 2025

Copy link
Copy Markdown

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes introduce explicit handling for null values in the RichMultiString dictionary setter, treating them as removal requests rather than causing exceptions. Additionally, a new unit test verifies that applying a JSON patch with an empty string properly empties the RichMultiString instance.

Changes

Files/Paths Change Summary
backend/FwLite/MiniLcm/Models/RichMultiString.cs Modified the IDictionary.this[object key] setter to treat null as a remove operation.
backend/FwLite/MiniLcm.Tests/RichMultiStringTests.cs Added a unit test to verify JSON patch replaces with empty string result in an empty object.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Ensure that a JSON patch operation with an empty string is interpreted as a remove (i.e., does not throw, but removes the entry) (#1783)
Prevent exceptions when deserializing or patching with an empty string/null in RichMultiString (#1783)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Poem

A patch for strings both rich and bright,
Now empty means “remove”—that’s right!
No more exceptions in the night,
Our tests confirm it works just right.
🐇✨
Code hops ahead, with bugs in flight!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@github-actions github-actions Bot added the 💻 FW Lite issues related to the fw lite application, not miniLcm or crdt related label Jun 30, 2025
@argos-ci

argos-ci Bot commented Jun 30, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Jul 1, 2025, 6:50 AM

@github-actions

github-actions Bot commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

UI unit Tests

 1 files  ± 0  31 suites  +5   9s ⏱️ -1s
36 tests +10  36 ✅ +10  0 💤 ±0  0 ❌ ±0 
64 runs  +12  64 ✅ +12  0 💤 ±0  0 ❌ ±0 

Results for commit b20f97b. ± Comparison against base commit 492fe8b.

♻️ This comment has been updated with latest results.

@hahn-kev hahn-kev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

nice catch. I agree it is weird, but I'm ok with it here. I'd be fine with doing the same on Add, but also fine to just ignore it for now. I did introduce a method on WSId which probably should have been there way sooner.

@myieye

myieye commented Jul 1, 2025

Copy link
Copy Markdown
Collaborator Author

Test failures are already in develop

@myieye myieye merged commit 6aa63fa into develop Jul 1, 2025
18 of 19 checks passed
@myieye myieye deleted the 1783-cant-download-fruit-project branch July 1, 2025 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

💻 FW Lite issues related to the fw lite application, not miniLcm or crdt related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Can't download fruit project

2 participants