evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix missing debouncer cancel in update coordinator (#89383)

Browse source 
* Fix missing debouncer cancel in update coordinator

* Improve

* Adjust with comment

* Adjust again

* Simplify PR

* Adjust tests to avoid lingering timer

* Improve
This commit is contained in:
epenet 2023-03-09 21:16:52 +01:00 • committed by GitHub
parent 7ef1c289be
commit 48fca3bb27
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
homeassistant/helpers/update_coordinator.py
View file

@ -148,6 +148,8 @@ class DataUpdateCoordinator(BaseDataUpdateCoordinatorProtocol, Generic[_T]):
self._unsub_refresh()
self._unsub_refresh = None
self._debounced_refresh.async_cancel()
def async_contexts(self) -> Generator[Any, None, None]:
"""Return all registered contexts."""
yield from (
@ -163,6 +165,8 @@ class DataUpdateCoordinator(BaseDataUpdateCoordinatorProtocol, Generic[_T]):
if self.config_entry and self.config_entry.pref_disable_polling:
return
# We do not cancel the debouncer here. If the refresh interval is shorter
# than the debouncer cooldown, this would cause the debounce to never be called
if self._unsub_refresh:
self._unsub_refresh()
self._unsub_refresh = None

14
tests/helpers/test_update_coordinator.py
View file

@ -146,6 +146,9 @@ async def test_request_refresh(crd) -> None:
assert crd.data == 1
assert crd.last_update_success is True
# Cleanup to avoid lingering timer
crd._unschedule_refresh()
async def test_request_refresh_no_auto_update(crd_without_update_interval) -> None:
"""Test request refresh for update coordinator without automatic update."""
@ -160,6 +163,9 @@ async def test_request_refresh_no_auto_update(crd_without_update_interval) -> No
assert crd.data == 1
assert crd.last_update_success is True
# Cleanup to avoid lingering timer
crd._unschedule_refresh()
@pytest.mark.parametrize(
"err_msg",
@ -293,7 +299,8 @@ async def test_coordinator_entity(crd: update_coordinator.DataUpdateCoordinator[
) as mock_async_on_remove:
await entity.async_added_to_hass()
assert mock_async_on_remove.called
mock_async_on_remove.assert_called_once()
_on_remove_callback = mock_async_on_remove.call_args[0][0]
# Verify we do not update if the entity is disabled
crd.last_update_success = False
@ -303,6 +310,11 @@ async def test_coordinator_entity(crd: update_coordinator.DataUpdateCoordinator[
assert list(crd.async_contexts()) == [context]
# Call remove callback to cleanup debouncer and avoid lingering timer
assert len(crd._listeners) == 1
_on_remove_callback()
assert len(crd._listeners) == 0
async def test_async_set_updated_data(crd) -> None:
"""Test async_set_updated_data for update coordinator."""