fix(configuration): fix automatic heartbeatInterval set

Fix issue because of which `heartbeatInterval` wasn't computed if `presenceTimeout` provided during PubNub client configuration
pubnub · Jun 4, 2024 · 6e101b8 · 6e101b8
1 parent 26c4d73
commit 6e101b8
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 8 deletions.
diff --git a/dist/web/pubnub.js b/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;

diff --git a/dist/web/pubnub.min.js b/dist/web/pubnub.min.js
diff --git a/lib/core/interfaces/configuration.js b/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;

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/core/interfaces/configuration.ts b/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;

diff --git a/test/integration/components/config.test.ts b/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);
+    });
   });
 });