@webex/plugin-meetings 3.0.0-beta.3 → 3.0.0-beta.300

package/src/roap/{index.js → index.ts}

@@ -1,3 +1,4 @@
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import {ROAP} from '../constants';
@@ -5,6 +6,10 @@ import LoggerProxy from '../common/logs/logger-proxy';
 
 import RoapRequest from './request';
 import TurnDiscovery from './turnDiscovery';
+import Meeting from '../meeting';
+import MeetingUtil from '../meeting/util';
+import Metrics from '../metrics';
+import BEHAVIORAL_METRICS from '../metrics/constants';
 
 /**
  * Roap options
@@ -17,11 +22,11 @@ import TurnDiscovery from './turnDiscovery';
  */
 
 /**
-  * @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
@@ -29,12 +34,19 @@ import TurnDiscovery from './turnDiscovery';
  * @private
  */
 export default class Roap extends StatelessWebexPlugin {
+  attrs: any;
+  lastRoapOffer: any;
+  options: any;
+  roapHandler: any;
+  roapRequest: any;
+  turnDiscovery: any;
+
   /**
    *
    * @param {Object} attrs
    * @param {Object} options
    */
-  constructor(attrs, options) {
+  constructor(attrs: any, options: any) {
     super({}, options);
     /**
      * @instance
@@ -57,6 +69,7 @@ export default class Roap extends StatelessWebexPlugin {
      * @private
      * @memberof Roap
      */
+    // @ts-ignore
     this.roapRequest = new RoapRequest({}, options);
 
     this.turnDiscovery = new TurnDiscovery(this.roapRequest);
@@ -66,16 +79,19 @@ export default class Roap extends StatelessWebexPlugin {
    *
    * @param {SeqOptions} options
    * @returns {null}
-   * @private
    * @memberof Roap
    */
-  sendRoapOK(options) {
+  public sendRoapOK(options: any) {
     return Promise.resolve().then(() => {
-      const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', options.correlationId);
+      // @ts-ignore
+      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}`);
@@ -85,11 +101,8 @@ export default class Roap extends StatelessWebexPlugin {
           roapMessage,
           locusSelfUrl: meeting.selfUrl,
           mediaId: options.mediaId,
-          correlationId: options.correlationId,
-          audioMuted: meeting.isAudioMuted(),
-          videoMuted: meeting.isVideoMuted(),
           meetingId: meeting.id,
-          preferTranscoding: !meeting.isMultistream,
+          locusMediaRequest: meeting.locusMediaRequest,
         })
         .then(() => {
           LoggerProxy.logger.log(`Roap:index#sendRoapOK --> ROAP OK sent with seq ${options.seq}`);
@@ -103,60 +116,61 @@ export default class Roap extends StatelessWebexPlugin {
    * @param {Boolean} options.audioMuted
    * @param {Boolean} options.videoMuted
    * @returns {Promise}
-   * @private
    * @memberof Roap
    */
-  sendRoapAnswer(options) {
-    const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', options.correlationId);
+  public sendRoapAnswer(options: any) {
+    // @ts-ignore
+    const meeting = this.webex.meetings.meetingCollection.getByKey(
+      'correlationId',
+      options.correlationId
+    );
     const roapMessage = {
       messageType: ROAP.ROAP_TYPES.ANSWER,
       sdps: [options.sdp],
       version: ROAP.ROAP_VERSION,
-      seq: options.seq
+      seq: options.seq,
     };
 
-    return this.roapRequest
-      .sendRoap({
-        roapMessage,
-        locusSelfUrl: meeting.selfUrl,
-        mediaId: options.mediaId,
-        correlationId: options.correlationId,
-        audioMuted: meeting.isAudioMuted(),
-        videoMuted: meeting.isVideoMuted(),
-        meetingId: meeting.id,
-        preferTranscoding: !meeting.isMultistream,
-      });
+    return this.roapRequest.sendRoap({
+      roapMessage,
+      locusSelfUrl: meeting.selfUrl,
+      mediaId: options.mediaId,
+      meetingId: meeting.id,
+      locusMediaRequest: meeting.locusMediaRequest,
+    });
   }
 
   /**
    * Sends a ROAP error...
    * @param {Object} options
    * @returns {Promise}
-   * @private
    * @memberof Roap
    */
   sendRoapError(options) {
-    const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', options.correlationId);
+    // @ts-ignore
+    const meeting = this.webex.meetings.meetingCollection.getByKey(
+      'correlationId',
+      options.correlationId
+    );
     const roapMessage = {
       messageType: ROAP.ROAP_TYPES.ERROR,
       version: ROAP.ROAP_VERSION,
       errorType: options.errorType,
-      seq: options.seq
-
+      seq: options.seq,
     };
 
-    return this.roapRequest.sendRoap({
-      roapMessage,
-      locusSelfUrl: meeting.selfUrl,
-      mediaId: options.mediaId,
-      correlationId: options.correlationId,
-      audioMuted: meeting.isAudioMuted(),
-      videoMuted: meeting.isVideoMuted(),
-      meetingId: meeting.id,
-      preferTranscoding: !meeting.isMultistream,
-    })
+    return this.roapRequest
+      .sendRoap({
+        roapMessage,
+        locusSelfUrl: meeting.selfUrl,
+        mediaId: options.mediaId,
+        meetingId: meeting.id,
+        locusMediaRequest: meeting.locusMediaRequest,
+      })
       .then(() => {
-        LoggerProxy.logger.log(`Roap:index#sendRoapError --> ROAP ERROR sent with seq ${options.seq}`);
+        LoggerProxy.logger.log(
+          `Roap:index#sendRoapError --> ROAP ERROR sent with seq ${options.seq}`
+        );
       });
   }
 
@@ -164,57 +178,91 @@ export default class Roap extends StatelessWebexPlugin {
    * sends a roap media request
    * @param {RoapOptions} options
    * @returns {Promise}
-   * @private
    * @memberof Roap
    */
-  sendRoapMediaRequest(options) {
-    const {
-      meeting, seq, sdp, reconnect, tieBreaker
-    } = options;
+  sendRoapMediaRequest(options: any) {
+    const {meeting, seq, sdp, reconnect, tieBreaker} = options;
     const roapMessage = {
       messageType: ROAP.ROAP_TYPES.OFFER,
       sdps: [sdp],
       version: ROAP.ROAP_VERSION,
       seq,
-      tieBreaker
+      tieBreaker,
+      headers: ['includeAnswerInHttpResponse', 'noOkInTransaction'],
     };
 
     // When reconnecting, it's important that the first roap message being sent out has empty media id.
     // Normally this is the roap offer, but when TURN discovery is enabled,
     // then this is the TURN discovery request message
-    const sendEmptyMediaId = reconnect && !meeting.config.experimental.enableTurnDiscovery;
+    return this.turnDiscovery.isSkipped(meeting).then((isTurnDiscoverySkipped) => {
+      const sendEmptyMediaId = reconnect && isTurnDiscoverySkipped;
 
-    return this.roapRequest
-      .sendRoap({
-        roapMessage,
-        correlationId: meeting.correlationId,
-        locusSelfUrl: meeting.selfUrl,
-        mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
-        audioMuted: meeting.isAudioMuted(),
-        videoMuted: meeting.isVideoMuted(),
-        meetingId: meeting.id,
-        preferTranscoding: !meeting.isMultistream,
-      })
-      .then(({locus, mediaConnections}) => {
-        if (mediaConnections) {
-          meeting.updateMediaConnections(mediaConnections);
-        }
+      return this.roapRequest
+        .sendRoap({
+          roapMessage,
+          locusSelfUrl: meeting.selfUrl,
+          mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
+          meetingId: meeting.id,
+          preferTranscoding: !meeting.isMultistream,
+          locusMediaRequest: meeting.locusMediaRequest,
+          ipVersion: MeetingUtil.getIpVersion(meeting.webex),
+        })
+        .then(({locus, mediaConnections}) => {
+          if (mediaConnections) {
+            meeting.updateMediaConnections(mediaConnections);
+          }
 
-        return locus;
-      });
+          let roapAnswer;
+
+          if (mediaConnections?.[0]?.remoteSdp) {
+            const remoteSdp = JSON.parse(mediaConnections[0].remoteSdp);
+
+            if (remoteSdp.roapMessage) {
+              const {
+                seq: answerSeq,
+                messageType,
+                sdps,
+                errorType,
+                errorCause,
+                headers,
+              } = remoteSdp.roapMessage;
+
+              roapAnswer = {
+                seq: answerSeq,
+                messageType,
+                sdp: sdps[0],
+                errorType,
+                errorCause,
+                headers,
+              };
+            }
+          }
+
+          if (!roapAnswer) {
+            Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ROAP_HTTP_RESPONSE_MISSING, {
+              correlationId: meeting.correlationId,
+              messageType: 'ANSWER',
+              isMultistream: meeting.isMultistream,
+            });
+          }
+
+          return {locus, roapAnswer};
+        });
+    });
   }
 
   /**
-     * Performs a TURN server discovery procedure, which involves exchanging
-     * some roap messages with the server. This exchange has to be done before
-     * any other roap messages are sent
-     *
-     * @param {Meeting} meeting
-     * @param {Boolean} isReconnecting should be set to true if this is a new
-     *                                 media connection just after a reconnection
-     * @returns {Promise}
-     */
-  doTurnDiscovery(meeting, isReconnecting) {
-    return this.turnDiscovery.doTurnDiscovery(meeting, isReconnecting);
+   * Performs a TURN server discovery procedure, which involves exchanging
+   * some roap messages with the server. This exchange has to be done before
+   * any other roap messages are sent
+   *
+   * @param {Meeting} meeting
+   * @param {Boolean} isReconnecting should be set to true if this is a new
+   *                                 media connection just after a reconnection
+   * @param {Boolean} [isForced]
+   * @returns {Promise}
+   */
+  doTurnDiscovery(meeting: Meeting, isReconnecting: boolean, isForced?: boolean) {
+    return this.turnDiscovery.doTurnDiscovery(meeting, isReconnecting, isForced);
   }
 }

package/src/roap/request.ts

@@ -0,0 +1,153 @@
+// @ts-ignore
+import {StatelessWebexPlugin} from '@webex/webex-core';
+
+import LoggerProxy from '../common/logs/logger-proxy';
+import {IP_VERSION, REACHABILITY} from '../constants';
+import {LocusMediaRequest} from '../meeting/locusMediaRequest';
+
+/**
+ * @class RoapRequest
+ */
+export default class RoapRequest extends StatelessWebexPlugin {
+  /**
+   * Returns reachability data.
+   * @param {Object} localSdp
+   * @returns {Object}
+   */
+  async attachReachabilityData(localSdp) {
+    let joinCookie;
+
+    // @ts-ignore
+    const reachabilityResult = await this.webex.meetings.reachability.getReachabilityResults();
+
+    if (reachabilityResult && Object.keys(reachabilityResult).length) {
+      localSdp.reachability = reachabilityResult;
+    }
+
+    // @ts-ignore
+    const joinCookieRaw = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageJoinCookie)
+      .catch(() => {});
+
+    if (joinCookieRaw) {
+      try {
+        joinCookie = JSON.parse(joinCookieRaw);
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `MeetingRequest#constructor --> Error in parsing join cookie data: ${e}`
+        );
+      }
+    }
+
+    return {localSdp, joinCookie};
+  }
+
+  /**
+   * Sends a ROAP message
+   * @param {Object} options
+   * @param {Object} options.roapMessage
+   * @param {String} options.locusSelfUrl
+   * @param {String} options.mediaId
+   * @param {String} options.correlationId
+   * @param {String} options.meetingId
+   * @param {IP_VERSION} options.ipVersion only required for offers
+   * @returns {Promise} returns the response/failure of the request
+   */
+  async sendRoap(options: {
+    roapMessage: any;
+    locusSelfUrl: string;
+    mediaId: string;
+    meetingId: string;
+    ipVersion?: IP_VERSION;
+    locusMediaRequest?: LocusMediaRequest;
+  }) {
+    const {roapMessage, locusSelfUrl, mediaId, meetingId, locusMediaRequest, ipVersion} = options;
+
+    if (!mediaId) {
+      LoggerProxy.logger.info('Roap:request#sendRoap --> sending empty mediaID');
+    }
+
+    if (!locusMediaRequest) {
+      LoggerProxy.logger.warn(
+        'Roap:request#sendRoap --> locusMediaRequest unavailable, not sending roap'
+      );
+
+      return Promise.reject(new Error('sendRoap called when locusMediaRequest is undefined'));
+    }
+    const {localSdp: localSdpWithReachabilityData, joinCookie} = await this.attachReachabilityData({
+      roapMessage,
+    });
+
+    LoggerProxy.logger.info(
+      `Roap:request#sendRoap --> ${locusSelfUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`
+    );
+
+    // @ts-ignore
+    this.webex.internal.newMetrics.submitClientEvent({
+      name: 'client.locus.media.request',
+      options: {
+        meetingId,
+      },
+    });
+
+    return locusMediaRequest
+      .send({
+        type: 'RoapMessage',
+        selfUrl: locusSelfUrl,
+        joinCookie,
+        mediaId,
+        roapMessage,
+        reachability: localSdpWithReachabilityData.reachability,
+        ipVersion,
+      })
+      .then((res) => {
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.locus.media.response',
+          options: {
+            meetingId,
+          },
+        });
+        // always it will be the first mediaConnection Object
+        const mediaConnections =
+          res.body.mediaConnections &&
+          res.body.mediaConnections.length > 0 &&
+          res.body.mediaConnections[0];
+
+        LoggerProxy.logger.debug(
+          `Roap:request#sendRoap --> response:${JSON.stringify(
+            mediaConnections,
+            null,
+            2
+          )}'\n StatusCode:'${res.statusCode}`
+        );
+        const {locus} = res.body;
+
+        locus.roapSeq = options.roapMessage.seq;
+
+        return {
+          locus,
+          ...(mediaConnections && {mediaConnections: res.body.mediaConnections}),
+        };
+      })
+      .catch((err) => {
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.locus.media.response',
+          options: {
+            meetingId,
+            rawError: err,
+          },
+        });
+        LoggerProxy.logger.error(`Roap:request#sendRoap --> Error:${JSON.stringify(err, null, 2)}`);
+        LoggerProxy.logger.error(
+          `Roap:request#sendRoapRequest --> errorBody:${JSON.stringify(
+            roapMessage,
+            null,
+            2
+          )} + '\\n mediaId:'${options.mediaId}`
+        );
+        throw err;
+      });
+  }
+}