Relax Reolink update interval and timeout for big installs (home-assistant#156509)

Author: starkillerOG

homeassistant/components/reolink/__init__.py

@@ -58,7 +58,8 @@
     Platform.SWITCH,
     Platform.UPDATE,
 ]
-DEVICE_UPDATE_INTERVAL = timedelta(seconds=60)
+DEVICE_UPDATE_INTERVAL_MIN = timedelta(seconds=60)
+DEVICE_UPDATE_INTERVAL_PER_CAM = timedelta(seconds=10)
 FIRMWARE_UPDATE_INTERVAL = timedelta(hours=24)
 NUM_CRED_ERRORS = 3
 
@@ -137,9 +138,12 @@ async def async_setup_entry(
         }
         hass.config_entries.async_update_entry(config_entry, data=data)
 
+    min_timeout = host.api.timeout * (RETRY_ATTEMPTS + 2)
+    update_timeout = max(min_timeout, min_timeout * host.api.num_cameras / 10)
+
     async def async_device_config_update() -> None:
         """Update the host state cache and renew the ONVIF-subscription."""
-        async with asyncio.timeout(host.api.timeout * (RETRY_ATTEMPTS + 2)):
+        async with asyncio.timeout(update_timeout):
             try:
                 await host.update_states()
             except CredentialsInvalidError as err:
@@ -156,7 +160,7 @@ async def async_device_config_update() -> None:
 
         host.credential_errors = 0
 
-        async with asyncio.timeout(host.api.timeout * (RETRY_ATTEMPTS + 2)):
+        async with asyncio.timeout(min_timeout):
             await host.renew()
 
         if host.api.new_devices and config_entry.state == ConfigEntryState.LOADED:
@@ -171,7 +175,7 @@ async def async_device_config_update() -> None:
 
     async def async_check_firmware_update() -> None:
         """Check for firmware updates."""
-        async with asyncio.timeout(host.api.timeout * (RETRY_ATTEMPTS + 2)):
+        async with asyncio.timeout(min_timeout):
             try:
                 await host.api.check_new_firmware(host.firmware_ch_list)
             except ReolinkError as err:
@@ -197,7 +201,10 @@ async def async_check_firmware_update() -> None:
         config_entry=config_entry,
         name=f"reolink.{host.api.nvr_name}",
         update_method=async_device_config_update,
-        update_interval=DEVICE_UPDATE_INTERVAL,
+        update_interval=max(
+            DEVICE_UPDATE_INTERVAL_MIN,
+            DEVICE_UPDATE_INTERVAL_PER_CAM * host.api.num_cameras,
+        ),
     )
     firmware_coordinator = DataUpdateCoordinator(
         hass,

homeassistant/components/reolink/update.py

@@ -23,7 +23,7 @@
     DataUpdateCoordinator,
 )
 
-from . import DEVICE_UPDATE_INTERVAL
+from . import DEVICE_UPDATE_INTERVAL_MIN, DEVICE_UPDATE_INTERVAL_PER_CAM
 from .const import DOMAIN
 from .entity import (
     ReolinkChannelCoordinatorEntity,
@@ -221,7 +221,10 @@ async def _pause_update_coordinator(self) -> None:
 
     async def _resume_update_coordinator(self, *args: Any) -> None:
         """Resume updating the states using the data update coordinator (after reboots)."""
-        self._reolink_data.device_coordinator.update_interval = DEVICE_UPDATE_INTERVAL
+        self._reolink_data.device_coordinator.update_interval = max(
+            DEVICE_UPDATE_INTERVAL_MIN,
+            DEVICE_UPDATE_INTERVAL_PER_CAM * self._host.api.num_cameras,
+        )
         try:
             await self._reolink_data.device_coordinator.async_refresh()
         finally:

tests/components/reolink/conftest.py

@@ -106,6 +106,7 @@ def _init_host_mock(host_mock: MagicMock) -> None:
     host_mock.protocol = "rtsp"
     host_mock.channels = [0]
     host_mock.stream_channels = [0]
+    host_mock.num_cameras = 1
     host_mock.new_devices = False
     host_mock.sw_version_update_required = False
     host_mock.hardware_version = "IPC_00000"

tests/components/reolink/test_binary_sensor.py

@@ -5,7 +5,7 @@
 
 from freezegun.api import FrozenDateTimeFactory
 
-from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL
+from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL_MIN
 from homeassistant.config_entries import ConfigEntryState
 from homeassistant.const import STATE_OFF, STATE_ON, Platform
 from homeassistant.core import HomeAssistant
@@ -35,7 +35,7 @@ async def test_motion_sensor(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_host.motion_detected.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -69,7 +69,7 @@ async def test_smart_ai_sensor(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_host.baichuan.smart_ai_state.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -94,7 +94,7 @@ async def test_index_sensor(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_host.baichuan.io_input_state.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 

tests/components/reolink/test_config_flow.py

@@ -16,7 +16,7 @@
 )
 
 from homeassistant import config_entries
-from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL
+from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL_MIN
 from homeassistant.components.reolink.config_flow import DEFAULT_PROTOCOL
 from homeassistant.components.reolink.const import (
     CONF_BC_ONLY,
@@ -564,7 +564,7 @@ async def test_dhcp_ip_update_aborted_if_wrong_mac(
 
     # ensure the last_update_succes is False for the device_coordinator.
     reolink_host.get_states.side_effect = ReolinkError("Test error")
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -661,7 +661,7 @@ async def test_dhcp_ip_update(
 
     # ensure the last_update_succes is False for the device_coordinator.
     reolink_host.get_states.side_effect = ReolinkError("Test error")
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 

tests/components/reolink/test_host.py

@@ -10,7 +10,7 @@
 from reolink_aio.enums import SubType
 from reolink_aio.exceptions import NotSupportedError, ReolinkError, SubscriptionError
 
-from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL
+from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL_MIN
 from homeassistant.components.reolink.host import (
     FIRST_ONVIF_LONG_POLL_TIMEOUT,
     FIRST_ONVIF_TIMEOUT,
@@ -258,15 +258,15 @@ async def test_renew(
     await hass.async_block_till_done()
     assert config_entry.state is ConfigEntryState.LOADED
 
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
     reolink_host.renew.assert_called()
 
     reolink_host.renew.side_effect = SubscriptionError("Test error")
 
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -275,7 +275,7 @@ async def test_renew(
     reolink_host.subscribe.reset_mock()
     reolink_host.subscribe.side_effect = SubscriptionError("Test error")
 
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -341,7 +341,7 @@ async def test_long_poll_stop_when_push(
     webhook_id = config_entry.runtime_data.host.webhook_id
     await client.post(f"/api/webhook/{webhook_id}")
 
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 

tests/components/reolink/test_init.py

@@ -14,7 +14,7 @@
 )
 
 from homeassistant.components.reolink import (
-    DEVICE_UPDATE_INTERVAL,
+    DEVICE_UPDATE_INTERVAL_MIN,
     FIRMWARE_UPDATE_INTERVAL,
     NUM_CRED_ERRORS,
 )
@@ -174,7 +174,7 @@ async def test_credential_error_three(
     issue_id = f"config_entry_reauth_{DOMAIN}_{config_entry.entry_id}"
     for _ in range(NUM_CRED_ERRORS):
         assert (HOMEASSISTANT_DOMAIN, issue_id) not in issue_registry.issues
-        freezer.tick(DEVICE_UPDATE_INTERVAL)
+        freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
         async_fire_time_changed(hass)
         await hass.async_block_till_done()
 
@@ -917,7 +917,7 @@ async def test_new_device_discovered(
     assert reolink_host.logout.call_count == 0
     reolink_host.new_devices = True
 
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -988,7 +988,7 @@ async def test_LoginPrivacyModeError(
     reolink_host.baichuan.check_subscribe_events.reset_mock()
     assert reolink_host.baichuan.check_subscribe_events.call_count == 0
 
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 

tests/components/reolink/test_select.py

@@ -7,7 +7,7 @@
 from reolink_aio.api import Chime
 from reolink_aio.exceptions import InvalidParameterError, ReolinkError
 
-from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL
+from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL_MIN
 from homeassistant.components.select import DOMAIN as SELECT_DOMAIN
 from homeassistant.config_entries import ConfigEntryState
 from homeassistant.const import (
@@ -68,7 +68,7 @@ async def test_floodlight_mode_select(
         )
 
     reolink_host.whiteled_mode.return_value = -99  # invalid value
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -142,7 +142,7 @@ async def test_host_scene_select(
         )
 
     reolink_host.baichuan.active_scene = "Invalid value"
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -202,7 +202,7 @@ async def test_chime_select(
     # Test unavailable
     reolink_chime.event_info = {}
     reolink_chime.update_enums()
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 

tests/components/reolink/test_switch.py

@@ -7,7 +7,7 @@
 from reolink_aio.api import Chime
 from reolink_aio.exceptions import ReolinkError
 
-from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL
+from homeassistant.components.reolink import DEVICE_UPDATE_INTERVAL_MIN
 from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
 from homeassistant.config_entries import ConfigEntryState
 from homeassistant.const import (
@@ -45,7 +45,7 @@ async def test_switch(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_host.audio_record.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -91,7 +91,7 @@ async def test_switch(
     reolink_host.set_audio.reset_mock(side_effect=True)
 
     reolink_host.camera_online.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -118,7 +118,7 @@ async def test_host_switch(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_host.email_enabled.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -183,7 +183,7 @@ async def test_chime_switch(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_chime.led_state = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()
 
@@ -248,7 +248,7 @@ async def test_rule_switch(
     assert hass.states.get(entity_id).state == STATE_ON
 
     reolink_host.baichuan.rule_enabled.return_value = False
-    freezer.tick(DEVICE_UPDATE_INTERVAL)
+    freezer.tick(DEVICE_UPDATE_INTERVAL_MIN)
     async_fire_time_changed(hass)
     await hass.async_block_till_done()