Fix entity usage issue (#460)

fix(subscription-flow): fix `heartbeat` cancellation failure

Fix issue because of which in new flow `heartbeat` request not cancelled properly when issued in
burst.

fix(cbor): fix issue with resource name as integer

Fix issue because resource names, which consist only of integers, have been decoded as Unicode
characters.

fix(subscription): fix issue with unsubscription on entity with a similar name

Fix issue because the entity that has been created with `-pnpres` suffix has been removed
from subscription loop during unsubscribe from entity with presence listening capability.

feat(shared-worker): start backup heartbeat timer

Launch a backup heartbeat timer per registered PubNub instance in SharedWorker context to protect
against browsers throttling of background (hidden) tabs.

refactor(logger): use explicit names of classes instead of constructor

Use string names of classes for locations instead of dynamic access to constructor names because it
affect how logs looks like after minification.

Author: parfeon

.pubnub.yml

@@ -1,5 +1,18 @@
 ---
 changelog:
+  - date: 2025-06-30
+    version: v9.7.0
+    changes:
+      - type: feature
+        text: "Launch a backup heartbeat timer per registered PubNub instance in SharedWorker context to protect  against browsers throttling of background (hidden) tabs."
+      - type: bug
+        text: "Fix issue because of which in new flow `heartbeat` request not cancelled properly when issued in  burst."
+      - type: bug
+        text: "Fix issue because resource names, which consist only of integers, have been decoded as Unicode characters."
+      - type: bug
+        text: "Fix issue because the entity that has been created with `-pnpres` suffix has been removed  from subscription loop during unsubscribe from entity with presence listening capability."
+      - type: improvement
+        text: "Use string names of classes for locations instead of dynamic access to constructor names because it affect how logs looks like after minification."
   - date: 2025-06-30
     version: v9.6.2
     changes:
@@ -1263,7 +1276,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '9.6.2'
+version: '9.7.0'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1279,7 +1292,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.6.2.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.7.0.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1950,7 +1963,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v9.6.2/pubnub.9.6.2.js
+            location: https://github.com/pubnub/javascript/releases/download/v9.7.0/pubnub.9.7.0.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

CHANGELOG.md

@@ -1,3 +1,17 @@
+## v9.7.0
+June 30 2025
+
+#### Added
+- Launch a backup heartbeat timer per registered PubNub instance in SharedWorker context to protect  against browsers throttling of background (hidden) tabs.
+
+#### Fixed
+- Fix issue because of which in new flow `heartbeat` request not cancelled properly when issued in  burst.
+- Fix issue because resource names, which consist only of integers, have been decoded as Unicode characters.
+- Fix issue because the entity that has been created with `-pnpres` suffix has been removed  from subscription loop during unsubscribe from entity with presence listening capability.
+
+#### Modified
+- Use string names of classes for locations instead of dynamic access to constructor names because it affect how logs looks like after minification.
+
 ## v9.6.2
 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.6.2.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.6.2.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.7.0.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.7.0.min.js
 
 2. Configure your keys:
 

dist/web/pubnub.js

@@ -465,6 +465,11 @@
                 if (hbRequestsBySubscriptionKey[heartbeatRequestKey] &&
                     hbRequestsBySubscriptionKey[heartbeatRequestKey].clientIdentifier === client.clientIdentifier)
                     delete hbRequestsBySubscriptionKey[heartbeatRequestKey].clientIdentifier;
+                if (heartbeat.timer) {
+                    clearInterval(heartbeat.timer);
+                    delete heartbeat.heartbeatEvent;
+                    delete heartbeat.timer;
+                }
             }
         }
         if (!request) {
@@ -1242,20 +1247,23 @@
      * Use information from request to populate list of channels and other useful information.
      *
      * @param event - Send request.
+     * @returns `true` if channels / groups list has been changed. May return `undefined` because `client` is missing.
      */
     const updateClientSubscribeStateIfRequired = (event) => {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         var _m, _o, _p, _q, _r, _s, _t, _u, _v;
         const query = event.request.queryParameters;
         const { clientIdentifier } = event;
         const client = pubNubClients[clientIdentifier];
+        let changed = false;
         // This should never happen.
         if (!client)
             return;
         const channelGroupQuery = ((_a = query['channel-group']) !== null && _a !== void 0 ? _a : '');
         const state = ((_b = query.state) !== null && _b !== void 0 ? _b : '');
         let subscription = client.subscription;
         if (!subscription) {
+            changed = true;
             subscription = {
                 path: '',
                 channelGroupQuery: '',
@@ -1294,11 +1302,17 @@
         }
         if (subscription.path !== event.request.path) {
             subscription.path = event.request.path;
-            subscription.channels = channelsFromRequest(event.request);
+            const _channelsFromRequest = channelsFromRequest(event.request);
+            if (!changed)
+                changed = includesStrings(subscription.channels, _channelsFromRequest);
+            subscription.channels = _channelsFromRequest;
         }
         if (subscription.channelGroupQuery !== channelGroupQuery) {
             subscription.channelGroupQuery = channelGroupQuery;
-            subscription.channelGroups = channelGroupsFromRequest(event.request);
+            const _channelGroupsFromRequest = channelGroupsFromRequest(event.request);
+            if (!changed)
+                changed = includesStrings(subscription.channelGroups, _channelGroupsFromRequest);
+            subscription.channelGroups = _channelGroupsFromRequest;
         }
         let { authKey } = client;
         const { userId } = client;
@@ -1326,7 +1340,8 @@
      */
     const updateClientHeartbeatState = (event) => {
         var _a, _b;
-        const client = pubNubClients[event.clientIdentifier];
+        const { clientIdentifier } = event;
+        const client = pubNubClients[clientIdentifier];
         const { request } = event;
         // This should never happen.
         if (!client)
@@ -1335,6 +1350,16 @@
             channels: [],
             channelGroups: [],
         }));
+        _clientHeartbeat.heartbeatEvent = Object.assign({}, event);
+        if (!_clientHeartbeat.timer) {
+            _clientHeartbeat.timer = setInterval(() => {
+                const client = pubNubClients[clientIdentifier];
+                // This should never happen.
+                if (!client || !client.heartbeat || !client.heartbeat.heartbeatEvent)
+                    return;
+                handleHeartbeatRequestEvent(client.heartbeat.heartbeatEvent);
+            }, client.heartbeatInterval * 1000);
+        }
         // Update presence heartbeat information about client.
         _clientHeartbeat.channelGroups = channelGroupsFromRequest(request).filter((group) => !group.endsWith('-pnpres'));
         _clientHeartbeat.channels = channelsFromRequest(request).filter((channel) => !channel.endsWith('-pnpres'));
@@ -1396,6 +1421,9 @@
                 if (serviceRequestId)
                     cancelRequest(serviceRequestId);
             }
+            // Make sure to stop heartbeat timer.
+            if (invalidatedClient.heartbeat && invalidatedClient.heartbeat.timer)
+                clearInterval(invalidatedClient.heartbeat.timer);
             if (serviceHeartbeatRequests[subscriptionKey]) {
                 const hbRequestsBySubscriptionKey = ((_a = serviceHeartbeatRequests[subscriptionKey]) !== null && _a !== void 0 ? _a : (serviceHeartbeatRequests[subscriptionKey] = {}));
                 const heartbeatRequestKey = `${invalidatedClient.userId}_${(_b = clientAggregateAuthKey(invalidatedClient)) !== null && _b !== void 0 ? _b : ''}`;

dist/web/pubnub.min.js

@@ -9,11 +9,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeConfiguration = void 0;
+const console_logger_1 = require("../../loggers/console-logger");
 const retry_policy_1 = require("./retry-policy");
-const uuid_1 = __importDefault(require("./uuid"));
 const logger_1 = require("../interfaces/logger");
 const logger_manager_1 = require("./logger-manager");
-const console_logger_1 = require("../../loggers/console-logger");
+const uuid_1 = __importDefault(require("./uuid"));
 // --------------------------------------------------------
 // ----------------------- Defaults -----------------------
 // --------------------------------------------------------
@@ -164,7 +164,7 @@ const makeConfiguration = (base, setupCryptoModule) => {
             return base.PubNubFile;
         },
         get version() {
-            return '9.6.2';
+            return '9.7.0';
         },
         getVersion() {
             return this.version;

dist/web/pubnub.worker.js

@@ -123,7 +123,7 @@ class default_1 {
     encrypt(data, customCipherKey, options) {
         if (this.configuration.customEncrypt) {
             if (this.logger)
-                this.logger.warn(this.constructor.name, "'customEncrypt' is deprecated. Consult docs for better alternative.");
+                this.logger.warn('Crypto', "'customEncrypt' is deprecated. Consult docs for better alternative.");
             return this.configuration.customEncrypt(data);
         }
         return this.pnEncrypt(data, customCipherKey, options);
@@ -140,7 +140,7 @@ class default_1 {
     decrypt(data, customCipherKey, options) {
         if (this.configuration.customDecrypt) {
             if (this.logger)
-                this.logger.warn(this.constructor.name, "'customDecrypt' is deprecated. Consult docs for better alternative.");
+                this.logger.warn('Crypto', "'customDecrypt' is deprecated. Consult docs for better alternative.");
             return this.configuration.customDecrypt(data);
         }
         return this.pnDecrypt(data, customCipherKey, options);
@@ -159,7 +159,7 @@ class default_1 {
         if (!decidedCipherKey)
             return data;
         if (this.logger) {
-            this.logger.debug(this.constructor.name, () => ({
+            this.logger.debug('Crypto', () => ({
                 messageType: 'object',
                 message: Object.assign({ data, cipherKey: decidedCipherKey }, (options !== null && options !== void 0 ? options : {})),
                 details: 'Encrypt with parameters:',
@@ -196,7 +196,7 @@ class default_1 {
         if (!decidedCipherKey)
             return data;
         if (this.logger) {
-            this.logger.debug(this.constructor.name, () => ({
+            this.logger.debug('Crypto', () => ({
                 messageType: 'object',
                 message: Object.assign({ data, cipherKey: decidedCipherKey }, (options !== null && options !== void 0 ? options : {})),
                 details: 'Decrypt with parameters:',
@@ -218,7 +218,7 @@ class default_1 {
             }
             catch (e) {
                 if (this.logger)
-                    this.logger.error(this.constructor.name, () => ({ messageType: 'error', message: e }));
+                    this.logger.error('Crypto', () => ({ messageType: 'error', message: e }));
                 return null;
             }
         }
@@ -233,7 +233,7 @@ class default_1 {
             }
             catch (e) {
                 if (this.logger)
-                    this.logger.error(this.constructor.name, () => ({ messageType: 'error', message: e }));
+                    this.logger.error('Crypto', () => ({ messageType: 'error', message: e }));
                 return null;
             }
         }

dist/web/pubnub.worker.min.js

@@ -19,7 +19,7 @@ class DedupingManager {
      */
     constructor(config) {
         this.config = config;
-        config.logger().debug(this.constructor.name, () => ({
+        config.logger().debug('DedupingManager', () => ({
             messageType: 'object',
             message: { maximumCacheSize: config.maximumCacheSize },
             details: 'Create with configuration:',