fix: Source route table duplicating entries

Author: Nerivec

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "zigbee-on-host",
-    "version": "0.1.5",
+    "version": "0.1.6",
     "description": "ZigBee stack designed to run on a host and communicate with a radio co-processor (RCP)",
     "engines": {
         "node": ">=20.17.0"

package.json

@@ -51,6 +51,18 @@ async function printSave(dataPath: string): Promise<void> {
     console.log(devicesJson);
 
     await writeFile(join(dataPath, "zohsave-devices.json"), devicesJson, "utf8");
+
+    const routes = [];
+
+    for (const [addr16, entries] of driver.sourceRouteTable) {
+        routes.push({ addr16, entries });
+    }
+
+    const routesJson = JSON.stringify(routes, undefined, 2);
+
+    console.log(routesJson);
+
+    await writeFile(join(dataPath, "zohsave-routes.json"), routesJson, "utf8");
 }
 
 if (require.main === module) {

src/dev/zohsave-to-readable.ts

@@ -2079,7 +2079,7 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
 
             if (entries === undefined) {
                 this.sourceRouteTable.set(source16, [entry]);
-            } else {
+            } else if (!this.hasSourceRoute(source16, entry, entries)) {
                 entries.push(entry);
             }
         }
@@ -4252,6 +4252,42 @@ export class OTRCPDriver extends EventEmitter<AdapterDriverEventMap> {
         }
     }
 
