Merge pull request #972 from project-chip/subfix

Cherry pick Subscription clearing fix
project-chip · Jun 26, 2024 · 2d9f216 · 2d9f216
2 parents 04c34b0 + 1067826
commit 2d9f216
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,10 @@ The main work (all changes without a GitHub username in brackets in the below li
 	### __WORK IN PROGRESS__
 -->
 
+### __WORK IN PROGRESS__
+* Matter-Core functionality:
+  * Fix: Makes sure to clear all subscriptions from the subscriber noe and not only the current session when not keeping subscriptions
+
 ### 0.9.2 (2024-06-20)
 * Matter-Core functionality:
   * Enhancement: Added some more certification relevant checks in Interaction server

diff --git a/packages/matter.js/src/MatterDevice.ts b/packages/matter.js/src/MatterDevice.ts
@@ -504,6 +504,10 @@ export class MatterDevice {
         return { session, channel: await networkInterface.openChannel(device.addresses[0]) };
     }
 
+    async clearSubscriptionsForNode(peerNodeId: NodeId, flushSubscriptions?: boolean) {
+        await this.#sessionManager.clearSubscriptionsForNode(peerNodeId, flushSubscriptions);
+    }
+
     async close() {
         this.#isClosing = true;
         await this.endCommissioning();

diff --git a/packages/matter.js/src/protocol/interaction/InteractionServer.ts b/packages/matter.js/src/protocol/interaction/InteractionServer.ts
@@ -1061,8 +1061,10 @@ export class InteractionServer implements ProtocolHandler<MatterDevice>, Interac
         }
 
         if (!keepSubscriptions) {
-            logger.debug(`Clear subscriptions for Session ${session.name} because keepSubscriptions=false`);
-            await session.clearSubscriptions(true);
+            logger.debug(
+                `Clear subscriptions for Subscriber node ${session.peerNodeId} because keepSubscriptions=false`,
+            );
+            await session.context.clearSubscriptionsForNode(session.peerNodeId, true);
         }
 
         const maxInterval = subscriptionHandler.getMaxInterval();

diff --git a/packages/matter.js/src/session/SecureSession.ts b/packages/matter.js/src/session/SecureSession.ts
@@ -290,7 +290,8 @@ export class SecureSession<T> extends Session<T> {
     }
 
     async clearSubscriptions(flushSubscriptions = false) {
-        for (const subscription of this.#subscriptions) {
+        const subscriptions = [...this.#subscriptions]; // get all values because subscriptions will remove themselves when cancelled
+        for (const subscription of subscriptions) {
             await subscription.cancel(flushSubscriptions);
         }
         this.#subscriptions.length = 0;

diff --git a/packages/matter.js/src/session/SessionManager.ts b/packages/matter.js/src/session/SessionManager.ts
@@ -343,6 +343,14 @@ export class SessionManager<ContextT> {
             }));
     }
 
+    async clearSubscriptionsForNode(nodeId: NodeId, flushSubscriptions?: boolean) {
+        for (const session of this.#sessions) {
+            if (session.peerNodeId === nodeId) {
+                await session.clearSubscriptions(flushSubscriptions);
+            }
+        }
+    }
+
     async close() {
         await this.storeResumptionRecords();
         for (const session of this.#sessions) {