genesys-cloud-streaming-client 17.2.3-develop.106 → 17.2.3

package/dist/cjs/client.d.ts

@@ -48,6 +48,7 @@ export declare class Client extends EventEmitter {
     private handleNoLongerSubscribed;
     private handleDuplicateId;
     disconnect(): Promise<any>;
+    private getSessionStoreKey;
     private getConnectionData;
     private setConnectionData;
     private increaseBackoff;

package/dist/cjs/client.js

@@ -224,8 +224,12 @@ class Client extends events_1.default {
                 .then(resolve);
         }, 5000, 'disconnecting streaming service');
     }
+    getSessionStoreKey() {
+        const differentiator = this.config.appName || this.logger.clientId;
+        return `${SESSION_STORE_KEY}_${differentiator}`;
+    }
     getConnectionData() {
-        const connectionDataStr = sessionStorage.getItem(SESSION_STORE_KEY);
+        const connectionDataStr = sessionStorage.getItem(this.getSessionStoreKey());
         const defaultValue = {
             currentDelayMs: 0,
         };
@@ -241,17 +245,19 @@ class Client extends events_1.default {
         return defaultValue;
     }
     setConnectionData(data) {
-        sessionStorage.setItem(SESSION_STORE_KEY, JSON.stringify(data));
+        sessionStorage.setItem(this.getSessionStoreKey(), JSON.stringify(data));
     }
     increaseBackoff() {
         const connectionData = this.getConnectionData();
-        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY);
-        this.setConnectionData({
+        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY * 2);
+        const newConnectionData = {
             currentDelayMs: currentDelay,
             delayMsAfterNextReduction: currentDelay / 2,
             nextDelayReductionTime: new Date().getTime() + (currentDelay * BACKOFF_DECREASE_DELAY_MULTIPLIER),
             timeOfTotalReset: new Date().getTime() + 1000 * 60 * 60 // one hour in the future
-        });
+        };
+        this.setConnectionData(newConnectionData);
+        return newConnectionData;
     }
     decreaseBackoff(newAmountMs) {
         const data = this.getConnectionData();
@@ -301,6 +307,9 @@ class Client extends events_1.default {
         const startingDelay = this.getStartingDelay(connectionData, maxDelay);
         const delayFirstAttempt = this.hasMadeInitialAttempt;
         this.hasMadeInitialAttempt = true;
+        if (connectionData.currentDelayMs) {
+            this.logger.debug('streamingClient.connect was called, but backoff is remembered', { currentDelayMs: connectionData.currentDelayMs, delayingThisAttempt: delayFirstAttempt, clientId: this.logger.clientId, appName: this.config.appName });
+        }
         try {
             await exponential_backoff_1.backOff(async () => {
                 const connectionData = this.getConnectionData();
@@ -407,8 +416,9 @@ class Client extends events_1.default {
                 return true;
             }
         }
+        const connectionData = this.increaseBackoff();
         this.logger.error('Failed streaming client connection attempt, retrying', additionalErrorDetails, { skipServer: err instanceof offline_error_1.default });
-        this.increaseBackoff();
+        this.logger.debug('debug: retry info', { expectedRetryInMs: connectionData.currentDelayMs, appName: this.config.appName, clientId: this.logger.clientId });
         return true;
     }
     async makeConnectionAttempt() {

package/dist/deploy-info.json

@@ -17,6 +17,6 @@
       "file": "v17/streaming-client.browser.js"
     }
   ],
-  "build": "106",
-  "buildDate": "2024-06-27T23:18:38.267203Z"
+  "build": "99",
+  "buildDate": "2024-07-25T19:27:48.060772690Z"
 }

package/dist/es/client.d.ts

@@ -48,6 +48,7 @@ export declare class Client extends EventEmitter {
     private handleNoLongerSubscribed;
     private handleDuplicateId;
     disconnect(): Promise<any>;
+    private getSessionStoreKey;
     private getConnectionData;
     private setConnectionData;
     private increaseBackoff;

package/dist/es/client.js

@@ -226,8 +226,12 @@ export class Client extends EventEmitter {
             }, 5000, 'disconnecting streaming service');
         });
     }
