fix: Clear old Home Assistant discovery topics when exposes are chang…

…ed (#20313)
Koenkk · Dec 20, 2023 · a5b959a · a5b959a
1 parent b67888f
commit a5b959a
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/lib/extension/homeassistant.ts b/lib/extension/homeassistant.ts
@@ -1333,6 +1333,7 @@ export default class HomeAssistant extends Extension {
             (entity.options.hasOwnProperty('homeassistant') && !entity.options.homeassistant))) {
             return;
         }
+        const lastDiscovered = this.discovered[discoverKey];
 
         this.discovered[discoverKey] = {topics: new Set(), mockProperties: new Set(), objectIDs: new Set()};
         this.getConfigs(entity).forEach((config) => {
@@ -1543,6 +1544,11 @@ export default class HomeAssistant extends Extension {
             config.mockProperties?.forEach((mockProperty) =>
                 this.discovered[discoverKey].mockProperties.add(mockProperty));
         });
+        lastDiscovered?.topics?.forEach((topic) => {
+            if (!this.discovered[discoverKey].topics.has(topic)) {
+                this.mqtt.publish(topic, null, {retain: true, qos: 1}, this.discoveryTopic, false, false);
+            }
+        });
     }
 
     @bind private onMQTTMessage(data: eventdata.MQTTMessage): void {

diff --git a/test/homeassistant.test.js b/test/homeassistant.test.js
@@ -2482,4 +2482,17 @@ describe('HomeAssistant extension', () => {
             expect.any(Function),
         );
     });
-});
+
+    it('Should remove discovery entries for removed exposes when device options change', async () => {
+        MQTT.publish.mockClear();
+        MQTT.events.message('zigbee2mqtt/bridge/request/device/options', stringify({"id": "0xf4ce368a38be56a1", "options": {"dimmer_1_enabled": "false", "dimmer_1_dimming_enabled": "false"}}));
+        await flushPromises();
+
+        expect(MQTT.publish).toHaveBeenCalledWith(
+            'homeassistant/light/0xf4ce368a38be56a1/light_l2/config',
+            null,
+            { retain: true, qos: 1 },
+            expect.any(Function),
+        );
+    });
+});