Fix rapid subscribe aggregate (#461)

* fix(shared-worker): fix rapid subscribe aggregate

Fix the issue because of which rapid subscription (from other PubNub clients in response to
received subscribe response) throttling causes delayed channel list change.

refactor(shared-worker): add output of requests processed by the `SharedWorker`

Modify the `log` payload for `SharedWorker` to make it possible to log sent / received requests
information to the main browser window (not to the SharedWorker console).

* feat(shared-worker): emit heartbeat processing status

Depending on client configuration, it will emit `status` for heartbeat, which has been started by the `SharedWorker` backup heartbeat timer mechanism.

feat(shared-worker): stop `backup` heartbeats on 403

Stop heartbeats until the auth key / access token is changed. On change, `SharedWorker` will send an immediate heartbeat request.

refactor(shared-worker): restart `backup` heartbeat on explicit heartbeat

Restart the timer of the backup heartbeat if an explicit heartbeat request has been received from the main PubNub client.

* fix(subscription-set): fix issue with global subscription set

Fix the issue with the global subscription set (used for legacy interface support) because of which
`unsubscribe` with the legacy interface wasn't able to complete the unsubscribe process.

* refactor(shared-worker): move some logs before request sending

To avoid confusion in the logs reading where the message about sending the request appears earlier
than it should, move the log output before sending the request.

* refactor(shared-worker): announce request sending logs to interested clients

Make sure that more clients will receive log messages about request sending (we're limited to a
single client for heartbeat requests).

refactor(shared-worker): change log message when heartbeat impossible for presence-only channels

Change the misleading console message for heartbeat requests, which are scheduled for
presence-only (`-pnpres`).

* test: subscription/presence behavior with shared-worker (#463)

* added karma configuration for sharedworker tests with headless browser,
added tests with edge cases for subscribe/unsubscribe with sharedworker

* fix: shared worker tests to adapt quick subscription aggregation handling compatible behaviour

* test: shared worker subscription aggregation and isolation in message distribution in scenario where messages arrive in one of the aggregated channel entities

* test(shared-worker): added test for token management, to test token change behaviour in share worker active subscription

* test(shared-worker): added message verification to confirm subscription change, added new test to verify resubscribing to same channel with message reecive check

* test(shared-worker): test cleanup, removed debug logs

* test(shared-worker) confirm auth token changes through middleware generated request url

* test: added test to inspect presence behaviour mimicking tab close activities

---------

Co-authored-by: Mohit Tejani <[email protected]>

* refactor(shared-worker): incorporate server threshold into heartbeat filter

Incorporate a 3-second threshold from the server to the logic that is used to skip heartbeat
requests if it has been sent too soon (because the previous one was not so long ago).

* fix(shared-worker): fix issue which prevented catchup

Fix the condition that, in some cases (burst subscribe from registered clients) incorrectly
identified when the initial subscribe REST API response should be patched with catch timetoken.

* refactor(shared-worker): re-adjust "backup" timer on early heartbeat

Re-adjust "backup" heartbeat timer when one of the clients request sent too early after previous
request.

* PubNub SDK v9.8.0 release.

---------

Co-authored-by: Mohit Tejani <[email protected]>
Co-authored-by: Mohit Tejani <[email protected]>
Co-authored-by: PubNub Release Bot <[email protected]>

Author: 4 people

.mocharc.json

@@ -4,7 +4,8 @@
   "spec": "test/**/*.test.ts",
   "exclude": [
     "test/dist/*.{js,ts}",
-    "test/feature/*.{js,ts}"
+    "test/feature/*.{js,ts}",
+    "test/integration/shared-worker/*.{js,ts}"
   ],
   "timeout": 5000,
   "reporter": "spec"

.prettierrc

@@ -1,5 +1,5 @@
 {
-  "parser" : "typescript",
+  "parser": "typescript",
   "semi": true,
   "printWidth": 120,
   "singleQuote": true,

.pubnub.yml

@@ -1,5 +1,20 @@
 ---
 changelog:
+  - date: 2025-07-11
+    version: v9.8.0
+    changes:
+      - type: feature
+        text: "Depending on client configuration, it will emit `status` for heartbeat, which has been started by the `SharedWorker` backup heartbeat timer mechanism."
+      - type: feature
+        text: "Stop heartbeats until the auth key / access token is changed. On change, `SharedWorker` will send an immediate heartbeat request."
+      - type: bug
+        text: "Fix the issue with the global subscription set (used for legacy interface support) because of which `unsubscribe` with the legacy interface wasn't able to complete the unsubscribe process."
+      - type: bug
+        text: "Fix the issue because of which rapid subscription (from other PubNub clients in response to received subscribe response) throttling causes delayed channel list change."
+      - type: improvement
+        text: "Restart the timer of the backup heartbeat if an explicit heartbeat request has been received from the main PubNub client."
+      - type: improvement
+        text: "Modify the `log` payload for `SharedWorker` to make it possible to log sent / received requests information to the main browser window (not to the `SharedWorker` console)."
   - date: 2025-06-30
     version: v9.7.0
     changes:
@@ -1276,7 +1291,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '9.7.0'
+version: '9.8.0'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1292,7 +1307,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.7.0.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.8.0.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1963,7 +1978,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v9.7.0/pubnub.9.7.0.js
+            location: https://github.com/pubnub/javascript/releases/download/v9.8.0/pubnub.9.8.0.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

CHANGELOG.md

@@ -1,3 +1,18 @@
+## v9.8.0
+July 11 2025
+
+#### Added
+- Depending on client configuration, it will emit `status` for heartbeat, which has been started by the `SharedWorker` backup heartbeat timer mechanism.
+- Stop heartbeats until the auth key / access token is changed. On change, `SharedWorker` will send an immediate heartbeat request.
+
+#### Fixed
+- Fix the issue with the global subscription set (used for legacy interface support) because of which `unsubscribe` with the legacy interface wasn't able to complete the unsubscribe process.
+- Fix the issue because of which rapid subscription (from other PubNub clients in response to received subscribe response) throttling causes delayed channel list change.
+
+#### Modified
+- Restart the timer of the backup heartbeat if an explicit heartbeat request has been received from the main PubNub client.
+- Modify the `log` payload for `SharedWorker` to make it possible to log sent / received requests information to the main browser window (not to the `SharedWorker` console).
+
 ## v9.7.0
 June 30 2025
 

README.md

@@ -27,8 +27,8 @@ Watch [Getting Started with PubNub JS SDK](https://app.dashcam.io/replay/64ee0d2
      npm install pubnub
      ```
    * or download one of our builds from our CDN: 
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.7.0.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.7.0.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.8.0.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.8.0.min.js
 
 2. Configure your keys: