feat(shared-worker): move heartbeat call into SharedWorker

Pass heartbeat request through `SharedWorker`` (if used) to optimize the number of requests for clients opened in few tabs and subscribed on same channels / groups list. refactor(heartbeat): remove redundant `heartbeat` from unsubscribe Don't send `heartbeat` request on unsubscribe.
pubnub · Jan 30, 2025 · 226a706 · 226a706
1 parent f5f9670
commit 226a706
Show file tree

Hide file tree

Showing 8 changed files with 600 additions and 47 deletions.
diff --git a/dist/web/pubnub.js b/dist/web/pubnub.js
@@ -3078,7 +3078,7 @@
 	    }
 	    makeSendable(req) {
 	        // Use default request flow for non-subscribe / presence leave requests.
-	        if (!req.path.startsWith('/v2/subscribe') && !req.path.endsWith('/leave'))
+	        if (!req.path.startsWith('/v2/subscribe') && !req.path.endsWith('/heartbeat') && !req.path.endsWith('/leave'))
 	            return this.configuration.transport.makeSendable(req);
 	        let controller;
 	        const sendRequestEvent = {
@@ -3188,6 +3188,7 @@
 	            clientIdentifier: this.configuration.clientIdentifier,
 	            subscriptionKey: this.configuration.subscriptionKey,
 	            userId: this.configuration.userId,
+	            heartbeatInterval: this.configuration.heartbeatInterval,
 	            logVerbosity: this.configuration.logVerbosity,
 	            workerLogVerbosity: this.configuration.workerLogVerbosity,
 	        }, true);
@@ -3212,7 +3213,7 @@
 	        else if (data.type === 'shared-worker-console-dir') {
 	            if (data.message)
 	                console.log(`[SharedWorker] ${data.message}`);
-	            console.dir(data.data);
+	            console.dir(data.data, { depth: 10 });
 	        }
 	        else if (data.type === 'shared-worker-ping') {
 	            const { logVerbosity, subscriptionKey, clientIdentifier } = this.configuration;
@@ -4708,9 +4709,16 @@
 	        this.stopHeartbeatTimer();
 	        this.reconnectionManager.stopPolling();
 	    }
-	    reconnect() {
+	    /**
+	     * Restart subscription loop with current state.
+	     *
+	     * @param forUnsubscribe - Whether restarting subscription loop as part of channels list change on
+	     * unsubscribe or not.
+	     */
+	    reconnect(forUnsubscribe = false) {
 	        this.startSubscribeLoop();
-	        this.startHeartbeatTimer();
+	        if (!forUnsubscribe)
+	            this.startHeartbeatTimer();
 	    }
 	    /**
 	     * Update channels and groups used in subscription loop.
@@ -4809,7 +4817,7 @@
 	            this.region = null;
 	            this.reconnectionManager.stopPolling();
 	        }
-	        this.reconnect();
+	        this.reconnect(true);
 	    }
 	    unsubscribeAll(isOffline) {
 	        this.unsubscribe({
@@ -14546,6 +14554,7 @@
 	                    userId: clientConfiguration.getUserId(),
 	                    workerUrl: configurationCopy.subscriptionWorkerUrl,
 	                    sdkVersion: clientConfiguration.getVersion(),
+	                    heartbeatInterval: clientConfiguration.getHeartbeatInterval(),
 	                    logVerbosity: clientConfiguration.logVerbosity,
 	                    workerLogVerbosity: platformConfiguration.subscriptionWorkerLogVerbosity,
 	                    transport,

diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/dist/web/pubnub.worker.js b/dist/web/pubnub.worker.js
diff --git a/dist/web/pubnub.worker.min.js b/dist/web/pubnub.worker.min.js
diff --git a/src/core/components/subscription-manager.ts b/src/core/components/subscription-manager.ts
@@ -190,9 +190,15 @@ export class SubscriptionManager {
     this.reconnectionManager.stopPolling();
   }
 
-  public reconnect() {
+  /**
+   * Restart subscription loop with current state.
+   *
+   * @param forUnsubscribe - Whether restarting subscription loop as part of channels list change on
+   * unsubscribe or not.
+   */
+  public reconnect(forUnsubscribe: boolean = false) {
     this.startSubscribeLoop();
-    this.startHeartbeatTimer();
+    if (!forUnsubscribe) this.startHeartbeatTimer();
   }
 
   /**
@@ -315,7 +321,7 @@ export class SubscriptionManager {
       this.reconnectionManager.stopPolling();
     }
 
-    this.reconnect();
+    this.reconnect(true);
   }
 
   public unsubscribeAll(isOffline?: boolean) {

diff --git a/src/transport/subscription-worker/subscription-worker-middleware.ts b/src/transport/subscription-worker/subscription-worker-middleware.ts
@@ -55,6 +55,13 @@ type PubNubMiddlewareConfiguration = {
    */
   workerLogVerbosity: boolean;
 
+  /**
+   * How often the client will announce itself to server. The value is in seconds.
+   *
+   * @default `not set`
+   */
+  heartbeatInterval?: number;
+
   /**
    * Platform-specific transport for requests processing.
    */
@@ -100,7 +107,7 @@ export class SubscriptionWorkerMiddleware implements Transport {
 
   makeSendable(req: TransportRequest): [Promise<TransportResponse>, CancellationController | undefined] {
     // Use default request flow for non-subscribe / presence leave requests.
-    if (!req.path.startsWith('/v2/subscribe') && !req.path.endsWith('/leave'))
+    if (!req.path.startsWith('/v2/subscribe') && !req.path.endsWith('/heartbeat') && !req.path.endsWith('/leave'))
       return this.configuration.transport.makeSendable(req);
 
     let controller: CancellationController | undefined;
@@ -225,6 +232,7 @@ export class SubscriptionWorkerMiddleware implements Transport {
         clientIdentifier: this.configuration.clientIdentifier,
         subscriptionKey: this.configuration.subscriptionKey,
         userId: this.configuration.userId,
+        heartbeatInterval: this.configuration.heartbeatInterval,
         logVerbosity: this.configuration.logVerbosity,
         workerLogVerbosity: this.configuration.workerLogVerbosity,
       },
@@ -254,7 +262,7 @@ export class SubscriptionWorkerMiddleware implements Transport {
       console.log(`[SharedWorker] ${data.message}`);
     } else if (data.type === 'shared-worker-console-dir') {
       if (data.message) console.log(`[SharedWorker] ${data.message}`);
-      console.dir(data.data);
+      console.dir(data.data, { depth: 10 });
     } else if (data.type === 'shared-worker-ping') {
       const { logVerbosity, subscriptionKey, clientIdentifier } = this.configuration;