@webex/plugin-meetings 3.4.0 → 3.5.0

package/src/networkQualityMonitor/index.ts

@@ -1,211 +0,0 @@
-import EventsScope from '../common/events/events-scope';
-import {EVENT_TRIGGERS} from '../constants';
-
-/**
- * Meeting - network quality event
- * Emitted on each interval of retrieving stats Analyzer data
- * @event network:quality
- * @type {Object}
- * @property {string} mediaType {video|audio}
- * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
- * @memberof NetworkQualityMonitor
- */
-/**
- * NetworkQualityMonitor class that will emit events based on detected quality
- *
- * @class NetworkQualityMonitor
- * @extends {EventsScope}
- */
-export default class NetworkQualityMonitor extends EventsScope {
-  config: any;
-  frequencyTypes: any;
-  indicatorTypes: any;
-  mediaType: any;
-  networkQualityScore: any;
-  networkQualityStatus: any;
-
-  /**
-   * Creates a new instance of NetworkQualityMonitor
-   * @constructor
-   * @public
-   * @param {Object} config
-   * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-   * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-   * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-   * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-   * @property {string} mediaType - audio|video
-   */
-  constructor(config: any) {
-    super();
-    this.config = config;
-    this.indicatorTypes = Object.freeze({
-      PACKETLOSS: 'packetLoss',
-      LATENCY: 'latency',
-      JITTER: 'jitter',
-    });
-    this.frequencyTypes = Object.freeze({
-      UPLINK: 'uplink',
-      DOWNLINK: 'downlink',
-    });
-    this.networkQualityScore = 1;
-    this.networkQualityStatus = {
-      [this.frequencyTypes.UPLINK]: {},
-    };
-    this.mediaType = null;
-  }
-
-  /**
-   * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-   *
-   * @memberof NetworkQualityMonitor
-   * @returns {void}
-   */
-  emitNetworkQuality() {
-    this.emit(
-      {
-        file: 'networkQualityMonitor',
-        function: 'emitNetworkQuality',
-      },
-      EVENT_TRIGGERS.NETWORK_QUALITY,
-      {
-        mediaType: this.mediaType,
-        networkQualityScore: this.networkQualityScore,
-      }
-    );
-  }
-
-  /**
-   * invokes emitNetworkQuality method resets values back to default
-   * @returns {void}
-   * @memberof NetworkQualityMonitor
-   */
-  updateNetworkQualityStatus() {
-    this.emitNetworkQuality();
-
-    // reset values
-    this.networkQualityScore = 1;
-    this.mediaType = null;
-  }
-
-  /**
-   * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-   * @param {Object} configObj
-   * @param {string} configObj.mediaType {audio|video}
-   * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-   * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-   * @returns {void}
-   * @public
-   * @memberof NetworkQualityMonitor
-   */
-  public determineUplinkNetworkQuality({
-    mediaType,
-    remoteRtpResults,
-    statsAnalyzerCurrentStats,
-  }: {
-    mediaType: string;
-    remoteRtpResults: any;
-    statsAnalyzerCurrentStats: object;
-  }) {
-    const roundTripTimeInMilliseconds = remoteRtpResults.roundTripTime * 1000;
-    const jitterInMilliseconds = remoteRtpResults.jitter * 1000;
-    const {currentPacketLossRatio} = statsAnalyzerCurrentStats[mediaType].send;
-
-    this.mediaType = mediaType;
-
-    const {JITTER, PACKETLOSS, LATENCY} = this.indicatorTypes;
-    const {UPLINK} = this.frequencyTypes;
-
-    /**
-     * determines if packetLoss ratio is over threshold set in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const determinePacketLoss = () => {
-      if (currentPacketLossRatio > this.config.videoPacketLossRatioThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * determines if round trip time value is over threshold set in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const determineLatency = () => {
-      if (roundTripTimeInMilliseconds > this.config.rttThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * determines if jitter value is over threshold in config
-     * sets networkQualityScore to 0 if over threshold
-     * @returns {boolean}
-     */
-    const deterMineJitter = () => {
-      if (jitterInMilliseconds > this.config.jitterThreshold) {
-        this.networkQualityScore = 0;
-
-        return false;
-      }
-
-      return true;
-    };
-
-    /**
-     * returns null if val is specifically undefined
-     * @param {(number|undefined)} value
-     * @returns {(number|null)}
-     */
-    const determineIfUndefined = (value: number | undefined) =>
-      typeof value === 'undefined' ? null : value;
-
-    if (!this.networkQualityStatus[UPLINK][mediaType]) {
-      this.networkQualityStatus[UPLINK][mediaType] = {};
-    }
-
-    /**
-     * Values for some browsers specifically Safari will be undefined we explicitly set to null
-     * https://bugs.webkit.org/show_bug.cgi?id=206645
-     * https://bugs.webkit.org/show_bug.cgi?id=212668
-     */
-    // PACKET LOSS
-    this.networkQualityStatus[UPLINK][mediaType][PACKETLOSS] = {
-      acceptable: determinePacketLoss(),
-      value: determineIfUndefined(currentPacketLossRatio),
-    };
-
-    // LATENCY measured in Round trip time
-    this.networkQualityStatus[UPLINK][mediaType][LATENCY] = {
-      acceptable: determineLatency(),
-      value: determineIfUndefined(remoteRtpResults.roundTripTime),
-    };
-
-    // JITTER
-    this.networkQualityStatus[UPLINK][mediaType][JITTER] = {
-      acceptable: deterMineJitter(),
-      value: determineIfUndefined(remoteRtpResults.jitter),
-    };
-
-    this.updateNetworkQualityStatus();
-  }
-
-  /**
-   * Get the current status of network quaility object - networkQualityStatus
-   * @returns {Object}
-   * @public
-   */
-  get networkQualityStats() {
-    const {UPLINK} = this.frequencyTypes;
-
-    return this.networkQualityStatus[UPLINK];
-  }
-}

