genesys-cloud-streaming-client 17.1.2-develop.96 → 17.1.2-develop.97

package/dist/cjs/client.d.ts

@@ -16,6 +16,7 @@ export declare class Client extends EventEmitter {
     connecting: boolean;
     hardReconnectRequired: boolean;
     reconnectOnNoLongerSubscribed: boolean;
+    useServerSidePings: boolean;
     logger: Logger;
     config: IClientConfig;
     isGuest: boolean;
@@ -55,6 +56,7 @@ export declare class Client extends EventEmitter {
     connect(connectOpts?: StreamingClientConnectOptions): Promise<void>;
     private backoffConnectRetryHandler;
     private makeConnectionAttempt;
+    private setupConnectionMonitoring;
     private prepareForConnect;
     stopServerLogging(): void;
     startServerLogging(): void;

package/dist/cjs/client.js

@@ -8,6 +8,7 @@ require("./polyfills");
 const notifications_1 = require("./notifications");
 const webrtc_1 = require("./webrtc");
 const ping_1 = require("./ping");
+const server_monitor_1 = require("./server-monitor");
 const utils_1 = require("./utils");
 const http_client_1 = require("./http-client");
 const events_1 = tslib_1.__importDefault(require("events"));
@@ -43,6 +44,7 @@ class Client extends events_1.default {
         this.hasMadeInitialAttempt = false;
         this.http = new http_client_1.HttpClient();
         this.reconnectOnNoLongerSubscribed = options.reconnectOnNoLongerSubscribed !== false;
+        this.useServerSidePings = options.useServerSidePings !== false;
         this.config = {
             host: options.host,
             apiHost: options.apiHost || options.host.replace('wss://streaming.', ''),
@@ -175,11 +177,12 @@ class Client extends events_1.default {
         };
     }
     async handleStanzaDisconnectedEvent(disconnectedInstance) {
-        var _a;
+        var _a, _b;
         this.logger.info('stanzaDisconnected event received', { stanzaInstanceId: disconnectedInstance.id, channelId: disconnectedInstance.channelId });
         this.connected = false;
         this.connecting = false;
         (_a = disconnectedInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = disconnectedInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.removeAllListeners(STANZA_DISCONNECTED);
         this.removeAllListeners(NO_LONGER_SUBSCRIBED);
         // unproxy events
@@ -193,18 +196,20 @@ class Client extends events_1.default {
         }
     }
     handleNoLongerSubscribed(stanzaInstance) {
-        var _a;
+        var _a, _b;
         this.logger.warn('noLongerSubscribed event received', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
         (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.hardReconnectRequired = true;
         if (!this.reconnectOnNoLongerSubscribed) {
             this.autoReconnect = false;
         }
     }
     handleDuplicateId(stanzaInstance) {
-        var _a;
+        var _a, _b;
         this.logger.warn('duplicate_id event received, forcing hard reconnect', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
         (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.hardReconnectRequired = true;
     }
     async disconnect() {
@@ -407,7 +412,7 @@ class Client extends events_1.default {
         return true;
     }
     async makeConnectionAttempt() {
-        var _a;
+        var _a, _b;
         if (!navigator.onLine) {
             throw new offline_error_1.default('Browser is offline, skipping connection attempt');
         }
@@ -430,7 +435,7 @@ class Client extends events_1.default {
                 extension.handleStanzaInstanceChange(stanzaInstance);
             }
             this.activeStanzaInstance = stanzaInstance;
-            stanzaInstance.pinger = new ping_1.Ping(this, stanzaInstance);
+            await this.setupConnectionMonitoring(stanzaInstance);
             this.emit('connected');
         }
         catch (err) {
@@ -438,6 +443,7 @@ class Client extends events_1.default {
                 this.logger.error('Error occurred in connection attempt, but after websocket connected. Cleaning up connection so backoff is respected', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
                 this.removeStanzaBoundEventHandlers();
                 (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+                (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
                 await stanzaInstance.disconnect();
                 this.connected = false;
                 this.connecting = previousConnectingState;
@@ -445,6 +451,26 @@ class Client extends events_1.default {
             throw err;
         }
     }
+    async setupConnectionMonitoring(stanzaInstance) {
+        const setupClientPinger = (message) => {
+            const logMessage = `$(message), falling back to client-side pinging`;
+            this.logger.warn(logMessage, { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
+            stanzaInstance.pinger = new ping_1.Ping(this, stanzaInstance);
+        };
+        if (this.useServerSidePings) {
+            try {
+                // if this fails, then hawk doesn't support serverside pinging and we need to do client side pings
+                await stanzaInstance.subscribeToNode(this._notifications.pubsubHost, 'enable.server.side.pings');
+                stanzaInstance.serverMonitor = new server_monitor_1.ServerMonitor(this, stanzaInstance);
+            }
+            catch (err) {
+                setupClientPinger('failed to establish server-side pinging');
+            }
+        }
+        else {
+            setupClientPinger('client configured to not use server-side pinging');
+        }
+    }
     async prepareForConnect() {
         if (this.config.jwt) {
             this.hardReconnectRequired = false;

package/dist/cjs/server-monitor.d.ts

@@ -0,0 +1,16 @@
+import { Client } from './client';
+import { NamedAgent } from './types/named-agent';
+export interface ServerMonitorOptions {
+    stanzaTimeout?: number;
+}
+export declare class ServerMonitor {
+    private client;
+    private stanzaInstance;
+    private stanzaTimeout;
+    private timeoutId?;
+    private boundSetupStanzaTimeout?;
+    constructor(client: Client, stanzaInstance: NamedAgent, options?: ServerMonitorOptions);
+    private start;
+    stop(): void;
+    private setupStanzaTimeout;
+}

package/dist/cjs/server-monitor.js

@@ -0,0 +1,42 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerMonitor = void 0;
+const DEFAULT_STANZA_TIMEOUT = 70 * 1000;
+class ServerMonitor {
+    constructor(client, stanzaInstance, options = {}) {
+        this.client = client;
+        this.stanzaInstance = stanzaInstance;
+        this.stanzaTimeout = options.stanzaTimeout || DEFAULT_STANZA_TIMEOUT;
+        this.timeoutId = undefined;
+        this.start();
+    }
+    start() {
+        this.boundSetupStanzaTimeout = this.setupStanzaTimeout.bind(this);
+        this.client.on('connected', this.boundSetupStanzaTimeout);
+        this.stanzaInstance.on('raw:incoming', this.boundSetupStanzaTimeout);
+    }
+    stop() {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = undefined;
+        if (this.boundSetupStanzaTimeout) {
+            this.client.off('connected', this.boundSetupStanzaTimeout);
+            this.stanzaInstance.off('raw:incoming', this.boundSetupStanzaTimeout);
+            this.boundSetupStanzaTimeout = undefined;
+        }
+    }
+    setupStanzaTimeout() {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = setTimeout(() => {
+            const info = {
+                channelId: this.client.config.channelId,
+                jid: this.stanzaInstance.jid,
+                stanzaInstanceId: this.stanzaInstance.id,
+                timeout: this.stanzaTimeout
+            };
+            this.client.logger.error('Time between XMPP stanzas exceeded timeout, disconnecting', info);
+            this.stanzaInstance.sendStreamError({ text: 'time between stanzas exceeded timeout', condition: 'connection-timeout' });
+            this.stop();
+        }, this.stanzaTimeout);
+    }
+}
+exports.ServerMonitor = ServerMonitor;

package/dist/cjs/types/interfaces.d.ts

@@ -17,6 +17,7 @@ export interface IClientOptions {
     logLevel?: LogLevel;
     logFormatters?: LogFormatterFn[];
     signalIceConnected?: boolean;
+    useServerSidePings?: boolean;
     appName?: string;
     appVersion?: string;
     appId?: string;

package/dist/cjs/types/named-agent.d.ts

@@ -1,9 +1,11 @@
 import { Agent } from 'stanza';
 import { Ping } from '../ping';
+import { ServerMonitor } from '../server-monitor';
 export interface NamedAgent extends Omit<Agent, 'disconnect'> {
     id: string;
     channelId?: string;
     originalEmitter?: Function;
     pinger?: Ping;
+    serverMonitor?: ServerMonitor;
     disconnect: () => Promise<void>;
 }

package/dist/deploy-info.json

@@ -17,6 +17,6 @@
       "file": "v17/streaming-client.browser.js"
     }
   ],
-  "build": "96",
-  "buildDate": "2024-04-22T20:44:52.500279Z"
+  "build": "97",
+  "buildDate": "2024-05-02T22:19:19.442066Z"
 }

package/dist/es/client.d.ts

@@ -16,6 +16,7 @@ export declare class Client extends EventEmitter {
     connecting: boolean;
     hardReconnectRequired: boolean;
     reconnectOnNoLongerSubscribed: boolean;
+    useServerSidePings: boolean;
     logger: Logger;
     config: IClientConfig;
     isGuest: boolean;
@@ -55,6 +56,7 @@ export declare class Client extends EventEmitter {
     connect(connectOpts?: StreamingClientConnectOptions): Promise<void>;
     private backoffConnectRetryHandler;
     private makeConnectionAttempt;
+    private setupConnectionMonitoring;
     private prepareForConnect;
     stopServerLogging(): void;
     startServerLogging(): void;

package/dist/es/client.js

@@ -6,6 +6,7 @@ import './polyfills';
 import { Notifications } from './notifications';
 import { WebrtcExtension } from './webrtc';
 import { Ping } from './ping';
+import { ServerMonitor } from './server-monitor';
 import { delay, parseJwt, timeoutPromise } from './utils';
 import { HttpClient } from './http-client';
 import EventEmitter from 'events';
@@ -41,6 +42,7 @@ export class Client extends EventEmitter {
         this.hasMadeInitialAttempt = false;
         this.http = new HttpClient();
         this.reconnectOnNoLongerSubscribed = options.reconnectOnNoLongerSubscribed !== false;
+        this.useServerSidePings = options.useServerSidePings !== false;
         this.config = {
             host: options.host,
             apiHost: options.apiHost || options.host.replace('wss://streaming.', ''),
@@ -173,12 +175,13 @@ export class Client extends EventEmitter {
         };
     }
     handleStanzaDisconnectedEvent(disconnectedInstance) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.info('stanzaDisconnected event received', { stanzaInstanceId: disconnectedInstance.id, channelId: disconnectedInstance.channelId });
             this.connected = false;
             this.connecting = false;
             (_a = disconnectedInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+            (_b = disconnectedInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
             this.removeAllListeners(STANZA_DISCONNECTED);
             this.removeAllListeners(NO_LONGER_SUBSCRIBED);
             // unproxy events
@@ -193,18 +196,20 @@ export class Client extends EventEmitter {
         });
     }
     handleNoLongerSubscribed(stanzaInstance) {
-        var _a;
+        var _a, _b;
         this.logger.warn('noLongerSubscribed event received', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
         (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.hardReconnectRequired = true;
         if (!this.reconnectOnNoLongerSubscribed) {
             this.autoReconnect = false;
         }
     }
     handleDuplicateId(stanzaInstance) {
-        var _a;
+        var _a, _b;
         this.logger.warn('duplicate_id event received, forcing hard reconnect', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
         (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.hardReconnectRequired = true;
     }
     disconnect() {
@@ -413,7 +418,7 @@ export class Client extends EventEmitter {
         });
     }
     makeConnectionAttempt() {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             if (!navigator.onLine) {
                 throw new OfflineError('Browser is offline, skipping connection attempt');
@@ -437,7 +442,7 @@ export class Client extends EventEmitter {
                     extension.handleStanzaInstanceChange(stanzaInstance);
                 }
                 this.activeStanzaInstance = stanzaInstance;
-                stanzaInstance.pinger = new Ping(this, stanzaInstance);
+                yield this.setupConnectionMonitoring(stanzaInstance);
                 this.emit('connected');
             }
             catch (err) {
@@ -445,6 +450,7 @@ export class Client extends EventEmitter {
                     this.logger.error('Error occurred in connection attempt, but after websocket connected. Cleaning up connection so backoff is respected', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
                     this.removeStanzaBoundEventHandlers();
                     (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+                    (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
                     yield stanzaInstance.disconnect();
                     this.connected = false;
                     this.connecting = previousConnectingState;
@@ -453,6 +459,28 @@ export class Client extends EventEmitter {
             }
         });
     }
+    setupConnectionMonitoring(stanzaInstance) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const setupClientPinger = (message) => {
+                const logMessage = `$(message), falling back to client-side pinging`;
+                this.logger.warn(logMessage, { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
+                stanzaInstance.pinger = new Ping(this, stanzaInstance);
+            };
+            if (this.useServerSidePings) {
+                try {
+                    // if this fails, then hawk doesn't support serverside pinging and we need to do client side pings
+                    yield stanzaInstance.subscribeToNode(this._notifications.pubsubHost, 'enable.server.side.pings');
+                    stanzaInstance.serverMonitor = new ServerMonitor(this, stanzaInstance);
+                }
+                catch (err) {
+                    setupClientPinger('failed to establish server-side pinging');
+                }
+            }
+            else {
+                setupClientPinger('client configured to not use server-side pinging');
+            }
+        });
+    }
     prepareForConnect() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.config.jwt) {

package/dist/es/index.bundle.js

@@ -31444,6 +31444,45 @@ class Ping {
     }
 }
 
+const DEFAULT_STANZA_TIMEOUT = 70 * 1000;
+class ServerMonitor {
+    constructor(client, stanzaInstance, options = {}) {
+        this.client = client;
+        this.stanzaInstance = stanzaInstance;
+        this.stanzaTimeout = options.stanzaTimeout || DEFAULT_STANZA_TIMEOUT;
+        this.timeoutId = undefined;
+        this.start();
+    }
+    start() {
+        this.boundSetupStanzaTimeout = this.setupStanzaTimeout.bind(this);
+        this.client.on('connected', this.boundSetupStanzaTimeout);
+        this.stanzaInstance.on('raw:incoming', this.boundSetupStanzaTimeout);
+    }
+    stop() {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = undefined;
+        if (this.boundSetupStanzaTimeout) {
+            this.client.off('connected', this.boundSetupStanzaTimeout);
+            this.stanzaInstance.off('raw:incoming', this.boundSetupStanzaTimeout);
+            this.boundSetupStanzaTimeout = undefined;
+        }
+    }
+    setupStanzaTimeout() {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = setTimeout(() => {
+            const info = {
+                channelId: this.client.config.channelId,
+                jid: this.stanzaInstance.jid,
+                stanzaInstanceId: this.stanzaInstance.id,
+                timeout: this.stanzaTimeout
+            };
+            this.client.logger.error('Time between XMPP stanzas exceeded timeout, disconnecting', info);
+            this.stanzaInstance.sendStreamError({ text: 'time between stanzas exceeded timeout', condition: 'connection-timeout' });
+            this.stop();
+        }, this.stanzaTimeout);
+    }
+}
+
 var stanza = {};
 
 var Client$2 = {};
@@ -41444,6 +41483,7 @@ class Client extends EventEmitter {
         this.hasMadeInitialAttempt = false;
         this.http = new HttpClient();
         this.reconnectOnNoLongerSubscribed = options.reconnectOnNoLongerSubscribed !== false;
+        this.useServerSidePings = options.useServerSidePings !== false;
         this.config = {
             host: options.host,
             apiHost: options.apiHost || options.host.replace('wss://streaming.', ''),
@@ -41576,12 +41616,13 @@ class Client extends EventEmitter {
         };
     }
     handleStanzaDisconnectedEvent(disconnectedInstance) {
-        var _a;
+        var _a, _b;
         return __awaiter$5(this, void 0, void 0, function* () {
             this.logger.info('stanzaDisconnected event received', { stanzaInstanceId: disconnectedInstance.id, channelId: disconnectedInstance.channelId });
             this.connected = false;
             this.connecting = false;
             (_a = disconnectedInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+            (_b = disconnectedInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
             this.removeAllListeners(STANZA_DISCONNECTED);
             this.removeAllListeners(NO_LONGER_SUBSCRIBED);
             // unproxy events
@@ -41596,18 +41637,20 @@ class Client extends EventEmitter {
         });
     }
     handleNoLongerSubscribed(stanzaInstance) {
-        var _a;
+        var _a, _b;
         this.logger.warn('noLongerSubscribed event received', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
         (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.hardReconnectRequired = true;
         if (!this.reconnectOnNoLongerSubscribed) {
             this.autoReconnect = false;
         }
     }
     handleDuplicateId(stanzaInstance) {
-        var _a;
+        var _a, _b;
         this.logger.warn('duplicate_id event received, forcing hard reconnect', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
         (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+        (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
         this.hardReconnectRequired = true;
     }
     disconnect() {
@@ -41816,7 +41859,7 @@ class Client extends EventEmitter {
         });
     }
     makeConnectionAttempt() {
-        var _a;
+        var _a, _b;
         return __awaiter$5(this, void 0, void 0, function* () {
             if (!navigator.onLine) {
                 throw new OfflineError('Browser is offline, skipping connection attempt');
@@ -41840,7 +41883,7 @@ class Client extends EventEmitter {
                     extension.handleStanzaInstanceChange(stanzaInstance);
                 }
                 this.activeStanzaInstance = stanzaInstance;
-                stanzaInstance.pinger = new Ping(this, stanzaInstance);
+                yield this.setupConnectionMonitoring(stanzaInstance);
                 this.emit('connected');
             }
             catch (err) {
@@ -41848,6 +41891,7 @@ class Client extends EventEmitter {
                     this.logger.error('Error occurred in connection attempt, but after websocket connected. Cleaning up connection so backoff is respected', { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
                     this.removeStanzaBoundEventHandlers();
                     (_a = stanzaInstance.pinger) === null || _a === void 0 ? void 0 : _a.stop();
+                    (_b = stanzaInstance.serverMonitor) === null || _b === void 0 ? void 0 : _b.stop();
                     yield stanzaInstance.disconnect();
                     this.connected = false;
                     this.connecting = previousConnectingState;
@@ -41856,6 +41900,28 @@ class Client extends EventEmitter {
             }
         });
     }
+    setupConnectionMonitoring(stanzaInstance) {
+        return __awaiter$5(this, void 0, void 0, function* () {
+            const setupClientPinger = (message) => {
+                const logMessage = `$(message), falling back to client-side pinging`;
+                this.logger.warn(logMessage, { stanzaInstanceId: stanzaInstance.id, channelId: stanzaInstance.channelId });
+                stanzaInstance.pinger = new Ping(this, stanzaInstance);
+            };
+            if (this.useServerSidePings) {
+                try {
+                    // if this fails, then hawk doesn't support serverside pinging and we need to do client side pings
+                    yield stanzaInstance.subscribeToNode(this._notifications.pubsubHost, 'enable.server.side.pings');
+                    stanzaInstance.serverMonitor = new ServerMonitor(this, stanzaInstance);
+                }
+                catch (err) {
+                    setupClientPinger();
+                }
+            }
+            else {
+                setupClientPinger();
+            }
+        });
+    }
     prepareForConnect() {
         return __awaiter$5(this, void 0, void 0, function* () {
             if (this.config.jwt) {

package/dist/es/server-monitor.d.ts

@@ -0,0 +1,16 @@
+import { Client } from './client';
+import { NamedAgent } from './types/named-agent';
+export interface ServerMonitorOptions {
+    stanzaTimeout?: number;
+}
+export declare class ServerMonitor {
+    private client;
+    private stanzaInstance;
+    private stanzaTimeout;
+    private timeoutId?;
+    private boundSetupStanzaTimeout?;
+    constructor(client: Client, stanzaInstance: NamedAgent, options?: ServerMonitorOptions);
+    private start;
+    stop(): void;
+    private setupStanzaTimeout;
+}

package/dist/es/server-monitor.js

@@ -0,0 +1,39 @@
+'use strict';
+const DEFAULT_STANZA_TIMEOUT = 70 * 1000;
+export class ServerMonitor {
+    constructor(client, stanzaInstance, options = {}) {
+        this.client = client;
+        this.stanzaInstance = stanzaInstance;
+        this.stanzaTimeout = options.stanzaTimeout || DEFAULT_STANZA_TIMEOUT;
+        this.timeoutId = undefined;
+        this.start();
+    }
+    start() {
+        this.boundSetupStanzaTimeout = this.setupStanzaTimeout.bind(this);
+        this.client.on('connected', this.boundSetupStanzaTimeout);
+        this.stanzaInstance.on('raw:incoming', this.boundSetupStanzaTimeout);
+    }
+    stop() {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = undefined;
+        if (this.boundSetupStanzaTimeout) {
+            this.client.off('connected', this.boundSetupStanzaTimeout);
+            this.stanzaInstance.off('raw:incoming', this.boundSetupStanzaTimeout);
+            this.boundSetupStanzaTimeout = undefined;
+        }
+    }
+    setupStanzaTimeout() {
+        clearTimeout(this.timeoutId);
+        this.timeoutId = setTimeout(() => {
+            const info = {
+                channelId: this.client.config.channelId,
+                jid: this.stanzaInstance.jid,
+                stanzaInstanceId: this.stanzaInstance.id,
+                timeout: this.stanzaTimeout
+            };
+            this.client.logger.error('Time between XMPP stanzas exceeded timeout, disconnecting', info);
+            this.stanzaInstance.sendStreamError({ text: 'time between stanzas exceeded timeout', condition: 'connection-timeout' });
+            this.stop();
+        }, this.stanzaTimeout);
+    }
+}

package/dist/es/types/interfaces.d.ts

@@ -17,6 +17,7 @@ export interface IClientOptions {
     logLevel?: LogLevel;
     logFormatters?: LogFormatterFn[];
     signalIceConnected?: boolean;
+    useServerSidePings?: boolean;
     appName?: string;
     appVersion?: string;
     appId?: string;

package/dist/es/types/named-agent.d.ts

@@ -1,9 +1,11 @@
 import { Agent } from 'stanza';
 import { Ping } from '../ping';
+import { ServerMonitor } from '../server-monitor';
 export interface NamedAgent extends Omit<Agent, 'disconnect'> {
     id: string;
     channelId?: string;
     originalEmitter?: Function;
     pinger?: Ping;
+    serverMonitor?: ServerMonitor;
     disconnect: () => Promise<void>;
 }

package/dist/npm/CHANGELOG.md

@@ -5,6 +5,8 @@ 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.1.2...HEAD)
+### Changed
+* [PCM-2352](https://inindca.atlassian.net/browse/PCM-2352) - Use a timeout when using server-side pinging to detect when a connection has dropped
 
 # [v17.1.2](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v17.1.1...v17.1.2)
 * [NO-JIRA] - Removed Spigot testing from Jenkins build step.

package/dist/npm/client.d.ts

@@ -16,6 +16,7 @@ export declare class Client extends EventEmitter {
     connecting: boolean;
     hardReconnectRequired: boolean;
     reconnectOnNoLongerSubscribed: boolean;
+    useServerSidePings: boolean;
     logger: Logger;
     config: IClientConfig;
     isGuest: boolean;
@@ -55,6 +56,7 @@ export declare class Client extends EventEmitter {
     connect(connectOpts?: StreamingClientConnectOptions): Promise<void>;
     private backoffConnectRetryHandler;
     private makeConnectionAttempt;
+    private setupConnectionMonitoring;
     private prepareForConnect;
     stopServerLogging(): void;
     startServerLogging(): void;