@webex/plugin-meetings 3.0.0-beta.34 → 3.0.0-beta.340

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

@@ -7,6 +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';
 
 const {assert} = chai;
 
@@ -53,7 +54,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,
@@ -84,6 +90,7 @@ describe('plugin-meetings', () => {
       let pc;
       let networkQualityMonitor;
       let statsAnalyzer;
+      let mqeData;
 
       let receivedEventsData = {
         local: {},
@@ -113,12 +120,28 @@ describe('plugin-meetings', () => {
           audio: {
             senders: [
               {
+                localTrackLabel: 'fake-microphone',
                 report: [
                   {
                     type: 'outbound-rtp',
                     packetsSent: 0,
                     bytesSent: 1,
                   },
+                  {
+                    type: 'candidate-pair',
+                    state: 'succeeded',
+                    localCandidateId: 'fake-candidate-id',
+                  },
+                  {
+                    type: 'candidate-pair',
+                    state: 'failed',
+                    localCandidateId: 'bad-candidate-id',
+                  },
+                  {
+                    type: 'local-candidate',
+                    id: 'fake-candidate-id',
+                    protocol: 'tcp',
+                  },
                 ],
               },
             ],
@@ -130,6 +153,21 @@ describe('plugin-meetings', () => {
                     packetsReceived: 0,
                     bytesReceived: 1,
                   },
+                  {
+                    type: 'candidate-pair',
+                    state: 'succeeded',
+                    localCandidateId: 'fake-candidate-id',
+                  },
+                  {
+                    type: 'candidate-pair',
+                    state: 'failed',
+                    localCandidateId: 'bad-candidate-id',
+                  },
+                  {
+                    type: 'local-candidate',
+                    id: 'fake-candidate-id',
+                    protocol: 'tcp',
+                  },
                 ],
               },
             ],
@@ -137,12 +175,28 @@ describe('plugin-meetings', () => {
           video: {
             senders: [
               {
+                localTrackLabel: 'fake-camera',
                 report: [
                   {
                     type: 'outbound-rtp',
-                    framesSent: 0,
+                    framesSent: 1500,
                     bytesSent: 1,
                   },
+                  {
+                    type: 'candidate-pair',
+                    state: 'succeeded',
+                    localCandidateId: 'fake-candidate-id',
+                  },
+                  {
+                    type: 'candidate-pair',
+                    state: 'failed',
+                    localCandidateId: 'bad-candidate-id',
+                  },
+                  {
+                    type: 'local-candidate',
+                    id: 'fake-candidate-id',
+                    protocol: 'tcp',
+                  },
                 ],
               },
             ],
@@ -153,6 +207,24 @@ describe('plugin-meetings', () => {
                     type: 'inbound-rtp',
                     framesDecoded: 0,
                     bytesReceived: 1,
+                    frameHeight: 720,
+                    frameWidth: 1280,
+                    framesReceived: 1500,
+                  },
+                  {
+                    type: 'candidate-pair',
+                    state: 'succeeded',
+                    localCandidateId: 'fake-candidate-id',
+                  },
+                  {
+                    type: 'candidate-pair',
+                    state: 'failed',
+                    localCandidateId: 'bad-candidate-id',
+                  },
+                  {
+                    type: 'local-candidate',
+                    id: 'fake-candidate-id',
+                    protocol: 'tcp',
                   },
                 ],
               },
@@ -172,19 +244,19 @@ describe('plugin-meetings', () => {
               receivers: [fakeStats.video.receivers[0]],
             },
             screenShareAudio: {
-              senders: [],
-              receivers: [],
+              senders: [fakeStats.audio.senders[0]],
+              receivers: [fakeStats.audio.receivers[0]],
             },
             screenShareVideo: {
-              senders: [],
-              receivers: [],
+              senders: [fakeStats.video.senders[0]],
+              receivers: [fakeStats.video.receivers[0]],
             },
           }),
         };
 
         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;
@@ -198,6 +270,9 @@ describe('plugin-meetings', () => {
         statsAnalyzer.on(EVENTS.REMOTE_MEDIA_STOPPED, (data) => {
           receivedEventsData.remote.stopped = data;
         });
+        statsAnalyzer.on(EVENTS.MEDIA_QUALITY, ({data}) => {
+          mqeData = data;
+        });
       });
 
       afterEach(() => {
@@ -211,6 +286,19 @@ describe('plugin-meetings', () => {
         await testUtils.flushPromises();
       };
 
+      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);
+                }
+            }
+        }
+    }
+
       const progressTime = async () => {
         await clock.tickAsync(initialConfig.analyzerInterval);
         await testUtils.flushPromises();
@@ -224,6 +312,23 @@ describe('plugin-meetings', () => {
         assert.deepEqual(receivedEventsData.remote.stopped, expected.remote?.stopped);
       };
 
+      const checkMqeData = () => {
+        for (const data of [
+          mqeData.audioTransmit,
+          mqeData.audioReceive,
+          mqeData.videoTransmit,
+          mqeData.videoReceive,
+        ]) {
+          assert.strictEqual(data.length, 2);
+          assert.strictEqual(data[0].common.common.isMain, true);
+          assert.strictEqual(data[1].common.common.isMain, false);
+        }
+
+        assert.strictEqual(mqeData.videoReceive[0].streams[0].receivedFrameSize, 3600);
+        assert.strictEqual(mqeData.videoReceive[0].streams[0].receivedHeight, 720);
+        assert.strictEqual(mqeData.videoReceive[0].streams[0].receivedWidth, 1280);
+      };
+
       it('emits LOCAL_MEDIA_STARTED and LOCAL_MEDIA_STOPPED events for audio', async () => {
         await startStatsAnalyzer({expected: {sendAudio: true}});
 
@@ -303,6 +408,125 @@ describe('plugin-meetings', () => {
 
         checkReceivedEvent({expected: {remote: {stopped: {type: 'video'}}}});
       });
+
+      it('emits the correct MEDIA_QUALITY events', async () => {
+        await startStatsAnalyzer({expected: {receiveVideo: true}});
+
+        await progressTime();
+
+        // Check that the mqe data has been emitted and is correctly computed.
+        checkMqeData();
+      });
+
+      it('emits the correct transportType in MEDIA_QUALITY events', async () => {
+        await startStatsAnalyzer({expected: {receiveVideo: true}});
+
+        await progressTime();
+
+        assert.strictEqual(mqeData.audioTransmit[0].common.transportType, 'TCP');
+        assert.strictEqual(mqeData.videoReceive[0].common.transportType, 'TCP');
+      });
+
+      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';
+
+        await startStatsAnalyzer({expected: {receiveVideo: true}});
+
+        await progressTime();
+
+        assert.strictEqual(mqeData.audioTransmit[0].common.transportType, 'TLS');
+        assert.strictEqual(mqeData.videoReceive[0].common.transportType, 'TLS');
+      });
+
+      it('emits the correct peripherals in MEDIA_QUALITY events', async () => {
+        await startStatsAnalyzer({expected: {receiveVideo: true}});
+
+        await progressTime();
+
+        assert.strictEqual(
+          mqeData.intervalMetadata.peripherals.find((val) => val.name === MEDIA_DEVICES.MICROPHONE)
+            .information,
+          'fake-microphone'
+        );
+        assert.strictEqual(
+          mqeData.intervalMetadata.peripherals.find((val) => val.name === MEDIA_DEVICES.CAMERA)
+            .information,
+          'fake-camera'
+        );
+      });
+
+      it('emits the correct peripherals in MEDIA_QUALITY events when localTrackLabel is undefined', async () => {
+        fakeStats.audio.senders[0].localTrackLabel = undefined;
+        fakeStats.video.senders[0].localTrackLabel = undefined;
+
+        await startStatsAnalyzer({expected: {receiveVideo: true}});
+
+        await progressTime();
+
+        assert.strictEqual(
+          mqeData.intervalMetadata.peripherals.find((val) => val.name === MEDIA_DEVICES.MICROPHONE)
+            .information,
+          _UNKNOWN_
+        );
+        assert.strictEqual(
+          mqeData.intervalMetadata.peripherals.find((val) => val.name === MEDIA_DEVICES.CAMERA)
+            .information,
+          _UNKNOWN_
+        );
+      });
+
+      it('emits the correct frameRate', async () => {
+        await startStatsAnalyzer({expected: {receiveVideo: true}});
+
+        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('has the correct localIpAddress set when the candidateType is host', async () => {
+        await startStatsAnalyzer();
+
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
+        mergeProperties(fakeStats, {address: 'test', candidateType: 'host'});
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), 'test');
+      });
+
+      it('has the correct localIpAddress set when the candidateType is prflx and relayProtocol is set', async () => {
+        await startStatsAnalyzer();
+
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
+        mergeProperties(fakeStats, {relayProtocol: 'test', address: 'test2', candidateType: 'prflx'});
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), 'test2');
+      });
+
+      it('has the correct localIpAddress set when the candidateType is prflx and relayProtocol is not set', async () => {
+        await startStatsAnalyzer();
+
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
+        mergeProperties(fakeStats, {relatedAddress: 'relatedAddress', address: 'test2', candidateType: 'prflx'});
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), 'relatedAddress');
+      });
+
+      it('has no localIpAddress set when the candidateType is invalid', async () => {
+        await startStatsAnalyzer();
+
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
+        mergeProperties(fakeStats, {candidateType: 'invalid'});
+        await progressTime();
+        assert.strictEqual(statsAnalyzer.getLocalIpAddress(), '');
+      });
     });
   });
 });

package/test/unit/spec/webinar/collection.ts

@@ -0,0 +1,13 @@
+import {assert} from '@webex/test-helper-chai';
+import WebinarCollection from '@webex/plugin-meetings/src/webinar/collection';
+
+describe('plugin-meetings', () => {
+    describe('WebinarCollection', () => {
+        it('the webinar collection is as expected', () => {
+            const collection = new WebinarCollection();
+
+            assert.equal(collection.namespace, 'Meetings');
+            assert.equal(collection.mainIndex, 'sessionId');
+        });
+    });
+});

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

@@ -0,0 +1,60 @@
+import {assert, expect} from '@webex/test-helper-chai';
+import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
+import Webinar from '@webex/plugin-meetings/src/webinar';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+
+describe('plugin-meetings', () => {
+    describe('Webinar', () => {
+
+        let webex;
+        let webinar;
+
+        beforeEach(() => {
+            // @ts-ignore
+            webex = new MockWebex({});
+            webex.internal.mercury.on = sinon.stub();
+            webinar = new Webinar({}, {parent: webex});
+            webinar.locusUrl = 'locusUrl';
+            webex.request = sinon.stub().returns(Promise.resolve('REQUEST_RETURN_VALUE'));
+            webex.meetings = {};
+            webex.meetings.getMeetingByType = sinon.stub();
+        });
+
+        describe('#locusUrlUpdate', () => {
+            it('sets the locus url', () => {
+                webinar.locusUrlUpdate('newUrl');
+
+                assert.equal(webinar.locusUrl, 'newUrl');
+            });
+        });
+
+        describe('#webcastUrlUpdate', () => {
+            it('sets the webcast url', () => {
+                webinar.webcastUrlUpdate('newUrl');
+
+                assert.equal(webinar.webcastUrl, 'newUrl');
+            });
+        });
+
+        describe('#webinarAttendeesSearchingUrlUpdate', () => {
+            it('sets the webinarAttendeesSearching url', () => {
+                webinar.webinarAttendeesSearchingUrlUpdate('newUrl');
+
+                assert.equal(webinar.webinarAttendeesSearchingUrl, 'newUrl');
+            });
+        });
+
+        describe('#updateCanManageWebcast', () => {
+          it('update canManageWebcast', () => {
+            webinar.updateCanManageWebcast(true);
+
+            assert.equal(webinar.canManageWebcast, true);
+
+            webinar.updateCanManageWebcast(false);
+
+            assert.equal(webinar.canManageWebcast, false);
+          });
+        });
+    })
+})

