From 6b265120b3f12185dc04b3fcc2ebe963836dd10d Mon Sep 17 00:00:00 2001
From: Jan Bouwhuis <jbouwh@users.noreply.github.com>
Date: Tue, 12 Sep 2023 15:22:37 +0200
Subject: [PATCH] Fix entity name attribute on mqtt entity is not removed on
 update (#100187)

Fix entity name attribute is not remove on update
---
 homeassistant/components/mqtt/mixins.py |  5 +++
 tests/components/mqtt/test_mixins.py    | 60 ++++++++++++++++++++++++-
 2 files changed, 64 insertions(+), 1 deletion(-)

diff --git a/homeassistant/components/mqtt/mixins.py b/homeassistant/components/mqtt/mixins.py
index ceccfa5adc8..795eb30e8e2 100644
--- a/homeassistant/components/mqtt/mixins.py
+++ b/homeassistant/components/mqtt/mixins.py
@@ -1137,6 +1137,11 @@ class MqttEntity(
         elif not self._default_to_device_class_name():
             # Assign the default name
             self._attr_name = self._default_name
+        elif hasattr(self, "_attr_name"):
+            # An entity name was not set in the config
+            # don't set the name attribute and derive
+            # the name from the device_class
+            delattr(self, "_attr_name")
         if CONF_DEVICE in config:
             device_name: str
             if CONF_NAME not in config[CONF_DEVICE]:
diff --git a/tests/components/mqtt/test_mixins.py b/tests/components/mqtt/test_mixins.py
index 0647721b4d0..1ca9bf07d72 100644
--- a/tests/components/mqtt/test_mixins.py
+++ b/tests/components/mqtt/test_mixins.py
@@ -7,6 +7,7 @@ import pytest
 from homeassistant.components import mqtt, sensor
 from homeassistant.components.mqtt.sensor import DEFAULT_NAME as DEFAULT_SENSOR_NAME
 from homeassistant.const import (
+    ATTR_FRIENDLY_NAME,
     EVENT_HOMEASSISTANT_STARTED,
     EVENT_STATE_CHANGED,
     Platform,
@@ -324,7 +325,6 @@ async def test_default_entity_and_device_name(
 
     This is a test helper for the _setup_common_attributes_from_config mixin.
     """
-    # mqtt_mock = await mqtt_mock_entry()
 
     events = async_capture_events(hass, ir.EVENT_REPAIRS_ISSUE_REGISTRY_UPDATED)
     hass.state = CoreState.starting
@@ -352,3 +352,61 @@ async def test_default_entity_and_device_name(
 
     # Assert that an issues ware registered
     assert len(events) == issue_events
+
+
+@patch("homeassistant.components.mqtt.PLATFORMS", [Platform.BINARY_SENSOR])
+async def test_name_attribute_is_set_or_not(
+    hass: HomeAssistant,
+    mqtt_mock_entry: MqttMockHAClientGenerator,
+) -> None:
+    """Test frendly name with device_class set.
+
+    This is a test helper for the _setup_common_attributes_from_config mixin.
+    """
+    await mqtt_mock_entry()
+    async_fire_mqtt_message(
+        hass,
+        "homeassistant/binary_sensor/bla/config",
+        '{ "name": "Gate", "state_topic": "test-topic", "device_class": "door", '
+        '"object_id": "gate",'
+        '"device": {"identifiers": "very_unique", "name": "xyz_door_sensor"}'
+        "}",
+    )
+    await hass.async_block_till_done()
+
+    state = hass.states.get("binary_sensor.gate")
+
+    assert state is not None
+    assert state.attributes.get(ATTR_FRIENDLY_NAME) == "Gate"
+
+    # Remove the name in a discovery update
+    async_fire_mqtt_message(
+        hass,
+        "homeassistant/binary_sensor/bla/config",
+        '{ "state_topic": "test-topic", "device_class": "door", '
+        '"object_id": "gate",'
+        '"device": {"identifiers": "very_unique", "name": "xyz_door_sensor"}'
+        "}",
+    )
+    await hass.async_block_till_done()
+
+    state = hass.states.get("binary_sensor.gate")
+
+    assert state is not None
+    assert state.attributes.get(ATTR_FRIENDLY_NAME) == "Door"
+
+    # Set the name to `null` in a discovery update
+    async_fire_mqtt_message(
+        hass,
+        "homeassistant/binary_sensor/bla/config",
+        '{ "name": null, "state_topic": "test-topic", "device_class": "door", '
+        '"object_id": "gate",'
+        '"device": {"identifiers": "very_unique", "name": "xyz_door_sensor"}'
+        "}",
+    )
+    await hass.async_block_till_done()
+
+    state = hass.states.get("binary_sensor.gate")
+
+    assert state is not None
+    assert state.attributes.get(ATTR_FRIENDLY_NAME) is None