Do not unsubscribe mqtt integration discovery if entry is already configured #126907
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
home-assistant
bot
added
bugfix
cla-signed
core
has-tests
integration: mqtt
small-pr
|
Hey there @emontnemery, @bdraco, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
emontnemery
reviewed
Sep 27, 2024
| @@ -1454,7 +1454,7 @@ class TestFlow(config_entries.ConfigFlow): | |||
|
|
|||
| async def async_step_mqtt(self, discovery_info: MqttServiceInfo) -> FlowResult: | |||
| """Test mqtt step.""" | |||
| return self.async_abort(reason="already_configured") | |||
| return self.async_abort(reason="single_instance_allowed") | |||
There was a problem hiding this comment.
Do we have other tests which checks we don't abort if the abort reason is different?
There was a problem hiding this comment.
Not yet, we only had a test for already_configured which I adjusted.
I'll add a test for the already_configured to prove the subscription remains.
There was a problem hiding this comment.
Parameterized the tests now, and added some cases where we do not unsubscribe
frenck
pushed a commit
that referenced
this pull request
Sep 27, 2024
…figured (#126907) * Do not unsubscribe mqtt integration discovery if entry is already configured * Test cases without unsubscribe
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change
Integrations that support mqtt discovery use an integration discovery topic for discovery of a device. When am entry is discovered once it should not be set up again if the discovery message is send again. In that case the config flow is aborted. The MQTT integration used to unsubscribe to the integration discovery topic after such a flow was aborted with
already_configuredorsingle_instance_allowed. When multyple entries are supported by an integration this will cause an issue as when the integration discovery topic is unsubscribed to, no new discovery is possible.This PR will fix this issue by no longer unsubscribe the integration discovery topic when an
already_configuredabort flow happened. In case of asingle_instance_abortflow the integration discovery topic will still be unsubscribed to.Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: