@webex/plugin-meetings 3.4.0 → 3.5.0-next.10

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/src/rtcMetrics/constants.ts

@@ -1,3 +0,0 @@
-const RTC_METRICS = {APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'};
-
-export {RTC_METRICS as default};

package/src/rtcMetrics/index.ts

@@ -1,166 +0,0 @@
-/* eslint-disable class-methods-use-this */
-import {CallDiagnosticUtils} from '@webex/internal-plugin-metrics';
-import uuid from 'uuid';
-import RTC_METRICS from './constants';
-
-const parseJsonPayload = (payload: any[]): any | null => {
-  try {
-    if (payload && payload[0]) {
-      return JSON.parse(payload[0]);
-    }
-
-    return null;
-  } catch (_) {
-    return null;
-  }
-};
-
-/**
- * Rtc Metrics
- */
-export default class RtcMetrics {
-  /**
-   * Array of MetricData items to be sent to the metrics service.
-   */
-  metricsQueue = [];
-
-  intervalId: number;
-
-  webex: any;
-
-  meetingId: string;
-
-  correlationId: string;
-
-  connectionId: string;
-
-  /**
-   * Initialize the interval.
-   *
-   * @param {object} webex - The main `webex` object.
-   * @param {string} meetingId - The meeting id.
-   * @param {string} correlationId - The correlation id.
-   */
-  constructor(webex, meetingId, correlationId) {
-    // `window` is used to prevent typescript from returning a NodeJS.Timer.
-    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);
-    this.meetingId = meetingId;
-    this.webex = webex;
-    this.correlationId = correlationId;
-    this.setNewConnectionId();
-    // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.
-    setTimeout(this.sendMetricsInQueue.bind(this), 5 * 1000);
-  }
-
-  /**
-   * Check to see if the metrics queue has any items.
-   *
-   * @returns {void}
-   */
-  public sendMetricsInQueue() {
-    if (this.metricsQueue.length) {
-      this.sendMetrics();
-      this.metricsQueue = [];
-    }
-  }
-
-  /**
-   * Add metrics items to the metrics queue.
-   *
-   * @param {object} data - An object with a payload array of metrics items.
-   *
-   * @returns {void}
-   */
-  addMetrics(data) {
-    if (data.payload.length) {
-      if (data.name === 'stats-report') {
-        data.payload = data.payload.map(this.anonymizeIp);
-      }
-
-      this.metricsQueue.push(data);
-
-      try {
-        // If a connection fails, send the rest of the metrics in queue and get a new connection id.
-        const parsedPayload = parseJsonPayload(data.payload);
-        if (
-          data.name === 'onconnectionstatechange' &&
-          parsedPayload &&
-          parsedPayload.value === 'failed'
-        ) {
-          this.sendMetricsInQueue();
-          this.setNewConnectionId();
-        }
-      } catch (e) {
-        console.error(e);
-      }
-    }
-  }
-
-  /**
-   * Clear the metrics interval.
-   *
-   * @returns {void}
-   */
-  closeMetrics() {
-    this.sendMetricsInQueue();
-    clearInterval(this.intervalId);
-  }
-
-  /**
-   * Anonymize IP addresses.
-   *
-   * @param {array} stats - An RTCStatsReport organized into an array of strings.
-   * @returns {string}
-   */
-  anonymizeIp(stats: string): string {
-    const data = JSON.parse(stats);
-    // on local and remote candidates, anonymize the last 4 bits.
-    if (data.type === 'local-candidate' || data.type === 'remote-candidate') {
-      data.ip = CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;
-      data.address = CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;
-      data.relatedAddress =
-        CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;
-    }
-
-    return JSON.stringify(data);
-  }
-
-  /**
-   * Set a new connection id.
-   *
-   * @returns {void}
-   */
-  private setNewConnectionId() {
-    this.connectionId = uuid.v4();
-  }
-
-  /**
-   * Send metrics to the metrics service.
-   *
-   * @returns {void}
-   */
-  private sendMetrics() {
-    this.webex.request({
-      method: 'POST',
-      service: 'unifiedTelemetry',
-      resource: 'metric/v2',
-      headers: {
-        type: 'webrtcMedia',
-        appId: RTC_METRICS.APP_ID,
-      },
-      body: {
-        metrics: [
-          {
-            type: 'webrtc',
-            version: '1.1.0',
-            userId: this.webex.internal.device.userId,
-            meetingId: this.meetingId,
-            correlationId: this.correlationId,
-            connectionId: this.connectionId,
-            data: this.metricsQueue,
-          },
-        ],
-      },
-    });
-  }
-}

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);
-    });
-  });
-});

package/test/unit/spec/rtcMetrics/index.ts

