@webex/plugin-meetings 3.4.0 → 3.5.0-next.2

package/dist/reachability/index.js

@@ -12,11 +12,11 @@ _Object$defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
 var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
 var _values = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/values"));
 var _entries = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/entries"));
 var _keys = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/keys"));
+var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/toConsumableArray"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/slicedToArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
@@ -101,6 +101,7 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
         xtls: 0
       }
     });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "lastTrigger", void 0);
     _this.webex = webex;
 
     /**
@@ -116,48 +117,108 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }
 
   /**
-   * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
-   * @returns {Promise<ReachabilityResults>} reachability results
-   * @public
-   * @memberof Reachability
+   * Fetches the list of media clusters from the backend
+   * @param {boolean} isRetry
+   * @private
+   * @returns {Promise<{clusters: ClusterList, joinCookie: any}>}
    */
   (0, _createClass2.default)(Reachability, [{
-    key: "gatherReachability",
+    key: "getClusters",
     value: (function () {
-      var _gatherReachability = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-        var _yield$this$reachabil, clusters, joinCookie;
+      var _getClusters = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        var isRetry,
+          _yield$this$reachabil,
+          clusters,
+          joinCookie,
+          _args = arguments;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.prev = 0;
-              _context.next = 3;
+              isRetry = _args.length > 0 && _args[0] !== undefined ? _args[0] : false;
+              _context.prev = 1;
+              _context.next = 4;
               return this.reachabilityRequest.getClusters(_util.default.getIpVersion(this.webex));
-            case 3:
+            case 4:
               _yield$this$reachabil = _context.sent;
               clusters = _yield$this$reachabil.clusters;
               joinCookie = _yield$this$reachabil.joinCookie;
-              _context.next = 8;
+              return _context.abrupt("return", {
+                clusters: clusters,
+                joinCookie: joinCookie
+              });
+            case 10:
+              _context.prev = 10;
+              _context.t0 = _context["catch"](1);
+              if (!isRetry) {
+                _context.next = 14;
+                break;
+              }
+              throw _context.t0;
+            case 14:
+              _loggerProxy.default.logger.error("Reachability:index#getClusters --> Failed with error: ".concat(_context.t0, ", retrying..."));
+              return _context.abrupt("return", this.getClusters(true));
+            case 16:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[1, 10]]);
+      }));
+      function getClusters() {
+        return _getClusters.apply(this, arguments);
+      }
+      return getClusters;
+    }()
+    /**
+     * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
+     * @param {string} trigger - explains the reason for starting reachability
+     * @returns {Promise<ReachabilityResults>} reachability results
+     * @public
+     * @memberof Reachability
+     */
+    )
+  }, {
+    key: "gatherReachability",
+    value: (function () {
+      var _gatherReachability = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(trigger) {
+        var _yield$this$getCluste, clusters, joinCookie;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              this.lastTrigger = trigger;
+
+              // kick off ip version detection. For now we don't await it, as we're doing it
+              // to gather the timings and send them with our reachability metrics
+              // @ts-ignore
+              this.webex.internal.device.ipNetworkDetector.detect();
+              _context2.next = 5;
+              return this.getClusters();
+            case 5:
+              _yield$this$getCluste = _context2.sent;
+              clusters = _yield$this$getCluste.clusters;
+              joinCookie = _yield$this$getCluste.joinCookie;
+              _context2.next = 10;
               return this.webex.boundedStorage.put(this.namespace, _constants.REACHABILITY.localStorageJoinCookie, (0, _stringify.default)(joinCookie));
-            case 8:
+            case 10:
               this.reachabilityDefer = new _common.Defer();
 
               // Perform Reachability Check
-              _context.next = 11;
+              _context2.next = 13;
               return this.performReachabilityChecks(clusters);
-            case 11:
-              return _context.abrupt("return", this.reachabilityDefer.promise);
-            case 14:
-              _context.prev = 14;
-              _context.t0 = _context["catch"](0);
-              _loggerProxy.default.logger.error("Reachability:index#gatherReachability --> Error:", _context.t0);
-              return _context.abrupt("return", {});
-            case 18:
+            case 13:
+              return _context2.abrupt("return", this.reachabilityDefer.promise);
+            case 16:
+              _context2.prev = 16;
+              _context2.t0 = _context2["catch"](0);
+              _loggerProxy.default.logger.error("Reachability:index#gatherReachability --> Error:", _context2.t0);
+              return _context2.abrupt("return", {});
+            case 20:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, this, [[0, 14]]);
+        }, _callee2, this, [[0, 16]]);
       }));
