Skip to content

Fix DeviceInfo round-trip serialization after areas/devices fields additions #1229

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

Merged
merged 2 commits into from
Jun 23, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jun 23, 2025

What does this implement/fix?

This PR fixes an issue with DeviceInfo round-trip serialization that was introduced when the areas, devices, and area fields were added in #1146.

When using DeviceInfo.to_dict() followed by creating a new DeviceInfo instance from that dictionary (a common pattern for mocking in tests), the code would fail with an AttributeError because the area field converter expected a protobuf object but received a dictionary.

The fix adds a convert method to AreaInfo that properly handles both dictionary and protobuf inputs, similar to how the convert_list methods already work for the list fields.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code quality improvements to existing code or addition of tests
  • Other

Related issue or feature (if applicable):

Pull request in esphome (if applicable):

  • N/A - This only affects the Python model classes, not the protobuf definitions

Checklist:

  • The code change is tested and works locally.
  • If api.proto was modified, a linked pull request has been made to esphome with the same changes.
  • Tests have been added to verify that the new code works (under tests/ folder).

Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1ddc6ea) to head (e18e8f2).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1229   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines         2965      2970    +5     
=========================================
+ Hits          2965      2970    +5     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bdraco bdraco merged commit 75b2e99 into main Jun 23, 2025
18 of 19 checks passed
Copy link

codspeed-hq bot commented Jun 23, 2025

CodSpeed Performance Report

Merging #1229 will not alter performance

Comparing area_devices_fix (e18e8f2) with main (1ddc6ea)

Summary

✅ 11 untouched benchmarks

@bdraco bdraco deleted the area_devices_fix branch June 23, 2025 11:55
Copy link
Contributor

coderabbitai bot commented Jun 23, 2025

Caution

Review failed

The pull request is closed.

"""

Walkthrough

A new convert class method was added to the AreaInfo dataclass to generalize conversion from both dictionaries and protobuf objects. The DeviceInfo dataclass was updated to use this method for its area field. Corresponding tests were added to verify correct serialization and deserialization of nested fields.

Changes

File(s) Change Summary
aioesphomeapi/model.py Added AreaInfo.convert class method; updated DeviceInfo.area field to use this converter.
tests/test_model.py Added tests for DeviceInfo serialization/deserialization with nested and updated fields.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeviceInfo
    participant AreaInfo

    User->>DeviceInfo: Create from dict (with area field)
    DeviceInfo->>AreaInfo: AreaInfo.convert(value)
    alt value is dict
        AreaInfo->>AreaInfo: from_dict(value)
    else value is protobuf
        AreaInfo->>AreaInfo: from_pb(value)
    end
    AreaInfo-->>DeviceInfo: AreaInfo instance
    DeviceInfo-->>User: DeviceInfo instance with area
Loading

Possibly related PRs

  • [API] Sub devices and areas #1146: Originally introduced the AreaInfo and DeviceInfo classes and their fields; the current PR builds directly on these classes and fields.

Suggested labels

minor
"""


📜 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 98bce27 and e18e8f2.

📒 Files selected for processing (2)
  • aioesphomeapi/model.py (2 hunks)
  • tests/test_model.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant