@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.200

package/src/statsAnalyzer/mqaUtil.js

@@ -1,173 +0,0 @@
-
-import {mean, max} from 'lodash';
-
-import {STATS} from '../constants';
-
-export const getAudioReceiverMqa = ({audioReceiver, statsResults, lastMqaDataSent}) => {
-  const mediaType = STATS.AUDIO_CORRELATE;
-  const sendrecvType = STATS.RECEIVE_DIRECTION;
-
-  audioReceiver.common.common.direction = statsResults[mediaType].direction;
-  audioReceiver.common.transportType = statsResults.connectionType.remote.transport[0];
-  // add rtpPacket info inside common as also for call analyzer
-  audioReceiver.common.rtpPackets = statsResults[mediaType][sendrecvType].totalPacketsReceived - lastMqaDataSent[mediaType][sendrecvType].totalPacketsReceived || 0;
-  // Hop by hop are numbers and not percentage so we compare on what we sent the last min
-  // collect the packets received for the last min
-  audioReceiver.streams[0].common.rtpPackets = audioReceiver.common.rtpPackets;
-  audioReceiver.common.mediaHopByHopLost = (statsResults[mediaType][sendrecvType].totalPacketsLost - lastMqaDataSent[mediaType][sendrecvType].totalPacketsLost) || 0;
-  audioReceiver.common.rtpHopByHopLost = statsResults[mediaType][sendrecvType].totalPacketsLost - lastMqaDataSent[mediaType][sendrecvType].totalPacketsLost || 0;
-
-  audioReceiver.streams[0].common.maxRtpJitter = max(statsResults[mediaType][sendrecvType].meanRtpJitter) * 1000 || 0;
-  audioReceiver.streams[0].common.meanRtpJitter = mean(statsResults[mediaType][sendrecvType].meanRtpJitter) * 1000 || 0;
-  audioReceiver.streams[0].common.rtpJitter = audioReceiver.streams[0].common.maxRtpJitter;
-
-  // Fec packets do come in as part of the FEC only for audio
-  const fecRecovered = (statsResults[mediaType][sendrecvType].fecPacketsReceived - lastMqaDataSent[mediaType][sendrecvType].fecPacketsReceived) - (statsResults[mediaType][sendrecvType].fecPacketsDiscarded - lastMqaDataSent[mediaType][sendrecvType].fecPacketsDiscarded);
-
-  audioReceiver.streams[0].common.rtpEndToEndLost = (statsResults[mediaType][sendrecvType].totalPacketsLost - lastMqaDataSent[mediaType][sendrecvType].totalPacketsLost) - fecRecovered || 0;
-
-  audioReceiver.streams[0].common.framesDropped = statsResults[mediaType][sendrecvType].totalSamplesDecoded - lastMqaDataSent[mediaType][sendrecvType].totalSamplesDecoded || 0;
-  audioReceiver.streams[0].common.renderedFrameRate = audioReceiver.streams[0].common.framesDropped * 100 / 60 || 0;
-  audioReceiver.streams[0].common.framesReceived = statsResults[mediaType][sendrecvType].totalSamplesReceived - lastMqaDataSent[mediaType][sendrecvType].totalSamplesReceived || 0;
-  audioReceiver.streams[0].common.concealedFrames = statsResults[mediaType][sendrecvType].concealedSamples - lastMqaDataSent[mediaType][sendrecvType].concealedSamples || 0;
-  audioReceiver.streams[0].common.receivedBitrate = (statsResults[mediaType][sendrecvType].totalBytesReceived - lastMqaDataSent[mediaType][sendrecvType].totalBytesReceived) * 8 / 60 || 0;
-
-  audioReceiver.common.rtpBitrate = audioReceiver.streams[0].common.receivedBitrate;
-};
-
-
-export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent}) => {
-  const mediaType = STATS.AUDIO_CORRELATE;
-  const sendrecvType = STATS.SEND_DIRECTION;
-
-  audioSender.common.common.direction = statsResults[mediaType].direction;
-  audioSender.common.transportType = statsResults.connectionType.local.transport[0];
-
-  audioSender.common.maxRemoteJitter = max(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
-  audioSender.common.meanRemoteJitter = mean(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
-
-  audioSender.common.rtpPackets = statsResults[mediaType][sendrecvType].totalPacketsSent - lastMqaDataSent[mediaType][sendrecvType].totalPacketsSent || 0;
-  audioSender.streams[0].common.rtpPackets = audioSender.common.rtpPackets;
-  // From candidate-pair
-  audioSender.common.availableBitrate = statsResults[mediaType][sendrecvType].availableOutgoingBitrate || 0;
-  // Calculate based on how much packets lost of received compated to how to the client sent
-
-  const totalpacketsLostForaMin = statsResults[mediaType][sendrecvType].totalPacketsLostOnReceiver - lastMqaDataSent[mediaType][sendrecvType].totalPacketsLostOnReceiver;
-
-  audioSender.common.remoteLossRate = totalpacketsLostForaMin > 0 ? (totalpacketsLostForaMin * 100 / audioSender.common.rtpPackets) : 0; // This is the packets sent with in last min || 0;
-
-  audioSender.common.maxRoundTripTime = max(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
-  audioSender.common.meanRoundTripTime = mean(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
-  audioSender.common.roundTripTime = audioSender.common.maxRoundTripTime;
-
-
-  // Calculate the outgoing bitrate
-  const totalBytesSentInaMin = statsResults[mediaType][sendrecvType].totalBytesSent - lastMqaDataSent[mediaType][sendrecvType].totalBytesSent;
-
-  audioSender.streams[0].common.transmittedBitrate = totalBytesSentInaMin ? (totalBytesSentInaMin) * 8 / 60 : 0;
-  audioSender.common.rtpBitrate = audioSender.streams[0].common.transmittedBitrate;
-
-
-  audioSender.streams[0].transmittedKeyFrames = statsResults[mediaType][sendrecvType].totalKeyFramesEncoded - lastMqaDataSent[mediaType][sendrecvType].totalKeyFramesEncoded || 0;
-  audioSender.streams[0].requestedKeyFrames = statsResults[mediaType][sendrecvType].totalFirCount - lastMqaDataSent[mediaType][sendrecvType].totalFirCount || 0;
-};
-
-
-export const getVideoReceiverMqa = ({
-  videoReceiver, statsResults, lastMqaDataSent, isShareStream = false
-}) => {
-  const mediaType = isShareStream ? STATS.SHARE_CORRELATE : STATS.VIDEO_CORRELATE;
-  const sendrecvType = STATS.RECEIVE_DIRECTION;
-
-  videoReceiver.common.common.direction = statsResults[mediaType].direction;
-  videoReceiver.common.transportType = statsResults.connectionType.remote.transport[0];
-  // collect the packets received for the last min
-  videoReceiver.common.rtpPackets = statsResults[mediaType][sendrecvType].totalPacketsReceived - lastMqaDataSent[mediaType][sendrecvType].totalPacketsReceived || 0;
-  videoReceiver.streams[0].common.rtpPackets = videoReceiver.common.rtpPackets;
-
-  const totalPacketLoss = (statsResults[mediaType][sendrecvType].totalPacketsLost - lastMqaDataSent[mediaType][sendrecvType].totalPacketsLost) || 0;
-
-  // Hope by hop are numbers and not percentage so we compare on what we sent the last min
-  // this is including packet lost
-  videoReceiver.common.mediaHopByHopLost = totalPacketLoss;
-  videoReceiver.common.rtpHopByHopLost = totalPacketLoss;
-
-  // End to end packetloss is after recovery
-  videoReceiver.streams[0].common.rtpEndToEndLost = totalPacketLoss;
-
-  // calculate this values
-
-  videoReceiver.common.maxRemoteJitter = max(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
-  videoReceiver.common.meanRemoteJitter = mean(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
-
-  videoReceiver.streams[0].common.rtpJitter = videoReceiver.common.maxRemoteJitter;
-  // videoReceiver.streams[0].common.rtpJitter = (statsResults.resolutions[mediaType][sendrecvType].jitterBufferDelay - lastMqaDataSent.resolutions[mediaType][sendrecvType].jitterBufferDelay) / (statsResults.resolutions[mediaType][sendrecvType].jitterBufferEmittedCount - lastMqaDataSent.resolutions[mediaType][sendrecvType].jitterBufferEmittedCount) * 1000 || 0;
-
-  // Calculate the outgoing bitrate
-  const totalBytesReceivedInaMin = statsResults[mediaType][sendrecvType].totalBytesReceived - lastMqaDataSent[mediaType][sendrecvType].totalBytesReceived;
-
-  videoReceiver.streams[0].common.receivedBitrate = totalBytesReceivedInaMin ? (totalBytesReceivedInaMin) * 8 / 60 : 0;
-  videoReceiver.common.rtpBitrate = videoReceiver.streams[0].common.receivedBitrate;
-
-  // From tracks //TODO: calculate a proper one
-  const totalFrameReceivedInaMin = statsResults.resolutions[mediaType][sendrecvType].framesReceived - lastMqaDataSent.resolutions[mediaType][sendrecvType].framesReceived;
-  const totalFrameDecodedInaMin = statsResults.resolutions[mediaType][sendrecvType].framesDecoded - lastMqaDataSent.resolutions[mediaType][sendrecvType].framesDecoded;
-
-  videoReceiver.streams[0].common.receivedFrameRate = totalFrameReceivedInaMin ? totalFrameReceivedInaMin * 100 / 60 : 0;
-  videoReceiver.streams[0].common.renderedFrameRate = totalFrameDecodedInaMin ? totalFrameDecodedInaMin * 100 / 60 : 0;
-
-  videoReceiver.streams[0].common.framesDropped = statsResults.resolutions[mediaType][sendrecvType].framesDropped - lastMqaDataSent.resolutions[mediaType][sendrecvType].framesDropped;
-  videoReceiver.streams[0].receivedHeight = statsResults.resolutions[mediaType][sendrecvType].height;
-  videoReceiver.streams[0].receivedWidth = statsResults.resolutions[mediaType][sendrecvType].width;
-  videoReceiver.streams[0].receivedFrameSize = statsResults.resolutions[mediaType][sendrecvType].height * statsResults.resolutions[mediaType][sendrecvType].height / 256;
-
-  videoReceiver.streams[0].receivedKeyFrames = statsResults[mediaType][sendrecvType].keyFramesDecoded - lastMqaDataSent[mediaType][sendrecvType].keyFramesDecoded || 0;
-  videoReceiver.streams[0].requestedKeyFrames = statsResults[mediaType][sendrecvType].totalPliCount - lastMqaDataSent[mediaType][sendrecvType].totalPliCount || 0;
-};
-
-export const getVideoSenderMqa = ({
-  videoSender, statsResults, lastMqaDataSent, isShareStream = false
-}) => {
-  const mediaType = isShareStream ? STATS.SHARE_CORRELATE : STATS.VIDEO_CORRELATE;
-  const sendrecvType = STATS.SEND_DIRECTION;
-
-  videoSender.common.common.direction = statsResults[mediaType].direction;
-  videoSender.common.transportType = statsResults.connectionType.local.transport[0];
-
-  videoSender.common.maxRemoteJitter = max(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
-  videoSender.common.meanRemoteJitter = mean(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
-
-
-  videoSender.common.rtpPackets = statsResults[mediaType][sendrecvType].totalPacketsSent - lastMqaDataSent[mediaType][sendrecvType].totalPacketsSent || 0;
-  videoSender.common.availableBitrate = statsResults[mediaType][sendrecvType].availableOutgoingBitrate || 0;
-  // Calculate based on how much packets lost of received compated to how to the client sent
-
-  const totalpacketsLostForaMin = statsResults[mediaType][sendrecvType].totalPacketsLostOnReceiver - lastMqaDataSent[mediaType][sendrecvType].totalPacketsLostOnReceiver;
-
-  videoSender.common.remoteLossRate = totalpacketsLostForaMin > 0 ? (totalpacketsLostForaMin) * 100 / (videoSender.common.rtpPackets + totalpacketsLostForaMin) : 0; // This is the packets sent with in last min || 0;
-
-  videoSender.common.maxRoundTripTime = max(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
-  videoSender.common.meanRoundTripTime = mean(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
-  videoSender.common.roundTripTime = videoSender.common.maxRoundTripTime;
-
-  videoSender.streams[0].common.rtpPackets = statsResults[mediaType][sendrecvType].totalPacketsSent - lastMqaDataSent[mediaType][sendrecvType].totalPacketsSent || 0;
-
-  // Calculate the outgoing bitrate
-  const totalBytesSentInaMin = statsResults[mediaType][sendrecvType].totalBytesSent - lastMqaDataSent[mediaType][sendrecvType].totalBytesSent;
-
-  videoSender.streams[0].common.transmittedBitrate = totalBytesSentInaMin ? (totalBytesSentInaMin) * 8 / 60 : 0;
-
-  videoSender.common.rtpBitrate = videoSender.streams[0].common.transmittedBitrate;
-
-
-  videoSender.streams[0].transmittedKeyFrames = statsResults[mediaType][sendrecvType].totalKeyFramesEncoded - lastMqaDataSent[mediaType][sendrecvType].totalKeyFramesEncoded || 0;
-  videoSender.streams[0].requestedKeyFrames = statsResults[mediaType][sendrecvType].totalFirCount - lastMqaDataSent[mediaType][sendrecvType].totalFirCount || 0;
-
-  // From tracks //TODO: calculate a proper one
-  const totalFrameSentInaMin = statsResults.resolutions[mediaType][sendrecvType].framesSent - (lastMqaDataSent.resolutions[mediaType][sendrecvType].framesSent || 0);
-
-  videoSender.streams[0].common.transmittedFrameRate = totalFrameSentInaMin ? totalFrameSentInaMin * 100 / 60 : 0;
-  videoSender.streams[0].transmittedHeight = statsResults.resolutions[mediaType][sendrecvType].height;
-  videoSender.streams[0].transmittedWidth = statsResults.resolutions[mediaType][sendrecvType].width;
-  videoSender.streams[0].transmittedFrameSize = statsResults.resolutions[mediaType][sendrecvType].height * statsResults.resolutions[mediaType][sendrecvType].width / 254;
-};

package/test/unit/spec/meeting/effectsState.js

@@ -1,291 +0,0 @@
-/* eslint-disable camelcase */
-import {assert} from '@webex/test-helper-chai';
-import sinon from 'sinon';
-import MockWebex from '@webex/test-helper-mock-webex';
-import {BNR_STATUS} from '@webex/plugin-meetings/src/constants';
-import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
-import Meeting from '@webex/plugin-meetings/src/meeting';
-import Meetings from '@webex/plugin-meetings';
-import Metrics from '@webex/plugin-meetings/src/metrics';
-import MediaUtil from '@webex/plugin-meetings/src/media/util';
-import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
-import createEffectsState from '@webex/plugin-meetings/src/meeting/effectsState';
-import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
-import LoggerConfig from '@webex/plugin-meetings/src/common/logs/logger-config';
-
-describe('plugin-meetings', () => {
-  const logger = {
-    info: () => {},
-    log: () => {},
-    error: () => {},
-    warn: () => {},
-    trace: () => {},
-    debug: () => {}
-  };
-
-  beforeEach(() => {
-    sinon.stub(Metrics, 'sendBehavioralMetric');
-  });
-  afterEach(() => {
-    sinon.restore();
-  });
-
-  Object.defineProperty(global.window.navigator, 'mediaDevices', {
-    writable: true,
-    value: {
-      getSupportedConstraints: sinon.stub().returns({
-        sampleRate: true
-      })
-    },
-  });
-  LoggerConfig.set({verboseEvents: true, enable: false});
-  LoggerProxy.set(logger);
-
-  let webex;
-  let meeting;
-  let uuid1;
-
-  const fakeMediaTrack = () => ({
-    id: Date.now().toString(),
-    stop: () => {},
-    readyState: 'live',
-    enabled: true,
-    getSettings: () => ({
-      sampleRate: 48000
-    })
-  });
-
-  class FakeMediaStream {
-    constructor(tracks) {
-      this.active = false;
-      this.id = '5146425f-c240-48cc-b86b-27d422988fb7';
-      this.tracks = tracks;
-    }
-
-    addTrack = () => undefined;
-
-    getAudioTracks = () => this.tracks;
-  }
-
-  class FakeAudioContext {
-    constructor() {
-      this.state = 'running';
-      this.baseLatency = 0.005333333333333333;
-      this.currentTime = 2.7946666666666666;
-      this.sampleRate = 48000;
-      this.audioWorklet = {
-        addModule: async () => undefined,
-      };
-    }
-
-    onstatechange = null;
-
-    createMediaStreamSource() {
-      return {
-        connect: () => undefined,
-        mediaStream: {
-          getAudioTracks() {
-          // eslint-disable-next-line no-undef
-            return [new MediaStreamTrack()];
-          },
-        },
-      };
-    }
-
-    createMediaStreamDestination() {
-      return {
-        stream: {
-          getAudioTracks() {
-          // eslint-disable-next-line no-undef
-            return [new MediaStreamTrack()];
-          },
-        },
-      };
-    }
-  }
-
-  class FakeAudioWorkletNode {
-    constructor() {
-      this.port = {
-        postMessage: () => undefined,
-      };
-    }
-
-    connect() {
-    /* placeholder method */
-    }
-  }
-
-  class FakeMediaStreamTrack {
-    constructor() {
-      this.kind = 'audio';
-      this.enabled = true;
-      this.label = 'Default - MacBook Pro Microphone (Built-in)';
-      this.muted = false;
-      this.readyState = 'live';
-      this.contentHint = '';
-    }
-
-    getSettings() {
-      return {
-        sampleRate: 48000
-      };
-    }
-  }
-  Object.defineProperty(global, 'MediaStream', {
-    writable: true,
-    value: FakeMediaStream,
-  });
-
-  Object.defineProperty(global, 'AudioContext', {
-    writable: true,
-    value: FakeAudioContext,
-  });
-
-  Object.defineProperty(global, 'AudioWorkletNode', {
-    writable: true,
-    value: FakeAudioWorkletNode,
-  });
-
-  Object.defineProperty(global, 'MediaStreamTrack', {
-    writable: true,
-    value: FakeMediaStreamTrack,
-  });
-
-  let effects;
-
-  beforeEach(() => {
-    webex = new MockWebex({
-      children: {
-        meetings: Meetings
-      }
-    });
-    meeting = new Meeting(
-      {
-        userId: uuid1
-      },
-      {
-        parent: webex
-      }
-    );
-
-    effects = createEffectsState('BNR');
-    meeting.canUpdateMedia = sinon.stub().returns(true);
-    MeetingUtil.validateOptions = sinon.stub().returns(Promise.resolve());
-
-    meeting.addMedia = sinon.stub().returns(Promise.resolve());
-    meeting.getMediaStreams = sinon.stub().returns(Promise.resolve());
-    sinon.stub(meeting, 'effects').value(effects);
-    sinon.replace(meeting, 'addMedia', () => {
-      sinon.stub(meeting.mediaProperties, 'audioTrack').value(fakeMediaTrack());
-      sinon.stub(meeting.mediaProperties, 'mediaDirection').value({
-        receiveAudio: true
-      });
-      sinon.stub(meeting.mediaProperties, 'webrtcMediaConnection').value({updateSendReceiveOptions: sinon.stub()});
-    });
-  });
-
-  describe('bnr effect library', () => {
-    beforeEach(async () => {
-      await meeting.getMediaStreams();
-      await meeting.addMedia();
-    });
-    describe('#enableBNR', () => {
-      it('should have #enableBnr', () => {
-        assert.exists(effects.enableBNR);
-      });
-
-      it('does bnr effect enable on audio track', async () => {
-        assert.isTrue(await effects.handleClientRequest(true, meeting));
-        assert.equal(effects.state.bnr.enabled, BNR_STATUS.ENABLED);
-
-        assert(Metrics.sendBehavioralMetric.calledOnce);
-        assert.calledWith(
-          Metrics.sendBehavioralMetric,
-          BEHAVIORAL_METRICS.ENABLE_BNR_SUCCESS,
-        );
-      });
-
-      it('does resolve request if bnr is already enabled', async () => {
-        effects.state.bnr.enabled = BNR_STATUS.ENABLED;
-        assert.isTrue(await effects.handleClientRequest(true, meeting));
-        assert.equal(effects.state.bnr.enabled, BNR_STATUS.ENABLED);
-      });
-
-      it('if called twice, does bnr effect enable on audio track for the first request and resolves second', async () => {
-        Promise.all([effects.handleClientRequest(true, meeting), effects.handleClientRequest(true, meeting)])
-          .then((resolveFirst, resolveSecond) => {
-            assert.isTrue(resolveFirst);
-            assert.isTrue(resolveSecond);
-            assert.calledOnce(MediaUtil.createMediaStream);
-          });
-      });
-
-      it('should throw error for inappropriate sample rate and send error metrics', async () => {
-        const fakeMediaTrack1 = () => ({
-          id: Date.now().toString(),
-          stop: () => {},
-          readyState: 'live',
-          getSettings: () => ({
-            sampleRate: 49000
-          })
-        });
-
-        sinon.stub(meeting.mediaProperties, 'audioTrack').value(fakeMediaTrack1());
-
-        // eslint-disable-next-line no-undef
-        MediaUtil.createMediaStream = sinon.stub().returns(new MediaStream([fakeMediaTrack1()]));
-        try {
-          await effects.handleClientRequest(true, meeting);
-        }
-        catch (err) {
-          assert(Metrics.sendBehavioralMetric.calledOnce);
-          assert.calledWith(
-            Metrics.sendBehavioralMetric,
-            BEHAVIORAL_METRICS.ENABLE_BNR_FAILURE, {
-              reason: err.message,
-              stack: err.stack
-            }
-          );
-          assert.equal(err.message, 'Sample rate of 49000 is not supported.');
-        }
-      });
-    });
-
-    describe('#disableBNR', () => {
-      beforeEach(() => {
-        effects.state.bnr.enabled = BNR_STATUS.ENABLED;
-      });
-      it('should have #disableBnr', () => {
-        assert.exists(effects.disableBNR);
-      });
-
-      it('does bnr disable on audio track', async () => {
-        assert.isTrue(await effects.handleClientRequest(false, meeting));
-        assert.equal(effects.state.bnr.enabled, BNR_STATUS.NOT_ENABLED);
-
-        assert(Metrics.sendBehavioralMetric.calledOnce);
-        assert.calledWith(
-          Metrics.sendBehavioralMetric,
-          BEHAVIORAL_METRICS.DISABLE_BNR_SUCCESS,
-        );
-      });
-
-      it('reject request for disable bnr if not enabled', async () => {
-        try {
-          await effects.handleClientRequest(false, meeting);
-        }
-        catch (e) {
-          assert.equal(e.message, 'Can not disable as BNR is not enabled');
-          assert.equal(effects.state.bnr.enabled, BNR_STATUS.ENABLED);
-
-          assert(Metrics.sendBehavioralMetric.calledOnce);
-          assert.calledWith(
-            Metrics.sendBehavioralMetric,
-            BEHAVIORAL_METRICS.DISABLE_BNR_FAILURE,
-          );
-        }
-      });
-    });
-  });
-});