Ensure players refreshed after group event (#106)

Author: andrewsayre

pyheos/command/player.py

@@ -150,6 +150,16 @@ async def load_players(self) -> PlayerUpdateResult:
         self._players_loaded = True
         return result
 
+    async def _refresh_players_base_info(self) -> None:
+        """Refresh the attributes of all player's base information."""
+        response = await self._connection.command(HeosCommand(c.COMMAND_GET_PLAYERS))
+        payload = cast(Sequence[dict[str, str]], response.payload)
+        for player_data in payload:
+            player_id = int(player_data[c.ATTR_PLAYER_ID])
+            player = self._players.get(player_id)
+            if player:
+                player._update_from_data(player_data)
+
     async def player_get_play_state(self, player_id: int) -> PlayState:
         """Get the state of the player.
 

pyheos/heos.py

@@ -235,17 +235,21 @@ async def _on_event_heos(self, event: HeosMessage) -> None:
         result: PlayerUpdateResult | None = None
         if event.command == const.EVENT_PLAYERS_CHANGED and self._players_loaded:
             result = await self.load_players()
-        if event.command == const.EVENT_SOURCES_CHANGED and self._music_sources_loaded:
+        elif (
+            event.command == const.EVENT_SOURCES_CHANGED and self._music_sources_loaded
+        ):
             await self.get_music_sources(refresh=True)
         elif event.command == const.EVENT_USER_CHANGED:
             if c.ATTR_SIGNED_IN in event.message:
                 self._signed_in_username = event.get_message_value(c.ATTR_USER_NAME)
             else:
                 self._signed_in_username = None
-        elif event.command == const.EVENT_GROUPS_CHANGED and self._groups_loaded:
+        elif event.command == const.EVENT_GROUPS_CHANGED:
             if self._players_loaded:
-                await self.get_players(refresh=True)
-            await self.get_groups(refresh=True)
+                # Ensure player group ID attributes (i.e. group_id) are update
+                await self._refresh_players_base_info()
+            if self._groups_loaded:
+                await self.get_groups(refresh=True)
 
         await self._dispatcher.wait_send(
             SignalType.CONTROLLER_EVENT, event.command, result, return_exceptions=True

tests/test_heos.py

@@ -1096,6 +1096,39 @@ async def handler(event: str, data: dict[str, Any]) -> None:
     assert not await heos.get_groups()
 
 
+@calls_player_commands()
+async def test_groups_changed_event_groups_not_loaded(
+    mock_device: MockHeosDevice, heos: Heos
+) -> None:
+    """Test groups changed fires dispatcher and updates players when groups not loaded."""
+    players = await heos.get_players()
+    assert all(player.group_id is not None for player in players.values())
+    signal = asyncio.Event()
+
+    async def handler(event: str, data: dict[str, Any]) -> None:
+        assert event == EVENT_GROUPS_CHANGED
+        signal.set()
+
+    heos.dispatcher.connect(SignalType.CONTROLLER_EVENT, handler)
+
+    # Write event through mock device
+    commands = [
+        mock_device.register(
+            c.COMMAND_GET_GROUPS, None, "group.get_groups_changed", replace=True
+        ),
+        mock_device.register(
+            c.COMMAND_GET_PLAYERS, None, "player.get_players_no_groups", replace=True
+        ),
+    ]
+    await mock_device.write_event("event.groups_changed")
+
+    # Wait until the signal is set
+    await signal.wait()
+    map(lambda c: c.assert_called(), commands)
+    assert all(player.group_id is None for player in players.values())
+    assert not heos.groups
+
+
 @calls_player_commands()
 async def test_player_playback_error_event(
     mock_device: MockHeosDevice, heos: Heos