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 errors when unjoining multiple Sonos devices simultaneously #73133

Merged

Conversation

jjlawren
Copy link
Contributor

@jjlawren jjlawren commented Jun 6, 2022

Proposed change

This wraps the media_player.join and .unjoin service calls in an async lock to avoid potential races during grouping operations.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

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
  • 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link

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

self.speaker.join(speakers)

def unjoin_player(self):
async with self.hass.data[DATA_SONOS].topology_condition:
Copy link
Member

Choose a reason for hiding this comment

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

you write lock in description but use a condition here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was trying to keep the description simple as the way it's used here should effectively act like a simple lock. Am I missing an angle on why it shouldn't be used in this manner?

Copy link
Member

Choose a reason for hiding this comment

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

was just checking!

@jjlawren jjlawren force-pushed the sonos/fix/media_player_unjoin_race branch from 20dfaf2 to 93142c3 Compare June 6, 2022 19:58
@balloob balloob merged commit 4f75de2 into home-assistant:dev Jun 6, 2022
@jjlawren jjlawren added this to the 2022.6.4 milestone Jun 6, 2022
@jjlawren jjlawren deleted the sonos/fix/media_player_unjoin_race branch June 6, 2022 22:41
@github-actions github-actions bot locked and limited conversation to collaborators Jun 7, 2022
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.

media_player.unjoin throws error when unjoining the "master"
4 participants