Fix automatic heartbeatInterval set (#378)

fix(configuration): fix automatic `heartbeatInterval` set

Fix issue because of which `heartbeatInterval` wasn't computed if `presenceTimeout` provided
during PubNub client configuration

.pubnub.yml

@@ -1,5 +1,10 @@
 ---
 changelog:
+  - date: 2024-06-05
+    version: v8.2.2
+    changes:
+      - type: bug
+        text: "Fix issue because of which `heartbeatInterval` wasn't computed if `presenceTimeout` provided during PubNub client configuration."
   - date: 2024-05-22
     version: v8.2.1
     changes:
@@ -993,7 +998,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '8.2.1'
+version: '8.2.2'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1009,7 +1014,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.2.1.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v8.2.2.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1680,7 +1685,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v8.2.1/pubnub.8.2.1.js
+            location: https://github.com/pubnub/javascript/releases/download/v8.2.2/pubnub.8.2.2.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v8.2.2
+June 05 2024
+
+#### Fixed
+- Fix issue because of which `heartbeatInterval` wasn't computed if `presenceTimeout` provided during PubNub client configuration.
+
 ## v8.2.1
 May 22 2024
 

README.md

@@ -28,8 +28,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.8.2.1.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.1.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.2.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.2.min.js
 
 2. Configure your keys:
 

dist/web/pubnub.js

@@ -3525,7 +3525,7 @@
 	 * @internal
 	 */
 	const setDefaults$1 = (configuration) => {
-	    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+	    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
 	    // Copy configuration.
 	    const configurationCopy = Object.assign({}, configuration);
 	    (_a = configurationCopy.logVerbosity) !== null && _a !== void 0 ? _a : (configurationCopy.logVerbosity = USE_VERBOSE_LOGGING);
@@ -3560,7 +3560,10 @@
 	        // eslint-disable-next-line no-console
 	        console.log('WARNING: Presence timeout is less than the minimum. Using minimum value: ', PRESENCE_TIMEOUT_MINIMUM);
 	    }
-	    (_q = configurationCopy.presenceTimeout) !== null && _q !== void 0 ? _q : (configurationCopy.presenceTimeout = PRESENCE_TIMEOUT);
+	    if (configurationCopy.presenceTimeout !== undefined)
+	        configurationCopy.heartbeatInterval = configurationCopy.presenceTimeout / 2 - 1;
+	    else
+	        configurationCopy.presenceTimeout = PRESENCE_TIMEOUT;
 	    // Apply extended configuration defaults.
 	    let announceSuccessfulHeartbeats = ANNOUNCE_HEARTBEAT_SUCCESS;
 	    let announceFailedHeartbeats = ANNOUNCE_HEARTBEAT_FAILURE;
@@ -3810,7 +3813,7 @@
 	            return base.PubNubFile;
 	        },
 	        get version() {
-	            return '8.2.1';
+	            return '8.2.2';
 	        },
 	        getVersion() {
 	            return this.version;

lib/core/components/configuration.js

@@ -110,7 +110,7 @@ const makeConfiguration = (base, setupCryptoModule) => {
             return base.PubNubFile;
         },
         get version() {
-            return '8.2.1';
+            return '8.2.2';
         },
         getVersion() {
             return this.version;

lib/core/interfaces/configuration.js

@@ -94,7 +94,7 @@ const PRESENCE_TIMEOUT_MINIMUM = 20;
  * @internal
  */
 const setDefaults = (configuration) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     // Copy configuration.
     const configurationCopy = Object.assign({}, configuration);
     (_a = configurationCopy.logVerbosity) !== null && _a !== void 0 ? _a : (configurationCopy.logVerbosity = USE_VERBOSE_LOGGING);
@@ -129,7 +129,10 @@ const setDefaults = (configuration) => {
         // eslint-disable-next-line no-console
         console.log('WARNING: Presence timeout is less than the minimum. Using minimum value: ', PRESENCE_TIMEOUT_MINIMUM);
     }
-    (_q = configurationCopy.presenceTimeout) !== null && _q !== void 0 ? _q : (configurationCopy.presenceTimeout = PRESENCE_TIMEOUT);
+    if (configurationCopy.presenceTimeout !== undefined)
+        configurationCopy.heartbeatInterval = configurationCopy.presenceTimeout / 2 - 1;
+    else
+        configurationCopy.presenceTimeout = PRESENCE_TIMEOUT;
     // Apply extended configuration defaults.
     let announceSuccessfulHeartbeats = ANNOUNCE_HEARTBEAT_SUCCESS;
     let announceFailedHeartbeats = ANNOUNCE_HEARTBEAT_FAILURE;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pubnub",
-  "version": "8.2.1",
+  "version": "8.2.2",
   "author": "PubNub <support@pubnub.com>",
   "description": "Publish & Subscribe Real-time Messaging with PubNub",
   "scripts": {

src/core/components/configuration.ts

@@ -169,7 +169,7 @@ export const makeConfiguration = (
       return base.PubNubFile;
     },
     get version(): string {
-      return '8.2.1';
+      return '8.2.2';
     },
     getVersion(): string {
       return this.version;

src/core/interfaces/configuration.ts

@@ -732,7 +732,9 @@ export const setDefaults = (configuration: UserConfiguration): ExtendedConfigura
     console.log('WARNING: Presence timeout is less than the minimum. Using minimum value: ', PRESENCE_TIMEOUT_MINIMUM);
   }
 
-  configurationCopy.presenceTimeout ??= PRESENCE_TIMEOUT;
+  if (configurationCopy.presenceTimeout !== undefined)
+    configurationCopy.heartbeatInterval = configurationCopy.presenceTimeout / 2 - 1;
+  else configurationCopy.presenceTimeout = PRESENCE_TIMEOUT;
 
   // Apply extended configuration defaults.
   let announceSuccessfulHeartbeats = ANNOUNCE_HEARTBEAT_SUCCESS;

test/integration/components/config.test.ts

@@ -3,6 +3,7 @@
 
 import assert from 'assert';
 import PubNub from '../../../src/node/index';
+import { PrivateClientConfiguration } from '../../../src/core/interfaces/configuration';
 
 describe('components/config', () => {
   describe('AuthKey parameter', () => {
@@ -82,5 +83,26 @@ describe('components/config', () => {
         pubnub.setUUID(' ');
       });
     });
+
+    it('heartbeatInterval not set if presenceTimeout not set', () => {
+      const pubnub = new PubNub({
+        subscribeKey: 'mySubKey',
+        publishKey: 'myPublishKey',
+        uuid: 'myUUID',
+      });
+      assert.equal((pubnub.configuration as PrivateClientConfiguration).getPresenceTimeout(), 300);
+      assert.equal((pubnub.configuration as PrivateClientConfiguration).getHeartbeatInterval(), undefined);
+    });
+
+    it('heartbeatInterval is set by formula when presenceTimeout is set', () => {
+      const pubnub = new PubNub({
+        subscribeKey: 'mySubKey',
+        publishKey: 'myPublishKey',
+        presenceTimeout: 30,
+        uuid: 'myUUID',
+      });
+      assert.equal((pubnub.configuration as PrivateClientConfiguration).getPresenceTimeout(), 30);
+      assert.equal((pubnub.configuration as PrivateClientConfiguration).getHeartbeatInterval(), 30 / 2 - 1);
+    });
   });
 });