Skip to content

Do not fetch disconnected Home Connect appliances #142200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions homeassistant/components/home_connect/coordinator.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,19 @@ def update(self, other: HomeConnectApplianceData) -> None:
self.settings.update(other.settings)
self.status.update(other.status)

@classmethod
def empty(cls, appliance: HomeAppliance) -> HomeConnectApplianceData:
"""Return empty data."""
return cls(
commands=set(),
events={},
info=appliance,
options={},
programs=[],
settings={},
status={},
)


class HomeConnectCoordinator(
DataUpdateCoordinator[dict[str, HomeConnectApplianceData]]
Expand Down Expand Up @@ -362,15 +375,7 @@ async def _async_setup(self) -> None:
model=appliance.vib,
)
if appliance.ha_id not in self.data:
self.data[appliance.ha_id] = HomeConnectApplianceData(
commands=set(),
events={},
info=appliance,
options={},
programs=[],
settings={},
status={},
)
self.data[appliance.ha_id] = HomeConnectApplianceData.empty(appliance)
else:
self.data[appliance.ha_id].info.connected = appliance.connected
old_appliances.remove(appliance.ha_id)
Expand Down Expand Up @@ -406,6 +411,15 @@ async def _get_appliance_data(
name=appliance.name,
model=appliance.vib,
)
if not appliance.connected:
_LOGGER.debug(
"Appliance %s is not connected, skipping data fetch",
appliance.ha_id,
)
if appliance_data_to_update:
appliance_data_to_update.info.connected = False
return appliance_data_to_update
return HomeConnectApplianceData.empty(appliance)
try:
settings = {
setting.key: setting
Expand Down
71 changes: 64 additions & 7 deletions tests/components/home_connect/test_coordinator.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@

from tests.common import MockConfigEntry, async_fire_time_changed

INITIAL_FETCH_CLIENT_METHODS = [
"get_settings",
"get_status",
"get_all_programs",
"get_available_commands",
"get_available_program",
]


@pytest.fixture
def platforms() -> list[str]:
Expand Down Expand Up @@ -214,15 +222,32 @@ async def test_coordinator_failure_refresh_and_stream(
assert state.state != STATE_UNAVAILABLE


@pytest.mark.parametrize(
"appliance",
["Dishwasher"],
indirect=True,
)
async def test_coordinator_not_fetching_on_disconnected_appliance(
config_entry: MockConfigEntry,
integration_setup: Callable[[MagicMock], Awaitable[bool]],
setup_credentials: None,
client: MagicMock,
appliance: HomeAppliance,
) -> None:
"""Test that the coordinator does not fetch anything on disconnected appliance."""
appliance.connected = False

assert config_entry.state == ConfigEntryState.NOT_LOADED
await integration_setup(client)
assert config_entry.state == ConfigEntryState.LOADED

for method in INITIAL_FETCH_CLIENT_METHODS:
assert getattr(client, method).call_count == 0


@pytest.mark.parametrize(
"mock_method",
[
"get_settings",
"get_status",
"get_all_programs",
"get_available_commands",
"get_available_program",
],
INITIAL_FETCH_CLIENT_METHODS,
)
async def test_coordinator_update_failing(
mock_method: str,
Expand Down Expand Up @@ -552,3 +577,35 @@ async def test_devices_updated_on_refresh(
assert not device_registry.async_get_device({(DOMAIN, appliances[0].ha_id)})
for appliance in appliances[2:3]:
assert device_registry.async_get_device({(DOMAIN, appliance.ha_id)})


@pytest.mark.parametrize("appliance", ["Washer"], indirect=True)
async def test_paired_disconnected_devices_not_fetching(
hass: HomeAssistant,
config_entry: MockConfigEntry,
integration_setup: Callable[[MagicMock], Awaitable[bool]],
setup_credentials: None,
client: MagicMock,
appliance: HomeAppliance,
) -> None:
"""Test that Home Connect API is not fetch after pairing a disconnected device."""
client.get_home_appliances = AsyncMock(return_value=ArrayOfHomeAppliances([]))
assert config_entry.state == ConfigEntryState.NOT_LOADED
assert await integration_setup(client)
assert config_entry.state == ConfigEntryState.LOADED

appliance.connected = False
await client.add_events(
[
EventMessage(
appliance.ha_id,
EventType.PAIRED,
data=ArrayOfEvents([]),
)
]
)
await hass.async_block_till_done()

client.get_specific_appliance.assert_awaited_once_with(appliance.ha_id)
for method in INITIAL_FETCH_CLIENT_METHODS:
assert getattr(client, method).call_count == 0