@webex/plugin-meetings 2.18.0 → 2.19.2

package/src/metrics/mqa-processor.js

@@ -1,118 +0,0 @@
-import {
-  STATS,
-  MQA_STATS
-} from '../constants';
-import BrowserDetection from '../common/browser-detection';
-
-const {isBrowser} = BrowserDetection();
-
-/**
- * @description MQAProcessor handles interval data for MQA
- * @export
- * @class MQAProcessor
- */
-class MQAProcessor {
-  /**
-     * @constructor
-     * @public
-     * @memberof MQAProcessor
-     */
-  constructor() {
-    this.data = {
-      videoReceive: [],
-      audioTransmit: [],
-      audioReceive: [],
-      videoTransmit: []
-    };
-    this.intervalNumber = 1;
-  }
-
-  /**
-   * @param {String} id
-   * @param {Array<WebRTCData>} interval - a slice of metrics history
-   * @returns {undefined}
-   * @memberof MQAProcessor
-   */
-  process(id, interval) {
-    let rtcCandidatePair, rtcOutVideo, rtpOutVideo; // TODO: , rtcInVideo, rtpInVideo, rtcOutAudio, rtcInAudio, rtpInAudio, rtpOutAudio; // TODO:
-    let vsTransmit;
-
-    const {
-      videoReceive, audioTransmit, audioReceive, videoTransmit
-    } = this.data;
-
-    const sumValue = interval[0]; // the head is the last interval value, webRTC spec has some values automatically summed
-
-    if (sumValue) {
-      rtcCandidatePair = sumValue.rtcCandidatePair;
-    }
-
-    switch (id) {
-      case STATS.AUDIO_SENDER_ID:
-        audioTransmit.push();
-        break;
-      case STATS.AUDIO_RECEIVER_ID:
-        audioReceive.push();
-        break;
-      case STATS.VIDEO_SENDER_ID:
-        videoTransmit.push();
-        break;
-      case STATS.VIDEO_RECEIVER_ID:
-        videoReceive.push();
-        break;
-      case STATS.SHARE_SENDER_ID:
-        if (sumValue) {
-          rtcOutVideo = sumValue.rtcOutVideo;
-          rtpOutVideo = sumValue.rtpOutVideo;
-        }
-        vsTransmit = {...MQA_STATS.DEFAULT_SHARE_SENDER_STATS};
-        if (isBrowser('firefox')) {
-          vsTransmit.common.remoteLossRate = rtpOutVideo ? rtpOutVideo.pliCount / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.common.rtpPackets = rtpOutVideo ? rtpOutVideo.packetsSent / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.streams[0].common.transmittedFrameRate = rtcOutVideo ? rtcOutVideo.framesEncoded / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.streams[0].common.rtpPackets = rtpOutVideo ? rtpOutVideo.packetsSent / (interval.length * this.intervalNumber) : 0;
-        }
-        else {
-          vsTransmit.common.availableBitRate = rtcCandidatePair ? rtcCandidatePair.availableOutgoingBitrate : 0;
-          vsTransmit.common.remoteLossRate = rtpOutVideo ? rtpOutVideo.pliCount / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.common.roundTripTime = rtcCandidatePair ? rtcCandidatePair.totalRoundTripTime / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.common.rtpPackets = rtpOutVideo ? rtpOutVideo.packetsSent / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.streams[0].common.rtpPackets = rtpOutVideo ? rtpOutVideo.packetsSent / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.streams[0].common.transmittedBitrate = rtcCandidatePair ? rtcCandidatePair.availableOutgoingBitrate : 0;
-          vsTransmit.streams[0].common.transmittedFrameRate = rtcOutVideo ? rtcOutVideo.framesSent / (interval.length * this.intervalNumber) : 0;
-          vsTransmit.streams[0].transmittedHeight = rtcOutVideo ? rtcOutVideo.frameHeight : 0;
-          vsTransmit.streams[0].transmittedKeyFrames = rtcOutVideo ? rtcOutVideo.hugeFramesSent : 0;
-          vsTransmit.streams[0].transmittedWidth = rtcOutVideo ? rtcOutVideo.frameWidth : 0;
-        }
-        videoTransmit.push(vsTransmit);
-        break;
-      default:
-        break;
-    }
-    this.data.intervalMetadata = this.data.intervalMetadata || {...MQA_STATS.intervalMetadata};
-  }
-
-  /**
-   * get the data payload for media quality events after they all have been processed
-   * wait to call this until after you have all the data from the interval you want
-   * this method clears the data as a side effect
-   * @returns {Object}
-   * @memberof MQAProcessor
-   */
-  getData() {
-    this.intervalNumber += 1;
-
-    const payload = {...this.data, intervalNumber: this.intervalNumber};
-
-    this.data = {
-      videoReceive: [],
-      audioTransmit: [],
-      audioReceive: [],
-      videoTransmit: []
-    };
-
-    return payload;
-  }
-}
-
-export default MQAProcessor;

package/src/stats/data.js

@@ -1,56 +0,0 @@
-import uuid from 'uuid';
-import {isEmpty, omit} from 'lodash';
-
-import {DEFAULT_OMISSION_DATA_KEYS} from '../constants';
-
-// TODO: Break this up a bit more, so that consumers aren't calling data.data.getData()
-/**
- * @class WebRTCData
- */
-export default class WebRTCData {
-  /**
-   * @param {Object} data
-   */
-  constructor(data) {
-    this.data = data;
-    this.id = uuid.v4();
-  }
-
-  /**
-   * get omitted rtc/rtcp/rtp/track/transport/candidate data with omitted data (default)
-   * @returns {Object}
-   */
-  omit() {
-    const flat = {};
-
-    Object.keys(this.data).forEach((key) => {
-      flat[key] = omit(this.data[key], DEFAULT_OMISSION_DATA_KEYS);
-    });
-
-    return flat;
-  }
-
-  /**
-   * returns if the data is empty
-   * @returns {Boolean};
-   */
-  isEmpty() {
-    return isEmpty(this.data);
-  }
-
-  /**
-   * get the unique id for this specific stat pull
-   * @returns {String};
-   */
-  getId() {
-    return this.id;
-  }
-
-  /**
-   * get the transformed data
-   * @returns {Object}
-   */
-  getData() {
-    return this.data;
-  }
-}

package/src/stats/events.js

