Fix config upgrades #356
Merged
Fix config upgrades #356
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous update changed the major version of the config from 1 to 2 and then made it so thatmigration always failed. The intention was that reconfiguration would somehow automatically fix this, but sadly that didn't work. With this change the config is automatically migrated to 2. Just to make this more complicated, the HA API for this is changing in 2024.3, so there are two code paths to handle the version change. The API key is then checked during initialization and if it doesn't work, ConfigEntryAuthFailed is raised. This shows up as a repair in settings which prompts the user to enter an API key.
nathanmarlor
approved these changes
Mar 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous update changed the major version of the config from 1 to 2 and then made it so thatmigration always failed. The intention was that reconfiguration would somehow automatically fix this, but sadly that didn't work. With this change the config is automatically migrated to 2. Just to make this more complicated, the HA API for this is changing in 2024.3, so there are two code paths to handle the version change.
The API key is then checked during initialization and if it doesn't work, ConfigEntryAuthFailed is raised. This shows up as a repair in settings which prompts the user to enter an API key.
Also updates the documentation to remove references to username/password and fixes a bug where it tried to refresh the old-style authentication token.