@webex/plugin-meetings 3.0.0-beta.22 → 3.0.0-beta.220

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

@@ -24,14 +24,15 @@ describe('plugin-meetings', () => {
       };
 
       const defaultStats = {
+        resolutions: {},
         internal: {
-          video: {
+          'video-send-1': {
             send: {
               totalPacketsLostOnReceiver: 10,
             },
           },
         },
-        video: {
+        'video-send-1': {
           send: {
             packetsSent: 2,
             meanRemoteJitter: [],
@@ -52,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,
@@ -65,12 +71,12 @@ describe('plugin-meetings', () => {
       });
 
       it('should trigger determineUplinkNetworkQuality with specific arguments', async () => {
-        await statsAnalyzer.parseGetStatsResult(statusResult, 'video');
+        await statsAnalyzer.parseGetStatsResult(statusResult, 'video-send-1', true);
 
         assert.calledOnce(statsAnalyzer.networkQualityMonitor.determineUplinkNetworkQuality);
         assert(
           sandBoxSpy.calledWith({
-            mediaType: 'video',
+            mediaType: 'video-send-1',
             remoteRtpResults: statusResult,
             statsAnalyzerCurrentStats: statsAnalyzer.statsResults,
           })
@@ -83,6 +89,7 @@ describe('plugin-meetings', () => {
       let pc;
       let networkQualityMonitor;
       let statsAnalyzer;
+      let mqeData;
 
       let receivedEventsData = {
         local: {},
@@ -110,28 +117,55 @@ describe('plugin-meetings', () => {
         // bytesReceived and bytesSent need to be non-zero in order for StatsAnalyzer to parse any other values
         fakeStats = {
           audio: {
-            receiver: {
-              type: 'inbound-rtp',
-              packetsReceived: 0,
-              bytesReceived: 1,
-            },
-            sender: {
-              type: 'outbound-rtp',
-              packetsSent: 0,
-              bytesSent: 1,
-            },
+            senders: [
+              {
+                report: [
+                  {
+                    type: 'outbound-rtp',
+                    packetsSent: 0,
+                    bytesSent: 1,
+                  },
+                ],
+              },
+            ],
+            receivers: [
+              {
+                report: [
+                  {
+                    type: 'inbound-rtp',
+                    packetsReceived: 0,
+                    bytesReceived: 1,
+                  },
+                ],
+              },
+            ],
           },
           video: {
-            receiver: {
-              type: 'inbound-rtp',
-              framesDecoded: 0,
-              bytesReceived: 1,
-            },
-            sender: {
-              type: 'outbound-rtp',
-              framesSent: 0,
-              bytesSent: 1,
-            },
+            senders: [
+              {
+                report: [
+                  {
+                    type: 'outbound-rtp',
+                    framesSent: 0,
+                    bytesSent: 1,
+                  },
+                ],
+              },
+            ],
+            receivers: [
+              {
+                report: [
+                  {
+                    type: 'inbound-rtp',
+                    framesDecoded: 0,
+                    bytesReceived: 1,
+                    frameHeight: 720,
+                    frameWidth: 1280,
+                    framesReceived: 1,
+                  },
+                ],
+              },
+            ],
           },
         };
 
@@ -139,28 +173,27 @@ describe('plugin-meetings', () => {
           getConnectionState: sinon.stub().returns(ConnectionState.Connected),
           getTransceiverStats: sinon.stub().resolves({
             audio: {
-              sender: [fakeStats.audio.sender],
-              receiver: [fakeStats.audio.receiver],
-              currentDirection: 'sendrecv',
-              localTrackLabel: 'fake mic',
+              senders: [fakeStats.audio.senders[0]],
+              receivers: [fakeStats.audio.receivers[0]],
             },
             video: {
-              sender: [fakeStats.video.sender],
-              receiver: [fakeStats.video.receiver],
-              currentDirection: 'sendrecv',
-              localTrackLabel: 'fake camera',
+              senders: [fakeStats.video.senders[0]],
+              receivers: [fakeStats.video.receivers[0]],
+            },
+            screenShareAudio: {
+              senders: [],
+              receivers: [],
             },
             screenShareVideo: {
-              sender: [],
-              receiver: [],
-              currentDirection: 'sendrecv',
+              senders: [],
+              receivers: [],
             },
           }),
         };
 
         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;
@@ -174,6 +207,9 @@ describe('plugin-meetings', () => {
         statsAnalyzer.on(EVENTS.REMOTE_MEDIA_STOPPED, (data) => {
           receivedEventsData.remote.stopped = data;
         });
+        statsAnalyzer.on(EVENTS.MEDIA_QUALITY, ({data}) => {
+          mqeData = data;
+        });
       });
 
       afterEach(() => {
@@ -200,6 +236,12 @@ describe('plugin-meetings', () => {
         assert.deepEqual(receivedEventsData.remote.stopped, expected.remote?.stopped);
       };
 
+      const checkMqeData = () => {
+        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}});
 
@@ -207,7 +249,7 @@ describe('plugin-meetings', () => {
         checkReceivedEvent({expected: {}});
 
         // setup a mock to return some values higher the previous ones
-        fakeStats.audio.sender.packetsSent += 10;
+        fakeStats.audio.senders[0].report[0].packetsSent += 10;
 
         await progressTime();
 
@@ -227,7 +269,7 @@ describe('plugin-meetings', () => {
         checkReceivedEvent({expected: {}});
 
         // setup a mock to return some values higher the previous ones
-        fakeStats.video.sender.framesSent += 1;
+        fakeStats.video.senders[0].report[0].framesSent += 1;
 
         await progressTime();
 
@@ -247,7 +289,7 @@ describe('plugin-meetings', () => {
         checkReceivedEvent({expected: {}});
 
         // setup a mock to return some values higher the previous ones
-        fakeStats.audio.receiver.packetsReceived += 5;
+        fakeStats.audio.receivers[0].report[0].packetsReceived += 5;
 
         await progressTime();
         // check that we got the REMOTE_MEDIA_STARTED event for audio
@@ -267,7 +309,7 @@ describe('plugin-meetings', () => {
         checkReceivedEvent({expected: {}});
 
         // setup a mock to return some values higher the previous ones
-        fakeStats.video.receiver.framesDecoded += 1;
+        fakeStats.video.receivers[0].report[0].framesDecoded += 1;
 
         await progressTime();
         // check that we got the REMOTE_MEDIA_STARTED event for video
@@ -279,6 +321,15 @@ 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();
+      });
     });
   });
 });

package/test/utils/constants.js

@@ -0,0 +1,9 @@
+// MOVE TO TEST CONSTANTS
+export const MEDIA_SERVERS = {
+  // The homer media server for converged multistream meetings.
+  HOMER: 'homer',
+  // The linus media server
+  LINUS: 'linus',
+  // The calliope media server for transcoded meetings
+  CALLIOPE: 'calliope',
+};

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({localTracks: {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({localTracks: {microphone, camera}});
+    await Promise.all(Object.values(mediaReadyPromises).map((defer) => defer.promise));
+ };
+
+
+  assert.exists(user.meeting.mediaProperties.audioTrack, 'audioTrack not present');
+  assert.exists(user.meeting.mediaProperties.videoTrack, 'videoTrack 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,49 +193,7 @@ const delayedTest = (callback, timeout) =>
     }, timeout);
   });
 
-const addMedia = (user) => {
-  const mediaReadyPromises = {
-    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) => {
@@ -279,7 +235,6 @@ export default {
   waitForEvents,
   checkParticipantUpdatedStatus,
   delayedPromise,
-  addMedia,
   waitUntil,
   delayedTest,
   flushPromises,

package/test/utils/webex-config.js

@@ -57,6 +57,10 @@ Config.webex = {
       enabled: true,
     },
     enableRtx: true,
+    experimental: {
+      enableMediaNegotiatedEvent: true,
+      enableUnifiedMeetings: true,
+    },
   },
   people: {
     showAllTypes: true,

package/test/utils/webex-test-users.js

@@ -17,9 +17,11 @@ require('@webex/plugin-people');
 require('@webex/plugin-rooms');
 require('@webex/plugin-meetings');
 
-const generateTestUsers = (options) =>
-  testUser
-    .create({count: options.count})
+const generateTestUsers = (options = {}) => {
+  options.config = options.config || {};
+  options.config.orgId = options.config.orgId || process.env.WEBEX_CONVERGED_ORG_ID;
+
+  return testUser.create(options)
     .then(async (userSet) => {
       if (userSet.length !== options.count) {
         return Promise.reject(new Error('Test users not created'));
@@ -52,6 +54,7 @@ const generateTestUsers = (options) =>
     .catch((error) => {
       console.error('#generateTestUsers=>ERROR', error);
     });
+};
 
 const reserveCMR = (user) =>
   user.webex

package/dist/meeting/effectsState.js

@@ -1,262 +0,0 @@
-"use strict";
-
-var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
-var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
-var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
-var _internalMediaCore = require("@webex/internal-media-core");
-var _constants = _interopRequireDefault(require("../metrics/constants"));
-var _metrics = _interopRequireDefault(require("../metrics"));
-var _util = _interopRequireDefault(require("../media/util"));
-var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
-var _constants2 = require("../constants");
-/* eslint-disable no-param-reassign */
-
-var createEffectsState = function createEffectsState(type) {
-  _loggerProxy.default.logger.info("Meeting:effectState#createEffectsState --> creating effectsState for effect ".concat(type));
-  return new EffectsState(type);
-};
-
-/* The purpose of this class is to manage the effects state(for eg., BNR).
- */
-var EffectsState = /*#__PURE__*/function () {
-  function EffectsState(type) {
-    (0, _classCallCheck2.default)(this, EffectsState);
-    (0, _defineProperty2.default)(this, "effectType", void 0);
-    (0, _defineProperty2.default)(this, "pendingPromiseReject", void 0);
-    (0, _defineProperty2.default)(this, "pendingPromiseResolve", void 0);
-    (0, _defineProperty2.default)(this, "state", void 0);
-    this.effectType = type;
-    this.state = {
-      bnr: {
-        enabled: _constants2.BNR_STATUS.NOT_ENABLED
-      },
-      callToWebrtcBNRInProgress: false
-    };
-    // these 2 hold the resolve, reject methods for the promise we returned to the client in last handleClientRequest() call
-    this.pendingPromiseResolve = null;
-    this.pendingPromiseReject = null;
-  }
-
-  /**
-   * @memberof EffectsState
-   * @param {Boolean} [isEnable] true for enableBNR, false for disableBNR request
-   * @param {Object} [meeting] the meeting object
-   * @returns {Promise}
-   */
-  (0, _createClass2.default)(EffectsState, [{
-    key: "handleClientRequest",
-    value: function () {
-      var _handleClientRequest = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(isEnable, meeting) {
-        var _this = this;
-        return _regenerator.default.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
-            case 0:
-              return _context.abrupt("return", new _promise.default(function (resolve, reject) {
-                if (_this.pendingPromiseResolve) {
-                  // resolve the last promise we returned to the client as the client has issued a new request that has superseded the previous one
-                  _this.pendingPromiseResolve();
-                }
-                _this.pendingPromiseResolve = resolve;
-                _this.pendingPromiseReject = reject;
-                if (isEnable) _this.enableBNR(meeting);else _this.disableBNR(meeting);
-              }));
-            case 1:
-            case "end":
-              return _context.stop();
-          }
-        }, _callee);
-      }));
-      function handleClientRequest(_x, _x2) {
-        return _handleClientRequest.apply(this, arguments);
-      }
-      return handleClientRequest;
-    }()
-    /**
-     * Internal API to return status of BNR
-     * @memberof EffectsState
-     * @returns {Boolean}
-     * @public
-     * @memberof Meeting
-     */
-  }, {
-    key: "isBnrEnabled",
-    value: function isBnrEnabled() {
-      return this.state.bnr.enabled === _constants2.BNR_STATUS.ENABLED;
-    }
-  }, {
-    key: "resolvePromise",
-    value: function resolvePromise() {
-      if (this.pendingPromiseResolve) {
-        this.pendingPromiseResolve(true);
-      }
-      this.pendingPromiseResolve = null;
-      this.pendingPromiseReject = null;
-    }
-  }, {
-    key: "rejectPromise",
-    value: function rejectPromise(e) {
-      if (this.pendingPromiseReject) {
-        this.pendingPromiseReject(e);
-      }
-      this.pendingPromiseResolve = null;
-      this.pendingPromiseReject = null;
-    }
-
-    /**
-     * enableBNR API
-     * @param {Object} meeting the meeting object
-     * @returns {Promise<Boolean>}
-     * @public
-     * @memberof EffectsState
-     */
-  }, {
-    key: "enableBNR",
-    value: function () {
-      var _enableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(meeting) {
-        var bnr, audioStream;
-        return _regenerator.default.wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
-            case 0:
-              _loggerProxy.default.logger.info('Meeting:effectState#enableBNR. Enable BNR called');
-              if (!this.isBnrEnabled()) {
-                _context2.next = 4;
-                break;
-              }
-              _loggerProxy.default.logger.warn('Meeting:index#enableBNR. BNR is already enabled');
-              return _context2.abrupt("return", this.resolvePromise());
-            case 4:
-              if (!this.state.callToWebrtcBNRInProgress) {
-                _context2.next = 7;
-                break;
-              }
-              _loggerProxy.default.logger.warn('Meeting:effectState#enableBNR. Call to WebRTC in progress, we need to wait for it to complete');
-              return _context2.abrupt("return", this.resolvePromise());
-            case 7:
-              bnr = this.state.bnr;
-              _context2.prev = 8;
-              bnr.enabled = _constants2.BNR_STATUS.SHOULD_ENABLE;
-              this.state.callToWebrtcBNRInProgress = true;
-              audioStream = _util.default.createMediaStream([meeting.mediaProperties.audioTrack]);
-              _loggerProxy.default.logger.info('Meeting:effectState#enableBNR. MediaStream created from meeting & sent to updateAudio');
-              _context2.next = 15;
-              return meeting.updateAudio({
-                sendAudio: true,
-                receiveAudio: meeting.mediaProperties.mediaDirection.receiveAudio,
-                stream: audioStream
-              });
-            case 15:
-              _loggerProxy.default.logger.info('Meeting:effectState#enableBNR. Updated meeting audio with bnr enabled track');
-              bnr.enabled = _constants2.BNR_STATUS.ENABLED;
-              this.state.callToWebrtcBNRInProgress = false;
-              _metrics.default.sendBehavioralMetric(_constants.default.ENABLE_BNR_SUCCESS);
-              _context2.next = 29;
-              break;
-            case 21:
-              _context2.prev = 21;
-              _context2.t0 = _context2["catch"](8);
-              bnr.enabled = _constants2.BNR_STATUS.NOT_ENABLED;
-              this.state.callToWebrtcBNRInProgress = false;
-              _loggerProxy.default.logger.error('Meeting:index#enableBNR.', _context2.t0);
-              _metrics.default.sendBehavioralMetric(_constants.default.ENABLE_BNR_FAILURE, {
-                reason: _context2.t0.message,
-                stack: _context2.t0.stack
-              });
-              this.rejectPromise(_context2.t0);
-              throw _context2.t0;
-            case 29:
-              return _context2.abrupt("return", this.resolvePromise());
-            case 30:
-            case "end":
-              return _context2.stop();
-          }
-        }, _callee2, this, [[8, 21]]);
-      }));
-      function enableBNR(_x3) {
-        return _enableBNR.apply(this, arguments);
-      }
-      return enableBNR;
-    }()
-    /**
-     * disableBNR API
-     * @param {Object} meeting the meeting object
-     * @returns {Promise<Boolean>}
-     * @public
-     * @memberof EffectsState
-     */
-  }, {
-    key: "disableBNR",
-    value: function () {
-      var _disableBNR = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(meeting) {
-        var bnr, audioTrack, audioStream;
-        return _regenerator.default.wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
-            case 0:
-              _loggerProxy.default.logger.info('Meeting:effectState#disableBNR. Disable BNR called');
-              bnr = this.state.bnr;
-              _context3.prev = 2;
-              if (!this.state.callToWebrtcBNRInProgress) {
-                _context3.next = 6;
-                break;
-              }
-              _loggerProxy.default.logger.info('Meeting:effectState#disableBNR. Call to WebRTC in progress, we need to wait for it to complete');
-              return _context3.abrupt("return", this.resolvePromise());
-            case 6:
-              bnr.enabled = _constants2.BNR_STATUS.SHOULD_DISABLE;
-              this.state.callToWebrtcBNRInProgress = true;
-
-              // @ts-ignore - disableBNR does not expect an argument
-              audioTrack = _internalMediaCore.Media.Effects.BNR.disableBNR(meeting.mediaProperties.audioTrack);
-              audioStream = _util.default.createMediaStream([audioTrack]);
-              _loggerProxy.default.logger.info('Meeting:effectState#disableBNR. Raw media track obtained from WebRTC & sent to updateAudio');
-              _context3.next = 13;
-              return meeting.updateAudio({
-                sendAudio: true,
-                receiveAudio: meeting.mediaProperties.mediaDirection.receiveAudio,
-                stream: audioStream
-              });
-            case 13:
-              bnr.enabled = _constants2.BNR_STATUS.NOT_ENABLED;
-              this.state.callToWebrtcBNRInProgress = false;
-              _metrics.default.sendBehavioralMetric(_constants.default.DISABLE_BNR_SUCCESS);
-              _context3.next = 26;
-              break;
-            case 18:
-              _context3.prev = 18;
-              _context3.t0 = _context3["catch"](2);
-              bnr.enabled = _constants2.BNR_STATUS.ENABLED;
-              this.state.callToWebrtcBNRInProgress = false;
-              _loggerProxy.default.logger.error("Meeting:index#disableBNR. ".concat(_context3.t0));
-              _metrics.default.sendBehavioralMetric(_constants.default.DISABLE_BNR_FAILURE, {
-                reason: _context3.t0.message,
-                stack: _context3.t0.stack
-              });
-              this.rejectPromise(_context3.t0);
-              throw _context3.t0;
-            case 26:
-              return _context3.abrupt("return", this.resolvePromise());
-            case 27:
-            case "end":
-              return _context3.stop();
-          }
-        }, _callee3, this, [[2, 18]]);
-      }));
-      function disableBNR(_x4) {
-        return _disableBNR.apply(this, arguments);
-      }
-      return disableBNR;
-    }()
-  }]);
-  return EffectsState;
-}();
-var _default = createEffectsState;
-exports.default = _default;
-//# sourceMappingURL=effectsState.js.map