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

Vesync unload error when not all platforms used #134166

Merged
merged 1 commit into from
Jan 1, 2025

Conversation

cdnninja
Copy link
Contributor

@cdnninja cdnninja commented Dec 28, 2024

Proposed change

Vesync errors on reload because in some cases not all platforms are used. The old code referenced the total platform list vs the in use list. Not sure if a more elegant way exists to get this data but this works. I was able to replicate the error and confirm resolved in my dev container.

This is referenced regularly as the error:

ValueError: Config entry was never loaded!

Example issues:

#131781
#131409

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @markperdue, @webdjoe, @TheGardenMonkey, mind taking a look at this pull request as it has been labeled with an integration (vesync) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of vesync can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign vesync Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@cdnninja
Copy link
Contributor Author

@iprak fyi since you have another in flight vesync PR. I don't think they clash but wanted you to see this. Open to recommendations to simplify this.

@iprak
Copy link
Contributor

iprak commented Dec 28, 2024

What a coincidence. I had fixed this locally as well by saving off the platforms actually used.

    hass.data[DOMAIN][VS_PLATFORMS] = platforms
...

async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
    """Unload a config entry."""
    # Only unload platforms which we had processed
    platforms = hass.data[DOMAIN].get(VS_PLATFORMS)
    unload_ok = (
        await hass.config_entries.async_unload_platforms(entry, platforms)
        if platforms
        else True
    )
    if unload_ok:
        hass.data.pop(DOMAIN)

    return unload_ok

@cdnninja
Copy link
Contributor Author

I was looking at that approach but this section of code updates platforms so needs to also be updated. https://github.com/cdnninja/core/blob/0ad8c4afff72c3eab55a9253c186b2023cf90991/homeassistant/components/vesync/__init__.py#L75-L127

So figured lots of lines of code. I am good with either approach though!

@iprak
Copy link
Contributor

iprak commented Dec 28, 2024

I was looking at that approach but this section of code updates platforms so needs to also be updated. https://github.com/cdnninja/core/blob/0ad8c4afff72c3eab55a9253c186b2023cf90991/homeassistant/components/vesync/__init__.py#L75-L127

So figured lots of lines of code. I am good with either approach though!

I missed that. Yes, your change will cover that as well.

Comment on lines +138 to +146
in_use_platforms = []
if hass.data[DOMAIN][VS_SWITCHES]:
in_use_platforms.append(Platform.SWITCH)
if hass.data[DOMAIN][VS_FANS]:
in_use_platforms.append(Platform.FAN)
if hass.data[DOMAIN][VS_LIGHTS]:
in_use_platforms.append(Platform.LIGHT)
if hass.data[DOMAIN][VS_SENSORS]:
in_use_platforms.append(Platform.SENSOR)
Copy link
Member

Choose a reason for hiding this comment

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

For a future iteration, I would strong suggest to actually just move the detection on what to add to the platforms, this way you can just load all platforms, and then if a platform is not relevant, you can just not add entities

@joostlek joostlek merged commit 3a68a0a into home-assistant:dev Jan 1, 2025
34 checks passed
@joostlek joostlek added this to the 2025.1.0 milestone Jan 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants