jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-04-25 17:57:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

More graceful exception handling in Plex library sensors (#52969)

Browse Source
This commit is contained in:
jjlawren 2021-07-13 13:22:31 -05:00 committed by GitHub
parent ff56ede960
commit f39f087b10
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
homeassistant/components/plex/sensor.py
View File

@ -2,6 +2,7 @@
import logging import logging
from plexapi.exceptions import NotFound from plexapi.exceptions import NotFound
import requests.exceptions
from homeassistant.components.sensor import SensorEntity from homeassistant.components.sensor import SensorEntity
from homeassistant.helpers.debounce import Debouncer from homeassistant.helpers.debounce import Debouncer
@ -148,6 +149,13 @@ class PlexLibrarySectionSensor(SensorEntity):
self._attr_available = True self._attr_available = True
except NotFound: except NotFound:
self._attr_available = False self._attr_available = False
except requests.exceptions.RequestException as err:
_LOGGER.error(
"Could not update library sensor for '%s': %s",
self.library_section.title,
err,
)
self._attr_available = False
self.async_write_ha_state() self.async_write_ha_state()
def _update_state_and_attrs(self): def _update_state_and_attrs(self):

31
tests/components/plex/test_sensor.py
View File

@ -1,6 +1,8 @@
"""Tests for Plex sensors.""" """Tests for Plex sensors."""
from datetime import timedelta from datetime import timedelta
import requests.exceptions
from homeassistant.config_entries import RELOAD_AFTER_UPDATE_DELAY from homeassistant.config_entries import RELOAD_AFTER_UPDATE_DELAY
from homeassistant.const import STATE_UNAVAILABLE from homeassistant.const import STATE_UNAVAILABLE
from homeassistant.helpers import entity_registry as er from homeassistant.helpers import entity_registry as er
@ -15,6 +17,7 @@ LIBRARY_UPDATE_PAYLOAD = {"StatusNotification": [{"title": "Library scan complet
async def test_library_sensor_values( async def test_library_sensor_values(
hass, hass,
caplog,
setup_plex_server, setup_plex_server,
mock_websocket, mock_websocket,
requests_mock, requests_mock,
@ -63,6 +66,34 @@ async def test_library_sensor_values(
assert library_tv_sensor.attributes["seasons"] == 1 assert library_tv_sensor.attributes["seasons"] == 1
assert library_tv_sensor.attributes["shows"] == 1 assert library_tv_sensor.attributes["shows"] == 1
# Handle `requests` exception
requests_mock.get(
"/library/sections/2/all?includeCollections=0&type=2",
exc=requests.exceptions.ReadTimeout,
)
trigger_plex_update(
mock_websocket, msgtype="status", payload=LIBRARY_UPDATE_PAYLOAD
)
await hass.async_block_till_done()
library_tv_sensor = hass.states.get("sensor.plex_server_1_library_tv_shows")
assert library_tv_sensor.state == STATE_UNAVAILABLE
assert "Could not update library sensor" in caplog.text
# Ensure sensor updates properly when it recovers
requests_mock.get(
"/library/sections/2/all?includeCollections=0&type=2",
text=library_tvshows_size,
)
trigger_plex_update(
mock_websocket, msgtype="status", payload=LIBRARY_UPDATE_PAYLOAD
)
await hass.async_block_till_done()
library_tv_sensor = hass.states.get("sensor.plex_server_1_library_tv_shows")
assert library_tv_sensor.state == "10"
# Handle library deletion # Handle library deletion
requests_mock.get( requests_mock.get(
"/library/sections/2/all?includeCollections=0&type=2", status_code=404 "/library/sections/2/all?includeCollections=0&type=2", status_code=404