-      function gatherReachability() {
+      function gatherReachability(_x) {
         return _gatherReachability.apply(this, arguments);
       }
       return gatherReachability;
@@ -172,10 +233,10 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "getReachabilityMetrics",
     value: (function () {
-      var _getReachabilityMetrics = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
+      var _getReachabilityMetrics = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
         var stats, updateStats, resultsJson, results;
-        return _regenerator.default.wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
             case 0:
               stats = {
                 reachability_public_udp_success: 0,
@@ -205,29 +266,29 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                   stats["reachability_".concat(clusterType, "_xtls_").concat(_outcome2)] += 1;
                 }
               };
-              _context2.prev = 2;
-              _context2.next = 5;
+              _context3.prev = 2;
+              _context3.next = 5;
               return this.webex.boundedStorage.get(_constants.REACHABILITY.namespace, _constants.REACHABILITY.localStorageResult);
             case 5:
-              resultsJson = _context2.sent;
+              resultsJson = _context3.sent;
               results = JSON.parse(resultsJson);
               (0, _values.default)(results).forEach(function (result) {
                 updateStats(result.isVideoMesh ? 'vmn' : 'public', result);
               });
-              _context2.next = 13;
+              _context3.next = 13;
               break;
             case 10:
-              _context2.prev = 10;
-              _context2.t0 = _context2["catch"](2);
+              _context3.prev = 10;
+              _context3.t0 = _context3["catch"](2);
               // empty storage, that's ok
-              _loggerProxy.default.logger.warn('Roap:request#getReachabilityMetrics --> Error parsing reachability data: ', _context2.t0);
+              _loggerProxy.default.logger.warn('Roap:request#getReachabilityMetrics --> Error parsing reachability data: ', _context3.t0);
             case 13:
-              return _context2.abrupt("return", stats);
+              return _context3.abrupt("return", stats);
             case 14:
             case "end":
-              return _context2.stop();
+              return _context3.stop();
           }
-        }, _callee2, this, [[2, 10]]);
+        }, _callee3, this, [[2, 10]]);
       }));
       function getReachabilityMetrics() {
         return _getReachabilityMetrics.apply(this, arguments);
@@ -280,17 +341,17 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "getReachabilityResults",
     value: (function () {
-      var _getReachabilityResults = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+      var _getReachabilityResults = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
         var _this2 = this;
         var results, resultsJson, allClusterResults;
-        return _regenerator.default.wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
+        return _regenerator.default.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              _context3.prev = 0;
-              _context3.next = 3;
+              _context4.prev = 0;
+              _context4.next = 3;
               return this.webex.boundedStorage.get(_constants.REACHABILITY.namespace, _constants.REACHABILITY.localStorageResult);
             case 3:
-              resultsJson = _context3.sent;
+              resultsJson = _context4.sent;
               allClusterResults = JSON.parse(resultsJson);
               results = (0, _lodash.mapValues)(allClusterResults, function (clusterResult) {
                 return {
@@ -305,20 +366,20 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                   })
                 };
               });
-              _context3.next = 11;
+              _context4.next = 11;
               break;
             case 8:
-              _context3.prev = 8;
-              _context3.t0 = _context3["catch"](0);
+              _context4.prev = 8;
+              _context4.t0 = _context4["catch"](0);
               // empty storage, that's ok
-              _loggerProxy.default.logger.warn('Roap:request#attachReachabilityData --> Error parsing reachability data: ', _context3.t0);
+              _loggerProxy.default.logger.warn('Roap:request#attachReachabilityData --> Error parsing reachability data: ', _context4.t0);
             case 11:
-              return _context3.abrupt("return", results);
+              return _context4.abrupt("return", results);
             case 12:
             case "end":
-              return _context3.stop();
+              return _context4.stop();
           }
