Do not add integration config entry to source device (#148730)

homeassistant/components/integration/__init__.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+import logging
+
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import Platform
 from homeassistant.core import HomeAssistant
@@ -9,14 +11,20 @@ from homeassistant.helpers.device import (
     async_entity_id_to_device_id,
     async_remove_stale_devices_links_keep_entity_device,
 )
-from homeassistant.helpers.helper_integration import async_handle_source_entity_changes
+from homeassistant.helpers.helper_integration import (
+    async_handle_source_entity_changes,
+    async_remove_helper_config_entry_from_source_device,
+)
 
 from .const import CONF_SOURCE_SENSOR
 
+_LOGGER = logging.getLogger(__name__)
+
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up Integration from a config entry."""
 
+    # This can be removed in HA Core 2026.2
     async_remove_stale_devices_links_keep_entity_device(
         hass,
         entry.entry_id,
@@ -29,20 +37,16 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
             options={**entry.options, CONF_SOURCE_SENSOR: source_entity_id},
         )
 
-    async def source_entity_removed() -> None:
-        # The source entity has been removed, we need to clean the device links.
-        async_remove_stale_devices_links_keep_entity_device(hass, entry.entry_id, None)
-
     entry.async_on_unload(
         async_handle_source_entity_changes(
             hass,
+            add_helper_config_entry_to_device=False,
             helper_config_entry_id=entry.entry_id,
             set_source_entity_id_or_uuid=set_source_entity_id_or_uuid,
             source_device_id=async_entity_id_to_device_id(
                 hass, entry.options[CONF_SOURCE_SENSOR]
             ),
             source_entity_id_or_uuid=entry.options[CONF_SOURCE_SENSOR],
-            source_entity_removed=source_entity_removed,
         )
     )
 
@@ -51,6 +55,40 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     return True
 
 
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
+    """Migrate old entry."""
+    _LOGGER.debug(
+        "Migrating from version %s.%s", config_entry.version, config_entry.minor_version
+    )
+
+    if config_entry.version > 1:
+        # This means the user has downgraded from a future version
+        return False
+    if config_entry.version == 1:
+        options = {**config_entry.options}
+        if config_entry.minor_version < 2:
+            # Remove the integration config entry from the source device
+            if source_device_id := async_entity_id_to_device_id(
+                hass, options[CONF_SOURCE_SENSOR]
+            ):
+                async_remove_helper_config_entry_from_source_device(
+                    hass,
+                    helper_config_entry_id=config_entry.entry_id,
+                    source_device_id=source_device_id,
+                )
+        hass.config_entries.async_update_entry(
+            config_entry, options=options, minor_version=2
+        )
+
+    _LOGGER.debug(
+        "Migration to version %s.%s successful",
+        config_entry.version,
+        config_entry.minor_version,
+    )
+
+    return True
+
+
 async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
     """Update listener, called when the config entry options are changed."""
     # Remove device link for entry, the source device may have changed.

homeassistant/components/integration/config_flow.py

@@ -147,6 +147,8 @@ OPTIONS_FLOW = {
 class ConfigFlowHandler(SchemaConfigFlowHandler, domain=DOMAIN):
     """Handle a config or options flow for Integration."""
 
+    MINOR_VERSION = 2
+
     config_flow = CONFIG_FLOW
     options_flow = OPTIONS_FLOW
 

homeassistant/components/integration/sensor.py

@@ -40,8 +40,7 @@ from homeassistant.core import (
     callback,
 )
 from homeassistant.helpers import config_validation as cv, entity_registry as er
-from homeassistant.helpers.device import async_device_info_to_link_from_entity
-from homeassistant.helpers.device_registry import DeviceInfo
+from homeassistant.helpers.device import async_entity_id_to_device
 from homeassistant.helpers.entity_platform import (
     AddConfigEntryEntitiesCallback,
     AddEntitiesCallback,
@@ -246,11 +245,6 @@ async def async_setup_entry(
         registry, config_entry.options[CONF_SOURCE_SENSOR]
     )
 
-    device_info = async_device_info_to_link_from_entity(
-        hass,
-        source_entity_id,
-    )
-
     if (unit_prefix := config_entry.options.get(CONF_UNIT_PREFIX)) == "none":
         # Before we had support for optional selectors, "none" was used for selecting nothing
         unit_prefix = None
@@ -265,6 +259,7 @@ async def async_setup_entry(
         round_digits = int(round_digits)
 
     integral = IntegrationSensor(
+        hass,
         integration_method=config_entry.options[CONF_METHOD],
         name=config_entry.title,
         round_digits=round_digits,
@@ -272,7 +267,6 @@ async def async_setup_entry(
         unique_id=config_entry.entry_id,
         unit_prefix=unit_prefix,
         unit_time=config_entry.options[CONF_UNIT_TIME],
-        device_info=device_info,
         max_sub_interval=max_sub_interval,
     )
 
@@ -287,6 +281,7 @@ async def async_setup_platform(
 ) -> None:
     """Set up the integration sensor."""
     integral = IntegrationSensor(
+        hass,
         integration_method=config[CONF_METHOD],
         name=config.get(CONF_NAME),
         round_digits=config.get(CONF_ROUND_DIGITS),
@@ -308,6 +303,7 @@ class IntegrationSensor(RestoreSensor):
 
     def __init__(
         self,
+        hass: HomeAssistant,
         *,
         integration_method: str,
         name: str | None,
@@ -317,7 +313,6 @@ class IntegrationSensor(RestoreSensor):
         unit_prefix: str | None,
         unit_time: UnitOfTime,
         max_sub_interval: timedelta | None,
-        device_info: DeviceInfo | None = None,
     ) -> None:
         """Initialize the integration sensor."""
         self._attr_unique_id = unique_id
@@ -335,7 +330,10 @@ class IntegrationSensor(RestoreSensor):
         self._attr_icon = "mdi:chart-histogram"
         self._source_entity: str = source_entity
         self._last_valid_state: Decimal | None = None
-        self._attr_device_info = device_info
+        self.device_entry = async_entity_id_to_device(
+            hass,
+            source_entity,
+        )
         self._max_sub_interval: timedelta | None = (
             None  # disable time based integration
             if max_sub_interval is None or max_sub_interval.total_seconds() == 0

tests/components/integration/test_init.py

@@ -7,8 +7,8 @@ import pytest
 from homeassistant.components import integration
 from homeassistant.components.integration.config_flow import ConfigFlowHandler
 from homeassistant.components.integration.const import DOMAIN
-from homeassistant.config_entries import ConfigEntry
-from homeassistant.core import Event, HomeAssistant
+from homeassistant.config_entries import ConfigEntry, ConfigEntryState
+from homeassistant.core import Event, HomeAssistant, callback
 from homeassistant.helpers import device_registry as dr, entity_registry as er
 from homeassistant.helpers.event import async_track_entity_registry_updated_event
 
@@ -83,6 +83,7 @@ def track_entity_registry_actions(hass: HomeAssistant, entity_id: str) -> list[s
     """Track entity registry actions for an entity."""
     events = []
 
+    @callback
     def add_event(event: Event[er.EventEntityRegistryUpdatedData]) -> None:
         """Add entity registry updated event to the list."""
         events.append(event.data["action"])
@@ -176,6 +177,7 @@ async def test_entry_changed(hass: HomeAssistant, platform) -> None:
     # Set up entities, with backing devices and config entries
     input_entry = _create_mock_entity("sensor", "input")
     valid_entry = _create_mock_entity("sensor", "valid")
+    assert input_entry.device_id != valid_entry.device_id
 
     # Setup the config entry
     config_entry = MockConfigEntry(
@@ -193,17 +195,21 @@ async def test_entry_changed(hass: HomeAssistant, platform) -> None:
     assert await hass.config_entries.async_setup(config_entry.entry_id)
     await hass.async_block_till_done()
 
-    assert config_entry.entry_id in _get_device_config_entries(input_entry)
+    assert config_entry.entry_id not in _get_device_config_entries(input_entry)
     assert config_entry.entry_id not in _get_device_config_entries(valid_entry)
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id == input_entry.device_id
 
     hass.config_entries.async_update_entry(
         config_entry, options={**config_entry.options, "source": "sensor.valid"}
     )
     await hass.async_block_till_done()
 
-    # Check that the config entry association has updated
+    # Check that the device association has updated
     assert config_entry.entry_id not in _get_device_config_entries(input_entry)
-    assert config_entry.entry_id in _get_device_config_entries(valid_entry)
+    assert config_entry.entry_id not in _get_device_config_entries(valid_entry)
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id == valid_entry.device_id
 
 
 async def test_device_cleaning(
@@ -276,7 +282,7 @@ async def test_device_cleaning(
     devices_before_reload = device_registry.devices.get_devices_for_config_entry_id(
         integration_config_entry.entry_id
     )
-    assert len(devices_before_reload) == 3
+    assert len(devices_before_reload) == 2
 
     # Config entry reload
     await hass.config_entries.async_reload(integration_config_entry.entry_id)
@@ -291,7 +297,7 @@ async def test_device_cleaning(
     devices_after_reload = device_registry.devices.get_devices_for_config_entry_id(
         integration_config_entry.entry_id
     )
-    assert len(devices_after_reload) == 1
+    assert len(devices_after_reload) == 0
 
 
 async def test_async_handle_source_entity_changes_source_entity_removed(
@@ -302,6 +308,54 @@ async def test_async_handle_source_entity_changes_source_entity_removed(
     sensor_config_entry: ConfigEntry,
     sensor_device: dr.DeviceEntry,
     sensor_entity_entry: er.RegistryEntry,
+) -> None:
+    """Test the integration config entry is removed when the source entity is removed."""
+    assert await hass.config_entries.async_setup(integration_config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id == sensor_entity_entry.device_id
+
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
+
+    events = track_entity_registry_actions(hass, integration_entity_entry.entity_id)
+
+    # Remove the source sensor's config entry from the device, this removes the
+    # source sensor
+    with patch(
+        "homeassistant.components.integration.async_unload_entry",
+        wraps=integration.async_unload_entry,
+    ) as mock_unload_entry:
+        device_registry.async_update_device(
+            sensor_device.id, remove_config_entry_id=sensor_config_entry.entry_id
+        )
+        await hass.async_block_till_done()
+        await hass.async_block_till_done()
+    mock_unload_entry.assert_not_called()
+
+    # Check that the entity is no longer linked to the source device
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id is None
+
+    # Check that the device is removed
+    assert not device_registry.async_get(sensor_device.id)
+
+    # Check that the integration config entry is not removed
+    assert integration_config_entry.entry_id in hass.config_entries.async_entry_ids()
+
+    # Check we got the expected events
+    assert events == ["update"]
+
+
+async def test_async_handle_source_entity_changes_source_entity_removed_shared_device(
+    hass: HomeAssistant,
+    device_registry: dr.DeviceRegistry,
+    entity_registry: er.EntityRegistry,
+    integration_config_entry: MockConfigEntry,
+    sensor_config_entry: ConfigEntry,
+    sensor_device: dr.DeviceEntry,
+    sensor_entity_entry: er.RegistryEntry,
 ) -> None:
     """Test the integration config entry is removed when the source entity is removed."""
     # Add another config entry to the sensor device
@@ -318,7 +372,7 @@ async def test_async_handle_source_entity_changes_source_entity_removed(
     assert integration_entity_entry.device_id == sensor_entity_entry.device_id
 
     sensor_device = device_registry.async_get(sensor_device.id)
-    assert integration_config_entry.entry_id in sensor_device.config_entries
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
 
     events = track_entity_registry_actions(hass, integration_entity_entry.entity_id)
 
@@ -335,7 +389,11 @@ async def test_async_handle_source_entity_changes_source_entity_removed(
         await hass.async_block_till_done()
     mock_unload_entry.assert_not_called()
 
-    # Check that the integration config entry is removed from the device
+    # Check that the entity is no longer linked to the source device
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id is None
+
+    # Check that the integration config entry is not in the device
     sensor_device = device_registry.async_get(sensor_device.id)
     assert integration_config_entry.entry_id not in sensor_device.config_entries
 
@@ -362,7 +420,7 @@ async def test_async_handle_source_entity_changes_source_entity_removed_from_dev
     assert integration_entity_entry.device_id == sensor_entity_entry.device_id
 
     sensor_device = device_registry.async_get(sensor_device.id)
-    assert integration_config_entry.entry_id in sensor_device.config_entries
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
 
     events = track_entity_registry_actions(hass, integration_entity_entry.entity_id)
 
@@ -377,7 +435,11 @@ async def test_async_handle_source_entity_changes_source_entity_removed_from_dev
         await hass.async_block_till_done()
     mock_unload_entry.assert_called_once()
 
-    # Check that the integration config entry is removed from the device
+    # Check that the entity is no longer linked to the source device
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id is None
+
+    # Check that the integration config entry is not in the device
     sensor_device = device_registry.async_get(sensor_device.id)
     assert integration_config_entry.entry_id not in sensor_device.config_entries
 
@@ -410,7 +472,7 @@ async def test_async_handle_source_entity_changes_source_entity_moved_other_devi
     assert integration_entity_entry.device_id == sensor_entity_entry.device_id
 
     sensor_device = device_registry.async_get(sensor_device.id)
-    assert integration_config_entry.entry_id in sensor_device.config_entries
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
     sensor_device_2 = device_registry.async_get(sensor_device_2.id)
     assert integration_config_entry.entry_id not in sensor_device_2.config_entries
 
@@ -427,11 +489,15 @@ async def test_async_handle_source_entity_changes_source_entity_moved_other_devi
         await hass.async_block_till_done()
     mock_unload_entry.assert_called_once()
 
-    # Check that the integration config entry is moved to the other device
+    # Check that the entity is linked to the other device
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id == sensor_device_2.id
+
+    # Check that the derivative config entry is not in any of the devices
     sensor_device = device_registry.async_get(sensor_device.id)
     assert integration_config_entry.entry_id not in sensor_device.config_entries
     sensor_device_2 = device_registry.async_get(sensor_device_2.id)
-    assert integration_config_entry.entry_id in sensor_device_2.config_entries
+    assert integration_config_entry.entry_id not in sensor_device_2.config_entries
 
     # Check that the integration config entry is not removed
     assert integration_config_entry.entry_id in hass.config_entries.async_entry_ids()
@@ -456,7 +522,7 @@ async def test_async_handle_source_entity_new_entity_id(
     assert integration_entity_entry.device_id == sensor_entity_entry.device_id
 
     sensor_device = device_registry.async_get(sensor_device.id)
-    assert integration_config_entry.entry_id in sensor_device.config_entries
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
 
     events = track_entity_registry_actions(hass, integration_entity_entry.entity_id)
 
@@ -474,12 +540,91 @@ async def test_async_handle_source_entity_new_entity_id(
     # Check that the integration config entry is updated with the new entity ID
     assert integration_config_entry.options["source"] == "sensor.new_entity_id"
 
-    # Check that the helper config is still in the device
+    # Check that the helper config is not in the device
     sensor_device = device_registry.async_get(sensor_device.id)
-    assert integration_config_entry.entry_id in sensor_device.config_entries
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
 
     # Check that the integration config entry is not removed
     assert integration_config_entry.entry_id in hass.config_entries.async_entry_ids()
 
     # Check we got the expected events
     assert events == []
+
+
+async def test_migration_1_1(
+    hass: HomeAssistant,
+    device_registry: dr.DeviceRegistry,
+    entity_registry: er.EntityRegistry,
+    sensor_entity_entry: er.RegistryEntry,
+    sensor_device: dr.DeviceEntry,
+) -> None:
+    """Test migration from v1.1 removes integration config entry from device."""
+
+    integration_config_entry = MockConfigEntry(
+        data={},
+        domain=DOMAIN,
+        options={
+            "method": "trapezoidal",
+            "name": "My integration",
+            "round": 1.0,
+            "source": sensor_entity_entry.entity_id,
+            "unit_prefix": "k",
+            "unit_time": "min",
+            "max_sub_interval": {"minutes": 1},
+        },
+        title="My integration",
+        version=1,
+        minor_version=1,
+    )
+    integration_config_entry.add_to_hass(hass)
+
+    # Add the helper config entry to the device
+    device_registry.async_update_device(
+        sensor_device.id, add_config_entry_id=integration_config_entry.entry_id
+    )
+
+    # Check preconditions
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert integration_config_entry.entry_id in sensor_device.config_entries
+
+    await hass.config_entries.async_setup(integration_config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert integration_config_entry.state is ConfigEntryState.LOADED
+
+    # Check that the helper config entry is removed from the device and the helper
+    # entity is linked to the source device
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert integration_config_entry.entry_id not in sensor_device.config_entries
+    integration_entity_entry = entity_registry.async_get("sensor.my_integration")
+    assert integration_entity_entry.device_id == sensor_entity_entry.device_id
+
+    assert integration_config_entry.version == 1
+    assert integration_config_entry.minor_version == 2
+
+
+async def test_migration_from_future_version(
+    hass: HomeAssistant,
+) -> None:
+    """Test migration from future version."""
+    config_entry = MockConfigEntry(
+        data={},
+        domain=DOMAIN,
+        options={
+            "method": "trapezoidal",
+            "name": "My integration",
+            "round": 1.0,
+            "source": "sensor.test",
+            "unit_prefix": "k",
+            "unit_time": "min",
+            "max_sub_interval": {"minutes": 1},
+        },
+        title="My integration",
+        version=2,
+        minor_version=1,
+    )
+    config_entry.add_to_hass(hass)
+    await hass.config_entries.async_setup(config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    assert config_entry.state is ConfigEntryState.MIGRATION_ERROR