feat: Support coordinator check (#18599)

* feat: Support coordinator check * add tests
Koenkk · Aug 14, 2023 · 3af130a · 3af130a
1 parent 145bc05
commit 3af130a
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 1 deletion.
diff --git a/lib/extension/bridge.ts b/lib/extension/bridge.ts
@@ -46,6 +46,7 @@ export default class Bridge extends Extension {
             'install_code/add': this.installCodeAdd,
             'touchlink/scan': this.touchlinkScan,
             'health_check': this.healthCheck,
+            'coordinator_check': this.coordinatorCheck,
             'options': this.bridgeOptions,
             // Below are deprecated
             'config/last_seen': this.configLastSeen,
@@ -181,6 +182,14 @@ export default class Bridge extends Extension {
         return utils.getResponse(message, {healthy: true}, null);
     }
 
+    @bind async coordinatorCheck(message: string | KeyValue): Promise<MQTTResponse> {
+        const result = await this.zigbee.coordinatorCheck();
+        const missingRouters = result.missingRouters.map((d) => {
+            return {ieee_address: d.ieeeAddr, friendly_name: d.name};
+        });
+        return utils.getResponse(message, {missing_routers: missingRouters}, null);
+    }
+
     @bind async groupAdd(message: string | KeyValue): Promise<MQTTResponse> {
         if (typeof message === 'object' && !message.hasOwnProperty('friendly_name')) {
             throw new Error(`Invalid payload`);

diff --git a/lib/zigbee.ts b/lib/zigbee.ts
@@ -195,6 +195,11 @@ export default class Zigbee {
         return this.herdsman.backup();
     }
 
+    async coordinatorCheck(): Promise<{missingRouters: Device[]}> {
+        const check = await this.herdsman.coordinatorCheck();
+        return {missingRouters: check.missingRouters.map((d) => this.resolveDevice(d.ieeeAddr))};
+    }
+
     async getNetworkParameters(): Promise<zh.NetworkParameters> {
         return this.herdsman.getNetworkParameters();
     }

diff --git a/test/bridge.test.js b/test/bridge.test.js
@@ -408,6 +408,18 @@ describe('Bridge', () => {
         );
     });
 
+    it('Should allow a coordinator check', async () => {
+        MQTT.publish.mockClear();
+        zigbeeHerdsman.coordinatorCheck.mockReturnValueOnce({missingRouters: [zigbeeHerdsman.getDeviceByIeeeAddr('0x000b57fffec6a5b2')]})
+        MQTT.events.message('zigbee2mqtt/bridge/request/coordinator_check', '');
+        await flushPromises();
+        expect(MQTT.publish).toHaveBeenCalledWith(
+            'zigbee2mqtt/bridge/response/coordinator_check',
+            stringify({"data":{"missing_routers":[{"friendly_name":"bulb","ieee_address":"0x000b57fffec6a5b2"}]},"status":"ok"}),
+            {retain: false, qos: 0}, expect.any(Function)
+        );
+    });
+
     it('Should allow to remove device by string', async () => {
         const device = zigbeeHerdsman.devices.bulb;
         settings.set(['groups'], {'1': {friendly_name: 'group_1', retain: false, devices: ['0x999b57fffec6a5b9/1', '0x000b57fffec6a5b2/1', 'bulb', 'bulb/right', 'other_bulb', 'bulb_1', '0x000b57fffec6a5b2', 'bulb/room/2']}});

diff --git a/test/frontend.test.js b/test/frontend.test.js
@@ -197,7 +197,7 @@ describe('Frontend', () => {
 
     });
 
-    it('onlythis Websocket interaction', async () => {
+    it('Websocket interaction', async () => {
         controller = new Controller(jest.fn(), jest.fn());
         await controller.start();
 

diff --git a/test/stub/zigbeeHerdsman.js b/test/stub/zigbeeHerdsman.js
@@ -214,6 +214,7 @@ const mock = {
     touchlinkIdentify: jest.fn(),
     start: jest.fn(),
     backup: jest.fn(),
+    coordinatorCheck: jest.fn(),
     isStopping: jest.fn(),
     permitJoin: jest.fn(),
     addInstallCode: jest.fn(),