Starlink migration to StarlinkConfigEntry (#137896)

* refactor: Utilize custom StarlinkConfigEntry

* fix: ruff-format

* fix: Init tests

* fix: StarlinkConfigEntry in coordinator after recent PRs

* fix: CONF_IP_ADDRESS constant

* fix: After merge clean up

* fix: Naming conventions

* feat: Add runtime_data into init test

* refactor: Remove runtime_data assert in unload entry test

homeassistant/components/starlink/__init__.py

@@ -2,12 +2,10 @@
 
 from __future__ import annotations
 
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
 
-from .const import DOMAIN
-from .coordinator import StarlinkUpdateCoordinator
+from .coordinator import StarlinkConfigEntry, StarlinkUpdateCoordinator
 
 PLATFORMS = [
     Platform.BINARY_SENSOR,
@@ -19,21 +17,19 @@ PLATFORMS = [
 ]
 
 
-async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+async def async_setup_entry(
+    hass: HomeAssistant, config_entry: StarlinkConfigEntry
+) -> bool:
     """Set up Starlink from a config entry."""
-    coordinator = StarlinkUpdateCoordinator(hass, entry)
+    config_entry.runtime_data = StarlinkUpdateCoordinator(hass, config_entry)
+    await config_entry.runtime_data.async_config_entry_first_refresh()
 
-    await coordinator.async_config_entry_first_refresh()
-
-    hass.data.setdefault(DOMAIN, {})[entry.entry_id] = coordinator
-
-    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+    await hass.config_entries.async_forward_entry_setups(config_entry, PLATFORMS)
     return True
 
 
-async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+async def async_unload_entry(
+    hass: HomeAssistant, config_entry: StarlinkConfigEntry
+) -> bool:
     """Unload a config entry."""
-    if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
-        hass.data[DOMAIN].pop(entry.entry_id)
-
-    return unload_ok
+    return await hass.config_entries.async_unload_platforms(config_entry, PLATFORMS)

homeassistant/components/starlink/binary_sensor.py

@@ -10,26 +10,22 @@ from homeassistant.components.binary_sensor import (
     BinarySensorEntity,
     BinarySensorEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EntityCategory
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
-from .coordinator import StarlinkData
+from .coordinator import StarlinkConfigEntry, StarlinkData
 from .entity import StarlinkEntity
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    entry: ConfigEntry,
+    config_entry: StarlinkConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up all binary sensors for this entry."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
-
     async_add_entities(
-        StarlinkBinarySensorEntity(coordinator, description)
+        StarlinkBinarySensorEntity(config_entry.runtime_data, description)
         for description in BINARY_SENSORS
     )
 

homeassistant/components/starlink/button.py

@@ -10,26 +10,23 @@ from homeassistant.components.button import (
     ButtonEntity,
     ButtonEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import EntityCategory
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
-from .coordinator import StarlinkUpdateCoordinator
+from .coordinator import StarlinkConfigEntry, StarlinkUpdateCoordinator
 from .entity import StarlinkEntity
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    entry: ConfigEntry,
+    config_entry: StarlinkConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up all binary sensors for this entry."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
-
     async_add_entities(
-        StarlinkButtonEntity(coordinator, description) for description in BUTTONS
+        StarlinkButtonEntity(config_entry.runtime_data, description)
+        for description in BUTTONS
     )
 
 

homeassistant/components/starlink/coordinator.py

@@ -34,6 +34,8 @@ from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, Upda
 
 _LOGGER = logging.getLogger(__name__)
 
+type StarlinkConfigEntry = ConfigEntry[StarlinkUpdateCoordinator]
+
 
 @dataclass
 class StarlinkData:
@@ -51,9 +53,9 @@ class StarlinkData:
 class StarlinkUpdateCoordinator(DataUpdateCoordinator[StarlinkData]):
     """Coordinates updates between all Starlink sensors defined in this file."""
 
-    config_entry: ConfigEntry
+    config_entry: StarlinkConfigEntry
 
-    def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry) -> None:
+    def __init__(self, hass: HomeAssistant, config_entry: StarlinkConfigEntry) -> None:
         """Initialize an UpdateCoordinator for a group of sensors."""
         self.channel_context = ChannelContext(target=config_entry.data[CONF_IP_ADDRESS])
         self.history_stats_start = None

homeassistant/components/starlink/device_tracker.py

@@ -8,25 +8,22 @@ from homeassistant.components.device_tracker import (
     TrackerEntity,
     TrackerEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import ATTR_ALTITUDE, DOMAIN
-from .coordinator import StarlinkData
+from .const import ATTR_ALTITUDE
+from .coordinator import StarlinkConfigEntry, StarlinkData
 from .entity import StarlinkEntity
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    entry: ConfigEntry,
+    config_entry: StarlinkConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up all binary sensors for this entry."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
-
     async_add_entities(
-        StarlinkDeviceTrackerEntity(coordinator, description)
+        StarlinkDeviceTrackerEntity(config_entry.runtime_data, description)
         for description in DEVICE_TRACKERS
     )
 

homeassistant/components/starlink/diagnostics.py

@@ -4,18 +4,15 @@ from dataclasses import asdict
 from typing import Any
 
 from homeassistant.components.diagnostics import async_redact_data
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 
-from .const import DOMAIN
-from .coordinator import StarlinkUpdateCoordinator
+from .coordinator import StarlinkConfigEntry
 
 TO_REDACT = {"id", "latitude", "longitude", "altitude"}
 
 
 async def async_get_config_entry_diagnostics(
-    hass: HomeAssistant, entry: ConfigEntry
+    hass: HomeAssistant, config_entry: StarlinkConfigEntry
 ) -> dict[str, Any]:
     """Return diagnostics for Starlink config entries."""
-    coordinator: StarlinkUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
-    return async_redact_data(asdict(coordinator.data), TO_REDACT)
+    return async_redact_data(asdict(config_entry.runtime_data.data), TO_REDACT)

homeassistant/components/starlink/sensor.py

@@ -12,7 +12,6 @@ from homeassistant.components.sensor import (
     SensorEntityDescription,
     SensorStateClass,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     DEGREE,
     PERCENTAGE,
@@ -28,21 +27,19 @@ from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 from homeassistant.helpers.typing import StateType
 from homeassistant.util.dt import now
 
-from .const import DOMAIN
-from .coordinator import StarlinkData
+from .coordinator import StarlinkConfigEntry, StarlinkData
 from .entity import StarlinkEntity
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    entry: ConfigEntry,
+    config_entry: StarlinkConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up all sensors for this entry."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
-
     async_add_entities(
-        StarlinkSensorEntity(coordinator, description) for description in SENSORS
+        StarlinkSensorEntity(config_entry.runtime_data, description)
+        for description in SENSORS
     )
 
 

homeassistant/components/starlink/switch.py

@@ -11,25 +11,22 @@ from homeassistant.components.switch import (
     SwitchEntity,
     SwitchEntityDescription,
 )
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
-from .coordinator import StarlinkData, StarlinkUpdateCoordinator
+from .coordinator import StarlinkConfigEntry, StarlinkData, StarlinkUpdateCoordinator
 from .entity import StarlinkEntity
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    entry: ConfigEntry,
+    config_entry: StarlinkConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up all binary sensors for this entry."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
-
     async_add_entities(
-        StarlinkSwitchEntity(coordinator, description) for description in SWITCHES
+        StarlinkSwitchEntity(config_entry.runtime_data, description)
+        for description in SWITCHES
     )
 
 

homeassistant/components/starlink/time.py

@@ -8,26 +8,23 @@ from datetime import UTC, datetime, time, tzinfo
 import math
 
 from homeassistant.components.time import TimeEntity, TimeEntityDescription
-from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import DOMAIN
-from .coordinator import StarlinkData, StarlinkUpdateCoordinator
+from .coordinator import StarlinkConfigEntry, StarlinkData, StarlinkUpdateCoordinator
 from .entity import StarlinkEntity
 
 
 async def async_setup_entry(
     hass: HomeAssistant,
-    entry: ConfigEntry,
+    config_entry: StarlinkConfigEntry,
     async_add_entities: AddConfigEntryEntitiesCallback,
 ) -> None:
     """Set up all time entities for this entry."""
-    coordinator = hass.data[DOMAIN][entry.entry_id]
-
     async_add_entities(
-        StarlinkTimeEntity(coordinator, description) for description in TIMES
+        StarlinkTimeEntity(config_entry.runtime_data, description)
+        for description in TIMES
     )
 
 

tests/components/starlink/test_init.py

@@ -33,8 +33,9 @@ async def test_successful_entry(hass: HomeAssistant) -> None:
         await hass.config_entries.async_setup(entry.entry_id)
         await hass.async_block_till_done()
 
+        assert entry.runtime_data
+        assert entry.runtime_data.data
         assert entry.state is ConfigEntryState.LOADED
-        assert entry.entry_id in hass.data[DOMAIN]
 
 
 async def test_unload_entry(hass: HomeAssistant) -> None:
@@ -59,4 +60,3 @@ async def test_unload_entry(hass: HomeAssistant) -> None:
         await hass.async_block_till_done()
 
         assert entry.state is ConfigEntryState.NOT_LOADED
-        assert entry.entry_id not in hass.data[DOMAIN]