hotfix: added migration for new config entry parameter base_url #98
Conversation
This file contains hidden or 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
Changes to be committed: modified: custom_components/diveracontrol/__init__.py
There was a problem hiding this comment.
Pull Request Overview
This PR adds migration logic for version 1.2.1 to include a new base_url parameter in the config entry data. The migration sets a default value of https://api.divera247.com for existing installations that lack this parameter.
- Added migration handler for v1.2.1 that adds the
base_urlfield to config entries - Sets default base_url to "https://api.divera247.com" for backwards compatibility
- Updates config entry version metadata to reflect the new patch version
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
191
to
211
| if VERSION == 1 and MINOR_VERSION == 2 and PATCH_VERSION == 1: | ||
| _LOGGER.info( | ||
| "Migrating config entry to version %s.%s.%s", | ||
| VERSION, | ||
| MINOR_VERSION, | ||
| PATCH_VERSION, | ||
| ) | ||
|
|
||
| if D_BASE_API_URL not in config_entry.data: | ||
| _LOGGER.info("Adding base_url to existing config entry") | ||
|
|
||
| hass.config_entries.async_update_entry( | ||
| config_entry, | ||
| data={ | ||
| **config_entry.data, | ||
| D_BASE_API_URL: "https://api.divera247.com", | ||
| }, | ||
| version=VERSION, | ||
| minor_version=MINOR_VERSION, | ||
| patch_version=PATCH_VERSION, | ||
| ) |
There was a problem hiding this comment.
The migration logic always logs 'Migrating config entry' (line 192-197) even when the base_url already exists and no migration is needed. Consider moving the log statement inside the conditional check at line 199 to only log when actual migration occurs, similar to how the v1.2.0 migration is structured (lines 140-151).
update: tests for config flow Changes to be committed: modified: custom_components/diveracontrol/__init__.py modified: tests/test_config_flow.py
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.
Changes to be committed:
modified: custom_components/diveracontrol/init.py