Add flipr API error detection and catch it correctly. (#67405)

homeassistant/components/flipr/__init__.py

@@ -3,6 +3,7 @@ from datetime import timedelta
 import logging
 
 from flipr_api import FliprAPIRestClient
+from flipr_api.exceptions import FliprError
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_EMAIL, CONF_PASSWORD, Platform
@@ -11,6 +12,7 @@ from homeassistant.helpers.entity import DeviceInfo, EntityDescription
 from homeassistant.helpers.update_coordinator import (
     CoordinatorEntity,
     DataUpdateCoordinator,
+    UpdateFailed,
 )
 
 from .const import ATTRIBUTION, CONF_FLIPR_ID, DOMAIN, MANUFACTURER, NAME
@@ -68,9 +70,15 @@ class FliprDataUpdateCoordinator(DataUpdateCoordinator):
 
     async def _async_update_data(self):
         """Fetch data from API endpoint."""
-        return await self.hass.async_add_executor_job(
-            self.client.get_pool_measure_latest, self.flipr_id
-        )
+        try:
+            data = await self.hass.async_add_executor_job(
+                self.client.get_pool_measure_latest, self.flipr_id
+            )
+        except (FliprError) as error:
+            _LOGGER.error(error)
+            raise UpdateFailed from error
+
+        return data
 
 
 class FliprEntity(CoordinatorEntity):

homeassistant/components/flipr/manifest.json

@@ -4,7 +4,7 @@
   "config_flow": true,
   "documentation": "https://www.home-assistant.io/integrations/flipr",
   "requirements": [
-    "flipr-api==1.4.1"],
+    "flipr-api==1.4.2"],
   "codeowners": [
     "@cnico"
   ],

requirements_all.txt

@@ -639,7 +639,7 @@ fixerio==1.0.0a0
 fjaraskupan==1.0.2
 
 # homeassistant.components.flipr
-flipr-api==1.4.1
+flipr-api==1.4.2
 
 # homeassistant.components.flux_led
 flux_led==0.28.27

requirements_test_all.txt

@@ -431,7 +431,7 @@ fivem-api==0.1.2
 fjaraskupan==1.0.2
 
 # homeassistant.components.flipr
-flipr-api==1.4.1
+flipr-api==1.4.2
 
 # homeassistant.components.flux_led
 flux_led==0.28.27

tests/components/flipr/test_sensor.py

@@ -2,6 +2,8 @@
 from datetime import datetime
 from unittest.mock import patch
 
+from flipr_api.exceptions import FliprError
+
 from homeassistant.components.flipr.const import CONF_FLIPR_ID, DOMAIN
 from homeassistant.const import (
     ATTR_ICON,
@@ -84,3 +86,31 @@ async def test_sensors(hass: HomeAssistant) -> None:
     assert state.attributes.get(ATTR_ICON) == "mdi:pool"
     assert state.attributes.get(ATTR_UNIT_OF_MEASUREMENT) == "mV"
     assert state.state == "0.23654886"
+
+
+async def test_error_flipr_api_sensors(hass: HomeAssistant) -> None:
+    """Test the Flipr sensors error."""
+    entry = MockConfigEntry(
+        domain=DOMAIN,
+        unique_id="test_entry_unique_id",
+        data={
+            CONF_EMAIL: "toto@toto.com",
+            CONF_PASSWORD: "myPassword",
+            CONF_FLIPR_ID: "myfliprid",
+        },
+    )
+
+    entry.add_to_hass(hass)
+
+    registry = await hass.helpers.entity_registry.async_get_registry()
+
+    with patch(
+        "flipr_api.FliprAPIRestClient.get_pool_measure_latest",
+        side_effect=FliprError("Error during flipr data retrieval..."),
+    ):
+        await hass.config_entries.async_setup(entry.entry_id)
+        await hass.async_block_till_done()
+
+    # Check entity is not generated because of the FliprError raised.
+    entity = registry.async_get("sensor.flipr_myfliprid_red_ox")
+    assert entity is None