@webex/plugin-meetings 3.0.0-stream-classes.4 → 3.0.0-test.1

package/dist/meetings/index.js

@@ -57,6 +57,7 @@ var _collection = _interopRequireDefault(require("./collection"));
 var _util2 = _interopRequireDefault(require("./util"));
 var _permission = _interopRequireDefault(require("../common/errors/permission"));
 var _webexErrors = require("../common/errors/webex-errors");
+var _noMeetingInfo = _interopRequireDefault(require("../common/errors/no-meeting-info"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof _WeakMap !== "function") return null; var cacheBabelInterop = new _WeakMap(); var cacheNodeInterop = new _WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? _Object$getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { _Object$defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys2(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -583,7 +584,9 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
 
       // @ts-ignore
       this.webex.internal.mercury.on(_constants.ONLINE, function () {
-        _this3.syncMeetings();
+        _this3.syncMeetings({
+          keepOnlyLocusMeetings: false
+        });
       });
 
       // @ts-ignore
@@ -686,40 +689,43 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     }
 
     /**
-     * API to enable or disable TURN discovery
-     * @param {Boolean} enable
+     * API to toggle starting adhoc meeting
+     * @param {Boolean} changeState
      * @private
      * @memberof Meetings
      * @returns {undefined}
      */
   }, {
-    key: "_toggleTurnDiscovery",
-    value: function _toggleTurnDiscovery(enable) {
-      if (typeof enable !== 'boolean') {
+    key: "_toggleAdhocMeetings",
+    value: function _toggleAdhocMeetings(changeState) {
+      var _this$config2, _this$config2$experim;
+      if (typeof changeState !== 'boolean') {
         return;
       }
       // @ts-ignore
-      this.config.experimental.enableTurnDiscovery = enable;
+      if (((_this$config2 = this.config) === null || _this$config2 === void 0 ? void 0 : (_this$config2$experim = _this$config2.experimental) === null || _this$config2$experim === void 0 ? void 0 : _this$config2$experim.enableAdhocMeetings) !== changeState) {
+        // @ts-ignore
+        this.config.experimental.enableAdhocMeetings = changeState;
+      }
     }
 
     /**
-     * API to toggle starting adhoc meeting
-     * @param {Boolean} changeState
+     * API to toggle TCP reachability, needs to be called before webex.meetings.register()
+     * @param {Boolean} newValue
      * @private
      * @memberof Meetings
      * @returns {undefined}
      */
   }, {
-    key: "_toggleAdhocMeetings",
-    value: function _toggleAdhocMeetings(changeState) {
-      var _this$config2, _this$config2$experim;
-      if (typeof changeState !== 'boolean') {
+    key: "_toggleTcpReachability",
+    value: function _toggleTcpReachability(newValue) {
+      if (typeof newValue !== 'boolean') {
         return;
       }
       // @ts-ignore
-      if (((_this$config2 = this.config) === null || _this$config2 === void 0 ? void 0 : (_this$config2$experim = _this$config2.experimental) === null || _this$config2$experim === void 0 ? void 0 : _this$config2$experim.enableAdhocMeetings) !== changeState) {
+      if (this.config.experimental.enableTcpReachability !== newValue) {
         // @ts-ignore
-        this.config.experimental.enableAdhocMeetings = changeState;
+        this.config.experimental.enableTcpReachability = newValue;
       }
     }
 
@@ -972,12 +978,19 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     }
 
     /**
-     * Create a meeting.
+     * Create a meeting or return an existing meeting.
+     *
+     * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
+     *
      * @param {string} destination - sipURL, phonenumber, or locus object}
      * @param {string} [type] - the optional specified type, such as locusId
      * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
      * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
-     * @param {string} correlationId - the optional specified correlationId
+     * @param {string} correlationId - the optional specified correlationId (callStateForMetrics.correlationId can be provided instead)
+     * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
+     * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
+     * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
+     * @param {String} [meetingLookupUrl] - meeting info prefetch url
      * @returns {Promise<Meeting>} A new Meeting.
      * @public
      * @memberof Meetings
@@ -990,12 +1003,21 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
       var useRandomDelayForInfo = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
       var infoExtraParams = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
       var correlationId = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : undefined;
+      var failOnMissingMeetingInfo = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : false;
+      var callStateForMetrics = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : undefined;
+      var meetingInfo = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : undefined;
+      var meetingLookupUrl = arguments.length > 8 && arguments[8] !== undefined ? arguments[8] : undefined;
       // TODO: type should be from a dictionary
 
       // Validate meeting information based on the provided destination and
       // type. This must be performed prior to determining if the meeting is
       // found in the collection, as we mutate the destination for hydra person
       // id values.
+      if (correlationId) {
+        callStateForMetrics = _objectSpread(_objectSpread({}, callStateForMetrics || {}), {}, {
+          correlationId: correlationId
+        });
+      }
       return this.meetingInfo.fetchInfoOptions(destination, type)
       // Catch a failure to fetch info options.
       .catch(function (error) {
@@ -1031,20 +1053,22 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
         // Validate if a meeting was found.
         if (!meeting) {
           // Create a meeting based on the normalized destination and type.
-          return _this10.createMeeting(targetDest, type, useRandomDelayForInfo, infoExtraParams, correlationId).then(function (createdMeeting) {
+          return _this10.createMeeting(targetDest, type, useRandomDelayForInfo, infoExtraParams, callStateForMetrics, failOnMissingMeetingInfo, meetingInfo, meetingLookupUrl).then(function (createdMeeting) {
             // If the meeting was successfully created.
             if (createdMeeting && createdMeeting.on) {
               // Create a destruction event for the meeting.
               createdMeeting.on(_constants.EVENTS.DESTROY_MEETING, function (payload) {
                 // @ts-ignore
                 if (_this10.config.autoUploadLogs) {
-                  var _createdMeeting$locus, _createdMeeting$locus2, _createdMeeting$locus3, _createdMeeting$locus4;
+                  var _createdMeeting$locus, _createdMeeting$locus2, _createdMeeting$locus3, _createdMeeting$locus4, _createdMeeting$locus5, _createdMeeting$locus6;
                   _this10.uploadLogs({
                     callStart: (_createdMeeting$locus = createdMeeting.locusInfo) === null || _createdMeeting$locus === void 0 ? void 0 : (_createdMeeting$locus2 = _createdMeeting$locus.fullState) === null || _createdMeeting$locus2 === void 0 ? void 0 : _createdMeeting$locus2.lastActive,
+                    locussessionid: (_createdMeeting$locus3 = createdMeeting.locusInfo) === null || _createdMeeting$locus3 === void 0 ? void 0 : (_createdMeeting$locus4 = _createdMeeting$locus3.fullState) === null || _createdMeeting$locus4 === void 0 ? void 0 : _createdMeeting$locus4.sessionId,
                     correlationId: createdMeeting.correlationId,
                     feedbackId: createdMeeting.correlationId,
                     locusId: createdMeeting.locusId,
-                    meetingId: (_createdMeeting$locus3 = createdMeeting.locusInfo) === null || _createdMeeting$locus3 === void 0 ? void 0 : (_createdMeeting$locus4 = _createdMeeting$locus3.info) === null || _createdMeeting$locus4 === void 0 ? void 0 : _createdMeeting$locus4.webExMeetingId
+                    meetingId: (_createdMeeting$locus5 = createdMeeting.locusInfo) === null || _createdMeeting$locus5 === void 0 ? void 0 : (_createdMeeting$locus6 = _createdMeeting$locus5.info) === null || _createdMeeting$locus6 === void 0 ? void 0 : _createdMeeting$locus6.webExMeetingId,
+                    autoupload: true
                   }).then(function () {
                     return _this10.destroy(createdMeeting, payload.reason);
                   });
@@ -1055,13 +1079,15 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
               createdMeeting.on(_constants.EVENTS.REQUEST_UPLOAD_LOGS, function (meetingInstance) {
                 // @ts-ignore
                 if (_this10.config.autoUploadLogs) {
-                  var _meetingInstance$locu, _meetingInstance$locu2, _meetingInstance$locu3, _meetingInstance$locu4;
+                  var _meetingInstance$locu, _meetingInstance$locu2, _meetingInstance$locu3, _meetingInstance$locu4, _meetingInstance$locu5, _meetingInstance$locu6;
                   _this10.uploadLogs({
                     callStart: meetingInstance === null || meetingInstance === void 0 ? void 0 : (_meetingInstance$locu = meetingInstance.locusInfo) === null || _meetingInstance$locu === void 0 ? void 0 : (_meetingInstance$locu2 = _meetingInstance$locu.fullState) === null || _meetingInstance$locu2 === void 0 ? void 0 : _meetingInstance$locu2.lastActive,
+                    locussessionid: meetingInstance === null || meetingInstance === void 0 ? void 0 : (_meetingInstance$locu3 = meetingInstance.locusInfo) === null || _meetingInstance$locu3 === void 0 ? void 0 : (_meetingInstance$locu4 = _meetingInstance$locu3.fullState) === null || _meetingInstance$locu4 === void 0 ? void 0 : _meetingInstance$locu4.sessionId,
                     correlationId: meetingInstance.correlationId,
                     feedbackId: meetingInstance.correlationId,
                     locusId: meetingInstance.locusId,
-                    meetingId: (_meetingInstance$locu3 = meetingInstance.locusInfo) === null || _meetingInstance$locu3 === void 0 ? void 0 : (_meetingInstance$locu4 = _meetingInstance$locu3.info) === null || _meetingInstance$locu4 === void 0 ? void 0 : _meetingInstance$locu4.webExMeetingId
+                    meetingId: (_meetingInstance$locu5 = meetingInstance.locusInfo) === null || _meetingInstance$locu5 === void 0 ? void 0 : (_meetingInstance$locu6 = _meetingInstance$locu5.info) === null || _meetingInstance$locu6 === void 0 ? void 0 : _meetingInstance$locu6.webExMeetingId,
+                    autoupload: true
                   });
                 }
               });
@@ -1073,6 +1099,7 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
             return _promise.default.resolve(createdMeeting);
           });
         }
+        meeting.setCallStateForMetrics(callStateForMetrics);
 
         // Return the existing meeting.
         return _promise.default.resolve(meeting);
@@ -1080,11 +1107,18 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     }
 
     /**
+     * Create meeting
+     *
+     * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
+     *
      * @param {String} destination see create()
      * @param {String} type see create()
      * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
      * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
-     * @param {String} correlationId the optional specified correlationId
+     * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
+     * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
+     * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
+     * @param {String} [meetingLookupUrl] - meeting info prefetch url
      * @returns {Promise} a new meeting instance complete with meeting info and destination
      * @private
      * @memberof Meetings
@@ -1096,7 +1130,10 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
         var type,
           useRandomDelayForInfo,
           infoExtraParams,
-          correlationId,
+          callStateForMetrics,
+          failOnMissingMeetingInfo,
+          meetingInfo,
+          meetingLookupUrl,
           meeting,
           _destination$fullStat,
           waitingTime,
@@ -1107,6 +1144,7 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
           maxWaitingTime,
           isMeetingActive,
           enableUnifiedMeetings,
+          meetingInfoOptions,
           meetingAddedType,
           _args3 = arguments;
         return _regenerator.default.wrap(function _callee3$(_context3) {
@@ -1115,7 +1153,10 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
               type = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : null;
               useRandomDelayForInfo = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : false;
               infoExtraParams = _args3.length > 3 && _args3[3] !== undefined ? _args3[3] : {};
-              correlationId = _args3.length > 4 && _args3[4] !== undefined ? _args3[4] : undefined;
+              callStateForMetrics = _args3.length > 4 && _args3[4] !== undefined ? _args3[4] : undefined;
+              failOnMissingMeetingInfo = _args3.length > 5 && _args3[5] !== undefined ? _args3[5] : false;
+              meetingInfo = _args3.length > 6 && _args3[6] !== undefined ? _args3[6] : undefined;
+              meetingLookupUrl = _args3.length > 7 && _args3[7] !== undefined ? _args3[7] : undefined;
               meeting = new _meeting.default({
                 // @ts-ignore
                 userId: this.webex.internal.device.userId,
@@ -1128,13 +1169,13 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
                 meetingInfoProvider: this.meetingInfo,
                 destination: destination,
                 destinationType: type,
-                correlationId: correlationId
+                callStateForMetrics: callStateForMetrics
               }, {
                 // @ts-ignore
                 parent: this.webex
               });
               this.meetingCollection.set(meeting);
-              _context3.prev = 6;
+              _context3.prev = 9;
               // if no participant has joined the scheduled meeting (meaning meeting is not active) and we get a locusEvent,
               // it means the meeting will start in 5-6 min. In that case, we want to fetchMeetingInfo
               // between 5 and 2 min (random between 3 minutes) before the meeting starts
@@ -1150,37 +1191,57 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
               }
               isMeetingActive = !!((_destination$fullStat = destination.fullState) !== null && _destination$fullStat !== void 0 && _destination$fullStat.active); // @ts-ignore
               enableUnifiedMeetings = this.config.experimental.enableUnifiedMeetings;
+              meetingInfoOptions = {
+                extraParams: infoExtraParams,
+                sendCAevents: !!(callStateForMetrics !== null && callStateForMetrics !== void 0 && callStateForMetrics.correlationId) // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+              };
+              if (!meetingInfo) {
+                _context3.next = 19;
+                break;
+              }
+              meeting.injectMeetingInfo(meetingInfo, meetingInfoOptions, meetingLookupUrl);
+              _context3.next = 26;
+              break;
+            case 19:
               if (!(enableUnifiedMeetings && !isMeetingActive && useRandomDelayForInfo && waitingTime > 0)) {
-                _context3.next = 16;
+                _context3.next = 24;
                 break;
               }
               meeting.fetchMeetingInfoTimeoutId = setTimeout(function () {
-                return meeting.fetchMeetingInfo({
-                  extraParams: infoExtraParams
-                });
+                return meeting.fetchMeetingInfo(meetingInfoOptions);
               }, waitingTime);
               meeting.parseMeetingInfo(undefined, destination);
-              _context3.next = 18;
+              _context3.next = 26;
               break;
-            case 16:
-              _context3.next = 18;
-              return meeting.fetchMeetingInfo({
-                extraParams: infoExtraParams
-              });
-            case 18:
-              _context3.next = 24;
+            case 24:
+              _context3.next = 26;
+              return meeting.fetchMeetingInfo(meetingInfoOptions);
+            case 26:
+              _context3.next = 38;
               break;
-            case 20:
-              _context3.prev = 20;
-              _context3.t0 = _context3["catch"](6);
-              if (!(_context3.t0 instanceof _captchaError.default) && !(_context3.t0 instanceof _passwordError.default) && !(_context3.t0 instanceof _permission.default)) {
-                // if there is no meeting info we assume its a 1:1 call or wireless share
-                _loggerProxy.default.logger.info("Meetings:index#createMeeting --> Info Unable to fetch meeting info for ".concat(destination, "."));
-                _loggerProxy.default.logger.info('Meetings:index#createMeeting --> Info assuming this destination is a 1:1 or wireless share');
+            case 28:
+              _context3.prev = 28;
+              _context3.t0 = _context3["catch"](9);
+              if (!(!(_context3.t0 instanceof _captchaError.default) && !(_context3.t0 instanceof _passwordError.default) && !(_context3.t0 instanceof _permission.default))) {
+                _context3.next = 37;
+                break;
+              }
+              _loggerProxy.default.logger.info("Meetings:index#createMeeting --> Info Unable to fetch meeting info for ".concat(destination, "."));
+              if (!failOnMissingMeetingInfo) {
+                _context3.next = 36;
+                break;
               }
+              _loggerProxy.default.logger.info("Meetings:index#createMeeting --> Destroying meeting due to missing meeting info.");
+              // @ts-ignore
+              this.destroy(meeting, _constants.MEETING_REMOVED_REASON.MISSING_MEETING_INFO);
+              throw new _noMeetingInfo.default();
+            case 36:
+              // if there is no meeting info and no error should be thrown then we assume its a 1:1 call or wireless share
+              _loggerProxy.default.logger.info('Meetings:index#createMeeting --> Info assuming this destination is a 1:1 or wireless share');
+            case 37:
               _loggerProxy.default.logger.debug("Meetings:index#createMeeting --> Debug ".concat(_context3.t0, " fetching /meetingInfo for creation."));
-            case 24:
-              _context3.prev = 24;
+            case 38:
+              _context3.prev = 38;
               // For type LOCUS_ID we need to parse the locus object to get the information
               // about the caller and callee
               // Meeting Added event will be created in `handleLocusEvent`
@@ -1200,14 +1261,14 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
                   type: meetingAddedType
                 });
               }
-              return _context3.finish(24);
-            case 27:
+              return _context3.finish(38);
+            case 41:
               return _context3.abrupt("return", meeting);
-            case 28:
+            case 42:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[6, 20, 24, 27]]);
+        }, _callee3, this, [[9, 28, 38, 41]]);
       }));
       function createMeeting(_x3) {
         return _createMeeting.apply(this, arguments);
@@ -1247,8 +1308,9 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     }
 
     /**
-     * syncs all the meeting from server
-     * @returns {undefined}
+     * Syncs all the meetings from server. Does nothing and returns immediately if unverified guest.
+     * @param {boolean} keepOnlyLocusMeetings - whether the sync should keep only locus meetings or any other meeting in meetingCollection
+     * @returns {Promise<void>}
      * @public
      * @memberof Meetings
      */
@@ -1256,6 +1318,14 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     key: "syncMeetings",
     value: function syncMeetings() {
       var _this11 = this;
+      var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref3$keepOnlyLocusMe = _ref3.keepOnlyLocusMeetings,
+        keepOnlyLocusMeetings = _ref3$keepOnlyLocusMe === void 0 ? true : _ref3$keepOnlyLocusMe;
+      // @ts-ignore
+      if (this.webex.credentials.isUnverifiedGuest) {
+        _loggerProxy.default.logger.info('Meetings:index#syncMeetings --> skipping meeting sync as unverified guest');
+        return _promise.default.resolve();
+      }
       return this.request.getActiveMeetings().then(function (locusArray) {
         var activeLocusUrl = [];
         if (locusArray !== null && locusArray !== void 0 && locusArray.loci && locusArray.loci.length > 0) {
@@ -1270,12 +1340,14 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
         }
         var meetingsCollection = _this11.meetingCollection.getAll();
         if ((0, _keys.default)(meetingsCollection).length > 0) {
-          // Some time the mercury event is missed after mercury reconnect
-          // if sync returns no locus then clear all the meetings
+          // Sometimes the mercury events are lost after mercury reconnect
+          // Remove any Locus meetings that are not returned by Locus
+          // (they had a locusUrl previously but are no longer active) in the sync
           for (var _i = 0, _Object$values = (0, _values.default)(meetingsCollection); _i < _Object$values.length; _i++) {
             var meeting = _Object$values[_i];
             // @ts-ignore
-            if (!activeLocusUrl.includes(meeting.locusUrl)) {
+            var locusUrl = meeting.locusUrl;
+            if ((keepOnlyLocusMeetings || locusUrl) && !activeLocusUrl.includes(locusUrl)) {
               // destroy function also uploads logs
               // @ts-ignore
               _this11.destroy(meeting, _constants.MEETING_REMOVED_REASON.NO_MEETINGS_TO_SYNC);
@@ -1384,6 +1456,19 @@ var Meetings = /*#__PURE__*/function (_WebexPlugin) {
     value: function getLogger() {
       return _loggerProxy.default.get();
     }
+
+    /**
+     * Returns the first meeting it finds that has the webrtc media connection created.
+     * Useful for debugging in the console.
+     *
+     * @private
+     * @returns {Meeting} Meeting object that has a webrtc media connection, else undefined
+     */
+  }, {
+    key: "getActiveWebrtcMeeting",
+    value: function getActiveWebrtcMeeting() {
+      return this.meetingCollection.getActiveWebrtcMeeting();
+    }
   }]);
   return Meetings;
 }(_webexCore.WebexPlugin);