+    getSessionStoreKey() {
+        const differentiator = this.config.appName || this.logger.clientId;
+        return `${SESSION_STORE_KEY}_${differentiator}`;
+    }
     getConnectionData() {
-        const connectionDataStr = sessionStorage.getItem(SESSION_STORE_KEY);
+        const connectionDataStr = sessionStorage.getItem(this.getSessionStoreKey());
         const defaultValue = {
             currentDelayMs: 0,
         };
@@ -243,17 +247,19 @@ export class Client extends EventEmitter {
         return defaultValue;
     }
     setConnectionData(data) {
-        sessionStorage.setItem(SESSION_STORE_KEY, JSON.stringify(data));
+        sessionStorage.setItem(this.getSessionStoreKey(), JSON.stringify(data));
     }
     increaseBackoff() {
         const connectionData = this.getConnectionData();
-        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY);
-        this.setConnectionData({
+        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY * 2);
+        const newConnectionData = {
             currentDelayMs: currentDelay,
             delayMsAfterNextReduction: currentDelay / 2,
             nextDelayReductionTime: new Date().getTime() + (currentDelay * BACKOFF_DECREASE_DELAY_MULTIPLIER),
             timeOfTotalReset: new Date().getTime() + 1000 * 60 * 60 // one hour in the future
-        });
+        };
+        this.setConnectionData(newConnectionData);
+        return newConnectionData;
     }
     decreaseBackoff(newAmountMs) {
         const data = this.getConnectionData();
@@ -304,6 +310,9 @@ export class Client extends EventEmitter {
             const startingDelay = this.getStartingDelay(connectionData, maxDelay);
             const delayFirstAttempt = this.hasMadeInitialAttempt;
             this.hasMadeInitialAttempt = true;
+            if (connectionData.currentDelayMs) {
+                this.logger.debug('streamingClient.connect was called, but backoff is remembered', { currentDelayMs: connectionData.currentDelayMs, delayingThisAttempt: delayFirstAttempt, clientId: this.logger.clientId, appName: this.config.appName });
+            }
             try {
                 yield backOff(() => __awaiter(this, void 0, void 0, function* () {
                     const connectionData = this.getConnectionData();
@@ -412,8 +421,9 @@ export class Client extends EventEmitter {
                     return true;
                 }
             }
+            const connectionData = this.increaseBackoff();
             this.logger.error('Failed streaming client connection attempt, retrying', additionalErrorDetails, { skipServer: err instanceof OfflineError });
-            this.increaseBackoff();
+            this.logger.debug('debug: retry info', { expectedRetryInMs: connectionData.currentDelayMs, appName: this.config.appName, clientId: this.logger.clientId });
             return true;
         });
     }

package/dist/es/index.bundle.js

@@ -41707,8 +41707,12 @@ class Client extends EventEmitter {
             }, 5000, 'disconnecting streaming service');
         });
     }