@@ -1,123 +0,0 @@
-import 'jsdom-global/register';
-import RtcMetrics from '@webex/plugin-meetings/src/rtcMetrics';
-import MockWebex from '@webex/test-helper-mock-webex';
-import {assert} from '@webex/test-helper-chai';
-import sinon from 'sinon';
-import RTC_METRICS from '../../../../src/rtcMetrics/constants';
-
-const FAKE_METRICS_ITEM = {payload: ['{"type":"string","value":"fake-metrics","id":""}']};
-const FAILURE_METRICS_ITEM = {
-  name: "onconnectionstatechange",
-  payload: ['{"type":"string","value":"failed","id":""}'],
-  timestamp: 1707929986667
-};
-
-const STATS_WITH_IP = '{"id":"RTCIceCandidate_/kQs0ZNU","type":"remote-candidate","transportId":"RTCTransport_0_1","isRemote":true,"ip":"11.22.111.255","address":"11.22.111.255","port":5004,"protocol":"udp","candidateType":"host","priority":2130706431}';
-const STATS_WITH_IP_RESULT = '{"id":"RTCIceCandidate_/kQs0ZNU","type":"remote-candidate","transportId":"RTCTransport_0_1","isRemote":true,"ip":"11.22.111.240","address":"11.22.111.240","port":5004,"protocol":"udp","candidateType":"host","priority":2130706431}';
-
-describe('RtcMetrics', () => {
-  let metrics: RtcMetrics;
-  let webex: MockWebex;
-  let clock;
-  let anonymizeIpSpy;
-
-  const sandbox = sinon.createSandbox();
-
-  beforeEach(() => {
-    clock = sinon.useFakeTimers();
-    webex = new MockWebex();
-    metrics = new RtcMetrics(webex, 'mock-meeting-id', 'mock-correlation-id');
-    anonymizeIpSpy = sandbox.spy(metrics, 'anonymizeIp');
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  it('sendMetrics should send a webex request', () => {
-    assert.notCalled(webex.request);
-
-    metrics.addMetrics(FAKE_METRICS_ITEM);
-    (metrics as any).sendMetrics();
-
-    assert.callCount(webex.request, 1);
-    assert.calledWithMatch(webex.request, sinon.match.has('headers', {
-      type: 'webrtcMedia',
-      appId: RTC_METRICS.APP_ID,
-    }));
-    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].data[0].payload', FAKE_METRICS_ITEM.payload));
-    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].meetingId', 'mock-meeting-id'));
-    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].correlationId', 'mock-correlation-id'));
-  });
-
-  it('should have a defined sendMetricsInQueue function which is public', () => {
-    assert.isDefined(metrics.sendMetricsInQueue);
-    assert.isFunction(metrics.sendMetricsInQueue);
-  });
-
-  it('should send metrics requests over time', () => {
-    assert.notCalled(webex.request);
-
-    metrics.addMetrics(FAKE_METRICS_ITEM);
-    assert.deepEqual(metrics.metricsQueue, [FAKE_METRICS_ITEM]);
-    clock.tick(60 * 1000);
-
-    assert.callCount(webex.request, 1);
-  });
-
-  it('should not send requests with no items in the queue', () => {
-    clock.tick(60 * 1000);
-    assert.notCalled(webex.request);
-  });
-
-  it('sendMetricsInQueue should send metrics if any exist in the queue', () => {
-    assert.notCalled(webex.request);
-
-    metrics.addMetrics(FAKE_METRICS_ITEM);
-    (metrics as any).sendMetricsInQueue();
-
-    assert.callCount(webex.request, 1);
-  });
-
-  it('should clear out metrics on close', () => {
-    assert.notCalled(webex.request);
-
-    metrics.addMetrics(FAKE_METRICS_ITEM);
-    metrics.closeMetrics();
-
-    assert.callCount(webex.request, 1);
-  });
-
-  it('should clear out metrics on failure', () => {
-    assert.notCalled(webex.request);
-
-    metrics.addMetrics(FAILURE_METRICS_ITEM);
-
-    assert.callCount(webex.request, 1);
-  });
-
-  it('should have the same connectionId on success', () => {
-    const originalId = metrics.connectionId;
-
-    metrics.addMetrics(FAKE_METRICS_ITEM);
-
-    assert.strictEqual(originalId, metrics.connectionId);
-  });
-
-  it('should have a new connectionId on failure', () => {
-    const originalId = metrics.connectionId;
-
-    metrics.addMetrics(FAILURE_METRICS_ITEM);
-
-    assert.notEqual(originalId, metrics.connectionId);
-  });
-
-  it('should anonymize IP addresses', () => {
-    assert.strictEqual(metrics.anonymizeIp(STATS_WITH_IP), STATS_WITH_IP_RESULT);
-  });
-
-  it('should call anonymizeIp', () => {
-    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
-    assert.calledOnce(anonymizeIpSpy);
-  })
-});