Handle LastFM unavailable

homeassistant/components/lastfm/sensor.py

@@ -3,7 +3,7 @@
 
 import hashlib
 
-from pylast import LastFMNetwork, Track, User, WSError
+from pylast import LastFMNetwork, PyLastError, Track, User
 import voluptuous as vol
 
 from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
@@ -105,25 +105,27 @@ def __init__(self, user: User, entry_id: str) -> None:
     def update(self) -> None:
         """Update device state."""
         try:
-            self._user.get_playcount()
-        except WSError as exc:
+            play_count = self._user.get_playcount()
+        except PyLastError as exc:
             self._attr_available = False
             LOGGER.error("Failed to load LastFM user `%s`: %r", self._user.name, exc)
             return
-        self._attr_entity_picture = self._user.get_image()
-        if now_playing := self._user.get_now_playing():
-            self._attr_native_value = format_track(now_playing)
-        else:
-            self._attr_native_value = STATE_NOT_SCROBBLING
-        top_played = None
-        if top_tracks := self._user.get_top_tracks(limit=1):
-            top_played = format_track(top_tracks[0].item)
-        last_played = None
-        if last_tracks := self._user.get_recent_tracks(limit=1):
-            last_played = format_track(last_tracks[0].track)
-        play_count = self._user.get_playcount()
-        self._attr_extra_state_attributes = {
-            ATTR_LAST_PLAYED: last_played,
-            ATTR_PLAY_COUNT: play_count,
-            ATTR_TOP_PLAYED: top_played,
-        }
+        try:
+            self._attr_entity_picture = self._user.get_image()
+            if now_playing := self._user.get_now_playing():
+                self._attr_native_value = format_track(now_playing)
+            else:
+                self._attr_native_value = STATE_NOT_SCROBBLING
+            top_played = None
+            if top_tracks := self._user.get_top_tracks(limit=1):
+                top_played = format_track(top_tracks[0].item)
+            last_played = None
+            if last_tracks := self._user.get_recent_tracks(limit=1):
+                last_played = format_track(last_tracks[0].track)
+            self._attr_extra_state_attributes = {
+                ATTR_LAST_PLAYED: last_played,
+                ATTR_PLAY_COUNT: play_count,
+                ATTR_TOP_PLAYED: top_played,
+            }
+        except PyLastError:
+            return

tests/components/lastfm/__init__.py

@@ -96,6 +96,27 @@ def get_friends(self) -> list[any]:
         return self._friends
 
 
+class FailingMockUser(MockUser):
+    """Mock user built to pass verification but raise exception later."""
+
+    amount_called = 0
+
+    def __init__(self):
+        """Initialize default user."""
+        super().__init__(
+            now_playing_result=Track("artist", "title", MockNetwork("lastfm")),
+            top_tracks=[Track("artist", "title", MockNetwork("lastfm"))],
+            recent_tracks=[Track("artist", "title", MockNetwork("lastfm"))],
+        )
+
+    def get_image(self) -> str:
+        """Raise exception when get user image."""
+        self.amount_called += 1
+        if self.amount_called > 1:
+            raise PyLastError("network", "status", "Page not found")
+        return ""
+
+
 def patch_user(user: MockUser) -> MockUser:
     """Patch interface."""
     return patch("pylast.User", return_value=user)

tests/components/lastfm/test_sensor.py

@@ -1,4 +1,5 @@
 """Tests for the lastfm sensor."""
+from datetime import timedelta
 from unittest.mock import patch
 
 from pylast import WSError
@@ -16,11 +17,12 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import issue_registry as ir
 from homeassistant.setup import async_setup_component
+from homeassistant.util import dt as dt_util
 
-from . import API_KEY, USERNAME_1, MockUser
+from . import API_KEY, USERNAME_1, FailingMockUser, MockUser
 from .conftest import ComponentSetup
 
-from tests.common import MockConfigEntry
+from tests.common import MockConfigEntry, async_fire_time_changed
 
 LEGACY_CONFIG = {
     Platform.SENSOR: [
@@ -111,3 +113,33 @@ async def test_update_playing(
     assert state.attributes[ATTR_LAST_PLAYED] == "artist - title"
     assert state.attributes[ATTR_TOP_PLAYED] == "artist - title"
     assert state.attributes[ATTR_PLAY_COUNT] == 1
+
+
+async def test_update_failed(
+    hass: HomeAssistant,
+    setup_integration: ComponentSetup,
+    config_entry: MockConfigEntry,
+    default_user: MockUser,
+) -> None:
+    """Test handling exception after API is tested."""
+    await setup_integration(config_entry, FailingMockUser())
+
+    entity_id = "sensor.testaccount1"
+
+    state = hass.states.get(entity_id)
+
+    assert state.state == "artist - title"
+    assert state.attributes[ATTR_LAST_PLAYED] == "artist - title"
+    assert state.attributes[ATTR_TOP_PLAYED] == "artist - title"
+    assert state.attributes[ATTR_PLAY_COUNT] == 1
+
+    future = dt_util.utcnow() + timedelta(minutes=15)
+    async_fire_time_changed(hass, future)
+    await hass.async_block_till_done()
+
+    state = hass.states.get(entity_id)
+
+    assert state.state == "artist - title"
+    assert state.attributes[ATTR_LAST_PLAYED] == "artist - title"
+    assert state.attributes[ATTR_TOP_PLAYED] == "artist - title"
+    assert state.attributes[ATTR_PLAY_COUNT] == 1