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.

Sign up for GitHub

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

Jump to bottom

Ensure MQTT resubscribes happen before birth message #116471

Merged
merged 8 commits into from
Apr 30, 2024
Merged

Ensure MQTT resubscribes happen before birth message #116471

merged 8 commits into from
Apr 30, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Apr 30, 2024 •
edited
Loading

Proposed change

There were two tasks running but there was no synchronization to ensure the resubs were done before the birth message was published.

related issue #115958

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 Ruff (ruff format 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:

@bdraco bdraco added this to the 2024.5.0 milestone Apr 30, 2024
@home-assistant
Copy link

Hey there @emontnemery, @jbouwh, 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.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

jbouwh
jbouwh approved these changes Apr 30, 2024
View reviewed changes
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

LGTM,
Thnx @bdraco 👍

bdraco
bdraco commented Apr 30, 2024
View reviewed changes
homeassistant/components/mqtt/client.py
qos=birth_message.qos,
retain=birth_message.retain,
)

birth_message = PublishMessage(**birth)
self.config_entry.async_create_background_task(
Copy link
Member Author

@bdraco bdraco Apr 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

There is a race here if we disconnect while the task is running, but thats existing and should be solved in another PR

We should hold a refrence to the task and cancel it on disconnect and than await it suppressing cancellederror

jbouwh
jbouwh approved these changes Apr 30, 2024
View reviewed changes
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

Thnx @bdraco 👍

@bdraco bdraco marked this pull request as ready for review April 30, 2024 19:46
@bdraco bdraco requested a review from emontnemery as a code owner April 30, 2024 19:46
@frenck frenck merged commit 2e9b191 into dev Apr 30, 2024
38 checks passed
@frenck frenck deleted the sync_birth_to_resub branch April 30, 2024 20:31
@jbouwh jbouwh mentioned this pull request Apr 30, 2024
Merged
20 tasks
@bdraco bdraco mentioned this pull request Apr 30, 2024
Closed
frenck pushed a commit that referenced this pull request May 1, 2024
@bdraco @frenck
Ensure MQTT resubscribes happen before birth message (#116471)
3d13345
@github-actions github-actions bot locked and limited conversation to collaborators May 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jbouwh jbouwh jbouwh approved these changes

@emontnemery emontnemery Awaiting requested review from emontnemery emontnemery is a code owner

Assignees

@jbouwh jbouwh

@emontnemery emontnemery

Labels
bugfix by-code-owner cherry-picked cla-signed core integration: mqtt Quality Scale: platinum small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
2024.5.0
Development

Successfully merging this pull request may close these issues.
4 participants
@bdraco @jbouwh @frenck @emontnemery