package/test/utils/integrationTestUtils.js

@@ -0,0 +1,46 @@
+import {assert} from '@webex/test-helper-chai';
+import {Defer} from '@webex/common';
+
+const addMedia = async (user, options = {}) => {
+
+  const {microphone, camera} = options;
+
+  if (options.multistream) {
+    await user.meeting.addMedia({localStreams: {microphone, camera}});
+  } else {
+    const mediaReadyPromises = Array.isArray(options.expectedMediaReadyTypes)
+      ? options.expectedMediaReadyTypes.reduce((output, expectedMediaReadyType) => {
+        if (typeof expectedMediaReadyType !== 'string') {
+          return output;
+        }
+
+        output[expectedMediaReadyType] = new Defer();
+
+        return output;
+      }, {})
+      : {remoteAudio: new Defer(), remoteVideo: new Defer()};
+
+    const mediaReady = (media) => {
+      if (!media) {
+        return;
+      }
+      if (mediaReadyPromises[media.type]) {
+        mediaReadyPromises[media.type].resolve();
+      }
+    };
+
+    user.meeting.on('media:ready', mediaReady);
+
+    await user.meeting.addMedia({localStreams: {microphone, camera}});
+    await Promise.all(Object.values(mediaReadyPromises).map((defer) => defer.promise));
+ };
+
+
+  assert.exists(user.meeting.mediaProperties.audioStream, 'audioStream not present');
+  assert.exists(user.meeting.mediaProperties.videoStream, 'videoStream not present');
+
+};
+
+export default {
+  addMedia
+};

