fix: routing tweaks (#34)

Author: Nerivec

src/drivers/ot-rcp-driver.ts

@@ -2633,6 +2633,16 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
         const linkCount = options & ZigbeeNWKConsts.CMD_LINK_OPTION_COUNT_MASK;
         const links: ZigbeeNWKLinkStatus[] = [];
 
+        let device = nwkHeader.source64 !== undefined ? this.deviceTable.get(nwkHeader.source64) : undefined;
+
+        if (!device && nwkHeader.source16 !== undefined) {
+            const source64 = this.address16ToAddress64.get(nwkHeader.source16);
+
+            if (source64 !== undefined) {
+                device = this.deviceTable.get(source64);
+            }
+        }
+
         for (let i = 0; i < linkCount; i++) {
             const address = data.readUInt16LE(offset);
             offset += 2;
@@ -2644,6 +2654,25 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
                 incomingCost: costByte & ZigbeeNWKConsts.CMD_LINK_INCOMING_COST_MASK,
                 outgoingCost: (costByte & ZigbeeNWKConsts.CMD_LINK_OUTGOING_COST_MASK) >> 4,
             });
+
+            if (device) {
+                if (address === ZigbeeConsts.COORDINATOR_ADDRESS) {
+                    // if neighbor is coordinator, update device table
+                    device.neighbor = true;
+                }
+
+                const entry: SourceRouteTableEntry =
+                    address === ZigbeeConsts.COORDINATOR_ADDRESS
+                        ? { relayAddresses: [], pathCost: 1 /* TODO ? */ }
+                        : { relayAddresses: [address], pathCost: 2 /* TODO ? */ };
+                const entries = this.sourceRouteTable.get(device.address16);
+
+                if (entries === undefined) {
+                    this.sourceRouteTable.set(device.address16, [entry]);
+                } else if (!this.hasSourceRoute(device.address16, entry, entries)) {
+                    entries.push(entry);
+                }
+            }
         }
 
         logger.debug(() => {
@@ -4979,6 +5008,8 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
                 this.emit("deviceLeft", source16, source64);
             });
 
+            // force new MTORR
+            await this.sendPeriodicManyToOneRouteRequest();
             // force saving after device change
             await this.savePeriodicState();
         }
@@ -5066,9 +5097,9 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
 
             if (!this.deviceTable.get(destination64 ?? this.address16ToAddress64.get(destination16)!)!.neighbor) {
                 // force immediate MTORR
+                logger.warning("No known route to destination, forcing discovery", NS);
                 setImmediate(this.sendPeriodicManyToOneRouteRequest.bind(this));
-
-                throw new Error("No known route to destination", { cause: SpinelStatus.UNKNOWN_NEIGHBOR });
+                // will send direct as "last resort"
             }
 
             return [undefined, undefined, undefined];
@@ -5105,9 +5136,9 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
 
                             if (!this.deviceTable.get(destination64 ?? this.address16ToAddress64.get(destination16)!)!.neighbor) {
                                 // force immediate MTORR
+                                logger.warning("No known route to destination, forcing discovery", NS);
                                 setImmediate(this.sendPeriodicManyToOneRouteRequest.bind(this));
-
-                                throw new Error("No known route to destination", { cause: SpinelStatus.UNKNOWN_NEIGHBOR });
+                                // will send direct as "last resort"
                             }
 
                             // no more source route, bail

test/ot-rcp-driver.test.ts

