@webex/plugin-meetings 3.7.0-next.32 → 3.7.0-next.34

package/src/meeting/index.ts

@@ -161,6 +161,7 @@ import {LocusMediaRequest} from './locusMediaRequest';
 import {ConnectionStateHandler, ConnectionStateEvent} from './connectionStateHandler';
 import JoinWebinarError from '../common/errors/join-webinar-error';
 import Member from '../member';
+import MultistreamNotSupportedError from '../common/errors/multistream-not-supported-error';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -4627,11 +4628,12 @@ export default class Meeting extends StatelessWebexPlugin {
    * Close the peer connections and remove them from the class.
    * Cleanup any media connection related things.
    *
+   * @param {boolean} resetMuteStates whether to also reset the audio/video mute state information
    * @returns {Promise}
    * @public
    * @memberof Meeting
    */
-  public closePeerConnections() {
+  public closePeerConnections(resetMuteStates = true) {
     if (this.mediaProperties.webrtcMediaConnection) {
       if (this.remoteMediaManager) {
         this.remoteMediaManager.stop();
@@ -4648,8 +4650,10 @@ export default class Meeting extends StatelessWebexPlugin {
       this.setNetworkStatus(undefined);
     }
 
-    this.audio = null;
-    this.video = null;
+    if (resetMuteStates) {
+      this.audio = null;
+      this.video = null;
+    }
 
     return Promise.resolve();
   }
@@ -4909,7 +4913,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @param {Object} options - options to join with media
    * @param {JoinOptions} [options.joinOptions] - see #join()
    * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
-   * @returns {Promise} -- {join: see join(), media: see addMedia()}
+   * @returns {Promise} -- {join: see join(), media: see addMedia(), multistreamEnabled: flag to indicate if we managed to join in multistream mode}
    * @public
    * @memberof Meeting
    * @example
@@ -4999,6 +5003,7 @@ export default class Meeting extends StatelessWebexPlugin {
       return {
         join: joinResponse,
         media: mediaResponse,
+        multistreamEnabled: this.isMultistream,
       };
     } catch (error) {
       LoggerProxy.logger.error('Meeting:index#joinWithMedia --> ', error);
@@ -5007,7 +5012,17 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.roap.abortTurnDiscovery();
 
-      if (joined && isRetry) {
+      // if this was the first attempt, let's do a retry
+      let shouldRetry = !isRetry;
+
+      if (CallDiagnosticUtils.isSdpOfferCreationError(error)) {
+        // errors related to offer creation (for example missing H264 codec) will happen again no matter how many times we try,
+        // so there is no point doing a retry
+        shouldRetry = false;
+      }
+
+      // we only want to call leave if join was successful and this was a retry or we won't be doing any more retries
+      if (joined && (isRetry || !shouldRetry)) {
         try {
           await this.leave({resourceId: joinOptions?.resourceId, reason: 'joinWithMedia failure'});
         } catch (e) {
@@ -5031,15 +5046,6 @@ export default class Meeting extends StatelessWebexPlugin {
         }
       );
 
-      // if this was the first attempt, let's do a retry
-      let shouldRetry = !isRetry;
-
-      if (CallDiagnosticUtils.isSdpOfferCreationError(error)) {
-        // errors related to offer creation (for example missing H264 codec) will happen again no matter how many times we try,
-        // so there is no point doing a retry
-        shouldRetry = false;
-      }
-
       if (shouldRetry) {
         LoggerProxy.logger.warn('Meeting:index#joinWithMedia --> retrying call to joinWithMedia');
         this.joinWithMediaRetryInfo.isRetry = true;
@@ -5295,7 +5301,16 @@ export default class Meeting extends StatelessWebexPlugin {
           (this.config.receiveReactions || options.receiveReactions) &&
           this.isReactionsSupported()
         ) {
-          const {name} = this.members.membersCollection.get(e.data.sender.participantId);
+          const member = this.members.membersCollection.get(e.data.sender.participantId);
+          if (!member) {
+            // @ts-ignore -- fix type
+            LoggerProxy.logger.warn(
+              `Meeting:index#processRelayEvent --> Skipping handling of ${REACTION_RELAY_TYPES.REACTION} for ${this.id}. participantId ${e.data.sender.participantId} does not exist in membersCollection.`
+            );
+            break;
+          }
+
+          const {name} = member;
           const processedReaction: ProcessedReaction = {
             reaction: e.data.reaction,
             sender: {
@@ -5349,6 +5364,9 @@ export default class Meeting extends StatelessWebexPlugin {
         this.voiceaListenerCallbacks[VOICEAEVENTS.NEW_CAPTION]
       );
 
+      // @ts-ignore
+      this.webex.internal.voicea.deregisterEvents();
+
       this.areVoiceaEventsSetup = false;
       this.triggerStopReceivingTranscriptionEvent();
     }
@@ -6064,6 +6082,11 @@ export default class Meeting extends StatelessWebexPlugin {
   public roapMessageReceived = (roapMessage: RoapMessage) => {
     const mediaServer = MeetingsUtil.getMediaServer(roapMessage.sdp);
 
+    if (this.isMultistream && mediaServer !== 'homer') {
+      throw new MultistreamNotSupportedError(
+        `Client asked for multistream backend (Homer), but got ${mediaServer} instead`
+      );
+    }
     this.mediaProperties.webrtcMediaConnection.roapMessageReceived(roapMessage);
 
     if (mediaServer) {
@@ -6186,16 +6209,20 @@ export default class Meeting extends StatelessWebexPlugin {
                 logText: `${LOG_HEADER} Roap Offer`,
               }
             ).catch((error) => {
+              const multistreamNotSupported = error instanceof MultistreamNotSupportedError;
+
               // @ts-ignore
               this.webex.internal.newMetrics.submitClientEvent({
                 name: 'client.media-engine.remote-sdp-received',
                 payload: {
-                  canProceed: false,
+                  canProceed: multistreamNotSupported,
                   errors: [
                     // @ts-ignore
                     this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode(
                       {
-                        clientErrorCode: CALL_DIAGNOSTIC_CONFIG.MISSING_ROAP_ANSWER_CLIENT_CODE,
+                        clientErrorCode: multistreamNotSupported
+                          ? CALL_DIAGNOSTIC_CONFIG.MULTISTREAM_NOT_AVAILABLE_CLIENT_CODE
+                          : CALL_DIAGNOSTIC_CONFIG.MISSING_ROAP_ANSWER_CLIENT_CODE,
                       }
                     ),
                   ],
@@ -6203,7 +6230,7 @@ export default class Meeting extends StatelessWebexPlugin {
                 options: {meetingId: this.id, rawError: error},
               });
 
-              this.deferSDPAnswer.reject(new Error('failed to send ROAP SDP offer'));
+              this.deferSDPAnswer.reject(error);
               clearTimeout(this.sdpResponseTimer);
               this.sdpResponseTimer = undefined;
             });
@@ -7093,7 +7120,9 @@ export default class Meeting extends StatelessWebexPlugin {
 
       const mc = await this.createMediaConnection(turnServerInfo, bundlePolicy);
 
-      LoggerProxy.logger.info(`${LOG_HEADER} media connection created`);
+      LoggerProxy.logger.info(
+        `${LOG_HEADER} media connection created this.isMultistream=${this.isMultistream}`
+      );
 
       if (this.isMultistream) {
         this.remoteMediaManager = new RemoteMediaManager(
@@ -7171,6 +7200,33 @@ export default class Meeting extends StatelessWebexPlugin {
     }
   }
 
+  /**
+   * Cleans up stats analyzer, peer connection and other things before
+   * we can create a new transcoded media connection
+   *
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async downgradeFromMultistreamToTranscoded(): Promise<void> {
+    if (this.statsAnalyzer) {
+      await this.statsAnalyzer.stopAnalyzer();
+    }
+    this.statsAnalyzer = null;
+
+    this.isMultistream = false;
+
+    if (this.mediaProperties.webrtcMediaConnection) {
+      // close peer connection, but don't reset mute state information, because we will want to use it on the retry
+      this.closePeerConnections(false);
+
+      this.mediaProperties.unsetPeerConnection();
+    }
+
+    this.locusMediaRequest?.downgradeFromMultistreamToTranscoded();
+
+    this.createStatsAnalyzer();
+  }
+
   /**
    * Sends stats report, closes peer connection and cleans up any media connection
    * related things before trying to establish media connection again with turn server
@@ -7365,13 +7421,33 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.createStatsAnalyzer();
 
-      await this.establishMediaConnection(
-        remoteMediaManagerConfig,
-        bundlePolicy,
-        forceTurnDiscovery,
-        turnServerInfo
-      );
+      try {
+        await this.establishMediaConnection(
+          remoteMediaManagerConfig,
+          bundlePolicy,
+          forceTurnDiscovery,
+          turnServerInfo
+        );
+      } catch (error) {
+        if (error instanceof MultistreamNotSupportedError) {
+          LoggerProxy.logger.warn(
+            `${LOG_HEADER} we asked for multistream backend (Homer), but got transcoded backend, recreating media connection...`
+          );
+
+          await this.downgradeFromMultistreamToTranscoded();
 
+          // Establish new media connection with forced TURN discovery
+          // We need to do TURN discovery again, because backend will be creating a new confluence, so it might land on a different node or cluster
+          await this.establishMediaConnection(
+            remoteMediaManagerConfig,
+            bundlePolicy,
+            true,
+            undefined
+          );
+        } else {
+          throw error;
+        }
+      }
       if (this.mediaProperties.hasLocalShareStream()) {
         await this.enqueueScreenShareFloorRequest();
       }
@@ -8341,7 +8417,7 @@ export default class Meeting extends StatelessWebexPlugin {
     if (layoutType) {
       if (!LAYOUT_TYPES.includes(layoutType)) {
         return this.rejectWithErrorLog(
-          'Meeting:index#changeVideoLayout --> cannot change video layout, invalid layoutType received.'
+          `Meeting:index#changeVideoLayout --> cannot change video layout, invalid layoutType "${layoutType}" received.`
         );
       }
 
@@ -8699,6 +8775,11 @@ export default class Meeting extends StatelessWebexPlugin {
       this.stopTranscription();
       this.transcription = undefined;
     }
+
+    this.annotation.deregisterEvents();
+
+    // @ts-ignore - fix types
+    this.webex.internal.llm.off('event:relay.event', this.processRelayEvent);
   };
 
   /**
@@ -8736,10 +8817,12 @@ export default class Meeting extends StatelessWebexPlugin {
 
       return;
     }
-    const {keepAliveUrl} = this.joinedWith;
+
     const keepAliveInterval = (this.joinedWith.keepAliveSecs - 1) * 750; // taken from UCF
 
     this.keepAliveTimerId = setInterval(() => {
+      const {keepAliveUrl} = this.joinedWith;
+
       this.meetingRequest.keepAlive({keepAliveUrl}).catch((error) => {
         LoggerProxy.logger.warn(
           `Meeting:index#startKeepAlive --> Stopping sending keepAlives to ${keepAliveUrl} after error ${error}`

package/src/meeting/locusMediaRequest.ts

@@ -342,4 +342,11 @@ export class LocusMediaRequest extends WebexPlugin {
   public isConfluenceCreated() {
     return this.confluenceState === 'created';
   }
+
+  /**
+   * This method needs to be called when we downgrade from multistream to transcoded connection.
+   */
+  public downgradeFromMultistreamToTranscoded() {
+    this.config.preferTranscoding = true;
+  }
 }

package/src/meetings/util.ts

@@ -90,7 +90,8 @@ MeetingsUtil.getMediaServer = (sdp) => {
       .find((line) => line.startsWith('o='))
       .split(' ')
       .shift()
-      .replace('o=', '');
+      .replace('o=', '')
+      .toLowerCase();
   } catch {
     mediaServer = undefined;
   }

package/src/roap/index.ts

@@ -231,14 +231,16 @@ export default class Roap extends StatelessWebexPlugin {
               headers,
             } = remoteSdp.roapMessage;
 
-            roapAnswer = {
-              seq: answerSeq,
-              messageType,
-              sdp: sdps[0],
-              errorType,
-              errorCause,
-              headers,
-            };
+            if (messageType === ROAP.ROAP_TYPES.ANSWER) {
+              roapAnswer = {
+                seq: answerSeq,
+                messageType,
+                sdp: sdps[0],
+                errorType,
+                errorCause,
+                headers,
+              };
+            }
           }
         }
 

package/test/unit/spec/annotation/index.ts

@@ -413,6 +413,51 @@ describe('live-annotation', () => {
         });
       });
     });
-  });
 
+    describe('#deregisterEvents', () => {
+      let llmOn;
+      let llmOff;
+      let mercuryOn;
+      let mercuryOff;
+
+      beforeEach(() => {
+        llmOn = sinon.spy(webex.internal.llm, 'on');
+        llmOff = sinon.spy(webex.internal.llm, 'off');
+        mercuryOn = sinon.spy(webex.internal.mercury, 'on');
+        mercuryOff = sinon.spy(webex.internal.mercury, 'off');
+      });
+
+      it('cleans up events', () => {
+        annotationService.locusUrlUpdate(locusUrl);
+        assert.calledWith(
+          mercuryOn,
+          'event:locus.approval_request',
+          annotationService.eventCommandProcessor,
+          annotationService
+        );
+        assert.calledWith(
+          llmOn,
+          'event:relay.event',
+          annotationService.eventDataProcessor,
+          annotationService
+        );
+        assert.match(annotationService.hasSubscribedToEvents, true);
+
+        annotationService.deregisterEvents();
+        assert.calledWith(llmOff, 'event:relay.event', annotationService.eventDataProcessor);
+        assert.calledWith(
+          mercuryOff,
+          'event:locus.approval_request',
+          annotationService.eventCommandProcessor
+        );
+        assert.match(annotationService.hasSubscribedToEvents, false);
+      });
+
+      it('does not call llm off if events have not been registered', () => {
+        annotationService.deregisterEvents();
+        assert.notCalled(llmOff);
+        assert.notCalled(mercuryOff);
+      });
+    });
+  });
 });