Skip to content
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

Skip fetching deactivated shopping lists in Bring integration #135336

Merged
merged 3 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 2 additions & 0 deletions homeassistant/components/bring/coordinator.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ async def _async_update_data(self) -> dict[str, BringData]:

list_dict: dict[str, BringData] = {}
for lst in lists_response["lists"]:
if (ctx := set(self.async_contexts())) and lst["listUuid"] not in ctx:
continue
try:
items = await self.bring.get_list(lst["listUuid"])
except BringRequestException as e:
Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/bring/entity.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def __init__(
bring_list: BringData,
) -> None:
"""Initialize the entity."""
super().__init__(coordinator)
super().__init__(coordinator, bring_list["listUuid"])

self._list_uuid = bring_list["listUuid"]

Expand Down
38 changes: 36 additions & 2 deletions tests/components/bring/test_init.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
"""Unit tests for the bring integration."""

from datetime import timedelta
from unittest.mock import AsyncMock

from freezegun.api import FrozenDateTimeFactory
import pytest

from homeassistant.components.bring import (
Expand All @@ -11,11 +13,14 @@
async_setup_entry,
)
from homeassistant.components.bring.const import DOMAIN
from homeassistant.config_entries import ConfigEntryState
from homeassistant.config_entries import ConfigEntryDisabler, ConfigEntryState
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
from homeassistant.helpers import device_registry as dr

from tests.common import MockConfigEntry
from .conftest import UUID

from tests.common import MockConfigEntry, async_fire_time_changed


async def setup_integration(
Expand Down Expand Up @@ -133,3 +138,32 @@ async def test_config_entry_not_ready_auth_error(
await hass.async_block_till_done()

assert bring_config_entry.state is ConfigEntryState.SETUP_RETRY


@pytest.mark.usefixtures("mock_bring_client")
async def test_coordinator_skips_deactivated(
hass: HomeAssistant,
bring_config_entry: MockConfigEntry,
freezer: FrozenDateTimeFactory,
mock_bring_client: AsyncMock,
device_registry: dr.DeviceRegistry,
) -> None:
"""Test the coordinator skips fetching lists for deactivated lists."""
await setup_integration(hass, bring_config_entry)

assert bring_config_entry.state is ConfigEntryState.LOADED

assert mock_bring_client.get_list.await_count == 2

device = device_registry.async_get_device(
identifiers={(DOMAIN, f"{UUID}_b4776778-7f6c-496e-951b-92a35d3db0dd")}
)
device_registry.async_update_device(device.id, disabled_by=ConfigEntryDisabler.USER)

mock_bring_client.get_list.reset_mock()

freezer.tick(timedelta(seconds=90))
async_fire_time_changed(hass)
await hass.async_block_till_done()

assert mock_bring_client.get_list.await_count == 1