@webex/plugin-meetings 3.0.0-beta.75 → 3.0.0-beta.76

package/src/statsAnalyzer/index.ts

@@ -28,6 +28,7 @@ import {
   getVideoSenderMqa,
   getVideoReceiverMqa,
 } from './mqaUtil';
+import {ReceiveSlot} from '../multistream/receiveSlot';
 
 export const EVENTS = {
   MEDIA_QUALITY: 'MEDIA_QUALITY',
@@ -53,6 +54,8 @@ const emptyReceiver = {
   meanRoundTripTime: [],
 };
 
+type ReceiveSlotCallback = (csi: number) => ReceiveSlot | undefined;
+
 /**
  * Stats Analyzer class that will emit events based on detected quality
  *
@@ -74,17 +77,20 @@ export class StatsAnalyzer extends EventsScope {
   statsInterval: NodeJS.Timeout;
   statsResults: any;
   statsStarted: any;
+  receiveSlotCallback: ReceiveSlotCallback;
 
   /**
    * Creates a new instance of StatsAnalyzer
    * @constructor
    * @public
    * @param {Object} config SDK Configuration Object
+   * @param {Function} receiveSlotCallback Callback used to access receive slots.
    * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
    * @param {Object} statsResults Default properties for stats
    */
   constructor(
     config: any,
+    receiveSlotCallback: ReceiveSlotCallback = () => undefined,
     networkQualityMonitor: object = {},
     statsResults: object = defaultStats
   ) {
@@ -98,6 +104,7 @@ export class StatsAnalyzer extends EventsScope {
     this.mqaSentCount = -1;
     this.lastMqaDataSent = {};
     this.lastEmittedStartStopEvent = {};
+    this.receiveSlotCallback = receiveSlotCallback;
   }
 
   /**
@@ -523,7 +530,8 @@ export class StatsAnalyzer extends EventsScope {
           currentStats.totalPacketsSent === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets sent`
+            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets sent`,
+            currentStats.totalPacketsSent
           );
         } else {
           if (
@@ -531,7 +539,8 @@ export class StatsAnalyzer extends EventsScope {
             currentStats.totalAudioEnergy === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No audio Energy present`
+              `StatsAnalyzer:index#compareLastStatsResult --> No audio Energy present`,
+              currentStats.totalAudioEnergy
             );
           }
 
@@ -565,14 +574,16 @@ export class StatsAnalyzer extends EventsScope {
 
         if (currentPacketsReceived === previousPacketsReceived || currentPacketsReceived === 0) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets received`,
+            currentPacketsReceived
           );
         } else if (
           currentSamplesReceived === previousSamplesReceived ||
           currentSamplesReceived === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No audio samples received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No audio samples received`,
+            currentSamplesReceived
           );
         }
 
@@ -589,7 +600,8 @@ export class StatsAnalyzer extends EventsScope {
           currentStats.totalPacketsSent === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets sent`
+            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets sent`,
+            currentStats.totalPacketsSent
           );
         } else {
           if (
@@ -597,7 +609,8 @@ export class StatsAnalyzer extends EventsScope {
             currentStats.framesEncoded === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames Encoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames Encoded`,
+              currentStats.framesEncoded
             );
           }
 
@@ -607,7 +620,8 @@ export class StatsAnalyzer extends EventsScope {
             this.statsResults.resolutions['video-send'].send.framesSent === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames sent`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames sent`,
+              this.statsResults.resolutions['video-send'].send.framesSent
             );
           }
         }
@@ -643,24 +657,28 @@ export class StatsAnalyzer extends EventsScope {
 
         if (currentPacketsReceived === previousPacketsReceived || currentPacketsReceived === 0) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets received`,
+            currentPacketsReceived
           );
         } else {
           if (currentFramesReceived === previousFramesReceived || currentFramesReceived === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video frames received`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video frames received`,
+              currentFramesReceived
             );
           }
 
           if (currentFramesDecoded === previousFramesDecoded || currentFramesDecoded === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video frames decoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video frames decoded`,
+              currentFramesDecoded
             );
           }
 
           if (currentFramesDropped - previousFramesDropped > 10) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> video frames are getting dropped`
+              `StatsAnalyzer:index#compareLastStatsResult --> video frames are getting dropped`,
+              currentFramesDropped - previousFramesDropped
             );
           }
         }
@@ -679,7 +697,8 @@ export class StatsAnalyzer extends EventsScope {
           currentStats.totalPacketsSent === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets sent`
+            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets sent`,
+            currentStats.totalPacketsSent
           );
         } else {
           if (
@@ -687,7 +706,8 @@ export class StatsAnalyzer extends EventsScope {
             currentStats.framesEncoded === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames getting encoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames getting encoded`,
+              currentStats.framesEncoded
             );
           }
 
@@ -697,7 +717,8 @@ export class StatsAnalyzer extends EventsScope {
             this.statsResults.resolutions['video-share-send'].send.framesSent === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames sent`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames sent`,
+              this.statsResults.resolutions['video-share-send'].send.framesSent
             );
           }
         }
@@ -735,24 +756,28 @@ export class StatsAnalyzer extends EventsScope {
 
         if (currentPacketsReceived === previousPacketsReceived || currentPacketsReceived === 0) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets received`,
+            currentPacketsReceived
           );
         } else {
           if (currentFramesReceived === previousFramesReceived || currentFramesReceived === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames received`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames received`,
+              currentFramesReceived
             );
           }
 
           if (currentFramesDecoded === previousFramesDecoded || currentFramesDecoded === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames decoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames decoded`,
+              currentFramesDecoded
             );
           }
 
           if (currentFramesDropped - previousFramesDropped > 10) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> share frames are getting dropped`
+              `StatsAnalyzer:index#compareLastStatsResult --> share frames are getting dropped`,
+              currentFramesDropped - previousFramesDropped
             );
           }
         }
@@ -933,6 +958,10 @@ export class StatsAnalyzer extends EventsScope {
 
     if (result.bytesReceived) {
       let kilobytes = 0;
+      const receiveSlot = this.receiveSlotCallback(result.ssrc);
+      const idAndCsi = receiveSlot
+        ? `id: "${receiveSlot.id || ''}"${receiveSlot.csi ? ` and csi: ${receiveSlot.csi}` : ''}`
+        : '';
 
       if (result.frameWidth && result.frameHeight) {
         this.statsResults.resolutions[mediaType][sendrecvType].width = result.frameWidth;
@@ -989,10 +1018,12 @@ export class StatsAnalyzer extends EventsScope {
         result.packetsReceived;
 
       if (this.statsResults[mediaType][sendrecvType].packetsReceived === 0) {
-        LoggerProxy.logger.info(
-          `StatsAnalyzer:index#processInboundRTPResult --> No packets received for ${mediaType} `,
-          this.statsResults[mediaType][sendrecvType].packetsReceived
-        );
+        if (receiveSlot) {
+          LoggerProxy.logger.info(
+            `StatsAnalyzer:index#processInboundRTPResult --> No packets received for receive slot ${idAndCsi}`,
+            this.statsResults[mediaType][sendrecvType].packetsReceived
+          );
+        }
       }
 
       //  Check the over all packet Lost ratio
@@ -1004,7 +1035,7 @@ export class StatsAnalyzer extends EventsScope {
           : 0;
       if (this.statsResults[mediaType][sendrecvType].currentPacketLossRatio > 3) {
         LoggerProxy.logger.info(
-          'StatsAnalyzer:index#processInboundRTPResult --> Packets getting lost from the receiver ',
+          `StatsAnalyzer:index#processInboundRTPResult --> Packets getting lost from the receiver with slot ${idAndCsi}`,
           this.statsResults[mediaType][sendrecvType].currentPacketLossRatio
         );
       }

package/test/unit/spec/multistream/receiveSlotManager.ts

@@ -15,7 +15,7 @@ describe('ReceiveSlotManager', () => {
 
   beforeEach(() => {
     fakeWcmeSlot = {
-      id: 'fake wcme slot',
+      id: {ssrc: 1},
     };
     fakeReceiveSlots = [];
     mockReceiveSlotCtor = sinon.stub(ReceiveSlotModule, 'ReceiveSlot').callsFake((mediaType) => {
@@ -23,6 +23,7 @@ describe('ReceiveSlotManager', () => {
         id: `fake sdk receive slot ${fakeReceiveSlots.length + 1}`,
         mediaType,
         findMemberId: sinon.stub(),
+        wcmeReceiveSlot: fakeWcmeSlot,
       };
 
       fakeReceiveSlots.push(fakeReceiveSlot);
@@ -168,7 +169,6 @@ describe('ReceiveSlotManager', () => {
   });
 
   describe('updateMemberIds', () => {
-
     it('calls findMemberId() on all allocated receive slots', async () => {
       const audioSlots: ReceiveSlot[] = [];
       const videoSlots: ReceiveSlot[] = [];
@@ -187,9 +187,17 @@ describe('ReceiveSlotManager', () => {
 
       assert.strictEqual(fakeReceiveSlots.length, audioSlots.length + videoSlots.length);
 
-      fakeReceiveSlots.forEach(slot => {
+      fakeReceiveSlots.forEach((slot) => {
         assert.calledOnce(slot.findMemberId);
       });
     });
   });
+
+  describe('findReceiveSlotBySsrc', () => {
+    it('finds a receive slot with a specific id', async () => {
+      await receiveSlotManager.allocateSlot(MediaType.VideoMain);
+      assert.exists(receiveSlotManager.findReceiveSlotBySsrc(1));
+      assert.strictEqual(receiveSlotManager.findReceiveSlotBySsrc(2), undefined);
+    });
+  });
 });

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

@@ -53,7 +53,12 @@ describe('plugin-meetings', () => {
       beforeEach(() => {
         const networkQualityMonitor = new NetworkQualityMonitor(initialConfig);
 
-        statsAnalyzer = new StatsAnalyzer(initialConfig, networkQualityMonitor, defaultStats);
+        statsAnalyzer = new StatsAnalyzer(
+          initialConfig,
+          () => ({}),
+          networkQualityMonitor,
+          defaultStats
+        );
 
         sandBoxSpy = sandbox.spy(
           statsAnalyzer.networkQualityMonitor,
@@ -188,7 +193,7 @@ describe('plugin-meetings', () => {
 
         networkQualityMonitor = new NetworkQualityMonitor(initialConfig);
 
-        statsAnalyzer = new StatsAnalyzer(initialConfig, networkQualityMonitor);
+        statsAnalyzer = new StatsAnalyzer(initialConfig, () => ({}), networkQualityMonitor);
 
         statsAnalyzer.on(EVENTS.LOCAL_MEDIA_STARTED, (data) => {
           receivedEventsData.local.started = data;