@@ -1,185 +0,0 @@
-import StatsAnalyzer from '../analyzer/analyzer';
-import {
-  DEFAULT_EVENT_VIDEO_SEND_KEYS,
-  DEFAULT_EVENT_AUDIO_SEND_KEYS,
-  DEFAULT_EVENT_AUDIO_RECEIVE_KEYS,
-  DEFAULT_EVENT_VIDEO_RECEIVE_KEYS,
-  EVENT_TYPES,
-  EVENT_STATS_MAP,
-  MEETINGS,
-  AUDIO,
-  VIDEO,
-  ANALYSIS_CHECKS
-} from '../constants';
-
-/**
- * @param {Object} operate the filtered, parsed, converted, transformed, simplified data point to check against
- * @param {String} type - local or remote
- * @param {String} keys - the stat keys for types of stats defined by DEFAULT_TRANSFORM_REGEX
- * @param {String} stat - the accessor to get the actual stat
- * @param {String} kind - audio or video
- * @returns {Object} always whatever the first sentFirstVideoBytes were, in the past or if it happened now, or undefined if never
- * @private
- * @memberof StatsEvents
- */
-const operateEvent = (operate, type, keys, stat, kind) => {
-  const foundMatch = {};
-
-  foundMatch.found = keys.some((key) => {
-    if (operate[key] && operate[key][stat] && operate[key][stat] > 0) {
-      foundMatch.match = {
-        type,
-        key,
-        data: operate[key],
-        stat,
-        kind
-      };
-
-      return true;
-    }
-
-    return false;
-  });
-
-  return foundMatch;
-};
-
-/**
- * @export
- * @class StatsEvents
- */
-export default class StatsEvents {
-  namespace = MEETINGS;
-
-  /**
-   * constructs an instance
-   * @constructor
-   * @param {StatsHistory} series
-   * @param {Function} callback
-   * @memberof StatsEvents
-   */
-  constructor(series = null, callback = () => {}) {
-    /**
-     * @instance
-     * @type {StatsHistory}
-     * @private
-     * @memberof StatsEvents
-     */
-    this.series = series;
-    /**
-     * @instance
-     * @type {Function}
-     * @private
-     * @memberof StatsEvents
-     */
-    this.callback = callback;
-    /**
-     * @instance
-     * @type {WebRTCData}
-     * @private
-     * @memberof StatsEvents
-     */
-    this.first = null;
-    /**
-     * @instance
-     * @type {Boolean}
-     * @private
-     * @memberof StatsEvents
-     */
-    this.sendRemainStopped = false;
-    /**
-     * @instance
-     * @type {Boolean}
-     * @private
-     * @memberof StatsEvents
-     */
-    this.recvRemainStopped = false;
-  }
-
-  /**
-   * looks for data starting to flow through
-   * @param {WebRTCData} data
-   * @returns {Object}
-   */
-  start(data) {
-    if (data && data.data && data.data.getData()) {
-      const operate = data.data.getData();
-
-      if (operate && !this.first) {
-        const operator = [
-          operateEvent(operate, EVENT_TYPES.LOCAL, DEFAULT_EVENT_AUDIO_SEND_KEYS, EVENT_STATS_MAP.BYTES_SENT, AUDIO),
-          operateEvent(operate, EVENT_TYPES.LOCAL, DEFAULT_EVENT_VIDEO_SEND_KEYS, EVENT_STATS_MAP.BYTES_SENT, VIDEO),
-          operateEvent(operate, EVENT_TYPES.REMOTE, DEFAULT_EVENT_VIDEO_RECEIVE_KEYS, EVENT_STATS_MAP.BYTES_RECEIVED, VIDEO),
-          operateEvent(operate, EVENT_TYPES.REMOTE, DEFAULT_EVENT_AUDIO_RECEIVE_KEYS, EVENT_STATS_MAP.BYTES_RECEIVED, AUDIO)
-        ];
-        const somethingMatched = operator.find((element) => element && element.found && element.match);
-
-        if (somethingMatched) {
-          this.first = somethingMatched.match;
-          this.callback(this.first);
-
-          return somethingMatched;
-        }
-      }
-    }
-
-    return null;
-  }
-
-  /**
-   * Looks for data to stop coming through
-   * @returns {Object}
-   */
-  stop() {
-    if (!this.series || this.series.get().length < 5) {
-      return null;
-    }
-    const fiveSecondsData = this.series.getSlice(5);
-    const prop = fiveSecondsData[0] && fiveSecondsData[0].rtpOutAudio || fiveSecondsData[0].rtpInAudio || fiveSecondsData[0].rtpInVideo || fiveSecondsData[0].rtpOutVideo;
-    const sendAnalysis = StatsAnalyzer.analyze(fiveSecondsData, {analysisKeys: [{key: EVENT_STATS_MAP.BYTES_SENT, check: ANALYSIS_CHECKS.INCREASING, prop}]});
-    const receiveAnalysis = StatsAnalyzer.analyze(fiveSecondsData, {analysisKeys: [{key: EVENT_STATS_MAP.BYTES_RECEIVED, check: ANALYSIS_CHECKS.INCREASING, prop}]});
-
-    if (!sendAnalysis.valid && sendAnalysis.data.bytesSent.reports.length > 0) {
-      if (!this.sendRemainStopped) {
-        const ret = {stop: true, stat: EVENT_STATS_MAP.BYTES_SENT};
-
-        this.callback(ret);
-        this.sendRemainStopped = true;
-        this.first = null;
-
-        return ret;
-      }
-    }
-    else if (sendAnalysis.valid && sendAnalysis.data.bytesSent.reports.length > 0) {
-      this.sendRemainStopped = false;
-    }
-    if (!receiveAnalysis.valid && receiveAnalysis.data.bytesReceived.reports.length > 0) {
-      if (!this.recvRemainStopped) {
-        const ret = {stop: true, stat: EVENT_STATS_MAP.BYTES_RECEIVED};
-
-        this.callback(ret);
-        this.recvRemainStopped = true;
-        this.first = null;
-
-        return ret;
-      }
-    }
-    else if (receiveAnalysis.valid && receiveAnalysis.data.bytesReceived.reports.length > 0) {
-      this.recvRemainStopped = false;
-    }
-
-    return null;
-  }
-
-  /**
-   * handles all the types of events that need to be sent when they happen from getStats API
-   * @param {WebRTCData} data
-   * @returns {Object}
-   */
-  event(data) {
-    return {
-      start: this.start(data),
-      stop: this.stop()
-    };
-  }
-}