+    /**
+     * Check if a source route entry for the given address is already present.
+     * If `existingEntries` not given and address16 doesn't have any entries, always returns false.
+     * @param address16 The network address to check for
+     * @param newEntry The entry to check
+     * @param existingEntries If given, skip the retrieval from `sourceRouteTable` and use these entries to check against instead
+     * @returns
+     */
+    public hasSourceRoute(address16: number, newEntry: SourceRouteTableEntry, existingEntries?: SourceRouteTableEntry[]): boolean {
+        if (!existingEntries) {
+            existingEntries = this.sourceRouteTable.get(address16);
+
+            if (!existingEntries) {
+                return false;
+            }
+        }
+
+        for (const existingEntry of existingEntries) {
+            if (newEntry.pathCost !== existingEntry.pathCost) {
+                return false;
+            }
+
+            if (newEntry.relayAddresses.length !== existingEntry.relayAddresses.length) {
+                return false;
+            }
+
+            for (const relay of newEntry.relayAddresses) {
+                if (!existingEntry.relayAddresses.includes(relay)) {
+                    return false;
+                }
+            }
+        }
+
+        return true;
+    }
+
     /**
      * Finds the best source route to the destination.
      * Bails early if source routing is disabled, or destination16 is broadcast.

src/drivers/ot-rcp-driver.ts

@@ -180,8 +180,6 @@ describe("OT RCP Driver", () => {
             driver.networkUp = true;
         });
 
-        afterEach(async () => {});
-
         it("handles loading with given network params - first start", async () => {
             const saveStateSpy = vi.spyOn(driver, "saveState");
 
@@ -457,11 +455,6 @@ describe("OT RCP Driver", () => {
             driver.networkUp = true;
         });
 
-        afterEach(() => {
-            driver.deviceTable.clear();
-            driver.address16ToAddress64.clear();
-        });
-
         it("ignores bogus data before start of HDLC frame", async () => {
             const parserEmit = vi.spyOn(driver.parser, "emit");
             const frame = makeSpinelLastStatus(1);
@@ -815,11 +808,6 @@ describe("OT RCP Driver", () => {
             driver.networkUp = true;
         });
 
-        afterEach(() => {
-            driver.deviceTable.clear();
-            driver.address16ToAddress64.clear();
-        });
-
         it("receives frame NET2_TRANSPORT_KEY_NWK_FROM_COORD - not for coordinator", async () => {
             // encrypted only APS
             const onStreamRawFrameSpy = vi.spyOn(driver, "onStreamRawFrame");
@@ -1039,11 +1027,6 @@ describe("OT RCP Driver", () => {
             driver.networkUp = true;
         });
 
-        afterEach(() => {
-            driver.deviceTable.clear();
-            driver.address16ToAddress64.clear();
-        });
-
         it("registers timers", async () => {
             // creates a bottleneck with vitest & promises, noop it
             vi.spyOn(driver, "savePeriodicState").mockImplementation(() => Promise.resolve());
@@ -1216,11 +1199,6 @@ describe("OT RCP Driver", () => {
             driver.networkUp = true;
         });
 
-        afterEach(() => {
-            driver.deviceTable.clear();
-            driver.address16ToAddress64.clear();
-        });
-
         it("handles source routing", async () => {
             // creates a bottleneck with vitest & promises, noop it
             vi.spyOn(driver, "savePeriodicState").mockImplementation(() => Promise.resolve());
@@ -1375,6 +1353,30 @@ describe("OT RCP Driver", () => {
             expect(findBestSourceRouteSpy).toHaveBeenLastCalledWith(0x4b8e, 5149013573816379n);
             expect(findBestSourceRouteSpy).toHaveLastReturnedWith([0, [0xcb47], 2]);
             expect(sendMACFrameSpy).toHaveBeenLastCalledWith(expect.any(Number), expect.any(Buffer), 0xcb47, undefined);
+
+            //-- no duplication of existing entries
+            driver.parser._transform(makeSpinelStreamRaw(6, NET4_ROUTE_RECORD_FROM_4B8E_RELAY_CB47), "utf8", () => {});
+            await vi.advanceTimersByTimeAsync(10);
+            // ROUTE_RECORD => OK
+            driver.parser._transform(makeSpinelLastStatus(6), "utf8", () => {});
+            await vi.advanceTimersByTimeAsync(10);
+
+            expect(driver.sourceRouteTable.get(0x4b8e)!.length).toStrictEqual(1);
+        });
+
+        it("checks if source route exists in entries for a given device", () => {
+            driver.sourceRouteTable.set(0x4b8e, [{ relayAddresses: [1, 2], pathCost: 3 }]);
+            const existingEntries = driver.sourceRouteTable.get(0x4b8e)!;
+
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [1, 2], pathCost: 3 }, existingEntries)).toStrictEqual(true);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [1, 2], pathCost: 2 }, existingEntries)).toStrictEqual(false);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [3], pathCost: 2 }, existingEntries)).toStrictEqual(false);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [4, 5], pathCost: 3 }, existingEntries)).toStrictEqual(false);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [1, 2], pathCost: 3 })).toStrictEqual(true);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [1, 2], pathCost: 2 })).toStrictEqual(false);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [3], pathCost: 2 })).toStrictEqual(false);
+            expect(driver.hasSourceRoute(0x4b8e, { relayAddresses: [4, 5], pathCost: 3 })).toStrictEqual(false);
+            expect(driver.hasSourceRoute(0x12345, { relayAddresses: [4, 5], pathCost: 3 })).toStrictEqual(false);
         });
     });
 
@@ -1416,11 +1418,6 @@ describe("OT RCP Driver", () => {
             driver.networkUp = true;
         });
 
-        afterEach(() => {
-            driver.deviceTable.clear();
-            driver.address16ToAddress64.clear();
-        });
-
         it("receives from NET5_GP_CHANNEL_REQUEST_BCAST while in commissioning mode", async () => {
             driver.gpEnterCommissioningMode(0xfe); // in commissioning mode
 

test/ot-rcp-driver.test.ts

@@ -919,7 +919,7 @@ describe("Zigbee", () => {
 
         expect(encFrame.subarray(0, -2)).toStrictEqual(NETDEF_ZGP_FRAME_BCAST_RECALL_SCENE_0.subarray(0, -2));
 
-        // TODO: Works against spec test vectors but not actual sniffed frame...
+        // XXX: don't have the GP security key for this one
         // const encNWKGPHeader = structuredClone(nwkGPHeader);
 
         // const encNWKFrame = encodeZigbeeNWKGPFrame(encNWKGPHeader, nwkGPPayload, NETDEF_NETWORK_KEY, macHeader.source64);