Release/v11.3.3 (#948)

Co-authored-by: PureCloud Jenkins <jenkins@genesys.com>
Co-authored-by: Victor <wang_shaojie@icloud.com>
Co-authored-by: Jon Hjelle <hjon@users.noreply.github.com>
Co-authored-by: Zachary Servies <zachservies@gmail.com>
Co-authored-by: Aidan Zimmermann <aidan.zimmermann@genesys.com>
Co-authored-by: Aidan Zimmermann <aidan.zimmermann@gmail.com>
Co-authored-by: Nils <nils.mak@aginsurance.be>

Author: 8 people

changelog.md

@@ -3,7 +3,11 @@ 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/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.2...HEAD)
+# [Unreleased](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.3...HEAD)
+
+# [v11.3.3](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.2...v11.3.3)
+#### Changed
+* [#937] - Exposes raw webmessage data from conversation topic
 
 # [v11.3.2](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.1...v11.3.2)
 ### Changed

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "genesys-cloud-webrtc-sdk",
-  "version": "11.3.2",
+  "version": "11.3.3",
   "description": "client for the interfacing with Genesys Cloud WebRTC",
   "repository": "https://github.com/mypurecloud/genesys-cloud-webrtc-sdk",
   "license": "MIT",

package.json

@@ -113,6 +113,7 @@ export async function proxyStreamingClientEvents (this: GenesysCloudWebrtcSdk):
 export const handleConversationUpdate = function (this: GenesysCloudWebrtcSdk, updateEvent: SubscriptionEvent) {
   const update = new ConversationUpdate(updateEvent.eventBody);
   this.sessionManager.handleConversationUpdate(update);
+  this.sessionManager.handleConversationUpdateRaw(updateEvent);
 };
 
 export const handleDisconnectedEvent = function (this: GenesysCloudWebrtcSdk, eventData: { reconnecting: boolean }) {

src/client-private.ts

@@ -17,6 +17,7 @@ import {
   IUpdateOutgoingMedia,
   IConversationHeldRequest,
   IActiveConversationDescription,
+  SubscriptionEvent,
 } from '../types/interfaces';
 
 type ExtendedHTMLAudioElement = HTMLAudioElement & {
@@ -46,6 +47,10 @@ export default abstract class BaseSessionHandler {
 
   abstract handleConversationUpdate (update: ConversationUpdate, sessions: IExtendedMediaSession[]): void;
 
+  handleConversationUpdateRaw (update: SubscriptionEvent): void {
+    this.sdk.emit('conversationUpdateRaw', update);
+  }
+
   protected log (level: LogLevels, message: any, details?: any, logOptions?: ILogMessageOptions): void {
     this.sdk.logger[level].call(this.sdk.logger, message, details, logOptions);
   }

src/sessions/base-session-handler.ts

@@ -21,7 +21,8 @@ import {
   IConversationHeldRequest,
   IPendingSessionActionParams,
   VideoMediaSession,
-  IActiveConversationDescription
+  IActiveConversationDescription,
+  SubscriptionEvent
 } from '../types/interfaces';
 import { ConversationUpdate } from '../conversations/conversation-update';
 import { SessionTypesAsStrings } from 'genesys-cloud-streaming-client';
@@ -74,6 +75,15 @@ export class SessionManager {
       );
   }
 
+  handleConversationUpdateRaw (update: SubscriptionEvent): void {
+    /* let each enabled handler process updates */
+    this.sessionHandlers
+      .filter(handler => !handler.disabled)
+      .forEach(handler =>
+        handler.handleConversationUpdateRaw(update)
+      );
+  }
+
   getPendingSession (params: { conversationId?: string, sessionId?: string, sessionType?: SessionTypes | SessionTypesAsStrings }): IPendingSession | undefined {
     const session = this.pendingSessions
       .find(s => {

src/sessions/session-manager.ts

@@ -1020,6 +1020,7 @@ export interface SdkEvents {
   handledPendingSession: ISessionIdAndConversationId;
   cancelPendingSession: ISessionIdAndConversationId;
   conversationUpdate: ISdkConversationUpdateEvent;
+  conversationUpdateRaw: SubscriptionEvent;
   station: (event: { action: 'Associated' | 'Disassociated', station: IStation | null }) => void;
   concurrentSoftphoneSessionsEnabled: boolean; // lineAppearence > 1
   resolutionUpdated: IResolutionChange

src/types/interfaces.ts

@@ -89,8 +89,8 @@ describe('setupStreamingClient', () => {
 
 describe('handleConversationUpdate', () => {
   it('should call sessionManager.handleConversationUpdate with the transformed event', () => {
-    mockSdk.sessionManager = { handleConversationUpdate: jest.fn() } as any;
-
+    mockSdk.sessionManager = { handleConversationUpdateRaw: jest.fn(), handleConversationUpdate: jest.fn() } as any;
+    
     const userId = '444kjskdk';
     const participant1 = {
       id: '7b809e10-fb79-4420-9d5f-69d232ddf490',
@@ -146,6 +146,65 @@ describe('handleConversationUpdate', () => {
   });
 });
 
+describe('handleConversationUpdateRaw', () => {
+  it('should call sessionManager.handleConversationUpdateRaw with the event', () => {
+    mockSdk.sessionManager = { handleConversationUpdateRaw: jest.fn(), handleConversationUpdate: jest.fn() } as any;
+
+    const userId = '444kjskdk';
+    const participant1 = {
+      id: '7b809e10-fb79-4420-9d5f-69d232ddf490',
+      userId: 'dad93e0d-31fa-4fd2-8fc4-d9d3f214ddcf',
+      purpose: 'user',
+      videos: [
+        {
+          state: CommunicationStates.connected,
+          id: '5e2bf9b8-c9d5-4975-b89b-756b6bd0b3d5',
+          context: '5d1130ff978496186c5ce304@conference.test-valve-1ym37mj1kao.orgspan.com',
+          audioMuted: false,
+          videoMuted: true,
+          sharingScreen: false,
+          peerCount: 0
+        }
+      ]
+    };
+
+    const local = {
+      id: '7sdffs-4420-9d5f-69d232ddf490',
+      userId,
+      purpose: 'user',
+      videos: [
+        {
+          state: CommunicationStates.connected,
+          id: '5e2bf9b855125-b89b-756b6bd0b3d5',
+          context: '5d1130ff978496186c5ce304@conference.test-valve-1ym37mj1kao.orgspan.com',
+          audioMuted: false,
+          videoMuted: true,
+          sharingScreen: false,
+          peerCount: 0
+        }
+      ]
+    };
+
+    const event: SubscriptionEvent = {
+      eventBody: {
+        id: 'ff5a3ba2-373b-42c7-912a-5309a2656095',
+        participants: [participant1, local]
+      },
+      metadata: {
+        correlationId: '11l2k31j'
+      },
+      topicName: `v2.users.${userId}.coversations`
+    };
+
+    handleConversationUpdate.call(mockSdk, event);
+
+    const spy = mockSdk.sessionManager.handleConversationUpdateRaw;
+    expect(spy).toHaveBeenCalled();
+    const arg = (spy as jest.Mock).mock.calls[0][0];
+    expect(arg).toEqual(event);
+  });
+});
+
 describe('handleDisconnectedEvent', () => {
   it('should emit disconnected event with message and eventData', () => {
     const eventData = { reconnecting: true };

test/unit/client-private.test.ts

@@ -466,6 +466,9 @@ describe('handleConversationUpdate', () => {
   it('nothing to test', () => {
     handler.handleConversationUpdate({} as any, {} as any);
   });
+  it('nothing to test', () => {
+    handler.handleConversationUpdateRaw({} as any);
+  });
 });
 
 describe('handlePropose', () => {

test/unit/sessions/base-session-handler.test.ts

@@ -141,6 +141,37 @@ describe('handleConversationUpdate', () => {
   });
 });
 
+describe('handleConversationUpdateRaw', () => {
+  it('should find all session that match the sessionType and call the associated handlers', () => {
+    const conversationId = 'convoid123';
+
+    const spy = jest.fn();
+    const fakeHandler = { handleConversationUpdateRaw: spy, sessionType: SessionTypes.collaborateVideo };
+    sessionManager.sessionHandlers = [fakeHandler] as any;
+
+    const fakeUpdate = {
+      id: conversationId
+    };
+    sessionManager.handleConversationUpdateRaw(fakeUpdate as any);
+    expect(spy).toBeCalledTimes(1);
+    expect(spy).toHaveBeenCalledWith(fakeUpdate);
+  });
+
+  it('should not pass update to handler if the handler is disabled', async () => {
+    const conversationId = 'convoid123'; 
+
+    const spy = jest.fn();
+    const fakeHandler = { handleConversationUpdateRaw: spy, disabled: true };
+    sessionManager.sessionHandlers = [fakeHandler] as any;
+
+    const fakeUpdate = {
+      id: conversationId
+    };
+    sessionManager.handleConversationUpdateRaw(fakeUpdate as any);
+    expect(spy).not.toHaveBeenCalled();
+  });
+});
+
 describe('getSession', () => {
   let session1: any;
   let session2: any;
@@ -913,7 +944,7 @@ describe('validateOutgoingMediaTracks()', () => {
     setMediaStateDevices(testDevices);
     mediaState = mockSdk.media.getState();
 
-    mockGetSessionById = jest.spyOn(sessionManager, 'getSessionBySessionId').mockImplementation((id) => sessions.find(s => s.id === id));
+    mockGetSessionById = jest.spyOn(sessionManager, 'getSessionBySessionId').mockImplementation((id) => sessions.find(s => s.id === id)!);
     mockGetSessionHandler = jest.spyOn(sessionManager, 'getSessionHandler').mockReturnValue(mockSessionHandler as any);
   });