package/src/stats/filter.js

@@ -1,40 +0,0 @@
-import {Transform} from 'readable-stream';
-
-import StatsTransformer from '../stats/transformer';
-import WebRTCData from '../stats/data';
-
-/**
- * Reforms the interesting data from an RTCStatsReport to a new format
- */
-export default class StatsFilter extends Transform {
-  /**
-   * Tells the Stream we're operating in objectMode
-   * @private
-   */
-  constructor() {
-    super({objectMode: true});
-  }
-
-  /**
-   * Filters out data on the RTCStatsReport to the data around call quality and pushes it as a WebRTCData object
-   * @param {RTCStatsReport} report
-   * @param {*} encoding
-   * @param {Function} callback
-   * @private
-   * @returns {undefined}
-   */
-  _transform(report, encoding, callback) {
-    if (!report) {
-      callback();
-
-      return;
-    }
-    const data = StatsTransformer.transform(report);
-    const push = new WebRTCData(data);
-
-    this.push({
-      data: push
-    });
-    callback();
-  }
-}

package/src/stats/history.js

@@ -1,107 +0,0 @@
-/**
- * stores the last x filtered stream datas
- */
-/**
- * @export
- * @class StatsHistory
- */
-export default class StatsHistory {
-  /**
-   * instantiate our wrapped history array
-   * @param {Number} max
-   */
-  constructor(max) {
-    /**
-     * @instance
-     * @type {Array}
-     * @public
-     * @memberof StatsHistory
-     */
-    this.history = [];
-    /**
-     * @instance
-     * @type {Number}
-     * @public
-     * @memberof StatsHistory
-     */
-    this.max = max;
-  }
-
-  /**
-   * @returns {Array} the array of stats reports, read from [0] = most recent to [length - 1] = least recent
-   * @public
-   * @memberof StatsHistory
-   */
-  get() {
-    return this.history;
-  }
-
-  /**
-   * deletes the history array and resets it
-   * @returns {undefined}
-   * @public
-   * @memberof StatsHistory
-   */
-  clear() {
-    this.history = [];
-  }
-
-  /**
-   * gets the stored stat
-   * @param {Number} index the location
-   * @returns {Object} the stat at location index
-   * @public
-   * @memberof StatsHistory
-   */
-  getAt(index) {
-    return this.history[index];
-  }
-
-  /**
-   * gets the most recently stored stat
-   * @returns {Object} the most recently added stat to the history recorder
-   * @public
-   * @memberof StatsHistory
-   */
-  getMostRecent() {
-    return this.history.length > 1 ? this.getAt(0) : null;
-  }
-
-  /**
-   * gets the last two values, that can be used to compare
-   * @returns {Object} {previous: WebRTCData, current: WebRTCData}
-   */
-  getComparable() {
-    return {
-      previous: this.getMostRecent(),
-      current: this.history.length > 2 ? this.getAt(1) : null
-    };
-  }
-
-  /**
-   * gets a cut of the n most recent WebRTC datas stored
-   * @param {Number} exclusiveEnd
-   * @returns {Array}
-   */
-  getSlice(exclusiveEnd) {
-    return this.history.slice(0, exclusiveEnd);
-  }
-
-  /**
-   * adds a history entry into tshe array at the head, removes from the tail
-   * if too large, returns the old tail if removed
-   * @param {WebRTCData} data filtered stats report to add to the history array
-   * @returns {Object} the removed stats report at the end if that had to be removed
-   * to make space for the new stats data report to be added to the front
-   */
-  add(data) {
-    let removed = null;
-
-    if (this.history.length >= this.max) {
-      removed = this.history.pop();
-    }
-    this.history.unshift(data);
-
-    return removed;
-  }
-}