@webex/plugin-meetings 3.0.0-beta.357 → 3.0.0-beta.358

package/dist/types/constants.d.ts

@@ -1017,7 +1017,7 @@ export declare const AVAILABLE_RESOLUTIONS: {
         };
     };
 };
-export declare const MQA_INTEVAL = 60000;
+export declare const MQA_INTERVAL = 60000;
 export declare const MEDIA_DEVICES: {
     MICROPHONE: string;
     SPEAKER: string;

package/dist/webinar/index.js

@@ -62,7 +62,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
   updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
-  version: "3.0.0-beta.357"
+  version: "3.0.0-beta.358"
 });
 var _default = Webinar;
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.357",
+  "version": "3.0.0-beta.358",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -33,12 +33,12 @@
   },
   "devDependencies": {
     "@peculiar/webcrypto": "^1.4.3",
-    "@webex/plugin-meetings": "3.0.0-beta.357",
-    "@webex/test-helper-chai": "3.0.0-beta.357",
-    "@webex/test-helper-mocha": "3.0.0-beta.357",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.357",
-    "@webex/test-helper-retry": "3.0.0-beta.357",
-    "@webex/test-helper-test-users": "3.0.0-beta.357",
+    "@webex/plugin-meetings": "3.0.0-beta.358",
+    "@webex/test-helper-chai": "3.0.0-beta.358",
+    "@webex/test-helper-mocha": "3.0.0-beta.358",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.358",
+    "@webex/test-helper-retry": "3.0.0-beta.358",
+    "@webex/test-helper-test-users": "3.0.0-beta.358",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -47,19 +47,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.357",
+    "@webex/common": "3.0.0-beta.358",
     "@webex/internal-media-core": "2.2.7",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.357",
-    "@webex/internal-plugin-device": "3.0.0-beta.357",
-    "@webex/internal-plugin-llm": "3.0.0-beta.357",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.357",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.357",
-    "@webex/internal-plugin-support": "3.0.0-beta.357",
-    "@webex/internal-plugin-user": "3.0.0-beta.357",
-    "@webex/media-helpers": "3.0.0-beta.357",
-    "@webex/plugin-people": "3.0.0-beta.357",
-    "@webex/plugin-rooms": "3.0.0-beta.357",
-    "@webex/webex-core": "3.0.0-beta.357",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.358",
+    "@webex/internal-plugin-device": "3.0.0-beta.358",
+    "@webex/internal-plugin-llm": "3.0.0-beta.358",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.358",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.358",
+    "@webex/internal-plugin-support": "3.0.0-beta.358",
+    "@webex/internal-plugin-user": "3.0.0-beta.358",
+    "@webex/media-helpers": "3.0.0-beta.358",
+    "@webex/plugin-people": "3.0.0-beta.358",
+    "@webex/plugin-rooms": "3.0.0-beta.358",
+    "@webex/webex-core": "3.0.0-beta.358",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -1236,7 +1236,7 @@ export const AVAILABLE_RESOLUTIONS = {
  *  mqa Interval for sending stats metrics
  */
 
-export const MQA_INTEVAL = 60000; // mqa analyzer interval its fixed to 60000
+export const MQA_INTERVAL = 60000; // mqa analyzer interval its fixed to 60000
 
 export const MEDIA_DEVICES = {
   MICROPHONE: 'microphone',

package/src/statsAnalyzer/index.ts

@@ -7,7 +7,7 @@ import EventsScope from '../common/events/events-scope';
 import {
   DEFAULT_GET_STATS_FILTER,
   STATS,
-  MQA_INTEVAL,
+  MQA_INTERVAL,
   NETWORK_TYPE,
   MEDIA_DEVICES,
   _UNKNOWN_,
@@ -299,7 +299,7 @@ export class StatsAnalyzer extends EventsScope {
         this.sendMqaData();
         this.mqaInterval = setInterval(() => {
           this.sendMqaData();
-        }, MQA_INTEVAL);
+        }, MQA_INTERVAL);
       });
     }
 

package/src/statsAnalyzer/mqaUtil.ts

