@webex/plugin-meetings 3.0.0-beta.30 → 3.0.0-beta.301

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,
@@ -84,6 +89,7 @@ describe('plugin-meetings', () => {
       let pc;
       let networkQualityMonitor;
       let statsAnalyzer;
+      let mqeData;
 
       let receivedEventsData = {
         local: {},
@@ -119,6 +125,21 @@ describe('plugin-meetings', () => {
                     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 +151,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'
+                  },
                 ],
               },
             ],
@@ -143,6 +179,21 @@ describe('plugin-meetings', () => {
                     framesSent: 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'
+                  },
                 ],
               },
             ],
@@ -153,6 +204,24 @@ describe('plugin-meetings', () => {
                     type: 'inbound-rtp',
                     framesDecoded: 0,
                     bytesReceived: 1,
+                    frameHeight: 720,
+                    frameWidth: 1280,
+                    framesReceived: 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'
                   },
                 ],
               },
@@ -184,7 +253,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;
@@ -198,6 +267,9 @@ describe('plugin-meetings', () => {
         statsAnalyzer.on(EVENTS.REMOTE_MEDIA_STOPPED, (data) => {
           receivedEventsData.remote.stopped = data;
         });
+        statsAnalyzer.on(EVENTS.MEDIA_QUALITY, ({data}) => {
+          mqeData = data;
+        });
       });
 
       afterEach(() => {
@@ -224,6 +296,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}});
 
@@ -303,6 +381,38 @@ 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');
+      });
     });
   });
 });

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,

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

