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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Postpone broadlink platform switch until config entry is ready #76371

Merged
merged 1 commit into from
Aug 7, 2022

Conversation

elupus
Copy link
Contributor

@elupus elupus commented Aug 7, 2022

Proposed change

We must setup the platform data with the config entry setup callback,
and device information. So trigger a platform not ready until the entry
has been setup, then use the stored callback function to setup.

The old solution relied on platform setup having completed before config entry setup. This is no longer guaranteed (if it ever was)

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
  • The code has been formatted using Black (black --fast 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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

We must setup the platform data with the config entry setup callback,
and device information. So trigger a platform not ready until the entry
has been setup, then use the stored callback function to setup.
@probot-home-assistant
Copy link

Hey there @Danielhiversen, @felipediel, @L-I-Am, mind taking a look at this pull request as it has been labeled with an integration (broadlink) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@elupus
Copy link
Contributor Author

elupus commented Aug 7, 2022

This is rather ugly. At some point we need to move the broadlink switches key to under the broadlink top yaml. That would be a breaking change and we do have a regression at the moment, so some type of fix is needed.

If you have some other nicer solutions i'm all ears.

@felipediel
Copy link
Contributor

felipediel commented Aug 7, 2022

We could subscribe to EVENT_COMPONENT_LOADED (https://developers.home-assistant.io/docs/integration_listen_events/) in the switch platform.

Thanks for the fix.

@bdraco bdraco added this to the 2022.8.2 milestone Aug 7, 2022
@balloob
Copy link
Member

balloob commented Aug 7, 2022

If there is a config entry, async_setup_platform shouldn't exist/use anything from it. async_setup_platform either sets up their own stuff independently (if legacy), or it triggers an import and then all is taken care off by the config entry. This hybrid approach should be avoided.

Will merge to fix the current issue, but this should be refactored.

@balloob balloob merged commit 4aeaeed into home-assistant:dev Aug 7, 2022
Dev automation moved this from Needs review to Done Aug 7, 2022
@balloob balloob mentioned this pull request Aug 7, 2022
@chriselera
Copy link

Confirmed working in 2022.8.2. Thanks!

@github-actions github-actions bot locked and limited conversation to collaborators Aug 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

Custom Broadlink IR/RF Switches not loaded at startup
7 participants