fix: fix websocket keepalive timer cleanup

Ref: #77
Signed-off-by: Philip Gerke <me@philipgerke.com>

Author: pgerke

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://
 semver.org/spec/v2.0.0.html).
 
+## 1.6.1 - 17.05.2025
+
+### Fixed
+
+- [#77](https://github.com/pgerke/freeathome-local-api-client/issues/77):
+  Fixed an issue that caused multiple websocket keep alive timer to be configured simultaneously
+
 ## 1.6.0 - 16.05.2025
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "freeathome-local-api-client",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "preview": false,
   "description": "A client library for the BUSCH-JAEGER free@home local API implemented in TypeScript",
   "repository": {

src/system-access-point.ts

@@ -86,6 +86,9 @@ export class SystemAccessPoint extends EventEmitter {
     }
 
     this.webSocket = this.createWebSocket(certificateVerification);
+    // (Re-)create the web socket keepalive timer
+    this.webSocketKeepaliveSubscription?.unsubscribe();
+    this.webSocketKeepaliveSubscription = undefined;
     this.webSocketKeepaliveSubscription =
       this.webSocketKeepaliveTimer$.subscribe(() => {
         if (!(this.webSocket && this.webSocket.readyState === WebSocket.OPEN))
@@ -94,6 +97,7 @@ export class SystemAccessPoint extends EventEmitter {
         this.logger.log("keepalive timer expired, sending ping message...");
         this.webSocket.ping();
       });
+    this.webSocketKeepaliveTimerReset$.next();
   }
 
   /**
@@ -144,6 +148,9 @@ export class SystemAccessPoint extends EventEmitter {
     webSocket.on("ping", (data: Buffer) => {
       this.emit("websocket-ping", data);
       this.logger.debug("Ping received", data.toString("ascii"));
+      this.webSocketKeepaliveTimerReset$.next();
+      webSocket.pong(data);
+      this.logger.debug("Pong sent", data.toString("ascii"));
     });
     webSocket.on("pong", (data: Buffer) => {
       this.emit("websocket-pong", data);
@@ -164,6 +171,8 @@ export class SystemAccessPoint extends EventEmitter {
     webSocket.on("close", (code, reason) => {
       this.emit("websocket-close", code, reason);
       this.logger.log("Connection closed");
+      this.webSocketKeepaliveSubscription?.unsubscribe();
+      this.webSocketKeepaliveSubscription = undefined;
     });
     webSocket.on("message", (data: RawData, isBinary: boolean) => {
       this.emit("websocket-message", data, isBinary);
@@ -182,8 +191,6 @@ export class SystemAccessPoint extends EventEmitter {
       throw new Error("Web socket is not open");
     }
 
-    this.webSocketKeepaliveSubscription?.unsubscribe();
-    this.webSocketKeepaliveSubscription = undefined;
     if (force) {
       this.webSocket.terminate();
     } else {

test/system-access-point.spec.ts

@@ -173,6 +173,7 @@ describe("System Access Point", () => {
 
   it("should call web socket event handlers", () => {
     spyOn(WebSocket.prototype, "send");
+    spyOn(WebSocket.prototype, "pong");
     const sysAp = new SystemAccessPoint(
       "ap",
       "username",