+    getSessionStoreKey() {
+        const differentiator = this.config.appName || this.logger.clientId;
+        return `${SESSION_STORE_KEY}_${differentiator}`;
+    }
     getConnectionData() {
-        const connectionDataStr = sessionStorage.getItem(SESSION_STORE_KEY);
+        const connectionDataStr = sessionStorage.getItem(this.getSessionStoreKey());
         const defaultValue = {
             currentDelayMs: 0,
         };
@@ -41724,17 +41728,19 @@ class Client extends EventEmitter {
         return defaultValue;
     }
     setConnectionData(data) {
-        sessionStorage.setItem(SESSION_STORE_KEY, JSON.stringify(data));
+        sessionStorage.setItem(this.getSessionStoreKey(), JSON.stringify(data));
     }
     increaseBackoff() {
         const connectionData = this.getConnectionData();
-        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY);
-        this.setConnectionData({
+        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY * 2);
+        const newConnectionData = {
             currentDelayMs: currentDelay,
             delayMsAfterNextReduction: currentDelay / 2,
             nextDelayReductionTime: new Date().getTime() + (currentDelay * BACKOFF_DECREASE_DELAY_MULTIPLIER),
             timeOfTotalReset: new Date().getTime() + 1000 * 60 * 60 // one hour in the future
-        });
+        };
+        this.setConnectionData(newConnectionData);
+        return newConnectionData;
     }
     decreaseBackoff(newAmountMs) {
         const data = this.getConnectionData();
@@ -41785,6 +41791,9 @@ class Client extends EventEmitter {
             const startingDelay = this.getStartingDelay(connectionData, maxDelay);
             const delayFirstAttempt = this.hasMadeInitialAttempt;
             this.hasMadeInitialAttempt = true;
+            if (connectionData.currentDelayMs) {
+                this.logger.debug('streamingClient.connect was called, but backoff is remembered', { currentDelayMs: connectionData.currentDelayMs, delayingThisAttempt: delayFirstAttempt, clientId: this.logger.clientId, appName: this.config.appName });
+            }
             try {
                 yield backOff_1(() => __awaiter$5(this, void 0, void 0, function* () {
                     const connectionData = this.getConnectionData();
@@ -41893,8 +41902,9 @@ class Client extends EventEmitter {
                     return true;
                 }
             }
+            const connectionData = this.increaseBackoff();
             this.logger.error('Failed streaming client connection attempt, retrying', additionalErrorDetails, { skipServer: err instanceof OfflineError });
-            this.increaseBackoff();
+            this.logger.debug('debug: retry info', { expectedRetryInMs: connectionData.currentDelayMs, appName: this.config.appName, clientId: this.logger.clientId });
             return true;
         });
     }

package/dist/npm/CHANGELOG.md

@@ -4,7 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# [Unreleased](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v17.2.2...HEAD)
+# [Unreleased](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v17.2.3...HEAD)
+# [v17.2.3](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v17.2.2...v17.2.3)
+### Fixed
+* [STREAM-134](https://inindca.atlassian.net/browse/STREAM-134) Isolate streaming client backoff delays by app name
 ### Changed
 * [no-jira] Fix string interpolation for log message and update docs for `useServerSidePings` default
 

package/dist/npm/client.d.ts

@@ -48,6 +48,7 @@ export declare class Client extends EventEmitter {
     private handleNoLongerSubscribed;
     private handleDuplicateId;
     disconnect(): Promise<any>;
+    private getSessionStoreKey;
     private getConnectionData;
     private setConnectionData;
     private increaseBackoff;

package/dist/npm/client.js

@@ -224,8 +224,12 @@ class Client extends events_1.default {
                 .then(resolve);
         }, 5000, 'disconnecting streaming service');
     }
+    getSessionStoreKey() {
+        const differentiator = this.config.appName || this.logger.clientId;
+        return `${SESSION_STORE_KEY}_${differentiator}`;
+    }
     getConnectionData() {
-        const connectionDataStr = sessionStorage.getItem(SESSION_STORE_KEY);
+        const connectionDataStr = sessionStorage.getItem(this.getSessionStoreKey());
         const defaultValue = {
             currentDelayMs: 0,
         };
@@ -241,17 +245,19 @@ class Client extends events_1.default {
         return defaultValue;
     }
     setConnectionData(data) {
-        sessionStorage.setItem(SESSION_STORE_KEY, JSON.stringify(data));
+        sessionStorage.setItem(this.getSessionStoreKey(), JSON.stringify(data));
     }
     increaseBackoff() {
         const connectionData = this.getConnectionData();
-        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY);
-        this.setConnectionData({
+        const currentDelay = Math.max(connectionData.currentDelayMs * 2, INITIAL_DELAY * 2);
+        const newConnectionData = {
             currentDelayMs: currentDelay,
             delayMsAfterNextReduction: currentDelay / 2,
             nextDelayReductionTime: new Date().getTime() + (currentDelay * BACKOFF_DECREASE_DELAY_MULTIPLIER),
             timeOfTotalReset: new Date().getTime() + 1000 * 60 * 60 // one hour in the future
-        });
+        };
+        this.setConnectionData(newConnectionData);
+        return newConnectionData;
     }
     decreaseBackoff(newAmountMs) {
         const data = this.getConnectionData();
@@ -301,6 +307,9 @@ class Client extends events_1.default {
         const startingDelay = this.getStartingDelay(connectionData, maxDelay);
         const delayFirstAttempt = this.hasMadeInitialAttempt;
         this.hasMadeInitialAttempt = true;
+        if (connectionData.currentDelayMs) {
+            this.logger.debug('streamingClient.connect was called, but backoff is remembered', { currentDelayMs: connectionData.currentDelayMs, delayingThisAttempt: delayFirstAttempt, clientId: this.logger.clientId, appName: this.config.appName });
+        }
         try {
             await exponential_backoff_1.backOff(async () => {
                 const connectionData = this.getConnectionData();
@@ -407,8 +416,9 @@ class Client extends events_1.default {
                 return true;
             }
         }
+        const connectionData = this.increaseBackoff();
         this.logger.error('Failed streaming client connection attempt, retrying', additionalErrorDetails, { skipServer: err instanceof offline_error_1.default });
-        this.increaseBackoff();
+        this.logger.debug('debug: retry info', { expectedRetryInMs: connectionData.currentDelayMs, appName: this.config.appName, clientId: this.logger.clientId });
         return true;
     }
     async makeConnectionAttempt() {