fix: Remove disappeared endpoints (#1227)

Author: Koenkk

src/controller/model/device.ts

@@ -1074,8 +1074,6 @@ class Device extends Entity<ControllerEventMap> {
 
         // Make sure that the endpoint are sorted.
         activeEndpoints.endpointList.sort((a, b) => a - b);
-
-        // TODO: this does not take care of removing endpoint (changing custom devices)?
         for (const endpoint of activeEndpoints.endpointList) {
             // Some devices, e.g. TERNCY return endpoint 0 in the active endpoints request.
             // This is not a valid endpoint number according to the ZCL, requesting a simple descriptor will result
@@ -1085,6 +1083,9 @@ class Device extends Entity<ControllerEventMap> {
                 this._endpoints.push(Endpoint.create(endpoint, undefined, undefined, [], [], this.networkAddress, this.ieeeAddr));
             }
         }
+
+        // Remove disappeared endpoints (can happen with e.g. custom devices).
+        this._endpoints = this._endpoints.filter((e) => activeEndpoints.endpointList.includes(e.ID));
     }
 
     /**

test/controller.test.ts

@@ -15,7 +15,7 @@ import * as Events from '../src/controller/events';
 import Request from '../src/controller/helpers/request';
 import zclTransactionSequenceNumber from '../src/controller/helpers/zclTransactionSequenceNumber';
 import ZclTransactionSequenceNumber from '../src/controller/helpers/zclTransactionSequenceNumber';
-import {Device, Group} from '../src/controller/model';
+import {Device, Endpoint, Group} from '../src/controller/model';
 import * as Models from '../src/models';
 import {Wait} from '../src/utils';
 import * as Utils from '../src/utils';
@@ -4037,6 +4037,18 @@ describe('Controller', () => {
         expect(mockAdapterSendZdo).toHaveBeenCalledTimes(8); // nodeDesc + activeEp + simpleDesc x1
     });
 
+    it('Should remove disappeared endpoints on updateActiveEndpoints', async () => {
+        await controller.start();
+        mockAdapterSendZdo.mockClear();
+        await mockAdapterEvents['deviceJoined']({networkAddress: 129, ieeeAddr: '0x129'});
+
+        const device = controller.getDeviceByIeeeAddr('0x129')!;
+        device.endpoints.push(Endpoint.create(2, undefined, undefined, [], [], device.networkAddress, device.ieeeAddr));
+        expect(device.endpoints.map((e) => e.ID)).toStrictEqual([1, 2]);
+        await device.updateActiveEndpoints();
+        expect(device.endpoints.map((e) => e.ID)).toStrictEqual([1]);
+    });
+
     it('Receive zclData report from unkown attribute', async () => {
         await controller.start();
         await mockAdapterEvents['deviceJoined']({networkAddress: 129, ieeeAddr: '0x129'});