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

Deprecate homekit_controller .homekit folder #32158

Conversation

Jc2k
Copy link
Member

@Jc2k Jc2k commented Feb 24, 2020

Breaking change

Support for homekit_controller's legacy pairing data folder .homekit has been deprecated. This has not been how pairings are saved since Home Assistant 0.94. In 0.109.0 we plan to remove this code. If you are running Home Assistant 0.94 or later this does not affect you - your pairings were already migrated to config entries. If you are running an older release and do not upgrade soon you will not be able to automatically migrate your existing pairings at upgrade time and will have to manually re-pair them.

Proposed change

Home Assistant currently tries to load pairing information from the .homekit folder when it sees a device that is paired but doesn't have a config entry. The is compatibility code from before homekit_controller supported config entries, and its been there for just under a year. I would like to deprecate it and then remove it after a couple of releases to simplify the code a bit.

Anyone running Home Assistant from after May 2019 would be unaffected as their .homekit folder will already be migrated. This would only affect people migrating from Home Assistant of that age directly to a version where support has been removed. The would have to repair their accessories via config flow.

CC @MartinHjelmare as discussed in #32141

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@project-bot project-bot bot added this to Needs review in Dev Feb 24, 2020
@MartinHjelmare MartinHjelmare changed the title homekit_controller: Deprecate .homekit folder Deprecate homekit_controller .homekit folder Feb 24, 2020
Dev automation moved this from Needs review to Review in progress Feb 24, 2020
@codecov
Copy link

codecov bot commented Feb 25, 2020

Codecov Report

Merging #32158 into dev will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev   #32158      +/-   ##
==========================================
+ Coverage   94.74%   94.75%   +0.01%     
==========================================
  Files         767      768       +1     
  Lines       55621    55644      +23     
==========================================
+ Hits        52696    52727      +31     
+ Misses       2925     2917       -8
Impacted Files Coverage Δ
...meassistant/components/mqtt/vacuum/schema_state.py 91.13% <0%> (-0.59%) ⬇️
homeassistant/components/twitch/sensor.py 96.7% <0%> (-0.04%) ⬇️
homeassistant/components/rflink/light.py 100% <0%> (ø) ⬆️
homeassistant/components/darksky/sensor.py 96.81% <0%> (ø) ⬆️
homeassistant/components/mqtt/fan.py 97.96% <0%> (ø) ⬆️
homeassistant/components/withings/const.py 100% <0%> (ø) ⬆️
homeassistant/components/mqtt/binary_sensor.py 100% <0%> (ø) ⬆️
homeassistant/components/almond/config_flow.py 100% <0%> (ø) ⬆️
...eassistant/components/homekit_controller/sensor.py 100% <0%> (ø) ⬆️
homeassistant/components/geonetnz_volcano/const.py 100% <0%> (ø) ⬆️
... and 48 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2d7bc4...d66ad9a. Read the comment docs.

@Jc2k
Copy link
Member Author

Jc2k commented Feb 25, 2020

OK - changes made. Release set to 0.109.0.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Please mention the time plan in the breaking changes paragraph.

Dev automation moved this from Review in progress to Reviewer approved Feb 25, 2020
@Jc2k
Copy link
Member Author

Jc2k commented Feb 25, 2020

@MartinHjelmare i tweaked it a bit and mentioned the target release - how is that?

@MartinHjelmare
Copy link
Member

Great!

@MartinHjelmare MartinHjelmare merged commit 438c4ac into home-assistant:dev Feb 25, 2020
Dev automation moved this from Reviewer approved to Done Feb 25, 2020
@Jc2k Jc2k deleted the homekit_controller_deprecated_dot_homekit branch February 25, 2020 13:20
@lock lock bot locked and limited conversation to collaborators Feb 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants