Fix entity_id should be based on object_id the first time an entity is added (home-assistant#148484)

Author: jbouwh

homeassistant/components/mqtt/entity.py

@@ -389,16 +389,6 @@ def _async_setup_entities() -> None:
     _async_setup_entities()
 
 
-def init_entity_id_from_config(
-    hass: HomeAssistant, entity: Entity, config: ConfigType, entity_id_format: str
-) -> None:
-    """Set entity_id from object_id if defined in config."""
-    if CONF_OBJECT_ID in config:
-        entity.entity_id = async_generate_entity_id(
-            entity_id_format, config[CONF_OBJECT_ID], None, hass
-        )
-
-
 class MqttAttributesMixin(Entity):
     """Mixin used for platforms that support JSON attributes."""
 
@@ -1312,6 +1302,7 @@ class MqttEntity(
     _attr_should_poll = False
     _default_name: str | None
     _entity_id_format: str
+    _update_registry_entity_id: str | None = None
 
     def __init__(
         self,
@@ -1346,13 +1337,33 @@ def __init__(
 
     def _init_entity_id(self) -> None:
         """Set entity_id from object_id if defined in config."""
-        init_entity_id_from_config(
-            self.hass, self, self._config, self._entity_id_format
+        if CONF_OBJECT_ID not in self._config:
+            return
+        self.entity_id = async_generate_entity_id(
+            self._entity_id_format, self._config[CONF_OBJECT_ID], None, self.hass
         )
+        if self.unique_id is None:
+            return
+        # Check for previous deleted entities
+        entity_registry = er.async_get(self.hass)
+        entity_platform = self._entity_id_format.split(".")[0]
+        if (
+            deleted_entry := entity_registry.deleted_entities.get(
+                (entity_platform, DOMAIN, self.unique_id)
+            )
+        ) and deleted_entry.entity_id != self.entity_id:
+            #  Plan to update the entity_id basis on `object_id` if a deleted entity was found
+            self._update_registry_entity_id = self.entity_id
 
     @final
     async def async_added_to_hass(self) -> None:
         """Subscribe to MQTT events."""
+        if self._update_registry_entity_id is not None:
+            entity_registry = er.async_get(self.hass)
+            entity_registry.async_update_entity(
+                self.entity_id, new_entity_id=self._update_registry_entity_id
+            )
+
         await super().async_added_to_hass()
         self._subscriptions = {}
         self._prepare_subscribe_topics()

tests/components/mqtt/test_discovery.py

@@ -1496,6 +1496,52 @@ async def test_discovery_with_object_id(
     assert (domain, "object bla") in hass.data["mqtt"].discovery_already_discovered
 
 
+async def test_discovery_with_object_id_for_previous_deleted_entity(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+) -> None:
+    """Test discovering an MQTT entity with object_id and unique_id."""
+
+    topic = "homeassistant/sensor/object/bla/config"
+    config = (
+        '{ "name": "Hello World 11", "unique_id": "very_unique", '
+        '"obj_id": "hello_id", "state_topic": "test-topic" }'
+    )
+    new_config = (
+        '{ "name": "Hello World 11", "unique_id": "very_unique", '
+        '"obj_id": "updated_hello_id", "state_topic": "test-topic" }'
+    )
+    initial_entity_id = "sensor.hello_id"
+    new_entity_id = "sensor.updated_hello_id"
+    name = "Hello World 11"
+    domain = "sensor"
+
+    await mqtt_mock_entry()
+    async_fire_mqtt_message(hass, topic, config)
+    await hass.async_block_till_done()
+
+    state = hass.states.get(initial_entity_id)
+
+    assert state is not None
+    assert state.name == name
+    assert (domain, "object bla") in hass.data["mqtt"].discovery_already_discovered
+
+    # Delete the entity
+    async_fire_mqtt_message(hass, topic, "")
+    await hass.async_block_till_done()
+    assert (domain, "object bla") not in hass.data["mqtt"].discovery_already_discovered
+
+    # Rediscover with new object_id
+    async_fire_mqtt_message(hass, topic, new_config)
+    await hass.async_block_till_done()
+
+    state = hass.states.get(new_entity_id)
+
+    assert state is not None
+    assert state.name == name
+    assert (domain, "object bla") in hass.data["mqtt"].discovery_already_discovered
+
+
 async def test_discovery_incl_nodeid(
     hass: HomeAssistant, mqtt_mock_entry: MqttMockHAClientGenerator
 ) -> None: