[STREAM-978] - Filter out voicemail participants from conversation update events. Fix potential TypeError when fetching conversations. (#950)

Author: zservies

changelog.md

@@ -5,6 +5,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # [Unreleased](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.2...HEAD)
 ### Fixed
+* [STREAM-978](https://inindca.atlassian.net/browse/STREAM-978) - When the RTCPeerConnection is in a 'failed' state, clean up the session. Filter out voicemail participants from conversation update events. Fix potential TypeError when fetching conversations.
 * [STREAM-987](https://inindca.atlassian.net/browse/STREAM-987) - Demo app: Memoize conversations so they don't change every render when nothing has changed
 
 # [v11.3.2](https://github.com/MyPureCloud/genesys-cloud-webrtc-sdk/compare/v11.3.1...v11.3.2)

src/sessions/base-session-handler.ts

@@ -114,6 +114,12 @@ export default abstract class BaseSessionHandler {
       if (state === 'interrupted') {
         this.sdk.emit('sessionInterrupted', { sessionId: session.id, sessionType: session.sessionType, conversationId: session.conversationId });
       }
+
+      /* If the RTCPeerConnection is in a 'failed' state, it is a state of finality and we need to clean up the session. */
+      if (state === 'failed') {
+        this.log('warn', 'RTCPeerConnection failed. Cleaning up session.', { state, conversationId: session.conversationId, sid: session.id, sessionType: session.sessionType });
+        this.forceEndSession(session, Constants.JingleReasonCondition.FailedTransport);
+      }
     });
 
     session.on('terminated', this.onSessionTerminated.bind(this, session));

src/sessions/softphone-session-handler.ts

@@ -185,7 +185,7 @@ export class SoftphoneSessionHandler extends BaseSessionHandler {
   getActiveConversations (): IActiveConversationDescription[] {
     const currentConversations = this.lastEmittedSdkConversationEvent?.current || [];
 
-    return currentConversations.map(currentConvo => ({ conversationId: currentConvo.conversationId, sessionId: currentConvo.session.id, sessionType: this.sessionType }));
+    return currentConversations.map(currentConvo => ({ conversationId: currentConvo.conversationId, sessionId: currentConvo.session?.id, sessionType: this.sessionType }));
   }
 
   handleSoftphoneConversationUpdate (update: ConversationUpdate, participant: IConversationParticipantFromEvent, callState: ICallStateFromParticipant, session?: IExtendedMediaSession): void {
@@ -500,7 +500,8 @@ export class SoftphoneSessionHandler extends BaseSessionHandler {
       return;
     }
 
-    const participantsForUser = update.participants.filter(p => p.userId === this.sdk._personDetails.id).reverse();
+    // Filter out voicemail participants - user ID can appear multiple times with different purposes.
+    const participantsForUser = update.participants.filter((p) => p.userId === this.sdk._personDetails.id && p.purpose !== 'voicemail').reverse();
     let participant: IConversationParticipantFromEvent;
 
     if (!participantsForUser.length) {

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

@@ -542,6 +542,27 @@ describe('handleSessionInit', () => {
     expect(eventSpy).toHaveBeenCalled();
   });
 
+  it('should terminate session when connectionState becomes failed', async () => {
+    const session: any = new MockSession();
+    const forceEndSessionSpy = jest.spyOn(handler, 'forceEndSession');
+    const logSpy = jest.spyOn(handler, 'log' as any);
+
+    session.id = '123abc';
+    session.conversationId = 'convoabc';
+    session.state = 'active';
+
+    await handler.handleSessionInit(session);
+    session.emit('connectionState', 'failed');
+
+    expect(logSpy).toHaveBeenCalledWith('warn', 'RTCPeerConnection failed. Cleaning up session.', {
+      state: 'failed',
+      conversationId: session.conversationId,
+      sid: session.id,
+      sessionType: session.sessionType
+    });
+    expect(forceEndSessionSpy).toHaveBeenCalledWith(session, 'failed-transport');
+  });
+
   it('should set conversationId and fromUserId on existing pendingSession and emit sessionStarted', async () => {
     const session: any = new MockSession();
     session.conversationId = null;

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

@@ -1888,6 +1888,39 @@ describe('getUserParticipantFromConversationEvent()', () => {
   it('should return the most recent participant if there are no calls on any of them', () => {
     expect(handler.getUserParticipantFromConversationEvent(converversationUpdate)).toEqual(participant2);
   });
+
+  it('should filter out voicemail participants and only return non-voicemail participants', () => {
+    const userParticipant: IConversationParticipantFromEvent = {
+      id: '3a843139-760b-41d8-8ac1-723ac2381280',
+      purpose: 'user',
+      userId,
+      videos: [],
+      calls: [{ ...call, state: CommunicationStates.connected }]
+    };
+
+    const voicemailParticipant: IConversationParticipantFromEvent = {
+      id: '3a843140-760b-41d8-8ac1-723ac2381290',
+      purpose: 'voicemail',
+      userId,
+      videos: [],
+      calls: []
+    };
+
+    const externalParticipant: IConversationParticipantFromEvent = {
+      id: 'dcec146d-52f2-4593-874d-d13f1bc3183d',
+      purpose: 'external',
+      userId: '1234',
+      videos: [],
+      calls: [{ ...call, state: CommunicationStates.connected }]
+    };
+
+    converversationUpdate.participants = [externalParticipant, userParticipant, voicemailParticipant];
+
+    const result = handler.getUserParticipantFromConversationEvent(converversationUpdate);
+    expect(result).toEqual(userParticipant);
+    expect(result?.purpose).toBe('user');
+    expect(result?.id).toBe('3a843139-760b-41d8-8ac1-723ac2381280');
+  });
 });
 
 describe('getCallStateFromParticipant()', () => {