@webex/plugin-meetings 2.36.1 → 2.37.1

package/src/roap/handler.ts

@@ -11,7 +11,6 @@ import RoapUtil from './util';
 import RoapCollection from './collection';
 import Meeting from '../meeting';
 
-
 const checkForAndHandleErrors = (action, meeting, correlationId) => {
   if (action && action.type) {
     if (action.msg && action.msg.messageType && action.msg.errorType) {
@@ -23,7 +22,9 @@ const checkForAndHandleErrors = (action, meeting, correlationId) => {
             }
           })
           .catch((err) => {
-            LoggerProxy.logger.warn(`Roap:handler#checkForAndHandleErrors --> Cannot reset the peer connection with error: ${err}`);
+            LoggerProxy.logger.warn(
+              `Roap:handler#checkForAndHandleErrors --> Cannot reset the peer connection with error: ${err}`
+            );
           });
 
         return true;
@@ -37,11 +38,11 @@ const checkForAndHandleErrors = (action, meeting, correlationId) => {
   return false;
 };
 
-const compareWithLastRoapMessage = (lastRoapMessage, currentRoapMessage) => lastRoapMessage?.msg?.seq === currentRoapMessage.msg.seq && lastRoapMessage?.msg?.messageType === currentRoapMessage.msg.messageType;
+const compareWithLastRoapMessage = (lastRoapMessage, currentRoapMessage) =>
+  lastRoapMessage?.msg?.seq === currentRoapMessage.msg.seq &&
+  lastRoapMessage?.msg?.messageType === currentRoapMessage.msg.messageType;
 
-const handleSessionStep = ({
-  roap, session, locusUrl, correlationId
-}) => {
+const handleSessionStep = ({roap, session, locusUrl, correlationId}) => {
   const {seq: sequenceId, messageType} = roap.msg;
 
   if (session.OFFER && messageType === _OFFER_) {
@@ -51,15 +52,22 @@ const handleSessionStep = ({
     const data = {
       correlation_id: correlationId,
       locus_id: locusUrl.split('/').pop(),
-      sequence: sequenceId
+      sequence: sequenceId,
     };
 
     Metrics.sendBehavioralMetric(metricName, data);
 
-    LoggerProxy.logger.warn(`Roap:handler#handleSessionStep --> Glare condition occurred with new mercury event, sequenceId: ${sequenceId}`);
-  }
-  else {
-    LoggerProxy.logger.info(`Roap:handler#handleSessionStep --> Save OFFER/ANSWER seq:${sequenceId} new mercury event ${messageType}local state: ${JSON.stringify(session.state.state, null, 2)}`);
+    LoggerProxy.logger.warn(
+      `Roap:handler#handleSessionStep --> Glare condition occurred with new mercury event, sequenceId: ${sequenceId}`
+    );
+  } else {
+    LoggerProxy.logger.info(
+      `Roap:handler#handleSessionStep --> Save OFFER/ANSWER seq:${sequenceId} new mercury event ${messageType}local state: ${JSON.stringify(
+        session.state.state,
+        null,
+        2
+      )}`
+    );
     session[messageType] = roap.msg;
     session[messageType].remote = !!roap.remote;
   }
@@ -75,7 +83,7 @@ export default class RoapHandler extends StatelessWebexPlugin {
   roapAnswer: any;
   roapFinished: any;
   roapOk: any;
-  
+
   constructor(attrs, options, roapOk, roapAnswer, roapFinished) {
     super({}, options);
     this.attrs = attrs;
@@ -99,7 +107,7 @@ export default class RoapHandler extends StatelessWebexPlugin {
         this.roapFinished(meeting.correlationId, action.msg.seq);
         break;
 
-        // TODO:  (important )handle roap state for sending offers as well
+      // TODO:  (important )handle roap state for sending offers as well
       // case ROAP.ROAP_STATE.WAIT_RX_OFFER:
       // case ROAP.ROAP_STATE.WAIT_RX_ANSWER:
       // case ROAP.ROAP_STATE.WAIT_RX_OK:
@@ -116,7 +124,7 @@ export default class RoapHandler extends StatelessWebexPlugin {
                 seq: session.OFFER.seq,
                 correlationId: meeting.correlationId,
                 audioMuted: meeting.isAudioMuted(),
-                videoMuted: meeting.isVideoMuted()
+                videoMuted: meeting.isVideoMuted(),
               });
             })
             .catch((error) => {
@@ -125,14 +133,16 @@ export default class RoapHandler extends StatelessWebexPlugin {
                 correlation_id: meeting.correlationId,
                 locus_id: meeting.locusUrl.split('/').pop(),
                 reason: error.message,
-                stack: error.stack
+                stack: error.stack,
               };
               const metadata = {
-                type: error.name
+                type: error.name,
               };
 
               Metrics.sendBehavioralMetric(metricName, data, metadata);
-              LoggerProxy.logger.error(`Roap:handler#perform --> Error occured during wait receive answer, continuing, ${error}`);
+              LoggerProxy.logger.error(
+                `Roap:handler#perform --> Error occured during wait receive answer, continuing, ${error}`
+              );
             });
         }
         break;
@@ -145,18 +155,25 @@ export default class RoapHandler extends StatelessWebexPlugin {
         break;
       // case ROAP.ROAP_STATE.IDLE_LOCAL_OFFER:
       case ROAP.ROAP_STATE.ERROR:
-        LoggerProxy.logger.error(`Roap:handler#perform --> Roap State ERROR for session: ${session}`);
+        LoggerProxy.logger.error(
+          `Roap:handler#perform --> Roap State ERROR for session: ${session}`
+        );
         break;
       case ROAP.ROAP_STATE.GLARE:
         session.GLARE_OFFER.tieBreaker = session.GLARE_OFFER.tieBreaker || 0;
         session.OFFER.tieBreaker = session.OFFER.tieBreaker || 0;
-        LoggerProxy.logger.warn('Roap:handler#perform --> Roap State resolved the GLARE condition.');
+        LoggerProxy.logger.warn(
+          'Roap:handler#perform --> Roap State resolved the GLARE condition.'
+        );
         if (session.GLARE_OFFER.tieBreaker < session.OFFER.tieBreaker) {
           // 2
-          LoggerProxy.logger.log('Roap:handler#perform --> Roap State local offer won after GLARE.');
-        }
-        else {
-          LoggerProxy.logger.log('Roap:handler#perform --> Roap State remote offer won after GLARE.');
+          LoggerProxy.logger.log(
+            'Roap:handler#perform --> Roap State local offer won after GLARE.'
+          );
+        } else {
+          LoggerProxy.logger.log(
+            'Roap:handler#perform --> Roap State remote offer won after GLARE.'
+          );
         }
         session.state.step(ROAP.ROAP_SIGNAL.GLARE_RESOLVED, meeting, action);
         // @ts-ignore
@@ -182,7 +199,7 @@ export default class RoapHandler extends StatelessWebexPlugin {
         roap: action,
         locusUrl: meeting.locusUrl,
         correlationId: meeting.correlationId,
-        session
+        session,
       });
       signal = ROAP.ROAP_SIGNAL[`${prefix}${action.msg.messageType}`];
       session.state.step(signal, meeting, action);
@@ -201,21 +218,29 @@ export default class RoapHandler extends StatelessWebexPlugin {
   handleAction(session: object, action: any, meeting: Meeting, correlationId: string) {
     let signal;
 
-
     switch (action.type) {
       case ROAP.RECEIVE_ROAP_MSG:
-        LoggerProxy.logger.log(`Roap:handler#handleAction --> RECEIVE_ROAP_MSG event captured, reciving a roap message : ${JSON.stringify(action)}`);
+        LoggerProxy.logger.log(
+          `Roap:handler#handleAction --> RECEIVE_ROAP_MSG event captured, reciving a roap message : ${JSON.stringify(
+            action
+          )}`
+        );
         if (compareWithLastRoapMessage(this.lastRoapMessage, action)) {
-          LoggerProxy.logger.warn(`Roap:handler#handleAction --> duplicate roap offer from server: ${action.msg.seq}`);
-        }
-        else {
+          LoggerProxy.logger.warn(
+            `Roap:handler#handleAction --> duplicate roap offer from server: ${action.msg.seq}`
+          );
+        } else {
           this.lastRoapMessage = action;
           action.remote = true;
           this.execute(signal, session, action, meeting, ROAP.RX_);
         }
         break;
       case ROAP.SEND_ROAP_MSG:
-        LoggerProxy.logger.log(`Roap:handler#handleAction --> SEND_ROAP_MSG event captured, sending roap message ${JSON.stringify(action)}`);
+        LoggerProxy.logger.log(
+          `Roap:handler#handleAction --> SEND_ROAP_MSG event captured, sending roap message ${JSON.stringify(
+            action
+          )}`
+        );
 
         action.local = true;
         this.execute(signal, session, action, meeting, ROAP.TX_);
@@ -227,10 +252,16 @@ export default class RoapHandler extends StatelessWebexPlugin {
         break;
       case ROAP.RECEIVE_CALL_LEAVE:
         RoapCollection.deleteSession(correlationId);
-        LoggerProxy.logger.log(`Roap:handler#handleAction --> RECEIVE_CALL_LEAVE event captured, cleaning up the RoapHandler for correlationId: ${correlationId}`); break;
+        LoggerProxy.logger.log(
+          `Roap:handler#handleAction --> RECEIVE_CALL_LEAVE event captured, cleaning up the RoapHandler for correlationId: ${correlationId}`
+        );
+        break;
       case ROAP.RESET_ROAP_STATE:
         RoapCollection.deleteSessionSequence(correlationId, action.msg.seq);
-        LoggerProxy.logger.log(`Roap:handler#handleAction --> RESET_ROAP_STATE event captured, resetting the RoapHandler state based on sequenceId: ${action.msg.seq}`); break;
+        LoggerProxy.logger.log(
+          `Roap:handler#handleAction --> RESET_ROAP_STATE event captured, resetting the RoapHandler state based on sequenceId: ${action.msg.seq}`
+        );
+        break;
       default:
         return true;
     }

package/src/roap/index.ts

@@ -21,11 +21,11 @@ import Meeting from '../meeting';
  */
 
 /**
-  * @typedef {Object} SeqOptions
-  * @property {String} correlationId
-  * @property {String} mediaId
-  * @property {Number} seq
-  */
+ * @typedef {Object} SeqOptions
+ * @property {String} correlationId
+ * @property {String} mediaId
+ * @property {Number} seq
+ */
 
 /**
  * @class Roap
@@ -68,7 +68,13 @@ export default class Roap extends StatelessWebexPlugin {
      * @private
      * @memberof Roap
      */
-    this.roapHandler = new RoapHandler(this.attrs, this.options, this.sendRoapOK.bind(this), this.sendRoapAnswer.bind(this), this.roapFinished.bind(this));
+    this.roapHandler = new RoapHandler(
+      this.attrs,
+      this.options,
+      this.sendRoapOK.bind(this),
+      this.sendRoapAnswer.bind(this),
+      this.roapFinished.bind(this)
+    );
     /**
      * The Roap Request Server Proxy Object
      * @instance
@@ -101,18 +107,19 @@ export default class Roap extends StatelessWebexPlugin {
     const msg = data.message;
     const {correlationId} = data;
 
-    LoggerProxy.logger.log(`Roap:index#roapEvent --> Received Roap Message [${JSON.stringify(msg, null, 2)}]`);
+    LoggerProxy.logger.log(
+      `Roap:index#roapEvent --> Received Roap Message [${JSON.stringify(msg, null, 2)}]`
+    );
 
     if (msg.messageType === ROAP.ROAP_TYPES.TURN_DISCOVERY_RESPONSE) {
       // turn discovery is not part of normal roap protocol and so we are not handling it
       // through the usual roap state machine
       this.turnDiscovery.handleTurnDiscoveryResponse(msg);
-    }
-    else {
+    } else {
       this.roapHandler.submit({
         type: ROAP.RECEIVE_ROAP_MSG,
         msg,
-        correlationId
+        correlationId,
       });
     }
   }
@@ -129,7 +136,7 @@ export default class Roap extends StatelessWebexPlugin {
     this.roapHandler.submit({
       type: ROAP.RECEIVE_CALL_LEAVE,
       seq,
-      correlationId
+      correlationId,
     });
 
     return Promise.resolve();
@@ -145,11 +152,14 @@ export default class Roap extends StatelessWebexPlugin {
   private sendRoapOK(options: any) {
     return Promise.resolve().then(() => {
       // @ts-ignore
-      const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', options.correlationId);
+      const meeting = this.webex.meetings.meetingCollection.getByKey(
+        'correlationId',
+        options.correlationId
+      );
       const roapMessage = {
         messageType: ROAP.ROAP_TYPES.OK,
         version: ROAP.ROAP_VERSION,
-        seq: options.seq
+        seq: options.seq,
       };
 
       LoggerProxy.logger.log(`Roap:index#sendRoapOK --> ROAP OK sending with seq ${options.seq}`);
@@ -162,13 +172,13 @@ export default class Roap extends StatelessWebexPlugin {
           correlationId: options.correlationId,
           audioMuted: meeting.isAudioMuted(),
           videoMuted: meeting.isVideoMuted(),
-          meetingId: meeting.id
+          meetingId: meeting.id,
         })
         .then(() => {
           this.roapHandler.submit({
             type: ROAP.SEND_ROAP_MSG,
             msg: roapMessage,
-            correlationId: options.correlationId
+            correlationId: options.correlationId,
           });
           LoggerProxy.logger.log(`Roap:index#sendRoapOK --> ROAP OK sent with seq ${options.seq}`);
           meeting.setRoapSeq(options.seq);
@@ -189,18 +199,21 @@ export default class Roap extends StatelessWebexPlugin {
    */
   private sendRoapAnswer(options: any) {
     // @ts-ignore
-    const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', options.correlationId);
+    const meeting = this.webex.meetings.meetingCollection.getByKey(
+      'correlationId',
+      options.correlationId
+    );
     const roapMessage = {
       messageType: ROAP.ROAP_TYPES.ANSWER,
       sdps: options.sdps,
       version: ROAP.ROAP_VERSION,
-      seq: options.seq
+      seq: options.seq,
     };
 
     this.roapHandler.submit({
       type: ROAP.SEND_ROAP_MSG,
       msg: roapMessage,
-      correlationId: options.correlationId
+      correlationId: options.correlationId,
     });
 
     return this.roapRequest
@@ -211,7 +224,7 @@ export default class Roap extends StatelessWebexPlugin {
         correlationId: options.correlationId,
         audioMuted: options.audioMuted,
         videoMuted: options.videoMuted,
-        meetingId: meeting.id
+        meetingId: meeting.id,
       })
       .then(() => {
         meeting.setRoapSeq(options.seq);
@@ -219,7 +232,7 @@ export default class Roap extends StatelessWebexPlugin {
         this.roapHandler.submit({
           type: ROAP.SEND_ROAP_MSG_SUCCESS,
           seq: roapMessage.seq,
-          correlationId: meeting.correlationId
+          correlationId: meeting.correlationId,
         });
       });
   }
@@ -238,7 +251,7 @@ export default class Roap extends StatelessWebexPlugin {
       messageType: ROAP.ROAP_TYPES.ERROR,
       version: ROAP.ROAP_VERSION,
       errorType,
-      seq: session.OFFER.seq
+      seq: session.OFFER.seq,
     };
 
     return this.roapRequest.sendRoap(msg, locus);
@@ -258,14 +271,17 @@ export default class Roap extends StatelessWebexPlugin {
       sdps: [options.sdp],
       // sdps: [options.sdp],
       version: ROAP.ROAP_VERSION,
-      seq: typeof options.roapSeq !== 'number' && Number.isNaN(parseFloat(options.roapSeq)) ? 0 : options.roapSeq + 1,
-      tieBreaker: 4294967294 // Math.floor(Math.random() * (2 ** 32) - 1) // TODO: Handle the roap  conflict scenario
+      seq:
+        typeof options.roapSeq !== 'number' && Number.isNaN(parseFloat(options.roapSeq))
+          ? 0
+          : options.roapSeq + 1,
+      tieBreaker: 4294967294, // Math.floor(Math.random() * (2 ** 32) - 1) // TODO: Handle the roap  conflict scenario
     };
 
     this.roapHandler.submit({
       type: ROAP.SEND_ROAP_MSG,
       msg: roapMessage,
-      correlationId: meeting.correlationId
+      correlationId: meeting.correlationId,
     });
 
     // When reconnecting, it's important that the first roap message being sent out has empty media id.
@@ -281,13 +297,13 @@ export default class Roap extends StatelessWebexPlugin {
         mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
         audioMuted: meeting.isAudioMuted(),
         videoMuted: meeting.isVideoMuted(),
-        meetingId: meeting.id
+        meetingId: meeting.id,
       })
       .then(({locus, mediaConnections}) => {
         this.roapHandler.submit({
           type: ROAP.SEND_ROAP_MSG_SUCCESS,
           seq: roapMessage.seq,
-          correlationId: meeting.correlationId
+          correlationId: meeting.correlationId,
         });
         meeting.setRoapSeq(roapMessage.seq);
 
@@ -316,56 +332,60 @@ export default class Roap extends StatelessWebexPlugin {
       messageType: ROAP.ROAP_TYPES.OFFER,
       sdps: [options.sdp],
       version: ROAP.ROAP_VERSION,
-      seq: typeof options.roapSeq !== 'number' && Number.isNaN(parseFloat(options.roapSeq)) ? 0 : options.roapSeq + 1,
-      tieBreaker: 4294967294 // Math.floor(Math.random() * (2 ** 32) - 1) // TODO: Handle the roap  conflict scenario
+      seq:
+        typeof options.roapSeq !== 'number' && Number.isNaN(parseFloat(options.roapSeq))
+          ? 0
+          : options.roapSeq + 1,
+      tieBreaker: 4294967294, // Math.floor(Math.random() * (2 ** 32) - 1) // TODO: Handle the roap  conflict scenario
     };
 
     this.roapHandler.submit({
       type: ROAP.SEND_ROAP_MSG,
       msg: roapMessage,
-      correlationId: meeting.correlationId
+      correlationId: meeting.correlationId,
     });
 
     const roapBody = {
       localMedias: [
         {
-          localSdp: JSON.stringify(this.roapRequest.attachRechabilityData({
-            roapMessage,
-            // eslint-disable-next-line no-warning-comments
-            // TODO: check whats the need for video and audiomute
-            audioMuted: !!meeting.isAudioMuted(),
-            videoMuted: !!meeting.isVideoMuted()
-          }))
-        // mediaId: meeting.mediaId
-        }
-      ]
+          localSdp: JSON.stringify(
+            this.roapRequest.attachRechabilityData({
+              roapMessage,
+              // eslint-disable-next-line no-warning-comments
+              // TODO: check whats the need for video and audiomute
+              audioMuted: !!meeting.isAudioMuted(),
+              videoMuted: !!meeting.isVideoMuted(),
+            })
+          ),
+          // mediaId: meeting.mediaId
+        },
+      ],
     };
 
-    return MeetingUtil.joinMeetingOptions(meeting, {roapMessage: roapBody})
-      .then((locus) => {
-        this.roapHandler.submit({
-          type: ROAP.SEND_ROAP_MSG_SUCCESS,
-          seq: roapMessage.seq,
-          correlationId: meeting.correlationId
-        });
-        meeting.setRoapSeq(roapMessage.seq);
+    return MeetingUtil.joinMeetingOptions(meeting, {roapMessage: roapBody}).then((locus) => {
+      this.roapHandler.submit({
+        type: ROAP.SEND_ROAP_MSG_SUCCESS,
+        seq: roapMessage.seq,
+        correlationId: meeting.correlationId,
+      });
+      meeting.setRoapSeq(roapMessage.seq);
 
-        // eslint-disable-next-line no-warning-comments
-        // TODO: we need to attach peerconenction to locus not sure if we need to pass everything here
-        return locus;
+      // eslint-disable-next-line no-warning-comments
+      // TODO: we need to attach peerconenction to locus not sure if we need to pass everything here
+      return locus;
       // eslint-disable-next-line no-warning-comments
       // TODO: check where to update the sequence number
-      });
+    });
   };
 
   /**
- * Called when the roap sequence is finished (completed successfully or failed)
- * @param {String} correlationId id of the meeting affected
- * @param {String} sequenceId the id of the finished sequence
- * @returns {undefined}
- * @private
- * @memberof Roap
- */
+   * Called when the roap sequence is finished (completed successfully or failed)
+   * @param {String} correlationId id of the meeting affected
+   * @param {String} sequenceId the id of the finished sequence
+   * @returns {undefined}
+   * @private
+   * @memberof Roap
+   */
   private roapFinished(correlationId: string, sequenceId: string) {
     RoapCollection.onSessionSequenceFinish(correlationId, sequenceId);
     // @ts-ignore