[STREAM-1180] If media handling is downgrading with an active conversation, fallback to reducedMediaHeadsets

Author: hjon

src/client.ts

@@ -876,7 +876,7 @@ export class GenesysCloudWebrtcSdk extends (EventEmitter as { new(): StrictEvent
    * @param mediaHandling how softphone media should be handled
    */
   setMediaHandling (mediaHandling: MediaHandling): void {
-    const useHeadsets = !(mediaHandling === MediaHandling.reducedMediaNoHeadsets);
+    const useHeadsets = !(mediaHandling === MediaHandling.reducedMedia);
 
     if (!this.sessionManager) {
       this._mediaHandling = mediaHandling;
@@ -887,13 +887,15 @@ export class GenesysCloudWebrtcSdk extends (EventEmitter as { new(): StrictEvent
     const activeConversations = this.sessionManager.getAllActiveConversations();
 
     if (activeConversations.length !== 0 && !useHeadsets) {
+      this._mediaHandling = MediaHandling.reducedMediaHeadsets;
+      this.setUseHeadsets(true);
       throw createAndEmitSdkError.call(this, SdkErrorTypes.not_supported, 'Cannot downgrade media handling to stop using headsets during an active call');
     }
 
     this._mediaHandling = mediaHandling;
     this.setUseHeadsets(useHeadsets);
 
-    const reduceMediaHandling = mediaHandling === MediaHandling.reducedMediaHeadsets || mediaHandling === MediaHandling.reducedMediaNoHeadsets;
+    const reduceMediaHandling = mediaHandling === MediaHandling.reducedMediaHeadsets || mediaHandling === MediaHandling.reducedMedia;
     if (reduceMediaHandling) {
       const conversationSessionIds = activeConversations.map(conversation => conversation.sessionId);
       // Disconnect connections that aren't associated with an active conversation.

src/headsets/headset.ts

@@ -49,8 +49,8 @@ export class HeadsetProxyService implements ISdkHeadsetService {
     // TODO: PCM-2060 - remove this
     this.useHeadsetOrchestration = !this.sdk._config.disableHeadsetControlsOrchestration;
 
-    if (this.sdk._mediaHandling === MediaHandling.reducedMediaNoHeadsets) {
-      this.sdk.logger.warn('setUseHeadsets was called with `true` but media handling is set to `reducedMediaNoHeadsets`; headsets are not supported in this configuration - not handling media. Not activating headsets.');
+    if (this.sdk._mediaHandling === MediaHandling.reducedMedia) {
+      this.sdk.logger.warn('setUseHeadsets was called with `true` but media handling is set to `reducedMedia`; headsets are not supported in this configuration - not handling media. Not activating headsets.');
       useHeadsets = false;
     }
 

src/sessions/softphone-session-handler.ts

@@ -150,7 +150,7 @@ export class SoftphoneSessionHandler extends BaseSessionHandler {
     const isPrivAnswerAuto = pendingSession.privAnswerMode === 'Auto';
     const eagerConnectionEstablishmentMode = this.sdk._config.eagerPersistentConnectionEstablishment;
     const logInfo = { sessionId: pendingSession?.id, conversationId: pendingSession.conversationId };
-    const reducedMediaHandling = this.sdk._mediaHandling === MediaHandling.reducedMediaHeadsets || this.sdk._mediaHandling === MediaHandling.reducedMediaNoHeadsets;
+    const reducedMediaHandling = this.sdk._mediaHandling === MediaHandling.reducedMediaHeadsets || this.sdk._mediaHandling === MediaHandling.reducedMedia;
 
     if (reducedMediaHandling) {
       this.log('info', 'received a propose while the SDK is configured for reduced media handling', logInfo);

src/types/enums.ts

@@ -52,19 +52,19 @@ export enum MediaHandling {
   /** Handle all media; headset controls follow alerting leader */
   alertingLeaderMedia = 'alerting-leader-media',
   /**
-   * Handle some media (see below); headset controls use traditional orchestration
+   * Handle some media (see below); headset controls are not used
    *
    * - New eager persistent connections will be ignored.
    * - Auto-answer calls will be handled, which could result in a
    * persistent connection being established.
    */
-  reducedMediaHeadsets = 'reduced-media-headsets',
+  reducedMedia = 'reduced-media',
   /**
-   * Handle some media (see below); headset controls are not used
+   * Internal use only. Handle some media (see below); headset controls use traditional orchestration.
    *
    * - New eager persistent connections will be ignored.
    * - Auto-answer calls will be handled, which could result in a
    * persistent connection being established.
    */
-  reducedMediaNoHeadsets = 'reduced-media-no-headsets',
+  reducedMediaHeadsets = 'reduced-media-headsets',
 }

test/unit/client.test.ts

@@ -1174,15 +1174,15 @@ describe('Client', () => {
       expect(useHeadsetsSpy).toHaveBeenCalledWith(true);
     });
 
-    it('should throw if media handling will not use headsets but there is an active conversation', () => {
+    it('should throw and reduce media handling if new media handling will not use headsets but there is an active conversation', () => {
       sdk = constructSdk();
       const conversations = [{ conversationId: 'test-conversation-id' }] as IActiveConversationDescription[];
       sessionManagerMock.getAllActiveConversations.mockReturnValue(conversations);
 
       expect(() => {
-        sdk.setMediaHandling(MediaHandling.reducedMediaNoHeadsets);
+        sdk.setMediaHandling(MediaHandling.reducedMedia);
       }).toThrow();
-      expect(sdk._mediaHandling).toBe(MediaHandling.standardMedia);
+      expect(sdk._mediaHandling).toBe(MediaHandling.reducedMediaHeadsets);
     });
 
     it('should disconnect any sessions not connected to an active conversation when set to a reduced handling of media', () => {

test/unit/headset/headset.test.ts

@@ -301,8 +301,8 @@ describe('HeadsetProxyService', () => {
       expect(proxyService['currentHeadsetService']).toBeInstanceOf(SdkHeadsetServiceFake);
     });
 
-    it('should use fake service if useHeadsets and media is set to reducedMediaNoHeadsets', () => {
-      proxyService['sdk']._mediaHandling = MediaHandling.reducedMediaNoHeadsets;
+    it('should use fake service if useHeadsets and media is set to reducedMedia', () => {
+      proxyService['sdk']._mediaHandling = MediaHandling.reducedMedia;
       const spy = jest.spyOn(proxyService, 'updateAudioInputDevice');
 
       proxyService.setUseHeadsets(true);

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

@@ -84,7 +84,7 @@ describe('handlePropose()', () => {
     expect(superSpyHandlePropose).not.toHaveBeenCalled();
     expect(superSpyProceed).not.toHaveBeenCalled();
 
-    mockSdk._mediaHandling = MediaHandling.reducedMediaNoHeadsets;
+    mockSdk._mediaHandling = MediaHandling.reducedMedia;
     await handler.handlePropose(pendingSession);
     expect(spy).not.toHaveBeenCalled();
     expect(superSpyHandlePropose).not.toHaveBeenCalled();
@@ -116,7 +116,7 @@ describe('handlePropose()', () => {
     mockSdk._config.disableAutoAnswer = false;
     const pendingSession = createPendingSession(SessionTypes.softphone);
     pendingSession.autoAnswer = true;
-    mockSdk._mediaHandling = MediaHandling.reducedMediaNoHeadsets;
+    mockSdk._mediaHandling = MediaHandling.reducedMedia;
 
     await handler.handlePropose(pendingSession);