fix: Improve looping performance (#23541)

* Use herdsman improved looping.

* Fix lint.

* Fix tests.

* Feedback

test/controller.test.js

@@ -85,7 +85,7 @@ describe('Controller', () => {
         expect(zigbeeHerdsman.setTransmitPower).toHaveBeenCalledTimes(0);
         expect(zigbeeHerdsman.permitJoin).toHaveBeenCalledTimes(1);
         expect(zigbeeHerdsman.permitJoin).toHaveBeenCalledWith(true, undefined, undefined);
-        expect(logger.info).toHaveBeenCalledWith(`Currently ${Object.values(zigbeeHerdsman.devices).length - 1} devices are joined:`);
+        expect(logger.info).toHaveBeenCalledWith(`Currently ${Object.values(zigbeeHerdsman.devices).length - 1} devices are joined.`);
         expect(logger.info).toHaveBeenCalledWith(
             'bulb (0x000b57fffec6a5b2): LED1545G12 - IKEA TRADFRI bulb E26/E27, white spectrum, globe, opal, 980 lm (Router)',
         );

test/networkMap.test.js

@@ -66,62 +66,40 @@ describe('Networkmap', () => {
          *                    |  -> CC2530_ROUTER -> WXKG02LM_rev1
          *
          */
-        coordinator.lqi = () => {
-            return {
-                neighbors: [
-                    {ieeeAddr: bulb_color.ieeeAddr, networkAddress: bulb_color.networkAddress, relationship: 2, depth: 1, linkquality: 120},
-                    {ieeeAddr: bulb.ieeeAddr, networkAddress: bulb.networkAddress, relationship: 2, depth: 1, linkquality: 92},
-                    {
-                        ieeeAddr: external_converter_device.ieeeAddr,
-                        networkAddress: external_converter_device.networkAddress,
-                        relationship: 2,
-                        depth: 1,
-                        linkquality: 92,
-                    },
-                ],
-            };
-        };
-        coordinator.routingTable = () => {
-            return {table: [{destinationAddress: CC2530_ROUTER.networkAddress, status: 'ACTIVE', nextHop: bulb.networkAddress}]};
-        };
-
-        bulb.lqi = () => {
-            return {
-                neighbors: [
-                    {ieeeAddr: bulb_color.ieeeAddr, networkAddress: bulb_color.networkAddress, relationship: 1, depth: 2, linkquality: 110},
-                    {ieeeAddr: CC2530_ROUTER.ieeeAddr, networkAddress: CC2530_ROUTER.networkAddress, relationship: 1, depth: 2, linkquality: 100},
-                ],
-            };
-        };
-        bulb.routingTable = () => {
-            return {table: []};
-        };
-
-        bulb_color.lqi = () => {
-            return {neighbors: []};
-        };
-        bulb_color.routingTable = () => {
-            return {table: []};
-        };
-
-        CC2530_ROUTER.lqi = () => {
-            return {
-                neighbors: [
-                    {ieeeAddr: '0x0000000000000000', networkAddress: WXKG02LM_rev1.networkAddress, relationship: 1, depth: 2, linkquality: 130},
-                    {ieeeAddr: bulb_color.ieeeAddr, networkAddress: bulb_color.networkAddress, relationship: 4, depth: 2, linkquality: 130},
-                ],
-            };
-        };
-        CC2530_ROUTER.routingTable = () => {
-            return {table: []};
-        };
-
-        unsupported_router.lqi = () => {
-            throw new Error('failed');
-        };
-        unsupported_router.routingTable = () => {
-            throw new Error('failed');
-        };
+        coordinator.lqi = jest.fn().mockResolvedValue({
+            neighbors: [
+                {ieeeAddr: bulb_color.ieeeAddr, networkAddress: bulb_color.networkAddress, relationship: 2, depth: 1, linkquality: 120},
+                {ieeeAddr: bulb.ieeeAddr, networkAddress: bulb.networkAddress, relationship: 2, depth: 1, linkquality: 92},
+                {
+                    ieeeAddr: external_converter_device.ieeeAddr,
+                    networkAddress: external_converter_device.networkAddress,
+                    relationship: 2,
+                    depth: 1,
+                    linkquality: 92,
+                },
+            ],
+        });
+        coordinator.routingTable = jest.fn().mockResolvedValue({
+            table: [{destinationAddress: CC2530_ROUTER.networkAddress, status: 'ACTIVE', nextHop: bulb.networkAddress}],
+        });
+        bulb.lqi = jest.fn().mockResolvedValue({
+            neighbors: [
+                {ieeeAddr: bulb_color.ieeeAddr, networkAddress: bulb_color.networkAddress, relationship: 1, depth: 2, linkquality: 110},
+                {ieeeAddr: CC2530_ROUTER.ieeeAddr, networkAddress: CC2530_ROUTER.networkAddress, relationship: 1, depth: 2, linkquality: 100},
+            ],
+        });
+        bulb.routingTable = jest.fn().mockResolvedValue({table: []});
+        bulb_color.lqi = jest.fn().mockResolvedValue({neighbors: []});
+        bulb_color.routingTable = jest.fn().mockResolvedValue({table: []});
+        CC2530_ROUTER.lqi = jest.fn().mockResolvedValue({
+            neighbors: [
+                {ieeeAddr: '0x0000000000000000', networkAddress: WXKG02LM_rev1.networkAddress, relationship: 1, depth: 2, linkquality: 130},
+                {ieeeAddr: bulb_color.ieeeAddr, networkAddress: bulb_color.networkAddress, relationship: 4, depth: 2, linkquality: 130},
+            ],
+        });
+        CC2530_ROUTER.routingTable = jest.fn().mockResolvedValue({table: []});
+        unsupported_router.lqi = jest.fn().mockRejectedValue(new Error('failed'));
+        unsupported_router.routingTable = jest.fn().mockRejectedValue(new Error('failed'));
     }
 
     it('Output raw networkmap legacy api', async () => {
@@ -826,4 +804,160 @@ describe('Networkmap', () => {
         const actual = JSON.parse(call[1]);
         expect(actual).toStrictEqual(expected);
     });
+
+    it('Handles retrying request when first attempt fails', async () => {
+        settings.set(['devices', '0x000b57fffec6a5b2', 'disabled'], true);
+        mock();
+        bulb.lqi.mockRejectedValueOnce(new Error('failed'));
+        MQTT.publish.mockClear();
+        MQTT.events.message('zigbee2mqtt/bridge/request/networkmap', stringify({type: 'raw', routes: true}));
+        await flushPromises();
+        expect(MQTT.publish).toHaveBeenCalledTimes(1);
+        let call = MQTT.publish.mock.calls[0];
+        expect(call[0]).toStrictEqual('zigbee2mqtt/bridge/response/networkmap');
+
+        const expected = {
+            data: {
+                routes: true,
+                type: 'raw',
+                value: {
+                    links: [
+                        {
+                            depth: 1,
+                            linkquality: 120,
+                            lqi: 120,
+                            relationship: 2,
+                            routes: [],
+                            source: {ieeeAddr: '0x000b57fffec6a5b3', networkAddress: 40399},
+                            sourceIeeeAddr: '0x000b57fffec6a5b3',
+                            sourceNwkAddr: 40399,
+                            target: {ieeeAddr: '0x00124b00120144ae', networkAddress: 0},
+                            targetIeeeAddr: '0x00124b00120144ae',
+                        },
+                        {
+                            depth: 1,
+                            linkquality: 92,
+                            lqi: 92,
+                            relationship: 2,
+                            routes: [{destinationAddress: 6540, nextHop: 40369, status: 'ACTIVE'}],
+                            source: {ieeeAddr: '0x000b57fffec6a5b2', networkAddress: 40369},
+                            sourceIeeeAddr: '0x000b57fffec6a5b2',
+                            sourceNwkAddr: 40369,
+                            target: {ieeeAddr: '0x00124b00120144ae', networkAddress: 0},
+                            targetIeeeAddr: '0x00124b00120144ae',
+                        },
+                        {
+                            depth: 1,
+                            linkquality: 92,
+                            lqi: 92,
+                            relationship: 2,
+                            routes: [],
+                            source: {ieeeAddr: '0x0017880104e45511', networkAddress: 1114},
+                            sourceIeeeAddr: '0x0017880104e45511',
+                            sourceNwkAddr: 1114,
+                            target: {ieeeAddr: '0x00124b00120144ae', networkAddress: 0},
+                            targetIeeeAddr: '0x00124b00120144ae',
+                        },
+                        {
+                            depth: 2,
+                            linkquality: 130,
+                            lqi: 130,
+                            relationship: 1,
+                            routes: [],
+                            source: {ieeeAddr: '0x0017880104e45521', networkAddress: 6538},
+                            sourceIeeeAddr: '0x0017880104e45521',
+                            sourceNwkAddr: 6538,
+                            target: {ieeeAddr: '0x0017880104e45559', networkAddress: 6540},
+                            targetIeeeAddr: '0x0017880104e45559',
+                        },
+                    ],
+                    nodes: [
+                        {
+                            definition: null,
+                            failed: [],
+                            friendlyName: 'Coordinator',
+                            ieeeAddr: '0x00124b00120144ae',
+                            lastSeen: 1000,
+                            modelID: null,
+                            networkAddress: 0,
+                            type: 'Coordinator',
+                        },
+                        {
+                            definition: {
+                                description: 'Hue Go',
+                                model: '7146060PH',
+                                supports:
+                                    'light (state, brightness, color_temp, color_temp_startup, color_xy, color_hs), power_on_behavior, effect, linkquality',
+                                vendor: 'Philips',
+                            },
+                            failed: [],
+                            friendlyName: 'bulb_color',
+                            ieeeAddr: '0x000b57fffec6a5b3',
+                            lastSeen: 1000,
+                            modelID: 'LLC020',
+                            networkAddress: 40399,
+                            type: 'Router',
+                        },
+                        {
+                            definition: {
+                                description: 'Wireless remote switch (double rocker), 2016 model',
+                                model: 'WXKG02LM_rev1',
+                                supports: 'battery, voltage, power_outage_count, action, linkquality',
+                                vendor: 'Aqara',
+                            },
+                            friendlyName: 'button_double_key',
+                            ieeeAddr: '0x0017880104e45521',
+                            lastSeen: 1000,
+                            modelID: 'lumi.sensor_86sw2.es1',
+                            networkAddress: 6538,
+                            type: 'EndDevice',
+                        },
+                        {
+                            definition: {
+                                description: 'Automatically generated definition',
+                                model: 'notSupportedModelID',
+                                supports: 'action, linkquality',
+                                vendor: 'Boef',
+                            },
+                            failed: ['lqi', 'routingTable'],
+                            friendlyName: '0x0017880104e45525',
+                            ieeeAddr: '0x0017880104e45525',
+                            lastSeen: 1000,
+                            manufacturerName: 'Boef',
+                            modelID: 'notSupportedModelID',
+                            networkAddress: 6536,
+                            type: 'Router',
+                        },
+                        {
+                            definition: {
+                                description: 'CC2530 router',
+                                model: 'CC2530.ROUTER',
+                                supports: 'led, linkquality',
+                                vendor: 'Custom devices (DiY)',
+                            },
+                            failed: [],
+                            friendlyName: 'cc2530_router',
+                            ieeeAddr: '0x0017880104e45559',
+                            lastSeen: 1000,
+                            modelID: 'lumi.router',
+                            networkAddress: 6540,
+                            type: 'Router',
+                        },
+                        {
+                            definition: {description: 'external', model: 'external_converter_device', supports: 'linkquality', vendor: 'external'},
+                            friendlyName: '0x0017880104e45511',
+                            ieeeAddr: '0x0017880104e45511',
+                            lastSeen: 1000,
+                            modelID: 'external_converter_device',
+                            networkAddress: 1114,
+                            type: 'EndDevice',
+                        },
+                    ],
+                },
+            },
+            status: 'ok',
+        };
+        const actual = JSON.parse(call[1]);
+        expect(actual).toStrictEqual(expected);
+    });
 });

test/stub/zigbeeHerdsman.js

@@ -857,8 +857,14 @@ const mock = {
         events[type] = handler;
     },
     stop: jest.fn(),
-    getDevices: jest.fn().mockImplementation(() => {
-        return Object.values(devices).filter((d) => returnDevices.length === 0 || returnDevices.includes(d.ieeeAddr));
+    getDevicesIterator: jest.fn().mockImplementation(function* (predicate) {
+        for (const key in devices) {
+            const device = devices[key];
+
+            if ((returnDevices.length === 0 || returnDevices.includes(device.ieeeAddr)) && (!predicate || predicate(device))) {
+                yield device;
+            }
+        }
     }),
     getDevicesByType: jest.fn().mockImplementation((type) => {
         return Object.values(devices)
@@ -875,8 +881,14 @@ const mock = {
             .filter((d) => returnDevices.length === 0 || returnDevices.includes(d.ieeeAddr))
             .find((d) => d.networkAddress === networkAddress);
     }),
-    getGroups: jest.fn().mockImplementation((query) => {
-        return Object.values(groups);
+    getGroupsIterator: jest.fn().mockImplementation(function* (predicate) {
+        for (const key in groups) {
+            const group = groups[key];
+
+            if (!predicate || predicate(group)) {
+                yield group;
+            }
+        }
     }),
     getGroupByID: jest.fn().mockImplementation((groupID) => {
         return Object.values(groups).find((d) => d.groupID === groupID);

test/utils.test.js

@@ -4,6 +4,11 @@ const versionHerdsman = require('../node_modules/zigbee-herdsman/package.json').
 const versionHerdsmanConverters = require('../node_modules/zigbee-herdsman-converters/package.json').version;
 
 describe('Utils', () => {
+    it('Object is empty', () => {
+        expect(utils.objectIsEmpty({})).toBeTruthy();
+        expect(utils.objectIsEmpty({a: 1})).toBeFalsy();
+    });
+
     it('Object has properties', () => {
         expect(utils.objectHasProperties({a: 1, b: 2, c: 3}, ['a', 'b'])).toBeTruthy();
         expect(utils.objectHasProperties({a: 1, b: 2, c: 3}, ['a', 'b', 'd'])).toBeFalsy();