@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

package/src/roap/index.js

@@ -1,380 +0,0 @@
-import {StatelessWebexPlugin} from '@webex/webex-core';
-
-import {ROAP} from '../constants';
-import LoggerProxy from '../common/logs/logger-proxy';
-import MeetingUtil from '../meeting/util';
-
-import RoapHandler from './handler';
-import RoapRequest from './request';
-import RoapCollection from './collection';
-import TurnDiscovery from './turnDiscovery';
-
-/**
- * Roap options
- * @typedef {Object} RoapOptions
- * @property {String} sdp
- * @property {Meeting} meeting
- * @property {Number} roapSeq
- * @property {Boolean} reconnect
- */
-
-/**
-  * @typedef {Object} SeqOptions
-  * @property {String} correlationId
-  * @property {String} mediaId
-  * @property {Number} seq
-  */
-
-/**
- * @class Roap
- * @export
- * @private
- */
-export default class Roap extends StatelessWebexPlugin {
-  /**
-   *
-   * @param {Object} attrs
-   * @param {Object} options
-   */
-  constructor(attrs, options) {
-    super({}, options);
-    /**
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Roap
-     */
-    this.attrs = attrs;
-    /**
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Roap
-     */
-    this.options = options;
-    /**
-     * The Roap Process State Handler
-     * @instance
-     * @type {RoapHandler}
-     * @private
-     * @memberof Roap
-     */
-    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
-     * @type {RoapRequest}
-     * @private
-     * @memberof Roap
-     */
-    this.roapRequest = new RoapRequest({}, options);
-    /**
-     * The last roap offer sent to server and acked
-     * @instance
-     * @type {Object}
-     * @private
-     * @memberof Roap
-     */
-    this.lastRoapOffer = {};
-
-    this.turnDiscovery = new TurnDiscovery(this.roapRequest);
-  }
-
-  /**
-   * Starts listening to mercury events for Roap messages
-   * @param {object} data event object
-   * @returns {Promise}
-   * @private
-   * @memberof Roap
-   */
-  roapEvent(data) {
-    const msg = data.message;
-    const {correlationId} = data;
-
-    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 {
-      this.roapHandler.submit({
-        type: ROAP.RECEIVE_ROAP_MSG,
-        msg,
-        correlationId
-      });
-    }
-  }
-
-  /**
-   *
-   * @param {String} correlationId correlation id of a meeting
-   * @param {Number} seq ROAP sequence number
-   * @returns {Promise}
-   * @private
-   * @memberof Roap
-   */
-  stop(correlationId, seq) {
-    this.roapHandler.submit({
-      type: ROAP.RECEIVE_CALL_LEAVE,
-      seq,
-      correlationId
-    });
-
-    return Promise.resolve();
-  }
-
-  /**
-   *
-   * @param {SeqOptions} options
-   * @returns {null}
-   * @private
-   * @memberof Roap
-   */
-  sendRoapOK(options) {
-    return Promise.resolve().then(() => {
-      const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', options.correlationId);
-      const roapMessage = {
-        messageType: ROAP.ROAP_TYPES.OK,
-        version: ROAP.ROAP_VERSION,
-        seq: options.seq
-      };
-
-      LoggerProxy.logger.log(`Roap:index#sendRoapOK --> ROAP OK sending with 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
-        })
-        .then(() => {
-          this.roapHandler.submit({
-            type: ROAP.SEND_ROAP_MSG,
-            msg: roapMessage,
-            correlationId: options.correlationId
-          });
-          LoggerProxy.logger.log(`Roap:index#sendRoapOK --> ROAP OK sent with seq ${options.seq}`);
-          meeting.setRoapSeq(options.seq);
-        });
-    });
-  }
-
-  // eslint-disable-next-line no-warning-comments
-  // TODO: try to merge sendRoapOk and roapAnswer
-  /**
-   * Sends a ROAP answer...
-   * @param {SeqOptions} options
-   * @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);
-    const roapMessage = {
-      messageType: ROAP.ROAP_TYPES.ANSWER,
-      sdps: options.sdps,
-      version: ROAP.ROAP_VERSION,
-      seq: options.seq
-    };
-
-    this.roapHandler.submit({
-      type: ROAP.SEND_ROAP_MSG,
-      msg: roapMessage,
-      correlationId: options.correlationId
-    });
-
-    return this.roapRequest
-      .sendRoap({
-        roapMessage,
-        locusSelfUrl: meeting.selfUrl,
-        mediaId: options.mediaId,
-        correlationId: options.correlationId,
-        audioMuted: options.audioMuted,
-        videoMuted: options.videoMuted,
-        meetingId: meeting.id
-      })
-      .then(() => {
-        meeting.setRoapSeq(options.seq);
-
-        this.roapHandler.submit({
-          type: ROAP.SEND_ROAP_MSG_SUCCESS,
-          seq: roapMessage.seq,
-          correlationId: meeting.correlationId
-        });
-      });
-  }
-
-  /**
-   * Sends a ROAP error...
-   * @param {Object} session
-   * @param {Object} locus
-   * @param {String} errorType
-   * @returns {Promise}
-   * @private
-   * @memberof Roap
-   */
-  sendRoapError(session, locus, errorType) {
-    const msg = {
-      messageType: ROAP.ROAP_TYPES.ERROR,
-      version: ROAP.ROAP_VERSION,
-      errorType,
-      seq: session.OFFER.seq
-    };
-
-    return this.roapRequest.sendRoap(msg, locus);
-  }
-
-  /**
-   * sends a roap media request
-   * @param {RoapOptions} options
-   * @returns {Promise}
-   * @private
-   * @memberof Roap
-   */
-  sendRoapMediaRequest(options) {
-    const {meeting, reconnect} = options;
-    const roapMessage = {
-      messageType: ROAP.ROAP_TYPES.OFFER,
-      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
-    };
-
-    this.roapHandler.submit({
-      type: ROAP.SEND_ROAP_MSG,
-      msg: roapMessage,
-      correlationId: meeting.correlationId
-    });
-
-    // 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.roapRequest
-      .sendRoap({
-        roapMessage,
-        correlationId: meeting.correlationId,
-        locusSelfUrl: meeting.selfUrl,
-        mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
-        audioMuted: meeting.isAudioMuted(),
-        videoMuted: meeting.isVideoMuted(),
-        meetingId: meeting.id
-      })
-      .then(({locus, mediaConnections}) => {
-        this.roapHandler.submit({
-          type: ROAP.SEND_ROAP_MSG_SUCCESS,
-          seq: roapMessage.seq,
-          correlationId: meeting.correlationId
-        });
-        meeting.setRoapSeq(roapMessage.seq);
-
-        if (mediaConnections) {
-          meeting.updateMediaConnections(mediaConnections);
-        }
-
-        // 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
-      });
-  }
-
-  /**
-   * sends a roap media request
-   * @param {RoapOptions} options
-   * @returns {Promise}
-   * @private
-   * @memberof Roap
-   */
-  sendRoapCallRequest = (options) => {
-    const {meeting} = options;
-    const roapMessage = {
-      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
-    };
-
-    this.roapHandler.submit({
-      type: ROAP.SEND_ROAP_MSG,
-      msg: roapMessage,
-      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
-        }
-      ]
-    };
-
-    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: 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
- */
-  roapFinished(correlationId, sequenceId) {
-    RoapCollection.onSessionSequenceFinish(correlationId, sequenceId);
-    const meeting = this.webex.meetings.meetingCollection.getByKey('correlationId', correlationId);
-
-    meeting.mediaNegotiatedEvent();
-    if (!RoapCollection.isBusy(correlationId)) {
-      meeting.processNextQueuedMediaUpdate();
-    }
-  }
-
-  /**
-   * 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);
-  }
-}

package/src/roap/request.js

@@ -1,198 +0,0 @@
-
-/* global window */
-import {StatelessWebexPlugin} from '@webex/webex-core';
-
-import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  PARTICIPANT,
-  LOCI,
-  CALL,
-  MEDIA,
-  HTTP_VERBS,
-  REACHABILITY
-} from '../constants';
-import Metrics from '../metrics';
-import {eventType} from '../metrics/config';
-import ParameterError from '../common/errors/parameter';
-/**
- * @class RoapRequest
- */
-export default class RoapRequest extends StatelessWebexPlugin {
-  /**
-   * Joins a meeting via ROAP
-   * @param {Object} options
-   * @returns {Promise} returns a promise that resolves/rejects whatever the request does
-   */
-
-
-  attachRechabilityData(localSdp) {
-    const reachabilityData = window.localStorage.getItem(REACHABILITY.localStorage);
-
-    if (reachabilityData) {
-      try {
-        const reachabilityResult = JSON.parse(reachabilityData);
-
-        /* istanbul ignore else */
-        if (reachabilityResult && Object.keys(reachabilityResult).length) {
-          localSdp.reachability = reachabilityResult;
-        }
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Roap:request#attachReachabilityData --> Error in parsing reachability data: ${e}`);
-      }
-    }
-
-    return localSdp;
-  }
-
-  joinMeetingWithRoap(options) {
-    LoggerProxy.logger.info('Roap:request#joinMeetingWithRoap --> Join locus with roap');
-    LoggerProxy.logger.info(`Roap:request#joinMeetingWithRoap --> Local SDP: ${options.roapMessage}`);
-
-    return Promise.resolve().then(async () => {
-      const deviceUrl = this.webex.internal.device.url;
-      let url = '';
-
-      const body = {
-        deviceUrl,
-        usingResource: options.resourceId || null,
-        correlationId: options.correlationId,
-        localMedias: [
-          {
-            localSdp: JSON.stringify(this.attachRechabilityData({
-              roapMessage: options.roapMessage,
-              audioMuted: false,
-              videoMuted: false
-            }))
-          }
-        ],
-        clientMediaPreferences: {
-          preferTranscoding: options.preferTranscoding ?? true
-        }
-      };
-
-      if (options.locusUrl) {
-        url = `${options.locusUrl}/${PARTICIPANT}`;
-      }
-      else if (options.sipUrl) {
-        try {
-          await this.webex.internal.services.waitForCatalog('postauth');
-          url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
-          body.invitee = {
-            address: options.sipTarget
-          };
-        }
-        catch (e) {
-          LoggerProxy.logger.error(`Roap:request#joinMeetingWithRoap --> ${e}`);
-          throw (e);
-        }
-      }
-      else {
-        throw new ParameterError('Must provide a locusUrl or sipTarget');
-      }
-
-      return this.webex
-        .request({
-          method: HTTP_VERBS.POST,
-          uri: url,
-          body
-        })
-        .then((res) => {
-          const {locus} = res.body;
-
-          locus.roapSeq = options.roapMessage.seq;
-          locus.id = locus.url.split('/').pop();
-          LoggerProxy.logger.info(`Roap:request#joinMeetingWithRoap --> Joined locus [${locus.id}][${locus.fullState.lastActive}]`);
-
-          return locus;
-        })
-        .catch((err) => {
-          LoggerProxy.logger.error(`Roap:request#joinMeetingWithRoap --> failed with error: ${err}`);
-          throw err;
-        });
-    });
-  }
-
-  /**
-   * Sends a ROAP message
-   * @param {Object} options
-   * @param {Object} options.roapMessage
-   * @param {String} options.locusSelfUrl
-   * @param {String} options.mediaId
-   * @param {String} options.correlationId
-   * @param {Boolean} options.audioMuted
-   * @param {Boolean} options.videoMuted
-   * @param {String} options.meetingId
-   * @returns {Promise} returns the response/failure of the request
-   */
-  sendRoap(options) {
-    const {
-      roapMessage, locusSelfUrl, mediaId, correlationId, meetingId
-    } = options;
-
-    if (!mediaId) {
-      LoggerProxy.logger.info('Roap:request#sendRoap --> Race Condition /call mediaID not present');
-    }
-
-    const mediaUrl = `${locusSelfUrl}/${MEDIA}`;
-    const deviceUrl = this.webex.internal.device.url;
-
-    LoggerProxy.logger.info(`Roap:request#sendRoap --> ${mediaUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`);
-
-    Metrics.postEvent({event: eventType.MEDIA_REQUEST, meetingId});
-
-    return this.webex
-      .request({
-        uri: mediaUrl,
-        method: HTTP_VERBS.PUT,
-        body: {
-          device: {
-            url: deviceUrl,
-            deviceType: this.config.meetings.deviceType
-          },
-          correlationId,
-          localMedias: [
-            {
-              localSdp: JSON.stringify(this.attachRechabilityData({
-                roapMessage,
-                // eslint-disable-next-line no-warning-comments
-                // TODO: check whats the need for video and audiomute
-                audioMuted: !!options.audioMuted,
-                videoMuted: !!options.videoMuted
-              })),
-              mediaId: options.mediaId
-            }
-          ],
-          clientMediaPreferences: {
-            preferTranscoding: options.preferTranscoding ?? true
-          }
-        }
-      })
-      .then((res) => {
-        Metrics.postEvent({event: eventType.MEDIA_RESPONSE, 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.info(
-          `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) => {
-        Metrics.postEvent({event: eventType.MEDIA_RESPONSE, meetingId, data: {error: Metrics.parseLocusError(err, true)}});
-        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;
-      });
-  }
-}