-        }, _callee3, this, [[0, 8]]);
+        }, _callee4, this, [[0, 8]]);
       }));
       function getReachabilityResults() {
         return _getReachabilityResults.apply(this, arguments);
@@ -335,16 +396,16 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "isAnyPublicClusterReachable",
     value: (function () {
-      var _isAnyPublicClusterReachable = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
+      var _isAnyPublicClusterReachable = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
         var reachable, reachabilityData, reachabilityResults;
-        return _regenerator.default.wrap(function _callee4$(_context4) {
-          while (1) switch (_context4.prev = _context4.next) {
+        return _regenerator.default.wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
             case 0:
               reachable = false; // @ts-ignore
-              _context4.next = 3;
+              _context5.next = 3;
               return this.webex.boundedStorage.get(this.namespace, _constants.REACHABILITY.localStorageResult).catch(function () {});
             case 3:
-              reachabilityData = _context4.sent;
+              reachabilityData = _context5.sent;
               if (reachabilityData) {
                 try {
                   reachabilityResults = JSON.parse(reachabilityData);
@@ -356,12 +417,12 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                   _loggerProxy.default.logger.error("Roap:request#attachReachabilityData --> Error in parsing reachability data: ".concat(e));
                 }
               }
-              return _context4.abrupt("return", reachable);
+              return _context5.abrupt("return", reachable);
             case 6:
             case "end":
-              return _context4.stop();
+              return _context5.stop();
           }
-        }, _callee4, this);
+        }, _callee5, this);
       }));
       function isAnyPublicClusterReachable() {
         return _isAnyPublicClusterReachable.apply(this, arguments);
@@ -382,16 +443,16 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "isWebexMediaBackendUnreachable",
     value: (function () {
-      var _isWebexMediaBackendUnreachable = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
+      var _isWebexMediaBackendUnreachable = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
         var unreachable, reachabilityData, reachabilityResults, protocols;
-        return _regenerator.default.wrap(function _callee5$(_context5) {
-          while (1) switch (_context5.prev = _context5.next) {
+        return _regenerator.default.wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
             case 0:
               unreachable = false; // @ts-ignore
-              _context5.next = 3;
+              _context6.next = 3;
               return this.webex.boundedStorage.get(this.namespace, _constants.REACHABILITY.localStorageResult).catch(function () {});
             case 3:
-              reachabilityData = _context5.sent;
+              reachabilityData = _context6.sent;
               if (reachabilityData) {
                 try {
                   reachabilityResults = JSON.parse(reachabilityData);
@@ -429,12 +490,12 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                   _loggerProxy.default.logger.error("Roap:request#attachReachabilityData --> Error in parsing reachability data: ".concat(e));
                 }
               }
-              return _context5.abrupt("return", unreachable);
+              return _context6.abrupt("return", unreachable);
             case 6:
             case "end":
-              return _context5.stop();
+              return _context6.stop();
           }
-        }, _callee5, this);
+        }, _callee6, this);
       }));
       function isWebexMediaBackendUnreachable() {
         return _isWebexMediaBackendUnreachable.apply(this, arguments);
@@ -591,10 +652,10 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "sendMetric",
     value: (function () {
-      var _sendMetric = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
+      var _sendMetric = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
         var results, stats;
-        return _regenerator.default.wrap(function _callee6$(_context6) {
-          while (1) switch (_context6.prev = _context6.next) {
+        return _regenerator.default.wrap(function _callee7$(_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
             case 0:
               results = [];
               (0, _values.default)(this.clusterReachability).forEach(function (clusterReachability) {
@@ -610,14 +671,25 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                   udp: this.getStatistics(results, 'udp', false),
                   tcp: this.getStatistics(results, 'tcp', false),
                   xtls: this.getStatistics(results, 'xtls', false)
-                }
+                },
+                ipver: {
+                  // @ts-ignore
+                  firstIpV4: this.webex.internal.device.ipNetworkDetector.firstIpV4,
+                  // @ts-ignore
+                  firstIpV6: this.webex.internal.device.ipNetworkDetector.firstIpV6,
+                  // @ts-ignore
+                  firstMdns: this.webex.internal.device.ipNetworkDetector.firstMdns,
+                  // @ts-ignore
+                  totalTime: this.webex.internal.device.ipNetworkDetector.totalTime
+                },
+                trigger: this.lastTrigger
               };
               _metrics.default.sendBehavioralMetric(_constants2.default.REACHABILITY_COMPLETED, _metrics.default.prepareMetricFields(stats));
             case 4:
             case "end":
-              return _context6.stop();
+              return _context7.stop();
           }
-        }, _callee6, this);
+        }, _callee7, this);
       }));
       function sendMetric() {
         return _sendMetric.apply(this, arguments);
@@ -671,19 +743,19 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "storeResults",
     value: (function () {
-      var _storeResults = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(results) {
-        return _regenerator.default.wrap(function _callee7$(_context7) {
-          while (1) switch (_context7.prev = _context7.next) {
+      var _storeResults = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(results) {
+        return _regenerator.default.wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
             case 0:
-              _context7.next = 2;
+              _context8.next = 2;
               return this.webex.boundedStorage.put(this.namespace, _constants.REACHABILITY.localStorageResult, (0, _stringify.default)(results));
             case 2:
             case "end":
-              return _context7.stop();
+              return _context8.stop();
           }
-        }, _callee7, this);
+        }, _callee8, this);
       }));
