fix: state recs convertValues do not add undefined when value is not …

[MartianGreed]

…present from schema

Closes #

Introduced changes

Checklist

• Linked relevant issue
• Updated relevant documentation
• Added relevant tests
• Add a dedicated CI job for new examples
• Performed self-review of the code

Summary by CodeRabbit

• Documentation

  • Introduced a patch update notice for multiple Dojo Engine packages.

• Bug Fixes

  • Improved value handling to prevent unintended null assignments for missing data.

• Tests

  • Added coverage to ensure that omitted fields are processed correctly without defaulting to unwanted values.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a new changeset markdown file that documents a patch update for multiple Dojo Engine packages. It includes a fix to the convertValues function, ensuring that when encountering an undefined value, the key is skipped rather than set to null. Alongside, a new test case verifies that the function does not output fields set to undefined, while still processing null values as expected. No modifications were made to exported or public entities.

Changes

File(s)	Summary
.changeset/rude-doors-beg.md	Adds a documentation file recording patch updates for various Dojo Engine packages and noting the fix in the convertValues function regarding undefined values.
packages/state/src/{__tests__/utils.test.ts, utils/index.ts}	Updates the convertValues function to skip keys with undefined values and adds a test case to ensure that the output does not mistakenly assign undefined values.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller/Test Suite
    participant Convert as convertValues Function
    Caller->>Convert: Call with (schema, values)
    alt value is undefined
        Convert->>Convert: Check value is undefined and skip processing
        Convert-->>Caller: Return accumulator unchanged
    else value is null
        Convert->>Convert: Process value as null
        Convert-->>Caller: Return accumulator with null entry
    else Valid value
        Convert->>Convert: Process and add value to accumulator
        Convert-->>Caller: Return updated accumulator
    end

Loading

Possibly related PRs

• fix: recs tests #301: Adjusts the convertValues logic in a similar context, ensuring consistent treatment of undefined values.
• fix: type build #307: Modifies the test suite for convertValues, closely aligning with the changes made in this PR.
• fix: prettier #298: Focuses on refining the behavior of convertValues with respect to distinguishing between undefined and null values.

Suggested Reviewers

• ponderingdemocritus

Poem

I’m a coder rabbit, hopping through the code,
Skipping undefineds on a smooth winding road.
Nulls remain cozy where they’re meant to be,
Tests verify my path, so clean and bug-free.
With each little patch, my joy starts to explode!
Happy hops in the world of CodeRabbit mode!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e2ee851 and 28398be.

⛔ Files ignored due to path filters (1)

• examples/example-vite-react-phaser-recs/src/dojo/generated/contractComponents.ts is excluded by !**/generated/**

📒 Files selected for processing (3)

• .changeset/rude-doors-beg.md (1 hunks)
• packages/state/src/__tests__/utils.test.ts (1 hunks)
• packages/state/src/utils/index.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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>, 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 generate docstrings to generate docstrings for 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.