@@ -1117,6 +1117,8 @@ describe("OT RCP Driver", () => {
         });
 
         it("disassociates", async () => {
+            // no-op, not relevant for this test
+            vi.spyOn(driver, "sendPeriodicManyToOneRouteRequest").mockImplementation(async () => {});
             driver.allowJoins(0xfe, true);
 
             // neighbor FFD
@@ -1687,6 +1689,8 @@ describe("OT RCP Driver", () => {
         });
 
         it("performs a join & authorize - ROUTER", async () => {
+            // no-op, not relevant for this test
+            vi.spyOn(driver, "sendPeriodicManyToOneRouteRequest").mockImplementation(async () => {});
             // Expected flow (APS acks requested from device are skipped for brevity):
             // - NET2_BEACON_REQ_FROM_DEVICE
             // - NET2_BEACON_RESP_FROM_COORD
@@ -2855,9 +2859,9 @@ describe("OT RCP Driver", () => {
 
             expect(driver.sourceRouteTable.get(0x4b8e)).toBeUndefined();
             await vi.advanceTimersByTimeAsync(11000); // past concentrator min time
-            expect(() => driver.findBestSourceRoute(0x4b8e, undefined)).toThrow("No known route to destination");
+            expect(driver.findBestSourceRoute(0x4b8e, undefined)).toStrictEqual([undefined, undefined, undefined]);
             await vi.advanceTimersByTimeAsync(10); // flush
-            expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(1);
+            expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(1 + 1 /* disassociate */);
             expect(sendZigbeeNWKRouteReqSpy).toHaveBeenCalledTimes(1);
 
             //-- too many NO_ACK
@@ -2871,18 +2875,31 @@ describe("OT RCP Driver", () => {
             await vi.advanceTimersByTimeAsync(5000); // not past concentrator min time
             expect(driver.findBestSourceRoute(0x6887, undefined)).toStrictEqual([2, [0x6, 0x7, 0x8], 4]);
             await vi.advanceTimersByTimeAsync(10); // flush
-            expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(2);
+            expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(2 + 1 /* disassociate */);
             expect(sendZigbeeNWKRouteReqSpy).toHaveBeenCalledTimes(1); // too soon
             expect(driver.sourceRouteTable.get(0x6887)).toStrictEqual([{ relayAddresses: [0x6, 0x7, 0x8], pathCost: 4 }]);
 
             //-- too many NO_ACK, no more route
             driver.macNoACKs.set(0x8, 4);
             await vi.advanceTimersByTimeAsync(6000); // past concentrator min time
-            expect(() => driver.findBestSourceRoute(0x6887, undefined)).toThrow("No known route to destination");
+            expect(driver.findBestSourceRoute(0x6887, undefined)).toStrictEqual([undefined, undefined, undefined]);
             await vi.advanceTimersByTimeAsync(10); // flush
-            expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(3);
+            expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(3 + 1 /* disassociate */);
             expect(sendZigbeeNWKRouteReqSpy).toHaveBeenCalledTimes(2);
             expect(driver.sourceRouteTable.get(0x6887)).toBeUndefined();
+
+            //--- received LINK_STATUS indicating direct link to coordinator available
+            expect(driver.deviceTable.get(driver.address16ToAddress64.get(0x6887)!)!.neighbor).toStrictEqual(false);
+            driver.processZigbeeNWKLinkStatus(
+                Buffer.from([97, 0x00, 0x00, 17]),
+                0,
+                // @ts-expect-error minimal mock
+                { source16: 0x6887, source64: 5149013643361676n },
+                { source16: 0x6887, source64: 5149013643361676n },
+            );
+            await vi.advanceTimersByTimeAsync(10); // flush
+            expect(driver.sourceRouteTable.get(0x6887)).toStrictEqual([{ relayAddresses: [], pathCost: 1 }]);
+            expect(driver.deviceTable.get(driver.address16ToAddress64.get(0x6887)!)!.neighbor).toStrictEqual(true);
         });
 
         it("checks if source route exists in entries for a given device", () => {
@@ -3013,8 +3030,8 @@ describe("OT RCP Driver", () => {
                 Buffer.from([2, dest16 & 0xff, (dest16 >> 8) & 0xff]),
                 0,
                 // @ts-expect-error minimal mock
-                { source16: 1, source64: 1n },
-                { source16: 1, source64: 1n },
+                { source16: 0x9ed5, source64: 5149013578478658n },
+                { source16: 0x9ed5, source64: 5149013578478658n },
             );
 
             expect(driver.routeFailures.get(0x91d2)).toStrictEqual(1);
@@ -3023,8 +3040,8 @@ describe("OT RCP Driver", () => {
                 Buffer.from([2, dest16 & 0xff, (dest16 >> 8) & 0xff]),
                 0,
                 // @ts-expect-error minimal mock
-                { source16: 1, source64: 1n },
-                { source16: 1, source64: 1n },
+                { source16: 0x9ed5, source64: 5149013578478658n },
+                { source16: 0x9ed5, source64: 5149013578478658n },
             );
 
             expect(driver.routeFailures.get(0x91d2)).toStrictEqual(2);
@@ -3033,13 +3050,13 @@ describe("OT RCP Driver", () => {
                 Buffer.from([2, dest16 & 0xff, (dest16 >> 8) & 0xff]),
                 0,
                 // @ts-expect-error minimal mock
-                { source16: 1, source64: 1n },
-                { source16: 1, source64: 1n },
+                { source16: 0x9ed5, source64: 5149013578478658n },
+                { source16: 0x9ed5, source64: 5149013578478658n },
             );
 
             expect(driver.routeFailures.get(0x91d2)).toStrictEqual(0);
             expect(driver.sourceRouteTable.get(0x9ed5)).toBeUndefined();
-            expect(() => driver.findBestSourceRoute(0x9ed5, undefined)).toThrow("No known route to destination");
+            expect(driver.findBestSourceRoute(0x9ed5, undefined)).toStrictEqual([undefined, undefined, undefined]);
             await vi.advanceTimersByTimeAsync(10); // flush
             expect(sendPeriodicManyToOneRouteRequestSpy).toHaveBeenCalledTimes(1);
             expect(sendZigbeeNWKRouteReqSpy).toHaveBeenCalledTimes(1);
@@ -3162,6 +3179,7 @@ describe("OT RCP Driver", () => {
             );
 
             //-- mock LEAVE
+            vi.spyOn(driver, "sendPeriodicManyToOneRouteRequest").mockImplementationOnce(async () => {}); // no-op for disassociate
             await driver.disassociate(0x91d2, 8118874123826907736n);
 
             expect(driver.sourceRouteTable.size).toStrictEqual(5);
@@ -3427,6 +3445,7 @@ describe("OT RCP Driver", () => {
 
             expect(lqiTable).toStrictEqual(expectedLQITable.subarray(0, 5 + 3 * 22));
 
+            vi.spyOn(driver, "sendPeriodicManyToOneRouteRequest").mockImplementationOnce(async () => {}); // no-op for disassociate
             await driver.disassociate(0xcb47, 5149013569626593n);
             expect(driver.deviceTable.size).toStrictEqual(5);