-      function storeResults(_x) {
+      function storeResults(_x2) {
         return _storeResults.apply(this, arguments);
       }
       return storeResults;
@@ -715,19 +787,19 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "performReachabilityChecks",
     value: (function () {
-      var _performReachabilityChecks = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(clusterList) {
+      var _performReachabilityChecks = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(clusterList) {
         var _this4 = this;
         var results, isFirstResult;
-        return _regenerator.default.wrap(function _callee10$(_context10) {
-          while (1) switch (_context10.prev = _context10.next) {
+        return _regenerator.default.wrap(function _callee11$(_context11) {
+          while (1) switch (_context11.prev = _context11.next) {
             case 0:
               results = {};
               this.clusterReachability = {};
               if (!(!clusterList || !(0, _keys.default)(clusterList).length)) {
-                _context10.next = 4;
+                _context11.next = 4;
                 break;
               }
-              return _context10.abrupt("return");
+              return _context11.abrupt("return");
             case 4:
               _loggerProxy.default.logger.log("Reachability:index#performReachabilityChecks --> doing UDP".concat(
               // @ts-ignore
@@ -783,7 +855,7 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                 tcp: true,
                 xtls: true
               }; // save the initialized results (in case we don't get any "resultReady" events at all)
-              _context10.next = 11;
+              _context11.next = 11;
               return this.storeResults(results);
             case 11:
               // now start the reachability on all the clusters
@@ -791,10 +863,10 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                 var cluster = clusterList[key];
                 _this4.clusterReachability[key] = new _clusterReachability.ClusterReachability(key, cluster);
                 _this4.clusterReachability[key].on(_clusterReachability.Events.resultReady, /*#__PURE__*/function () {
-                  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(data) {
+                  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(data) {
                     var protocol, result, clientMediaIPs, latencyInMilliseconds, areAllResultsReady;
-                    return _regenerator.default.wrap(function _callee8$(_context8) {
-                      while (1) switch (_context8.prev = _context8.next) {
+                    return _regenerator.default.wrap(function _callee9$(_context9) {
+                      while (1) switch (_context9.prev = _context9.next) {
                         case 0:
                           protocol = data.protocol, result = data.result, clientMediaIPs = data.clientMediaIPs, latencyInMilliseconds = data.latencyInMilliseconds;
                           if (isFirstResult[protocol]) {
@@ -811,7 +883,7 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                           results[key][protocol].result = result;
                           results[key][protocol].clientMediaIPs = clientMediaIPs;
                           results[key][protocol].latencyInMilliseconds = latencyInMilliseconds;
-                          _context8.next = 9;
+                          _context9.next = 9;
                           return _this4.storeResults(results);
                         case 9:
                           if (areAllResultsReady) {
@@ -827,31 +899,31 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
                           }
                         case 10:
                         case "end":
-                          return _context8.stop();
+                          return _context9.stop();
                       }
-                    }, _callee8);
+                    }, _callee9);
                   }));
-                  return function (_x3) {
+                  return function (_x4) {
                     return _ref4.apply(this, arguments);
                   };
                 }());
 
                 // clientMediaIps can be updated independently from the results, so we need to listen for them too
                 _this4.clusterReachability[key].on(_clusterReachability.Events.clientMediaIpsUpdated, /*#__PURE__*/function () {
-                  var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(data) {
-                    return _regenerator.default.wrap(function _callee9$(_context9) {
-                      while (1) switch (_context9.prev = _context9.next) {
+                  var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(data) {
+                    return _regenerator.default.wrap(function _callee10$(_context10) {
+                      while (1) switch (_context10.prev = _context10.next) {
                         case 0:
                           results[key][data.protocol].clientMediaIPs = data.clientMediaIPs;
-                          _context9.next = 3;
+                          _context10.next = 3;
                           return _this4.storeResults(results);
                         case 3:
                         case "end":
-                          return _context9.stop();
+                          return _context10.stop();
                       }
-                    }, _callee9);
+                    }, _callee10);
                   }));
-                  return function (_x4) {
+                  return function (_x5) {
                     return _ref5.apply(this, arguments);
                   };
                 }());
@@ -859,11 +931,11 @@ var Reachability = exports.default = /*#__PURE__*/function (_EventsScope) {
               });
             case 12:
             case "end":
-              return _context10.stop();
+              return _context11.stop();
           }
-        }, _callee10, this);
+        }, _callee11, this);
       }));
-      function performReachabilityChecks(_x2) {
+      function performReachabilityChecks(_x3) {
         return _performReachabilityChecks.apply(this, arguments);
       }
       return performReachabilityChecks;