Merge pull request #987 from MyPureCloud/STREAM-781

STREAM-781: only hold active conversations

Author: AidanWZ

changelog.md

@@ -9,8 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 * [STREAM-905](https://inindca.atlassian.net/browse/STREAM-905) - Fix issue where `sessionStarted` was not emitted for calls that re-use persistent connections after a media recovery has occurred. Now initializing `_emittedSessionStarteds` for reinvites but only emitting if not a reinvite.
-
 * [STREAM-1123](https://inindca.atlassian.net/browse/STREAM-1123) - Only update necessary tracks when changing devices. Prevent virtual background from getting replaced
+* [STREAM-781](https://inindca.atlassian.net/browse/STREAM-781) - Fix issue where hold caused `Unhandled promise rejection from setConversationHeld` for inactive conversations.
 
 ### Changed
 * [STREAM-1211](https://inindca.atlassian.net/browse/STREAM-1178) - Update `axios` to `v1.13.5`.

src/sessions/softphone-session-handler.ts

@@ -901,16 +901,25 @@ export class SoftphoneSessionHandler extends BaseSessionHandler {
     * connection that will attempt to hold the previous ended call
     */
     const otherSessions = sessions.filter(session => {
+      const convo = this.conversations[session.conversationId];
       return session.sessionType === SessionTypes.softphone &&
-        this.conversations[session.conversationId] &&
+        convo &&
         !this.isConversationHeld(session.conversationId) &&
+        !this.isEndedState(convo.mostRecentCallState) &&
         session !== currentSession;
     });
 
     this.log('debug', 'Received new session or unheld previously held session with LA>1, holding other active sessions.');
 
     otherSessions.forEach(session => {
       this.setConversationHeld(session, { conversationId: session.conversationId, held: true })
+        .catch(err => {
+          this.log('warn', 'Failed to hold other session during holdOtherSessions', {
+            sessionId: session.id,
+            conversationId: session.conversationId,
+            error: err
+          });
+        });
     });
   }
 

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

@@ -621,7 +621,7 @@ describe('acceptSession()', () => {
   });
 
   it('should hold other sessions if LA>1', () => {
-    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockImplementation();
+    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockResolvedValue(undefined);
     const getActiveSessionsSpy = jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue(sessionsArray);
     const mockAudioElement = {} as HTMLAudioElement;
     jest.spyOn(BaseSessionHandler.prototype, 'acceptSession');
@@ -650,7 +650,7 @@ describe('acceptSession()', () => {
   });
 
   it('should NOT hold other sessions if LA>1 and we are establishing an eager persistent connection', () => {
-    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockImplementation();
+    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockResolvedValue(undefined);
     const getActiveSessionsSpy = jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue(sessionsArray);
     const mockAudioElement = {} as HTMLAudioElement;
     jest.spyOn(BaseSessionHandler.prototype, 'acceptSession');
@@ -2451,6 +2451,105 @@ describe('setConversationHeld()', () => {
   });
 });
 
+describe('holdOtherSessions()', () => {
+  let currentSession: IExtendedMediaSession;
+  let otherSession: IExtendedMediaSession;
+
+  beforeEach(() => {
+    currentSession = new MockSession(SessionTypes.softphone) as any;
+    otherSession = new MockSession(SessionTypes.softphone) as any;
+    otherSession.sessionType = SessionTypes.softphone;
+  });
+
+  it('should call setConversationHeld for other active softphone sessions', () => {
+    jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue([currentSession, otherSession]);
+    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockResolvedValue(undefined);
+
+    handler.conversations = {
+      [currentSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+      [otherSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+    };
+
+    handler.holdOtherSessions(currentSession);
+
+    expect(setHoldSpy).toHaveBeenCalledWith(otherSession, { conversationId: otherSession.conversationId, held: true });
+    expect(setHoldSpy).not.toHaveBeenCalledWith(currentSession, expect.anything());
+  });
+
+  it('should not attempt to hold sessions with ended conversation states', () => {
+    const endedSession = new MockSession(SessionTypes.softphone) as any;
+    endedSession.sessionType = SessionTypes.softphone;
+
+    jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue([currentSession, otherSession, endedSession]);
+    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockResolvedValue(undefined);
+
+    handler.conversations = {
+      [currentSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+      [otherSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+      [endedSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.disconnected, held: false } } as any,
+    };
+
+    handler.holdOtherSessions(currentSession);
+
+    expect(setHoldSpy).toHaveBeenCalledWith(otherSession, { conversationId: otherSession.conversationId, held: true });
+    expect(setHoldSpy).not.toHaveBeenCalledWith(endedSession, expect.anything());
+  });
+
+  it('should not attempt to hold sessions with terminated conversation states', () => {
+    jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue([currentSession, otherSession]);
+    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockResolvedValue(undefined);
+
+    handler.conversations = {
+      [currentSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+      [otherSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.terminated, held: false } } as any,
+    };
+
+    handler.holdOtherSessions(currentSession);
+
+    expect(setHoldSpy).not.toHaveBeenCalled();
+  });
+
+  it('should log a warning and not throw if setConversationHeld rejects', async () => {
+    jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue([currentSession, otherSession]);
+    const error = new Error('Bad Request');
+    jest.spyOn(handler, 'setConversationHeld').mockRejectedValue(error);
+
+    handler.conversations = {
+      [currentSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+      [otherSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+    };
+
+    // should not throw
+    handler.holdOtherSessions(currentSession);
+
+    // flush the microtask queue so the .catch() handler runs
+    await flushPromises();
+
+    expect(mockSdk.logger.warn).toHaveBeenCalledWith(
+      expect.stringContaining('Failed to hold other session during holdOtherSessions'),
+      expect.objectContaining({
+        sessionId: otherSession.id,
+        conversationId: otherSession.conversationId,
+      }),
+      undefined
+    );
+  });
+
+  it('should not attempt to hold sessions that are already held', () => {
+    jest.spyOn(mockSessionManager, 'getAllActiveSessions').mockReturnValue([currentSession, otherSession]);
+    const setHoldSpy = jest.spyOn(handler, 'setConversationHeld').mockResolvedValue(undefined);
+
+    handler.conversations = {
+      [currentSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: false } } as any,
+      [otherSession.conversationId]: { mostRecentCallState: { state: CommunicationStates.connected, held: true } } as any,
+    };
+
+    handler.holdOtherSessions(currentSession);
+
+    expect(setHoldSpy).not.toHaveBeenCalled();
+  });
+});
+
 describe('patchPhoneCall()', () => {
   it('should patch a phone call', async () => {
     const conversationId = 'talking-buddies';