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

Fix error handling on subscribe when mqtt is not initialized #101832

Merged
merged 1 commit into from Oct 20, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Oct 11, 2023

Proposed change

When an automation trigger is set up, and it tries to subscribe an MQTT topic, while MQTT was not inialized correctly (e.g. becase of a yaml configuration failure), mqtt will throw an unhandled KeyError exception like:

2023-10-11 15:41:37.812 DEBUG (MainThread) [homeassistant.components.mqtt.trigger] Attaching MQTT trigger for topic: 'test/trigger', payload: 'now'
2023-10-11 15:41:37.848 INFO (MainThread) [homeassistant.components.automation.test_trigger] Initialized trigger Test trigger
2023-10-11 15:41:37.850 ERROR (MainThread) [homeassistant.components.automation.test_mqtt_trigger] Error setting up trigger test_mqtt_trigger
Traceback (most recent call last):
  File "/workspaces/core/homeassistant/components/mqtt/trigger.py", line 101, in async_attach_trigger
    remove = await mqtt.async_subscribe(
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/workspaces/core/homeassistant/components/mqtt/client.py", line 179, in async_subscribe
    mqtt_data = get_mqtt_data(hass)
                ^^^^^^^^^^^^^^^^^^^
  File "/workspaces/core/homeassistant/components/mqtt/util.py", line 180, in get_mqtt_data
    mqtt_data = hass.data[DATA_MQTT]
                ~~~~~~~~~^^^^^^^^^^^
KeyError: 'mqtt'
2023-10-11 15:41:37.856 INFO (MainThread) [homeassistant.components.automation.test_98664] Initialized trigger Test #98664

This PR makes sure this type of error is handled correctly, so we get something like:

2023-10-11 15:39:08.530 ERROR (MainThread) [homeassistant.components.automation.test_mqtt_trigger] Got error 'Unable to subscribe MQTT topic test/trigger. Makes sure the MQTT integration is set up correctly' when setting up triggers for test_mqtt_trigger

get_mqtt_data is used to expose an internal dataclass, to ensure typing, and it is set when mqtt is initialized the first time.

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

  • 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
  • I have followed the perfect PR recommendations
  • 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @emontnemery, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@jbouwh jbouwh added the bugfix label Oct 11, 2023
@jbouwh jbouwh changed the title Error handling on subscribe when mqtt is not initialized Fix error handling on subscribe when mqtt is not initialized Oct 11, 2023
@jbouwh jbouwh force-pushed the mqtt-not-initialized-trigger-setup branch from eabd6bc to 47af9ea Compare October 11, 2023 17:48
@jbouwh jbouwh added this to the 2023.10.4 milestone Oct 20, 2023
@jbouwh jbouwh added the smash Indicator this PR is close to finish for merging or closing label Oct 20, 2023
@joostlek joostlek merged commit 485c525 into dev Oct 20, 2023
53 checks passed
@joostlek joostlek deleted the mqtt-not-initialized-trigger-setup branch October 20, 2023 13:16
@frenck frenck mentioned this pull request Oct 20, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Oct 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants