feat!: safari extension client status

src/helpers/client/safari-client.ts

@@ -65,6 +65,7 @@ export class SafariClient implements Client {
     this.listenResponseEvents();
     this.listenTransferActivityEvents();
     this.listenStatusEvents();
+    this.listenClientStatusEvents();
     this.listenPongEvents();
 
     if (keepAliveTimeout) {
@@ -205,6 +206,10 @@ export class SafariClient implements Client {
    */
   private listenResponseEvents() {
     document.addEventListener('AsperaDesktop.Response', (event: CustomEvent<JSONRPCResponse>) => {
+      if (!event.detail) {
+        return;
+      }
+
       this.handleResponse(event.detail);
     });
   }
@@ -214,6 +219,10 @@ export class SafariClient implements Client {
    */
   private listenTransferActivityEvents() {
     document.addEventListener('AsperaDesktop.TransferActivity', (event: any) => {
+      if (!event.detail) {
+        return;
+      }
+
       asperaSdk.activityTracking.handleTransferActivity(event.detail);
     });
   }
@@ -223,10 +232,27 @@ export class SafariClient implements Client {
    */
   private listenStatusEvents() {
     document.addEventListener('AsperaDesktop.Status', (event: any) => {
+      if (!event.detail) {
+        return;
+      }
+
       asperaSdk.activityTracking.handleWebSocketEvents(event.detail);
     });
   }
 
+  /**
+   * Listens for 'isAppAlive' events. This was introduced in version 1.0.9.
+   */
+  private listenClientStatusEvents() {
+    document.addEventListener('isAppAlive', (event: any) => {
+      if (!event.detail?.running) {
+        return;
+      }
+
+      asperaSdk.activityTracking.handleClientEvents(event.detail.running);
+    });
+  }
+
   /**
    * Listens for 'AsperaDesktop.Pong' events.
    */

src/models/aspera-sdk.model.ts

@@ -82,6 +82,8 @@ export class ActivityTracking {
 
   /** Keep track of the last WebSocket event **/
   private lastWebSocketEvent: WebsocketEvent = 'CLOSED';
+  /** Keep track of the last notified WebSocket event **/
+  private lastNotifiedWebSocketEvent: WebsocketEvent = undefined;
   /** Keep track of the last Safari extension event **/
   private lastSafariExtensionEvent: SafariExtensionEvent = 'DISABLED';
 
@@ -109,7 +111,7 @@ export class ActivityTracking {
   }
 
   /**
-   * Notify all consumers when a connection webSocketEvent occurs. For example, when the SDK
+   * Handle and notify if needed when a connection webSocketEvent occurs. For example, when the SDK
    * websocket connection to IBM Aspera App is closed or reconnected.
    *
    * @param webSocketEvent the event type.
@@ -119,13 +121,46 @@ export class ActivityTracking {
       return;
     }
 
+    this.lastWebSocketEvent = webSocketEvent;
+
+    this.notifyWebSocketEvent(webSocketEvent);
+  }
+
+  /**
+   * Notify all consumers when a connection webSocketEvent occurs.
+   *
+   * @param webSocketEvent the event type.
+   */
+  private notifyWebSocketEvent(webSocketEvent: WebsocketEvent): void {
+    if (this.lastNotifiedWebSocketEvent === webSocketEvent) {
+      return;
+    }
+
+    this.lastNotifiedWebSocketEvent = webSocketEvent;
+
     this.event_callbacks.forEach(callback => {
       if (typeof callback === 'function') {
         callback(webSocketEvent);
       }
     });
+  }
 
-    this.lastWebSocketEvent = webSocketEvent;
+  /**
+   * Notify all consumers when the client changes status. For example, when
+   * IBM Aspera App is launched or closed.
+   *
+   * @param running whether the client is running or not.
+   */
+  handleClientEvents(running: boolean): void {
+    let webSocketEvent: WebsocketEvent;
+
+    if (!running) {
+      webSocketEvent = 'CLOSED';
+    } else {
+      webSocketEvent = this.lastWebSocketEvent;
+    }
+
+    this.notifyWebSocketEvent(webSocketEvent);
   }
 
   /**