Added force closing of exchanges on shutdown of the node (#1660)

* Added force closing of exchanges on shutdown of the node * Fix typo --------- Co-authored-by: lauckhart <[email protected]>
project-chip · Jan 25, 2025 · 51ff4db · 51ff4db
1 parent cef7ec3
commit 51ff4db
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,9 @@ The main work (all changes without a GitHub username in brackets in the below li
 - @project-chip/matter.js
     - Fix: Allows more cases when checking if a device is battery powered to address real world devices
 
+-   @matter/protocol
+    - Fix: Added force closing of exchanges on shutdown of the node
+
 ## 0.12.0 (2025-01-23)
 
 -   @matter/general

diff --git a/packages/protocol/src/protocol/ExchangeManager.ts b/packages/protocol/src/protocol/ExchangeManager.ts
@@ -185,9 +185,10 @@ export class ExchangeManager {
         await MatterAggregateError.allSettled(this.#closers, "Error closing exchanges").catch(error =>
             logger.error(error),
         );
-        await MatterAggregateError.allSettled(this.#exchanges.values(), "Error closing exchanges").catch(error =>
-            logger.error(error),
-        );
+        await MatterAggregateError.allSettled(
+            Array.from(this.#exchanges.values()).map(exchange => exchange.close(true)),
+            "Error closing exchanges",
+        ).catch(error => logger.error(error));
         this.#exchanges.clear();
     }
 

diff --git a/packages/protocol/src/protocol/MessageExchange.ts b/packages/protocol/src/protocol/MessageExchange.ts
@@ -646,8 +646,16 @@ export class MessageExchange {
         return this.#timedInteractionTimer !== undefined && !this.#timedInteractionTimer.isRunning;
     }
 
-    async close() {
-        if (this.#closeTimer !== undefined) return; // close was already called
+    async close(force = false) {
+        if (this.#closeTimer !== undefined) {
+            if (force) {
+                // Force close does not wait any longer
+                this.#closeTimer.stop();
+                return this.#close();
+            }
+            // close was already called, so let retries happen because close not forced
+            return;
+        }
         this.#isClosing = true;
 
         if (this.#receivedMessageToAck !== undefined) {
@@ -659,7 +667,11 @@ export class MessageExchange {
             } catch (error) {
                 logger.error("An error happened when closing the exchange", error);
             }
-        } else if (this.#sentMessageToAck === undefined) {
+            if (force) {
+                // We have sent the Ack, so close here, no retries because close is forced
+                return this.#close();
+            }
+        } else if (this.#sentMessageToAck === undefined || force) {
             // No message left that we need to ack and no sent message left that waits for an ack, close directly
             return this.#close();
         }