@@ -29,13 +29,14 @@ export const getAudioReceiverMqa = ({audioReceiver, statsResults, lastMqaDataSen
   // add rtpPacket info inside common as also for call analyzer
   audioReceiver.common.rtpPackets =
     statsResults[mediaType][sendrecvType].totalPacketsReceived - lastPacketsReceived || 0;
+  audioReceiver.streams[0].common.rtpPackets = audioReceiver.common.rtpPackets;
+
   // 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 - lastPacketsLost || 0;
-  audioReceiver.common.rtpHopByHopLost =
+  const totalPacketsLost =
     statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
+  audioReceiver.common.mediaHopByHopLost = totalPacketsLost;
+  audioReceiver.common.rtpHopByHopLost = totalPacketsLost;
 
   audioReceiver.streams[0].common.maxRtpJitter =
     // @ts-ignore
@@ -49,6 +50,7 @@ export const getAudioReceiverMqa = ({audioReceiver, statsResults, lastMqaDataSen
     statsResults[mediaType][sendrecvType].fecPacketsReceived -
     lastFecPacketsReceived -
     (statsResults[mediaType][sendrecvType].fecPacketsDiscarded - lastFecPacketsDiscarded);
+  audioReceiver.common.fecPackets = fecRecovered || 0;
 
   audioReceiver.streams[0].common.rtpEndToEndLost =
     statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost - fecRecovered || 0;
@@ -105,7 +107,7 @@ export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent, m
     statsResults[mediaType][sendrecvType].totalPacketsLostOnReceiver - lastPacketsLost;
 
   audioSender.common.remoteLossRate =
-    totalpacketsLostForaMin > 0
+    audioSender.common.rtpPackets > 0
       ? (totalpacketsLostForaMin * 100) / audioSender.common.rtpPackets
       : 0; // This is the packets sent with in last min || 0;
 
@@ -156,16 +158,15 @@ export const getVideoReceiverMqa = ({videoReceiver, statsResults, lastMqaDataSen
     statsResults[mediaType][sendrecvType].totalPacketsReceived - lastPacketsReceived || 0;
   videoReceiver.streams[0].common.rtpPackets = videoReceiver.common.rtpPackets;
 
-  const totalPacketLoss =
-    statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
-
-  // Hope by hop are numbers and not percentage so we compare on what we sent the last min
+  // Hop 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;
+  const totalPacketsLost =
+    statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
+  videoReceiver.common.mediaHopByHopLost = totalPacketsLost;
+  videoReceiver.common.rtpHopByHopLost = totalPacketsLost;
 
   // End to end packetloss is after recovery
-  videoReceiver.streams[0].common.rtpEndToEndLost = totalPacketLoss;
+  videoReceiver.streams[0].common.rtpEndToEndLost = totalPacketsLost;
 
   // calculate this values
 
@@ -249,8 +250,8 @@ export const getVideoSenderMqa = ({videoSender, statsResults, lastMqaDataSent, m
     statsResults[mediaType][sendrecvType].totalPacketsLostOnReceiver - lastPacketsLost;
 
   videoSender.common.remoteLossRate =
-    totalpacketsLostForaMin > 0
-      ? (totalpacketsLostForaMin * 100) / (videoSender.common.rtpPackets + totalpacketsLostForaMin)
+    videoSender.common.rtpPackets > 0
+      ? (totalpacketsLostForaMin * 100) / videoSender.common.rtpPackets
       : 0; // This is the packets sent with in last min || 0;
 
   videoSender.common.maxRoundTripTime =

package/test/unit/spec/stats-analyzer/index.js

@@ -7,7 +7,7 @@ import {ConnectionState} from '@webex/internal-media-core';
 import {StatsAnalyzer, EVENTS} from '../../../../src/statsAnalyzer';
 import NetworkQualityMonitor from '../../../../src/networkQualityMonitor';
 import testUtils from '../../../utils/testUtils';
-import {MEDIA_DEVICES, _UNKNOWN_} from '@webex/plugin-meetings/src/constants';
+import {MEDIA_DEVICES, MQA_INTERVAL, _UNKNOWN_} from '@webex/plugin-meetings/src/constants';
 import LoggerProxy from '../../../../src/common/logs/logger-proxy';
 import LoggerConfig from '../../../../src/common/logs/logger-config';
 
@@ -285,8 +285,12 @@ describe('plugin-meetings', () => {
                 report: [
                   {
                     type: 'outbound-rtp',
-                    packetsSent: 0,
                     bytesSent: 1,
+                    packetsSent: 0,
+                  },
+                  {
+                    type: 'remote-inbound-rtp',
+                    packetsLost: 0,
                   },
                   {
                     type: 'candidate-pair',
@@ -311,8 +315,14 @@ describe('plugin-meetings', () => {
                 report: [
                   {
                     type: 'inbound-rtp',
-                    packetsReceived: 0,
                     bytesReceived: 1,
+                    fecPacketsDiscarded: 0,
+                    fecPacketsReceived: 0,
+                    packetsLost: 0,
+                    packetsReceived: 0,
+                  },
+                  {
+                    type: 'remote-outbound-rtp',
                   },
                   {
                     type: 'candidate-pair',
@@ -340,8 +350,13 @@ describe('plugin-meetings', () => {
                 report: [
                   {
                     type: 'outbound-rtp',
-                    framesSent: 1500,
                     bytesSent: 1,
+                    framesSent: 0,
+                    packetsSent: 0,
+                  },
+                  {
+                    type: 'remote-inbound-rtp',
+                    packetsLost: 0,
                   },
                   {
                     type: 'candidate-pair',
@@ -366,11 +381,16 @@ describe('plugin-meetings', () => {
                 report: [
                   {
                     type: 'inbound-rtp',
-                    framesDecoded: 0,
                     bytesReceived: 1,
                     frameHeight: 720,
                     frameWidth: 1280,
-                    framesReceived: 1500,
+                    framesDecoded: 0,
+                    framesReceived: 0,
+                    packetsLost: 0,
+                    packetsReceived: 0,
+                  },
+                  {
+                    type: 'remote-outbound-rtp',
                   },
                   {
                     type: 'candidate-pair',
@@ -448,21 +468,27 @@ describe('plugin-meetings', () => {
         await testUtils.flushPromises();
       };
 
-      const mergeProperties = (target, properties, keyValue = 'fake-candidate-id', matchKey= 'type', matchValue = 'local-candidate') => {
+      const mergeProperties = (
+        target,
+        properties,
+        keyValue = 'fake-candidate-id',
+        matchKey = 'type',
+        matchValue = 'local-candidate'
+      ) => {
         for (let key in target) {
-            if (target.hasOwnProperty(key)) {
-                if (typeof target[key] === 'object') {
-                    mergeProperties(target[key], properties, keyValue, matchKey, matchValue);
-                }
-                if (key === 'id' && target[key] === keyValue && target[matchKey] === matchValue) {
-                    Object.assign(target, properties);
-                }
+          if (target.hasOwnProperty(key)) {
+            if (typeof target[key] === 'object') {
+              mergeProperties(target[key], properties, keyValue, matchKey, matchValue);
+            }
+            if (key === 'id' && target[key] === keyValue && target[matchKey] === matchValue) {
+              Object.assign(target, properties);
             }
+          }
         }
-    }
+      };
 
-      const progressTime = async () => {
-        await clock.tickAsync(initialConfig.analyzerInterval);
+      const progressTime = async (time = initialConfig.analyzerInterval) => {
+        await clock.tickAsync(time);
         await testUtils.flushPromises();
       };
 
@@ -590,10 +616,10 @@ describe('plugin-meetings', () => {
       });
 
       it('emits the correct transportType in MEDIA_QUALITY events when using a TURN server', async () => {
-        fakeStats.audio.senders[0].report[3].relayProtocol = 'tls';
-        fakeStats.video.senders[0].report[3].relayProtocol = 'tls';
-        fakeStats.audio.receivers[0].report[3].relayProtocol = 'tls';
-        fakeStats.video.receivers[0].report[3].relayProtocol = 'tls';
+        fakeStats.audio.senders[0].report[4].relayProtocol = 'tls';
+        fakeStats.video.senders[0].report[4].relayProtocol = 'tls';
+        fakeStats.audio.receivers[0].report[4].relayProtocol = 'tls';
+        fakeStats.video.receivers[0].report[4].relayProtocol = 'tls';
 
         await startStatsAnalyzer({expected: {receiveVideo: true}});
 
@@ -640,14 +666,131 @@ describe('plugin-meetings', () => {
         );
       });
 
-      it('emits the correct frameRate', async () => {
-        await startStatsAnalyzer({expected: {receiveVideo: true}});
+      it('emits the correct transmittedFrameRate/receivedFrameRate', async () => {
+        it('at the start of the stats analyzer', async () => {
+          await startStatsAnalyzer();
+          assert.strictEqual(mqeData.videoTransmit[0].streams[0].common.transmittedFrameRate, 0);
+          assert.strictEqual(mqeData.videoReceive[0].streams[0].common.receivedFrameRate, 0);
+        });
 
-        await progressTime();
-        assert.strictEqual(mqeData.videoReceive[0].streams[0].common.receivedFrameRate, 25);
-        fakeStats.video.receivers[0].framesReceived = 3000;
-        await progressTime();
-        assert.strictEqual(mqeData.videoReceive[0].streams[0].common.receivedFrameRate, 25);
+        it('after frames are sent and received', async () => {
+          fakeStats.video.senders[0].report[0].framesSent += 300;
+          fakeStats.video.receivers[0].report[0].framesReceived += 300;
+          await progressTime(MQA_INTERVAL);
+
+          // 300 frames in 60 seconds = 5 frames per second
+          assert.strictEqual(mqeData.videoTransmit[0].streams[0].common.transmittedFrameRate, 5);
+          assert.strictEqual(mqeData.videoReceive[0].streams[0].common.receivedFrameRate, 5);
+        });
+      });
+
+      it('emits the correct rtpPackets', async () => {
+        it('at the start of the stats analyzer', async () => {
+          await startStatsAnalyzer();
+          assert.strictEqual(mqeData.audioTransmit[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.audioTransmit[0].streams[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.audioReceive[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.audioReceive[0].streams[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.videoTransmit[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.videoTransmit[0].streams[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.videoReceive[0].common.rtpPackets, 0);
+          assert.strictEqual(mqeData.videoReceive[0].streams[0].common.rtpPackets, 0);
+        });
+
+        it('after packets are sent', async () => {
+          fakeStats.audio.senders[0].report[0].packetsSent += 5;
+          fakeStats.video.senders[0].report[0].packetsSent += 5;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioTransmit[0].common.rtpPackets, 5);
+          assert.strictEqual(mqeData.audioTransmit[0].streams[0].common.rtpPackets, 5);
+          assert.strictEqual(mqeData.videoTransmit[0].common.rtpPackets, 5);
+          assert.strictEqual(mqeData.videoTransmit[0].streams[0].common.rtpPackets, 5);
+        });
+
+        it('after packets are received', async () => {
+          fakeStats.audio.senders[0].report[0].packetsSent += 10;
+          fakeStats.video.senders[0].report[0].packetsSent += 10;
+          fakeStats.audio.receivers[0].report[0].packetsReceived += 10;
+          fakeStats.video.receivers[0].report[0].packetsReceived += 10;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioReceive[0].common.rtpPackets, 10);
+          assert.strictEqual(mqeData.audioReceive[0].streams[0].common.rtpPackets, 10);
+          assert.strictEqual(mqeData.videoReceive[0].common.rtpPackets, 10);
+          assert.strictEqual(mqeData.videoReceive[0].streams[0].common.rtpPackets, 10);
+        });
+      });
+
+      it('emits the correct fecPackets', async () => {
+        it('at the start of the stats analyzer', async () => {
+          await startStatsAnalyzer();
+          assert.strictEqual(mqeData.audioReceive[0].common.fecPackets, 0);
+        });
+
+        it('after FEC packets are received', async () => {
+          fakeStats.audio.receivers[0].report[0].fecPacketsReceived += 5;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioReceive[0].common.fecPackets, 5);
+        });
+
+        it('after FEC packets are received and some FEC packets are discarded', async () => {
+          fakeStats.audio.receivers[0].report[0].fecPacketsReceived += 15;
+          fakeStats.audio.receivers[0].report[0].fecPacketsDiscarded += 5;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioReceive[0].common.fecPackets, 10);
+        });
+      });
+
+      it('emits the correct mediaHopByHopLost/rtpHopByHopLost', async () => {
+        it('at the start of the stats analyzer', async () => {
+          await startStatsAnalyzer();
+          assert.strictEqual(mqeData.audioReceive[0].common.mediaHopByHopLost, 0);
+          assert.strictEqual(mqeData.audioReceive[0].common.rtpHopByHopLost, 0);
+          assert.strictEqual(mqeData.videoReceive[0].common.mediaHopByHopLost, 0);
+          assert.strictEqual(mqeData.videoReceive[0].common.rtpHopByHopLost, 0);
+        });
+
+        it('after packets are lost', async () => {
+          fakeStats.audio.receivers[0].report[0].packetsLost += 5;
+          fakeStats.video.receivers[0].report[0].packetsLost += 5;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioReceive[0].common.mediaHopByHopLost, 5);
+          assert.strictEqual(mqeData.audioReceive[0].common.rtpHopByHopLost, 5);
+          assert.strictEqual(mqeData.videoReceive[0].common.mediaHopByHopLost, 5);
+          assert.strictEqual(mqeData.videoReceive[0].common.rtpHopByHopLost, 5);
+        });
+      });
+
+      it('emits the correct remoteLossRate', async () => {
+        it('at the start of the stats analyzer', async () => {
+          await startStatsAnalyzer();
+          assert.strictEqual(mqeData.audioTransmit[0].common.remoteLossRate, 0);
+          assert.strictEqual(mqeData.videoTransmit[0].common.remoteLossRate, 0);
+        });
+
+        it('after packets are sent', async () => {
+          fakeStats.audio.senders[0].report[0].packetsSent += 100;
+          fakeStats.video.senders[0].report[0].packetsSent += 100;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioTransmit[0].common.remoteLossRate, 0);
+          assert.strictEqual(mqeData.videoTransmit[0].common.remoteLossRate, 0);
+        });
+
+        it('after packets are sent and some packets are lost', async () => {
+          fakeStats.audio.senders[0].report[0].packetsSent += 200;
+          fakeStats.audio.senders[0].report[1].packetsLost += 10;
+          fakeStats.video.senders[0].report[0].packetsSent += 200;
+          fakeStats.video.senders[0].report[1].packetsLost += 10;
+          await progressTime(MQA_INTERVAL);
+
+          assert.strictEqual(mqeData.audioTransmit[0].common.remoteLossRate, 5);
+          assert.strictEqual(mqeData.videoTransmit[0].common.remoteLossRate, 5);
+        });
       });
 
       it('has the correct localIpAddress set when the candidateType is host', async () => {
@@ -665,7 +808,11 @@ describe('plugin-meetings', () => {
 
         await progressTime();
         assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
-        mergeProperties(fakeStats, {relayProtocol: 'test', address: 'test2', candidateType: 'prflx'});
+        mergeProperties(fakeStats, {
+          relayProtocol: 'test',
+          address: 'test2',
+          candidateType: 'prflx',
+        });
         await progressTime();
         assert.strictEqual(statsAnalyzer.getLocalIpAddress(), 'test2');
       });
@@ -675,7 +822,11 @@ describe('plugin-meetings', () => {
 
         await progressTime();
         assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
-        mergeProperties(fakeStats, {relatedAddress: 'relatedAddress', address: 'test2', candidateType: 'prflx'});
+        mergeProperties(fakeStats, {
+          relatedAddress: 'relatedAddress',
+          address: 'test2',
+          candidateType: 'prflx',
+        });
         await progressTime();
         assert.strictEqual(statsAnalyzer.getLocalIpAddress(), 'relatedAddress');
       });