package/dist/meeting/effectsState.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["createEffectsState","type","LoggerProxy","logger","info","EffectsState","effectType","state","bnr","enabled","BNR_STATUS","NOT_ENABLED","callToWebrtcBNRInProgress","pendingPromiseResolve","pendingPromiseReject","isEnable","meeting","resolve","reject","enableBNR","disableBNR","ENABLED","e","isBnrEnabled","warn","resolvePromise","SHOULD_ENABLE","audioStream","MediaUtil","createMediaStream","mediaProperties","audioTrack","updateAudio","sendAudio","receiveAudio","mediaDirection","stream","Metrics","sendBehavioralMetric","BEHAVIORAL_METRICS","ENABLE_BNR_SUCCESS","error","ENABLE_BNR_FAILURE","reason","message","stack","rejectPromise","SHOULD_DISABLE","WebRTCMedia","Effects","BNR","DISABLE_BNR_SUCCESS","DISABLE_BNR_FAILURE"],"sources":["effectsState.ts"],"sourcesContent":["/* eslint-disable no-param-reassign */\nimport {Media as WebRTCMedia} from '@webex/internal-media-core';\n\nimport BEHAVIORAL_METRICS from '../metrics/constants';\nimport Metrics from '../metrics';\nimport MediaUtil from '../media/util';\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport {BNR_STATUS} from '../constants';\n\nconst createEffectsState = (type: any) => {\n  LoggerProxy.logger.info(\n    `Meeting:effectState#createEffectsState --> creating effectsState for effect ${type}`\n  );\n\n  return new EffectsState(type);\n};\n\n/* The purpose of this class is to manage the effects state(for eg., BNR).\n */\nclass EffectsState {\n  effectType: any;\n  pendingPromiseReject: any;\n  pendingPromiseResolve: any;\n  state: any;\n\n  constructor(type: any) {\n    this.effectType = type;\n    this.state = {\n      bnr: {\n        enabled: BNR_STATUS.NOT_ENABLED,\n      },\n      callToWebrtcBNRInProgress: false,\n    };\n    // these 2 hold the resolve, reject methods for the promise we returned to the client in last handleClientRequest() call\n    this.pendingPromiseResolve = null;\n    this.pendingPromiseReject = null;\n  }\n\n  /**\n   * @memberof EffectsState\n   * @param {Boolean} [isEnable] true for enableBNR, false for disableBNR request\n   * @param {Object} [meeting] the meeting object\n   * @returns {Promise}\n   */\n  async handleClientRequest(isEnable?: boolean, meeting?: object) {\n    return new Promise((resolve, reject) => {\n      if (this.pendingPromiseResolve) {\n        // resolve the last promise we returned to the client as the client has issued a new request that has superseded the previous one\n        this.pendingPromiseResolve();\n      }\n      this.pendingPromiseResolve = resolve;\n      this.pendingPromiseReject = reject;\n\n      if (isEnable) this.enableBNR(meeting);\n      else this.disableBNR(meeting);\n    });\n  }\n\n  /**\n   * Internal API to return status of BNR\n   * @memberof EffectsState\n   * @returns {Boolean}\n   * @public\n   * @memberof Meeting\n   */\n  public isBnrEnabled() {\n    return this.state.bnr.enabled === BNR_STATUS.ENABLED;\n  }\n\n  resolvePromise() {\n    if (this.pendingPromiseResolve) {\n      this.pendingPromiseResolve(true);\n    }\n    this.pendingPromiseResolve = null;\n    this.pendingPromiseReject = null;\n  }\n\n  rejectPromise(e) {\n    if (this.pendingPromiseReject) {\n      this.pendingPromiseReject(e);\n    }\n    this.pendingPromiseResolve = null;\n    this.pendingPromiseReject = null;\n  }\n\n  /**\n   * enableBNR API\n   * @param {Object} meeting the meeting object\n   * @returns {Promise<Boolean>}\n   * @public\n   * @memberof EffectsState\n   */\n  public async enableBNR(meeting: any) {\n    LoggerProxy.logger.info('Meeting:effectState#enableBNR. Enable BNR called');\n\n    if (this.isBnrEnabled()) {\n      LoggerProxy.logger.warn('Meeting:index#enableBNR. BNR is already enabled');\n\n      return this.resolvePromise();\n    }\n\n    if (this.state.callToWebrtcBNRInProgress) {\n      LoggerProxy.logger.warn(\n        'Meeting:effectState#enableBNR. Call to WebRTC in progress, we need to wait for it to complete'\n      );\n\n      return this.resolvePromise();\n    }\n\n    const {bnr} = this.state;\n\n    try {\n      bnr.enabled = BNR_STATUS.SHOULD_ENABLE;\n      this.state.callToWebrtcBNRInProgress = true;\n      const audioStream = MediaUtil.createMediaStream([meeting.mediaProperties.audioTrack]);\n\n      LoggerProxy.logger.info(\n        'Meeting:effectState#enableBNR. MediaStream created from meeting & sent to updateAudio'\n      );\n      await meeting.updateAudio({\n        sendAudio: true,\n        receiveAudio: meeting.mediaProperties.mediaDirection.receiveAudio,\n        stream: audioStream,\n      });\n\n      LoggerProxy.logger.info(\n        'Meeting:effectState#enableBNR. Updated meeting audio with bnr enabled track'\n      );\n      bnr.enabled = BNR_STATUS.ENABLED;\n      this.state.callToWebrtcBNRInProgress = false;\n      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ENABLE_BNR_SUCCESS);\n    } catch (error) {\n      bnr.enabled = BNR_STATUS.NOT_ENABLED;\n      this.state.callToWebrtcBNRInProgress = false;\n      LoggerProxy.logger.error('Meeting:index#enableBNR.', error);\n\n      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ENABLE_BNR_FAILURE, {\n        reason: error.message,\n        stack: error.stack,\n      });\n      this.rejectPromise(error);\n\n      throw error;\n    }\n\n    return this.resolvePromise();\n  }\n\n  /**\n   * disableBNR API\n   * @param {Object} meeting the meeting object\n   * @returns {Promise<Boolean>}\n   * @public\n   * @memberof EffectsState\n   */\n  public async disableBNR(meeting: any) {\n    LoggerProxy.logger.info('Meeting:effectState#disableBNR. Disable BNR called');\n\n    const {bnr} = this.state;\n\n    try {\n      if (this.state.callToWebrtcBNRInProgress) {\n        LoggerProxy.logger.info(\n          'Meeting:effectState#disableBNR. Call to WebRTC in progress, we need to wait for it to complete'\n        );\n\n        return this.resolvePromise();\n      }\n\n      bnr.enabled = BNR_STATUS.SHOULD_DISABLE;\n      this.state.callToWebrtcBNRInProgress = true;\n\n      // @ts-ignore - disableBNR does not expect an argument\n      const audioTrack = WebRTCMedia.Effects.BNR.disableBNR(meeting.mediaProperties.audioTrack);\n\n      const audioStream = MediaUtil.createMediaStream([audioTrack]);\n\n      LoggerProxy.logger.info(\n        'Meeting:effectState#disableBNR. Raw media track obtained from WebRTC & sent to updateAudio'\n      );\n\n      await meeting.updateAudio({\n        sendAudio: true,\n        receiveAudio: meeting.mediaProperties.mediaDirection.receiveAudio,\n        stream: audioStream,\n      });\n\n      bnr.enabled = BNR_STATUS.NOT_ENABLED;\n\n      this.state.callToWebrtcBNRInProgress = false;\n\n      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.DISABLE_BNR_SUCCESS);\n    } catch (error) {\n      bnr.enabled = BNR_STATUS.ENABLED;\n      this.state.callToWebrtcBNRInProgress = false;\n      LoggerProxy.logger.error(`Meeting:index#disableBNR. ${error}`);\n\n      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.DISABLE_BNR_FAILURE, {\n        reason: error.message,\n        stack: error.stack,\n      });\n      this.rejectPromise(error);\n\n      throw error;\n    }\n\n    return this.resolvePromise();\n  }\n}\n\nexport default createEffectsState;\n"],"mappings":";;;;;;;;;;;;;;AACA;AAEA;AACA;AACA;AACA;AACA;AAPA;;AASA,IAAMA,kBAAkB,GAAG,SAArBA,kBAAkB,CAAIC,IAAS,EAAK;EACxCC,oBAAW,CAACC,MAAM,CAACC,IAAI,uFAC0DH,IAAI,EACpF;EAED,OAAO,IAAII,YAAY,CAACJ,IAAI,CAAC;AAC/B,CAAC;;AAED;AACA;AADA,IAEMI,YAAY;EAMhB,sBAAYJ,IAAS,EAAE;IAAA;IAAA;IAAA;IAAA;IAAA;IACrB,IAAI,CAACK,UAAU,GAAGL,IAAI;IACtB,IAAI,CAACM,KAAK,GAAG;MACXC,GAAG,EAAE;QACHC,OAAO,EAAEC,sBAAU,CAACC;MACtB,CAAC;MACDC,yBAAyB,EAAE;IAC7B,CAAC;IACD;IACA,IAAI,CAACC,qBAAqB,GAAG,IAAI;IACjC,IAAI,CAACC,oBAAoB,GAAG,IAAI;EAClC;;EAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA;MAAA,mGAMA,iBAA0BC,QAAkB,EAAEC,OAAgB;QAAA;QAAA;UAAA;YAAA;cAAA,iCACrD,qBAAY,UAACC,OAAO,EAAEC,MAAM,EAAK;gBACtC,IAAI,KAAI,CAACL,qBAAqB,EAAE;kBAC9B;kBACA,KAAI,CAACA,qBAAqB,EAAE;gBAC9B;gBACA,KAAI,CAACA,qBAAqB,GAAGI,OAAO;gBACpC,KAAI,CAACH,oBAAoB,GAAGI,MAAM;gBAElC,IAAIH,QAAQ,EAAE,KAAI,CAACI,SAAS,CAACH,OAAO,CAAC,CAAC,KACjC,KAAI,CAACI,UAAU,CAACJ,OAAO,CAAC;cAC/B,CAAC,CAAC;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACH;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,wBAAsB;MACpB,OAAO,IAAI,CAACT,KAAK,CAACC,GAAG,CAACC,OAAO,KAAKC,sBAAU,CAACW,OAAO;IACtD;EAAC;IAAA;IAAA,OAED,0BAAiB;MACf,IAAI,IAAI,CAACR,qBAAqB,EAAE;QAC9B,IAAI,CAACA,qBAAqB,CAAC,IAAI,CAAC;MAClC;MACA,IAAI,CAACA,qBAAqB,GAAG,IAAI;MACjC,IAAI,CAACC,oBAAoB,GAAG,IAAI;IAClC;EAAC;IAAA;IAAA,OAED,uBAAcQ,CAAC,EAAE;MACf,IAAI,IAAI,CAACR,oBAAoB,EAAE;QAC7B,IAAI,CAACA,oBAAoB,CAACQ,CAAC,CAAC;MAC9B;MACA,IAAI,CAACT,qBAAqB,GAAG,IAAI;MACjC,IAAI,CAACC,oBAAoB,GAAG,IAAI;IAClC;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA;MAAA,yFAOA,kBAAuBE,OAAY;QAAA;QAAA;UAAA;YAAA;cACjCd,oBAAW,CAACC,MAAM,CAACC,IAAI,CAAC,kDAAkD,CAAC;cAAC,KAExE,IAAI,CAACmB,YAAY,EAAE;gBAAA;gBAAA;cAAA;cACrBrB,oBAAW,CAACC,MAAM,CAACqB,IAAI,CAAC,iDAAiD,CAAC;cAAC,kCAEpE,IAAI,CAACC,cAAc,EAAE;YAAA;cAAA,KAG1B,IAAI,CAAClB,KAAK,CAACK,yBAAyB;gBAAA;gBAAA;cAAA;cACtCV,oBAAW,CAACC,MAAM,CAACqB,IAAI,CACrB,+FAA+F,CAChG;cAAC,kCAEK,IAAI,CAACC,cAAc,EAAE;YAAA;cAGvBjB,GAAG,GAAI,IAAI,CAACD,KAAK,CAAjBC,GAAG;cAAA;cAGRA,GAAG,CAACC,OAAO,GAAGC,sBAAU,CAACgB,aAAa;cACtC,IAAI,CAACnB,KAAK,CAACK,yBAAyB,GAAG,IAAI;cACrCe,WAAW,GAAGC,aAAS,CAACC,iBAAiB,CAAC,CAACb,OAAO,CAACc,eAAe,CAACC,UAAU,CAAC,CAAC;cAErF7B,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,uFAAuF,CACxF;cAAC;cAAA,OACIY,OAAO,CAACgB,WAAW,CAAC;gBACxBC,SAAS,EAAE,IAAI;gBACfC,YAAY,EAAElB,OAAO,CAACc,eAAe,CAACK,cAAc,CAACD,YAAY;gBACjEE,MAAM,EAAET;cACV,CAAC,CAAC;YAAA;cAEFzB,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,6EAA6E,CAC9E;cACDI,GAAG,CAACC,OAAO,GAAGC,sBAAU,CAACW,OAAO;cAChC,IAAI,CAACd,KAAK,CAACK,yBAAyB,GAAG,KAAK;cAC5CyB,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACC,kBAAkB,CAAC;cAAC;cAAA;YAAA;cAAA;cAAA;cAEpEhC,GAAG,CAACC,OAAO,GAAGC,sBAAU,CAACC,WAAW;cACpC,IAAI,CAACJ,KAAK,CAACK,yBAAyB,GAAG,KAAK;cAC5CV,oBAAW,CAACC,MAAM,CAACsC,KAAK,CAAC,0BAA0B,eAAQ;cAE3DJ,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACG,kBAAkB,EAAE;gBAClEC,MAAM,EAAE,aAAMC,OAAO;gBACrBC,KAAK,EAAE,aAAMA;cACf,CAAC,CAAC;cACF,IAAI,CAACC,aAAa,cAAO;cAAC;YAAA;cAAA,kCAKrB,IAAI,CAACrB,cAAc,EAAE;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CAC7B;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA;MAAA,0FAOA,kBAAwBT,OAAY;QAAA;QAAA;UAAA;YAAA;cAClCd,oBAAW,CAACC,MAAM,CAACC,IAAI,CAAC,oDAAoD,CAAC;cAEtEI,GAAG,GAAI,IAAI,CAACD,KAAK,CAAjBC,GAAG;cAAA;cAAA,KAGJ,IAAI,CAACD,KAAK,CAACK,yBAAyB;gBAAA;gBAAA;cAAA;cACtCV,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,gGAAgG,CACjG;cAAC,kCAEK,IAAI,CAACqB,cAAc,EAAE;YAAA;cAG9BjB,GAAG,CAACC,OAAO,GAAGC,sBAAU,CAACqC,cAAc;cACvC,IAAI,CAACxC,KAAK,CAACK,yBAAyB,GAAG,IAAI;;cAE3C;cACMmB,UAAU,GAAGiB,wBAAW,CAACC,OAAO,CAACC,GAAG,CAAC9B,UAAU,CAACJ,OAAO,CAACc,eAAe,CAACC,UAAU,CAAC;cAEnFJ,WAAW,GAAGC,aAAS,CAACC,iBAAiB,CAAC,CAACE,UAAU,CAAC,CAAC;cAE7D7B,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,4FAA4F,CAC7F;cAAC;cAAA,OAEIY,OAAO,CAACgB,WAAW,CAAC;gBACxBC,SAAS,EAAE,IAAI;gBACfC,YAAY,EAAElB,OAAO,CAACc,eAAe,CAACK,cAAc,CAACD,YAAY;gBACjEE,MAAM,EAAET;cACV,CAAC,CAAC;YAAA;cAEFnB,GAAG,CAACC,OAAO,GAAGC,sBAAU,CAACC,WAAW;cAEpC,IAAI,CAACJ,KAAK,CAACK,yBAAyB,GAAG,KAAK;cAE5CyB,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACY,mBAAmB,CAAC;cAAC;cAAA;YAAA;cAAA;cAAA;cAErE3C,GAAG,CAACC,OAAO,GAAGC,sBAAU,CAACW,OAAO;cAChC,IAAI,CAACd,KAAK,CAACK,yBAAyB,GAAG,KAAK;cAC5CV,oBAAW,CAACC,MAAM,CAACsC,KAAK,mDAAsC;cAE9DJ,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACa,mBAAmB,EAAE;gBACnET,MAAM,EAAE,aAAMC,OAAO;gBACrBC,KAAK,EAAE,aAAMA;cACf,CAAC,CAAC;cACF,IAAI,CAACC,aAAa,cAAO;cAAC;YAAA;cAAA,kCAKrB,IAAI,CAACrB,cAAc,EAAE;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CAC7B;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;EAAA;AAAA;AAAA,eAGYzB,kBAAkB;AAAA"}