package/test/utils/testUtils.js

@@ -1,5 +1,3 @@
-import {assert} from '@webex/test-helper-chai';
-import {Defer} from '@webex/common';
 
 const max = 30000;
 const waitForSpy = (spy, event) => {
@@ -195,56 +193,7 @@ const delayedTest = (callback, timeout) =>
     }, timeout);
   });
 
-const addMedia = (user, options = {}) => {
-  const mediaReadyPromises = Array.isArray(options.expectedMediaReadyTypes)
-    ? options.expectedMediaReadyTypes.reduce((output, expectedMediaReadyType) => {
-      if (typeof expectedMediaReadyType !== 'string') {
-        return output;
-      }
-
-      output[expectedMediaReadyType] = new Defer();
-
-      return output;
-    }, {})
-    : {local: new Defer(), remoteAudio: new Defer(), remoteVideo: new Defer()};
-
-  const mediaReady = (media) => {
-    if (!media) {
-      return;
-    }
-    if (mediaReadyPromises[media.type]) {
-      mediaReadyPromises[media.type].resolve();
-    }
-  };
 
-  user.meeting.on('media:ready', mediaReady);
-
-  return user.meeting
-    .getMediaStreams({
-      sendAudio: true,
-      sendVideo: true,
-      sendShare: false,
-    })
-    .then(([localStream, localShare]) =>
-      user.meeting.addMedia({
-        mediaSettings: {
-          sendAudio: true,
-          sendVideo: true,
-          sendShare: false,
-          receiveShare: true,
-          receiveAudio: true,
-          receiveVideo: true,
-        },
-        localShare,
-        localStream,
-      })
-    )
-    .then(() => Promise.all(Object.values(mediaReadyPromises).map((defer) => defer.promise)))
-    .then(() => {
-      assert.exists(user.meeting.mediaProperties.audioTrack, 'audioTrack not present');
-      assert.exists(user.meeting.mediaProperties.videoTrack, 'videoTrack not present');
-    });
-};
 
 const waitUntil = (waitTime) =>
   new Promise((resolve) => {
@@ -286,7 +235,6 @@ export default {
   waitForEvents,
   checkParticipantUpdatedStatus,
   delayedPromise,
-  addMedia,
   waitUntil,
   delayedTest,
   flushPromises,