genesys-cloud-streaming-client 16.1.3 → 16.1.4-develop.69

package/dist/es/webrtc.d.ts

@@ -4,7 +4,7 @@ import { IQ } from 'stanza/protocol';
 import { SessionManager } from 'stanza/jingle';
 import { SessionOpts } from 'stanza/jingle/Session';
 import { Client } from './client';
-import { ExtendedRTCIceServer, IClientOptions, SessionTypes, IPendingSession, StreamingClientExtension } from './types/interfaces';
+import { ExtendedRTCIceServer, IClientOptions, SessionTypes, IPendingSession, StreamingClientExtension, NRProxyStat, InsightAction } from './types/interfaces';
 import { NamedAgent } from './types/named-agent';
 import { StanzaMediaSession } from './types/stanza-media-session';
 import { IMediaSession } from './types/media-session';
@@ -54,6 +54,9 @@ export declare class WebrtcExtension extends EventEmitter implements StreamingCl
     handleGenesysWebrtcStanza(iq: IQ): Promise<boolean | void>;
     prepareSession(options: SessionOpts): StanzaMediaSession | undefined;
     proxyStatsForSession(session: IMediaSession): void;
+    addStatToQueue<T extends {
+        _eventType: string;
+    }>(stat: InsightAction<T>): void;
     getLogDetailsForPendingSessionId(sessionId: string): {
         conversationId?: string;
         sessionId: string;
@@ -89,6 +92,7 @@ export declare class WebrtcExtension extends EventEmitter implements StreamingCl
     getSessionTypeByJid(jid: string): SessionTypes;
     getSessionManager(): SessionManager | undefined;
     getAllSessions(): IMediaSession[];
+    proxyNRStat(stat: NRProxyStat): void;
     get expose(): WebrtcExtensionAPI;
 }
 export interface WebrtcExtensionAPI {
@@ -108,4 +112,5 @@ export interface WebrtcExtensionAPI {
     getSessionTypeByJid(jid: string): SessionTypes;
     getSessionManager: () => SessionManager | undefined;
     getAllSessions: () => IMediaSession[];
+    proxyNRStat: (stat: NRProxyStat) => void;
 }

package/dist/es/webrtc.js

@@ -9,7 +9,7 @@ import { isFirefox } from 'browserama';
 import { definitions } from './stanza-definitions/webrtc-signaling';
 import { isAcdJid, isScreenRecordingJid, isSoftphoneJid, isVideoJid, calculatePayloadSize, retryPromise } from './utils';
 import { Client } from './client';
-import { formatStatsEvent } from './stats-formatter';
+import { deepFlatten, formatStatsEvent } from './stats-formatter';
 import { SessionTypes } from './types/interfaces';
 import { StanzaMediaSession } from './types/stanza-media-session';
 import { GenesysCloudMediaSession } from './types/genesys-cloud-media-session';
@@ -160,6 +160,7 @@ export class WebrtcExtension extends EventEmitter {
             }
             const session = new GenesysCloudMediaSession(this, mediaSessionParams);
             yield session.setRemoteDescription(params.sdp);
+            this.proxyStatsForSession(session);
             session.on('sendIq', (iq) => { var _a; return (_a = this.stanzaInstance) === null || _a === void 0 ? void 0 : _a.sendIQ(iq); });
             session.on('terminated', () => {
                 this.webrtcSessions = this.webrtcSessions.filter(s => s.id !== session.id);
@@ -271,25 +272,48 @@ export class WebrtcExtension extends EventEmitter {
             }
             const statsCopy = JSON.parse(JSON.stringify(statsEvent));
             const extraDetails = {
-                conference: session.conversationId,
-                session: session.id,
+                conversationId: session.conversationId,
+                sessionId: session.id,
                 sessionType: session.sessionType
             };
             // format the event to what the api expects
             const event = formatStatsEvent(statsCopy, extraDetails);
-            const currentEventSize = calculatePayloadSize(event);
-            // Check if the size of the current event plus the size of the previous stats exceeds max size.
-            const exceedsMaxStatSize = this.statBuffer + currentEventSize > this.currentMaxStatSize;
-            this.statsArr.push(event);
-            this.statBuffer += currentEventSize;
-            // If it exceeds max size, don't append just send current payload.
-            if (exceedsMaxStatSize) {
-                this.flushStats();
-            }
-            else {
-                this.throttledSendStats();
+            this.addStatToQueue(event);
+        });
+    }
+    // this fn checks to see if the new stat fits inside the buffer. If not, send the queue;
+    addStatToQueue(stat) {
+        if (this.config.optOutOfWebrtcStatsTelemetry) {
+            return;
+        }
+        if (!stat.details._appId) {
+            stat.details._appId = this.logger.clientId;
+            stat.details._appName = 'streamingclient';
+            stat.details._appVersion = Client.version;
+        }
+        stat.details._originAppId = this.client.config.appId;
+        // nr only accepts single level objects so we must flatten everything just in case
+        const flattenedDetails = deepFlatten(stat.details);
+        // new relic doesn't accept booleans so we convert them to strings
+        Object.keys(flattenedDetails).forEach((key) => {
+            const val = flattenedDetails[key];
+            if (typeof val === 'boolean') {
+                flattenedDetails[key] = `${val}`;
             }
         });
+        const formattedStat = Object.assign(Object.assign({}, stat), { details: flattenedDetails });
+        const currentEventSize = calculatePayloadSize(formattedStat);
+        // Check if the size of the current event plus the size of the previous stats exceeds max size.
+        const exceedsMaxStatSize = this.statBuffer + currentEventSize > this.currentMaxStatSize;
+        this.statsArr.push(formattedStat);
+        this.statBuffer += currentEventSize;
+        // If it exceeds max size, don't append just send current payload.
+        if (exceedsMaxStatSize) {
+            this.flushStats();
+        }
+        else {
+            this.throttledSendStats();
+        }
     }
     getLogDetailsForPendingSessionId(sessionId) {
         const logDetails = {
@@ -400,6 +424,19 @@ export class WebrtcExtension extends EventEmitter {
             const loggingParams = { sessionId: sessionId, conversationId: msg.propose.conversationId, sessionType, isDuplicatePropose };
             this.logger.info('propose received', loggingParams);
             if (!isDuplicatePropose) {
+                const { appId } = this.client.config;
+                const proposeStat = {
+                    actionName: 'WebrtcStats',
+                    details: {
+                        _eventTimestamp: new Date().toISOString(),
+                        _eventType: 'firstPropose',
+                        conversationId: loggingParams.conversationId,
+                        sdpViaXmppRequested: !!msg.propose.sdpOverXmpp,
+                        sessionId: sessionId,
+                        sessionType: sessionType,
+                    }
+                };
+                this.addStatToQueue(proposeStat);
                 // TODO: is ofrom used?
                 // const roomJid = (msg.ofrom && msg.ofrom.full) || msg.from.full || msg.from;
                 const fromJid = msg.from;
@@ -731,6 +768,9 @@ export class WebrtcExtension extends EventEmitter {
         const stanzaSessions = stanzaSessionsObj && Object.values(stanzaSessionsObj) || [];
         return [...stanzaSessions, ...this.webrtcSessions];
     }
+    proxyNRStat(stat) {
+        this.addStatToQueue(stat);
+    }
     get expose() {
         return {
             on: this.on.bind(this),
@@ -748,7 +788,8 @@ export class WebrtcExtension extends EventEmitter {
             initiateRtcSession: this.initiateRtcSession.bind(this),
             getSessionTypeByJid: this.getSessionTypeByJid.bind(this),
             getSessionManager: this.getSessionManager.bind(this),
-            getAllSessions: this.getAllSessions.bind(this)
+            getAllSessions: this.getAllSessions.bind(this),
+            proxyNRStat: this.proxyNRStat.bind(this)
         };
     }
 }

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/v16.1.2...HEAD)
+### Added
+* [PCM-2276](https://inindca.atlassian.net/browse/PCM-2276) Added an function to proxy stats to nr from other apps like the webrtc sdk; Fixed some issues with nr stats gathering.
 
 # [v16.1.2](https://github.com/purecloudlabs/genesys-cloud-streaming-client/compare/v16.1.1...v16.1.2)
 ### Fixed

package/dist/npm/client.js

@@ -48,7 +48,8 @@ class Client extends events_1.default {
             jidResource: options.jidResource,
             channelId: null,
             appName: options.appName,
-            appVersion: options.appVersion
+            appVersion: options.appVersion,
+            appId: options.appId
         };
         this.backgroundAssistantMode = this.checkIsBackgroundAssistant();
         this.isGuest = !this.backgroundAssistantMode && !options.authToken;
@@ -433,7 +434,7 @@ class Client extends events_1.default {
         return Client.version;
     }
     static get version() {
-        return '16.1.3';
+        return '16.1.4';
     }
 }
 exports.Client = Client;

package/dist/npm/stats-formatter.d.ts

@@ -1,7 +1,6 @@
 import { StatsEvent } from 'webrtc-stats-gatherer';
-export declare function formatStatsEvent(event: StatsEvent, extraDetails?: any): {
-    actionName: string;
-    actionDate: number;
-    details: any;
-};
+import { FlatObject, InsightAction } from './types/interfaces';
+export declare function formatStatsEvent(event: StatsEvent, extraDetails?: FlatObject): InsightAction<{
+    _eventType: string;
+} & FlatObject>;
 export declare function deepFlatten(obj: any, prefix?: string): any;

package/dist/npm/stats-formatter.js

@@ -1,43 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deepFlatten = exports.formatStatsEvent = void 0;
+function isGetStatsEvent(event) {
+    return event.name === 'getStats';
+}
+function prepGetStatsEvent(event) {
+    let details = {};
+    Object.assign(details, deepFlatten(event.tracks, 'localTrack'));
+    delete event.tracks;
+    Object.assign(details, deepFlatten(event.remoteTracks, `remoteTrack`));
+    delete event.remoteTracks;
+    return details;
+}
 function formatStatsEvent(event, extraDetails = {}) {
-    let details;
-    const eventType = event.name;
-    if (event.name === 'connect') {
-        const e = event;
-        details = e;
-        Object.assign(details, deepFlatten(e.candidatePairDetails, 'candidatePairDetails'));
-        delete details.candidatePairDetails;
-    }
-    else if (event.name === 'getStats') {
-        const e = event;
-        details = e;
-        Object.assign(details, deepFlatten(e.tracks, 'localTrack'));
-        delete details.tracks;
-        Object.assign(details, deepFlatten(e.remoteTracks, `remoteTrack`));
-        delete details.remoteTracks;
-    }
-    else {
-        details = {};
-        if (event.name !== 'failure') {
-            // TODO: log this out when we get genesys-cloud-client-logger in place (allows logging from anywhere)
-        }
-        Object.assign(details, deepFlatten(event));
+    const details = {
+        _eventType: event.name,
+        _eventTimestamp: new Date().toISOString(),
+        ...extraDetails
+    };
+    // anything that needs to be renamed or massaged
+    if (isGetStatsEvent(event)) {
+        Object.assign(details, prepGetStatsEvent(event));
     }
+    // general case
+    Object.assign(details, deepFlatten(event));
     delete details.name;
-    Object.assign(details, extraDetails, { '_eventType': eventType });
-    // new relic doesn't accept booleans so we convert them to strings
-    Object.keys(details).forEach((key) => {
-        const val = details[key];
-        if (typeof val === 'boolean') {
-            details[key] = `${val}`;
-        }
-    });
     const formattedEvent = {
         actionName: 'WebrtcStats',
-        actionDate: Date.now(),
-        details
+        details,
     };
     return formattedEvent;
 }

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

@@ -186,3 +186,60 @@ export declare type HeadsetControlsRequest = TypedJsonRpcMessage<'headsetControl
 export declare type HeadsetControlsRejection = TypedJsonRpcMessage<'headsetControlsRejection', HeadsetControlsRejectionParams>;
 export declare type HeadsetControlsChanged = TypedJsonRpcMessage<'headsetControlsChanged', HeadsetControlsChangedParams>;
 export declare type GenesysMediaMessage = HeadsetControlsRequest | HeadsetControlsRejection | HeadsetControlsChanged;
+export declare type FlatObject = {
+    [key: string]: string | number | boolean | null | Date;
+};
+export declare type GenericAction = {
+    _eventType: string;
+};
+export declare type InsightReport = {
+    appName: string;
+    appVersion: string;
+    originAppName?: string;
+    originAppVersion?: string;
+    actions: InsightAction<any>[];
+};
+export declare type InsightAction<T extends {
+    _eventType: string;
+}> = {
+    actionName: 'WebrtcStats';
+    details: InsightActionDetails<T>;
+};
+export declare type InsightActionDetails<K extends {
+    _eventType: string;
+}> = {
+    _eventType: K['_eventType'];
+    /**
+     * This should be an ISO string
+     */
+    _eventTimestamp: string;
+    _appId?: string;
+    _appName?: string;
+    _appVersion?: string;
+} & K;
+export declare type FirstProposeStat = InsightAction<{
+    _eventType: 'firstPropose';
+    sdpViaXmppRequested: boolean;
+    sessionType: SessionTypesAsStrings;
+    originAppId?: string;
+    conversationId: string;
+    sessionId: string;
+}>;
+export declare type FirstAlertingConversationStat = InsightAction<{
+    _eventType: 'firstAlertingConversationUpdate';
+    conversationId: string;
+    participantId: string;
+}>;
+export declare type MediaStat = InsightAction<{
+    _eventType: 'mediaRequested' | 'mediaStarted' | 'mediaError';
+    requestId?: string;
+    message?: string;
+    audioRequested: boolean;
+    videoRequested: boolean;
+    displayRequested: boolean;
+    conversationId?: string;
+    sessionType?: SessionTypesAsStrings;
+    sessionId?: string;
+    elapsedMsFromInitialRequest?: number;
+}>;
+export declare type NRProxyStat = FirstAlertingConversationStat | MediaStat;

package/dist/npm/webrtc.d.ts

@@ -4,7 +4,7 @@ import { IQ } from 'stanza/protocol';
 import { SessionManager } from 'stanza/jingle';
 import { SessionOpts } from 'stanza/jingle/Session';
 import { Client } from './client';
-import { ExtendedRTCIceServer, IClientOptions, SessionTypes, IPendingSession, StreamingClientExtension } from './types/interfaces';
+import { ExtendedRTCIceServer, IClientOptions, SessionTypes, IPendingSession, StreamingClientExtension, NRProxyStat, InsightAction } from './types/interfaces';
 import { NamedAgent } from './types/named-agent';
 import { StanzaMediaSession } from './types/stanza-media-session';
 import { IMediaSession } from './types/media-session';
@@ -54,6 +54,9 @@ export declare class WebrtcExtension extends EventEmitter implements StreamingCl
     handleGenesysWebrtcStanza(iq: IQ): Promise<boolean | void>;
     prepareSession(options: SessionOpts): StanzaMediaSession | undefined;
     proxyStatsForSession(session: IMediaSession): void;
+    addStatToQueue<T extends {
+        _eventType: string;
+    }>(stat: InsightAction<T>): void;
     getLogDetailsForPendingSessionId(sessionId: string): {
         conversationId?: string;
         sessionId: string;
@@ -89,6 +92,7 @@ export declare class WebrtcExtension extends EventEmitter implements StreamingCl
     getSessionTypeByJid(jid: string): SessionTypes;
     getSessionManager(): SessionManager | undefined;
     getAllSessions(): IMediaSession[];
+    proxyNRStat(stat: NRProxyStat): void;
     get expose(): WebrtcExtensionAPI;
 }
 export interface WebrtcExtensionAPI {
@@ -108,4 +112,5 @@ export interface WebrtcExtensionAPI {
     getSessionTypeByJid(jid: string): SessionTypes;
     getSessionManager: () => SessionManager | undefined;
     getAllSessions: () => IMediaSession[];
+    proxyNRStat: (stat: NRProxyStat) => void;
 }

package/dist/npm/webrtc.js

@@ -162,6 +162,7 @@ class WebrtcExtension extends events_1.EventEmitter {
         }
         const session = new genesys_cloud_media_session_1.GenesysCloudMediaSession(this, mediaSessionParams);
         await session.setRemoteDescription(params.sdp);
+        this.proxyStatsForSession(session);
         session.on('sendIq', (iq) => { var _a; return (_a = this.stanzaInstance) === null || _a === void 0 ? void 0 : _a.sendIQ(iq); });
         session.on('terminated', () => {
             this.webrtcSessions = this.webrtcSessions.filter(s => s.id !== session.id);
@@ -262,25 +263,51 @@ class WebrtcExtension extends events_1.EventEmitter {
             }
             const statsCopy = JSON.parse(JSON.stringify(statsEvent));
             const extraDetails = {
-                conference: session.conversationId,
-                session: session.id,
+                conversationId: session.conversationId,
+                sessionId: session.id,
                 sessionType: session.sessionType
             };
             // format the event to what the api expects
             const event = stats_formatter_1.formatStatsEvent(statsCopy, extraDetails);
-            const currentEventSize = utils_1.calculatePayloadSize(event);
-            // Check if the size of the current event plus the size of the previous stats exceeds max size.
-            const exceedsMaxStatSize = this.statBuffer + currentEventSize > this.currentMaxStatSize;
-            this.statsArr.push(event);
-            this.statBuffer += currentEventSize;
-            // If it exceeds max size, don't append just send current payload.
-            if (exceedsMaxStatSize) {
-                this.flushStats();
-            }
-            else {
-                this.throttledSendStats();
+            this.addStatToQueue(event);
+        });
+    }
+    // this fn checks to see if the new stat fits inside the buffer. If not, send the queue;
+    addStatToQueue(stat) {
+        if (this.config.optOutOfWebrtcStatsTelemetry) {
+            return;
+        }
+        if (!stat.details._appId) {
+            stat.details._appId = this.logger.clientId;
+            stat.details._appName = 'streamingclient';
+            stat.details._appVersion = client_1.Client.version;
+        }
+        stat.details._originAppId = this.client.config.appId;
+        // nr only accepts single level objects so we must flatten everything just in case
+        const flattenedDetails = stats_formatter_1.deepFlatten(stat.details);
+        // new relic doesn't accept booleans so we convert them to strings
+        Object.keys(flattenedDetails).forEach((key) => {
+            const val = flattenedDetails[key];
+            if (typeof val === 'boolean') {
+                flattenedDetails[key] = `${val}`;
             }
         });
+        const formattedStat = {
+            ...stat,
+            details: flattenedDetails
+        };
+        const currentEventSize = utils_1.calculatePayloadSize(formattedStat);
+        // Check if the size of the current event plus the size of the previous stats exceeds max size.
+        const exceedsMaxStatSize = this.statBuffer + currentEventSize > this.currentMaxStatSize;
+        this.statsArr.push(formattedStat);
+        this.statBuffer += currentEventSize;
+        // If it exceeds max size, don't append just send current payload.
+        if (exceedsMaxStatSize) {
+            this.flushStats();
+        }
+        else {
+            this.throttledSendStats();
+        }
     }
     getLogDetailsForPendingSessionId(sessionId) {
         const logDetails = {
@@ -388,6 +415,19 @@ class WebrtcExtension extends events_1.EventEmitter {
         const loggingParams = { sessionId: sessionId, conversationId: msg.propose.conversationId, sessionType, isDuplicatePropose };
         this.logger.info('propose received', loggingParams);
         if (!isDuplicatePropose) {
+            const { appId } = this.client.config;
+            const proposeStat = {
+                actionName: 'WebrtcStats',
+                details: {
+                    _eventTimestamp: new Date().toISOString(),
+                    _eventType: 'firstPropose',
+                    conversationId: loggingParams.conversationId,
+                    sdpViaXmppRequested: !!msg.propose.sdpOverXmpp,
+                    sessionId: sessionId,
+                    sessionType: sessionType,
+                }
+            };
+            this.addStatToQueue(proposeStat);
             // TODO: is ofrom used?
             // const roomJid = (msg.ofrom && msg.ofrom.full) || msg.from.full || msg.from;
             const fromJid = msg.from;
@@ -706,6 +746,9 @@ class WebrtcExtension extends events_1.EventEmitter {
         const stanzaSessions = stanzaSessionsObj && Object.values(stanzaSessionsObj) || [];
         return [...stanzaSessions, ...this.webrtcSessions];
     }
+    proxyNRStat(stat) {
+        this.addStatToQueue(stat);
+    }
     get expose() {
         return {
             on: this.on.bind(this),
@@ -723,7 +766,8 @@ class WebrtcExtension extends events_1.EventEmitter {
             initiateRtcSession: this.initiateRtcSession.bind(this),
             getSessionTypeByJid: this.getSessionTypeByJid.bind(this),
             getSessionManager: this.getSessionManager.bind(this),
-            getAllSessions: this.getAllSessions.bind(this)
+            getAllSessions: this.getAllSessions.bind(this),
+            proxyNRStat: this.proxyNRStat.bind(this)
         };
     }
 }