package/test/unit/spec/networkQualityMonitor/index.js

@@ -1,99 +0,0 @@
-import 'jsdom-global/register';
-import chai from 'chai';
-import chaiAsPromised from 'chai-as-promised';
-import sinon from 'sinon';
-
-import NetworkQualityMonitor from '../../../../src/networkQualityMonitor';
-import {EVENT_TRIGGERS} from '../../../../src/constants';
-
-const {assert} = chai;
-
-chai.use(chaiAsPromised);
-sinon.assert.expose(chai.assert, {prefix: ''});
-
-// eslint-disable-next-line mocha/no-exclusive-tests
-describe('plugin-meetings', () => {
-  describe('NetworkQualityMonitor', () => {
-    let networkQualityMonitor;
-    let sandBoxEmitSpy;
-
-    const initialConfig = {
-      videoPacketLossRatioThreshold: 9,
-      rttThreshold: 500,
-      jitterThreshold: 500,
-    };
-
-    const configObject = {
-      mediaType: 'video-send',
-      remoteRtpResults: {
-        id: 'RTCRemoteInboundRtpVideoStream_2411086660',
-        timestamp: 1624472676193.79,
-        type: 'remote-inbound-rtp',
-        ssrc: 2411086660,
-        kind: 'video',
-        transportId: 'RTCTransport_1_1',
-        codecId: 'RTCCodec_1_Outbound_102',
-        jitter: 0.004,
-        packetsLost: 8,
-        localId: 'RTCOutboundRTPVideoStream_2411086660',
-        roundTripTime: 0.648,
-        fractionLost: 0,
-        totalRoundTripTime: 3.554,
-        roundTripTimeMeasurements: 14,
-      },
-      statsAnalyzerCurrentStats: {
-        'audio-send': {
-          send: {
-            currentPacketLossRatio: 8,
-          },
-        },
-        'video-send': {
-          send: {
-            currentPacketLossRatio: 10,
-          },
-        },
-      },
-    };
-
-    const sandbox = sinon.createSandbox();
-
-    beforeEach(() => {
-      networkQualityMonitor = new NetworkQualityMonitor(initialConfig);
-      sandbox.spy(networkQualityMonitor, 'updateNetworkQualityStatus');
-      sandBoxEmitSpy = sandbox.spy(networkQualityMonitor, 'emit');
-    });
-
-    afterEach(() => {
-      sandbox.restore();
-    });
-
-    it('should trigger updateNetworkQualityStatus when determineUplinkNetworkQuality has finished', async () => {
-      await networkQualityMonitor.determineUplinkNetworkQuality(configObject);
-
-      assert.calledOnce(networkQualityMonitor.updateNetworkQualityStatus);
-    });
-
-    it('should emit a network quality judgement event with the proper payload', async () => {
-      await networkQualityMonitor.determineUplinkNetworkQuality(configObject);
-      assert(
-        sandBoxEmitSpy.calledWith(
-          sinon.match({
-            file: 'networkQualityMonitor',
-            function: 'emitNetworkQuality',
-          }),
-          sinon.match(EVENT_TRIGGERS.NETWORK_QUALITY),
-          sinon.match({
-            mediaType: 'video-send',
-            networkQualityScore: 0,
-          })
-        )
-      );
-    });
-
-    it('should reset to default values after determineUplinkNetworkQuality call stack is complete', async () => {
-      await networkQualityMonitor.determineUplinkNetworkQuality(configObject);
-      assert.isNull(networkQualityMonitor.mediaType);
-      assert.deepEqual(networkQualityMonitor.networkQualityScore, 1);
-    });
-  });
-});