@webex/plugin-meetings 3.0.0-bnr.4 → 3.0.0-next.1

package/dist/reachability/clusterReachability.js

@@ -0,0 +1,357 @@
+"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.ClusterReachability = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime-corejs2/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/asyncToGenerator"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/toConsumableArray"));
+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 _common = require("@webex/common");
+var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
+var _util = require("./util");
+var _constants = require("../constants");
+var DEFAULT_TIMEOUT = 3000;
+var VIDEO_MESH_TIMEOUT = 1000;
+
+// result for a specific transport protocol (like udp or tcp)
+
+// reachability result for a specific media cluster
+/**
+ * A class that handles reachability checks for a single cluster.
+ */
+var ClusterReachability = exports.ClusterReachability = /*#__PURE__*/function () {
+  /**
+   * Constructor for ClusterReachability
+   * @param {string} name cluster name
+   * @param {ClusterNode} clusterInfo information about the media cluster
+   */
+  function ClusterReachability(name, clusterInfo) {
+    (0, _classCallCheck2.default)(this, ClusterReachability);
+    (0, _defineProperty2.default)(this, "numUdpUrls", void 0);
+    (0, _defineProperty2.default)(this, "numTcpUrls", void 0);
+    (0, _defineProperty2.default)(this, "result", void 0);
+    (0, _defineProperty2.default)(this, "pc", void 0);
+    (0, _defineProperty2.default)(this, "defer", void 0);
+    // this defer is resolved once reachability checks for this cluster are completed
+    (0, _defineProperty2.default)(this, "startTimestamp", void 0);
+    (0, _defineProperty2.default)(this, "isVideoMesh", void 0);
+    (0, _defineProperty2.default)(this, "name", void 0);
+    this.name = name;
+    this.isVideoMesh = clusterInfo.isVideoMesh;
+    this.numUdpUrls = clusterInfo.udp.length;
+    this.numTcpUrls = clusterInfo.tcp.length;
+    this.pc = this.createPeerConnection(clusterInfo);
+    this.defer = new _common.Defer();
+    this.result = {
+      udp: {
+        result: 'untested'
+      },
+      tcp: {
+        result: 'untested'
+      },
+      xtls: {
+        result: 'untested'
+      }
+    };
+  }
+
+  /**
+   * Gets total elapsed time, can be called only after start() is called
+   * @returns {Number} Milliseconds
+   */
+  (0, _createClass2.default)(ClusterReachability, [{
+    key: "getElapsedTime",
+    value: function getElapsedTime() {
+      return Math.round(performance.now() - this.startTimestamp);
+    }
+
+    /**
+     * Generate peerConnection config settings
+     * @param {ClusterNode} cluster
+     * @returns {RTCConfiguration} peerConnectionConfig
+     */
+  }, {
+    key: "buildPeerConnectionConfig",
+    value: function buildPeerConnectionConfig(cluster) {
+      var udpIceServers = cluster.udp.map(function (url) {
+        return {
+          username: '',
+          credential: '',
+          urls: [url]
+        };
+      });
+
+      // STUN servers are contacted only using UDP, so in order to test TCP reachability
+      // we pretend that Linus is a TURN server, because we can explicitly say "transport=tcp" in TURN urls.
+      // We then check for relay candidates to know if TURN-TCP worked (see registerIceCandidateListener()).
+      var tcpIceServers = cluster.tcp.map(function (urlString) {
+        return {
+          username: 'webexturnreachuser',
+          credential: 'webexturnreachpwd',
+          urls: [(0, _util.convertStunUrlToTurn)(urlString, 'tcp')]
+        };
+      });
+      return {
+        iceServers: [].concat((0, _toConsumableArray2.default)(udpIceServers), (0, _toConsumableArray2.default)(tcpIceServers)),
+        iceCandidatePoolSize: 0,
+        iceTransportPolicy: 'all'
+      };
+    }
+
+    /**
+     * Creates an RTCPeerConnection
+     * @param {ClusterNode} clusterInfo information about the media cluster
+     * @returns {RTCPeerConnection} peerConnection
+     */
+  }, {
+    key: "createPeerConnection",
+    value: function createPeerConnection(clusterInfo) {
+      try {
+        var config = this.buildPeerConnectionConfig(clusterInfo);
+        var peerConnection = new RTCPeerConnection(config);
+        return peerConnection;
+      } catch (peerConnectionError) {
+        _loggerProxy.default.logger.warn("Reachability:index#createPeerConnection --> Error creating peerConnection:", peerConnectionError);
+        return undefined;
+      }
+    }
+
+    /**
+     * @returns {ClusterReachabilityResult} reachability result for this cluster
+     */
+  }, {
+    key: "getResult",
+    value: function getResult() {
+      return this.result;
+    }
+
+    /**
+     * Closes the peerConnection
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "closePeerConnection",
+    value: function closePeerConnection() {
+      if (this.pc) {
+        this.pc.onicecandidate = null;
+        this.pc.onicegatheringstatechange = null;
+        this.pc.close();
+      }
+    }
+
+    /**
+     * Resolves the defer, indicating that reachability checks for this cluster are completed
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "finishReachabilityCheck",
+    value: function finishReachabilityCheck() {
+      this.defer.resolve();
+    }
+
+    /**
+     * Adds public IP (client media IPs)
+     * @param {string} protocol
+     * @param {string} publicIP
+     * @returns {void}
+     */
+  }, {
+    key: "addPublicIP",
+    value: function addPublicIP(protocol, publicIP) {
+      var result = this.result[protocol];
+      if (publicIP) {
+        if (result.clientMediaIPs) {
+          if (!result.clientMediaIPs.includes(publicIP)) {
+            result.clientMediaIPs.push(publicIP);
+          }
+        } else {
+          result.clientMediaIPs = [publicIP];
+        }
+      }
+    }
+
+    /**
+     * Registers a listener for the iceGatheringStateChange event
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "registerIceGatheringStateChangeListener",
+    value: function registerIceGatheringStateChangeListener() {
+      var _this = this;
+      this.pc.onicegatheringstatechange = function () {
+        var COMPLETE = _constants.ICE_GATHERING_STATE.COMPLETE;
+        if (_this.pc.iceConnectionState === COMPLETE) {
+          _this.closePeerConnection();
+          _this.finishReachabilityCheck();
+        }
+      };
+    }
+
+    /**
+     * Checks if we have the results for all the protocols (UDP and TCP)
+     *
+     * @returns {boolean} true if we have all results, false otherwise
+     */
+  }, {
+    key: "haveWeGotAllResults",
+    value: function haveWeGotAllResults() {
+      var _this2 = this;
+      return ['udp', 'tcp'].every(function (protocol) {
+        return _this2.result[protocol].result === 'reachable' || _this2.result[protocol].result === 'untested';
+      });
+    }
+
+    /**
+     * Stores the latency in the result for the given protocol and marks it as reachable
+     *
+     * @param {string} protocol
+     * @param {number} latency
+     * @returns {void}
+     */
+  }, {
+    key: "storeLatencyResult",
+    value: function storeLatencyResult(protocol, latency) {
+      var result = this.result[protocol];
+      if (result.latencyInMilliseconds === undefined) {
+        _loggerProxy.default.logger.log( // @ts-ignore
+        "Reachability:index#storeLatencyResult --> Successfully reached ".concat(this.name, " over ").concat(protocol, ": ").concat(latency, "ms"));
+        result.latencyInMilliseconds = latency;
+        result.result = 'reachable';
+      }
+    }
+
+    /**
+     * Registers a listener for the icecandidate event
+     *
+     * @returns {void}
+     */
+  }, {
+    key: "registerIceCandidateListener",
+    value: function registerIceCandidateListener() {
+      var _this3 = this;
+      this.pc.onicecandidate = function (e) {
+        var CANDIDATE_TYPES = {
+          SERVER_REFLEXIVE: 'srflx',
+          RELAY: 'relay'
+        };
+        if (e.candidate) {
+          if (e.candidate.type === CANDIDATE_TYPES.SERVER_REFLEXIVE) {
+            _this3.storeLatencyResult('udp', _this3.getElapsedTime());
+            _this3.addPublicIP('udp', e.candidate.address);
+          }
+          if (e.candidate.type === CANDIDATE_TYPES.RELAY) {
+            _this3.storeLatencyResult('tcp', _this3.getElapsedTime());
+            // we don't add public IP for TCP, because in the case of relay candidates
+            // e.candidate.address is the TURN server address, not the client's public IP
+          }
+
+          if (_this3.haveWeGotAllResults()) {
+            _this3.closePeerConnection();
+            _this3.finishReachabilityCheck();
+          }
+        }
+      };
+    }
+
+    /**
+     * Starts the process of doing UDP and TCP reachability checks on the media cluster.
+     * XTLS reachability checking is not supported.
+     *
+     * @returns {Promise}
+     */
+  }, {
+    key: "start",
+    value: (function () {
+      var _start = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        var offer;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              if (this.pc) {
+                _context.next = 3;
+                break;
+              }
+              _loggerProxy.default.logger.warn("Reachability:ClusterReachability#start --> Error: peerConnection is undefined");
+              return _context.abrupt("return", this.result);
+            case 3:
+              // Initialize this.result as saying that nothing is reachable.
+              // It will get updated as we go along and successfully gather ICE candidates.
+              this.result.udp = {
+                result: this.numUdpUrls > 0 ? 'unreachable' : 'untested'
+              };
+              this.result.tcp = {
+                result: this.numTcpUrls > 0 ? 'unreachable' : 'untested'
+              };
+              _context.prev = 5;
+              _context.next = 8;
+              return this.pc.createOffer({
+                offerToReceiveAudio: true
+              });
+            case 8:
+              offer = _context.sent;
+              this.startTimestamp = performance.now();
+
+              // not awaiting the next call on purpose, because we're not sending the offer anywhere and there won't be any answer
+              // we just need to make this call to trigger the ICE gathering process
+              this.pc.setLocalDescription(offer);
+              _context.next = 13;
+              return this.gatherIceCandidates();
+            case 13:
+              _context.next = 18;
+              break;
+            case 15:
+              _context.prev = 15;
+              _context.t0 = _context["catch"](5);
+              _loggerProxy.default.logger.warn("Reachability:ClusterReachability#start --> Error: ", _context.t0);
+            case 18:
+              return _context.abrupt("return", this.result);
+            case 19:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[5, 15]]);
+      }));
+      function start() {
+        return _start.apply(this, arguments);
+      }
+      return start;
+    }()
+    /**
+     * Starts the process of gathering ICE candidates
+     *
+     * @returns {Promise} promise that's resolved once reachability checks for this cluster are completed or timeout is reached
+     */
+    )
+  }, {
+    key: "gatherIceCandidates",
+    value: function gatherIceCandidates() {
+      var _this4 = this;
+      var timeout = this.isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT;
+      this.registerIceGatheringStateChangeListener();
+      this.registerIceCandidateListener();
+
+      // Set maximum timeout
+      setTimeout(function () {
+        var CLOSED = _constants.CONNECTION_STATE.CLOSED;
+
+        // Close any open peerConnections
+        if (_this4.pc.connectionState !== CLOSED) {
+          _this4.closePeerConnection();
+          _this4.finishReachabilityCheck();
+        }
+      }, timeout);
+      return this.defer.promise;
+    }
+  }]);
+  return ClusterReachability;
+}();
+//# sourceMappingURL=clusterReachability.js.map

package/dist/reachability/clusterReachability.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_common","require","_loggerProxy","_interopRequireDefault","_util","_constants","DEFAULT_TIMEOUT","VIDEO_MESH_TIMEOUT","ClusterReachability","exports","name","clusterInfo","_classCallCheck2","default","_defineProperty2","isVideoMesh","numUdpUrls","udp","length","numTcpUrls","tcp","pc","createPeerConnection","defer","Defer","result","xtls","_createClass2","key","value","getElapsedTime","Math","round","performance","now","startTimestamp","buildPeerConnectionConfig","cluster","udpIceServers","map","url","username","credential","urls","tcpIceServers","urlString","convertStunUrlToTurn","iceServers","concat","_toConsumableArray2","iceCandidatePoolSize","iceTransportPolicy","config","peerConnection","RTCPeerConnection","peerConnectionError","LoggerProxy","logger","warn","undefined","getResult","closePeerConnection","onicecandidate","onicegatheringstatechange","close","finishReachabilityCheck","resolve","addPublicIP","protocol","publicIP","clientMediaIPs","includes","push","registerIceGatheringStateChangeListener","_this","COMPLETE","ICE_GATHERING_STATE","iceConnectionState","haveWeGotAllResults","_this2","every","storeLatencyResult","latency","latencyInMilliseconds","log","registerIceCandidateListener","_this3","e","CANDIDATE_TYPES","SERVER_REFLEXIVE","RELAY","candidate","type","address","_start","_asyncToGenerator2","_regenerator","mark","_callee","offer","wrap","_callee$","_context","prev","next","abrupt","createOffer","offerToReceiveAudio","sent","setLocalDescription","gatherIceCandidates","t0","stop","start","apply","arguments","_this4","timeout","setTimeout","CLOSED","CONNECTION_STATE","connectionState","promise"],"sources":["clusterReachability.ts"],"sourcesContent":["import {Defer} from '@webex/common';\n\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport {ClusterNode} from './request';\nimport {convertStunUrlToTurn} from './util';\n\nimport {ICE_GATHERING_STATE, CONNECTION_STATE} from '../constants';\n\nconst DEFAULT_TIMEOUT = 3000;\nconst VIDEO_MESH_TIMEOUT = 1000;\n\n// result for a specific transport protocol (like udp or tcp)\nexport type TransportResult = {\n  result: 'reachable' | 'unreachable' | 'untested';\n  latencyInMilliseconds?: number; // amount of time it took to get the first ICE candidate\n  clientMediaIPs?: string[];\n};\n\n// reachability result for a specific media cluster\nexport type ClusterReachabilityResult = {\n  udp: TransportResult;\n  tcp: TransportResult;\n  xtls: TransportResult;\n};\n\n/**\n * A class that handles reachability checks for a single cluster.\n */\nexport class ClusterReachability {\n  private numUdpUrls: number;\n  private numTcpUrls: number;\n  private result: ClusterReachabilityResult;\n  private pc?: RTCPeerConnection;\n  private defer: Defer; // this defer is resolved once reachability checks for this cluster are completed\n  private startTimestamp: number;\n  public readonly isVideoMesh: boolean;\n  public readonly name;\n\n  /**\n   * Constructor for ClusterReachability\n   * @param {string} name cluster name\n   * @param {ClusterNode} clusterInfo information about the media cluster\n   */\n  constructor(name: string, clusterInfo: ClusterNode) {\n    this.name = name;\n    this.isVideoMesh = clusterInfo.isVideoMesh;\n    this.numUdpUrls = clusterInfo.udp.length;\n    this.numTcpUrls = clusterInfo.tcp.length;\n\n    this.pc = this.createPeerConnection(clusterInfo);\n\n    this.defer = new Defer();\n    this.result = {\n      udp: {\n        result: 'untested',\n      },\n      tcp: {\n        result: 'untested',\n      },\n      xtls: {\n        result: 'untested',\n      },\n    };\n  }\n\n  /**\n   * Gets total elapsed time, can be called only after start() is called\n   * @returns {Number} Milliseconds\n   */\n  private getElapsedTime() {\n    return Math.round(performance.now() - this.startTimestamp);\n  }\n\n  /**\n   * Generate peerConnection config settings\n   * @param {ClusterNode} cluster\n   * @returns {RTCConfiguration} peerConnectionConfig\n   */\n  private buildPeerConnectionConfig(cluster: ClusterNode): RTCConfiguration {\n    const udpIceServers = cluster.udp.map((url) => ({\n      username: '',\n      credential: '',\n      urls: [url],\n    }));\n\n    // STUN servers are contacted only using UDP, so in order to test TCP reachability\n    // we pretend that Linus is a TURN server, because we can explicitly say \"transport=tcp\" in TURN urls.\n    // We then check for relay candidates to know if TURN-TCP worked (see registerIceCandidateListener()).\n    const tcpIceServers = cluster.tcp.map((urlString: string) => {\n      return {\n        username: 'webexturnreachuser',\n        credential: 'webexturnreachpwd',\n        urls: [convertStunUrlToTurn(urlString, 'tcp')],\n      };\n    });\n\n    return {\n      iceServers: [...udpIceServers, ...tcpIceServers],\n      iceCandidatePoolSize: 0,\n      iceTransportPolicy: 'all',\n    };\n  }\n\n  /**\n   * Creates an RTCPeerConnection\n   * @param {ClusterNode} clusterInfo information about the media cluster\n   * @returns {RTCPeerConnection} peerConnection\n   */\n  private createPeerConnection(clusterInfo: ClusterNode) {\n    try {\n      const config = this.buildPeerConnectionConfig(clusterInfo);\n\n      const peerConnection = new RTCPeerConnection(config);\n\n      return peerConnection;\n    } catch (peerConnectionError) {\n      LoggerProxy.logger.warn(\n        `Reachability:index#createPeerConnection --> Error creating peerConnection:`,\n        peerConnectionError\n      );\n\n      return undefined;\n    }\n  }\n\n  /**\n   * @returns {ClusterReachabilityResult} reachability result for this cluster\n   */\n  getResult() {\n    return this.result;\n  }\n\n  /**\n   * Closes the peerConnection\n   *\n   * @returns {void}\n   */\n  private closePeerConnection() {\n    if (this.pc) {\n      this.pc.onicecandidate = null;\n      this.pc.onicegatheringstatechange = null;\n      this.pc.close();\n    }\n  }\n\n  /**\n   * Resolves the defer, indicating that reachability checks for this cluster are completed\n   *\n   * @returns {void}\n   */\n  private finishReachabilityCheck() {\n    this.defer.resolve();\n  }\n\n  /**\n   * Adds public IP (client media IPs)\n   * @param {string} protocol\n   * @param {string} publicIP\n   * @returns {void}\n   */\n  private addPublicIP(protocol: 'udp' | 'tcp', publicIP?: string | null) {\n    const result = this.result[protocol];\n\n    if (publicIP) {\n      if (result.clientMediaIPs) {\n        if (!result.clientMediaIPs.includes(publicIP)) {\n          result.clientMediaIPs.push(publicIP);\n        }\n      } else {\n        result.clientMediaIPs = [publicIP];\n      }\n    }\n  }\n\n  /**\n   * Registers a listener for the iceGatheringStateChange event\n   *\n   * @returns {void}\n   */\n  private registerIceGatheringStateChangeListener() {\n    this.pc.onicegatheringstatechange = () => {\n      const {COMPLETE} = ICE_GATHERING_STATE;\n\n      if (this.pc.iceConnectionState === COMPLETE) {\n        this.closePeerConnection();\n        this.finishReachabilityCheck();\n      }\n    };\n  }\n\n  /**\n   * Checks if we have the results for all the protocols (UDP and TCP)\n   *\n   * @returns {boolean} true if we have all results, false otherwise\n   */\n  private haveWeGotAllResults(): boolean {\n    return ['udp', 'tcp'].every(\n      (protocol) =>\n        this.result[protocol].result === 'reachable' || this.result[protocol].result === 'untested'\n    );\n  }\n\n  /**\n   * Stores the latency in the result for the given protocol and marks it as reachable\n   *\n   * @param {string} protocol\n   * @param {number} latency\n   * @returns {void}\n   */\n  private storeLatencyResult(protocol: 'udp' | 'tcp', latency: number) {\n    const result = this.result[protocol];\n\n    if (result.latencyInMilliseconds === undefined) {\n      LoggerProxy.logger.log(\n        // @ts-ignore\n        `Reachability:index#storeLatencyResult --> Successfully reached ${this.name} over ${protocol}: ${latency}ms`\n      );\n      result.latencyInMilliseconds = latency;\n      result.result = 'reachable';\n    }\n  }\n\n  /**\n   * Registers a listener for the icecandidate event\n   *\n   * @returns {void}\n   */\n  private registerIceCandidateListener() {\n    this.pc.onicecandidate = (e) => {\n      const CANDIDATE_TYPES = {\n        SERVER_REFLEXIVE: 'srflx',\n        RELAY: 'relay',\n      };\n\n      if (e.candidate) {\n        if (e.candidate.type === CANDIDATE_TYPES.SERVER_REFLEXIVE) {\n          this.storeLatencyResult('udp', this.getElapsedTime());\n          this.addPublicIP('udp', e.candidate.address);\n        }\n\n        if (e.candidate.type === CANDIDATE_TYPES.RELAY) {\n          this.storeLatencyResult('tcp', this.getElapsedTime());\n          // we don't add public IP for TCP, because in the case of relay candidates\n          // e.candidate.address is the TURN server address, not the client's public IP\n        }\n\n        if (this.haveWeGotAllResults()) {\n          this.closePeerConnection();\n          this.finishReachabilityCheck();\n        }\n      }\n    };\n  }\n\n  /**\n   * Starts the process of doing UDP and TCP reachability checks on the media cluster.\n   * XTLS reachability checking is not supported.\n   *\n   * @returns {Promise}\n   */\n  async start(): Promise<ClusterReachabilityResult> {\n    if (!this.pc) {\n      LoggerProxy.logger.warn(\n        `Reachability:ClusterReachability#start --> Error: peerConnection is undefined`\n      );\n\n      return this.result;\n    }\n\n    // Initialize this.result as saying that nothing is reachable.\n    // It will get updated as we go along and successfully gather ICE candidates.\n    this.result.udp = {\n      result: this.numUdpUrls > 0 ? 'unreachable' : 'untested',\n    };\n    this.result.tcp = {\n      result: this.numTcpUrls > 0 ? 'unreachable' : 'untested',\n    };\n\n    try {\n      const offer = await this.pc.createOffer({offerToReceiveAudio: true});\n\n      this.startTimestamp = performance.now();\n\n      // not awaiting the next call on purpose, because we're not sending the offer anywhere and there won't be any answer\n      // we just need to make this call to trigger the ICE gathering process\n      this.pc.setLocalDescription(offer);\n\n      await this.gatherIceCandidates();\n    } catch (error) {\n      LoggerProxy.logger.warn(`Reachability:ClusterReachability#start --> Error: `, error);\n    }\n\n    return this.result;\n  }\n\n  /**\n   * Starts the process of gathering ICE candidates\n   *\n   * @returns {Promise} promise that's resolved once reachability checks for this cluster are completed or timeout is reached\n   */\n  private gatherIceCandidates() {\n    const timeout = this.isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT;\n\n    this.registerIceGatheringStateChangeListener();\n    this.registerIceCandidateListener();\n\n    // Set maximum timeout\n    setTimeout(() => {\n      const {CLOSED} = CONNECTION_STATE;\n\n      // Close any open peerConnections\n      if (this.pc.connectionState !== CLOSED) {\n        this.closePeerConnection();\n        this.finishReachabilityCheck();\n      }\n    }, timeout);\n\n    return this.defer.promise;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,YAAA,GAAAC,sBAAA,CAAAF,OAAA;AAEA,IAAAG,KAAA,GAAAH,OAAA;AAEA,IAAAI,UAAA,GAAAJ,OAAA;AAEA,IAAMK,eAAe,GAAG,IAAI;AAC5B,IAAMC,kBAAkB,GAAG,IAAI;;AAE/B;;AAOA;AAOA;AACA;AACA;AAFA,IAGaC,mBAAmB,GAAAC,OAAA,CAAAD,mBAAA;EAU9B;AACF;AACA;AACA;AACA;EACE,SAAAA,oBAAYE,IAAY,EAAEC,WAAwB,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAL,mBAAA;IAAA,IAAAM,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAV9B;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA;IAWpB,IAAI,CAACH,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACK,WAAW,GAAGJ,WAAW,CAACI,WAAW;IAC1C,IAAI,CAACC,UAAU,GAAGL,WAAW,CAACM,GAAG,CAACC,MAAM;IACxC,IAAI,CAACC,UAAU,GAAGR,WAAW,CAACS,GAAG,CAACF,MAAM;IAExC,IAAI,CAACG,EAAE,GAAG,IAAI,CAACC,oBAAoB,CAACX,WAAW,CAAC;IAEhD,IAAI,CAACY,KAAK,GAAG,IAAIC,aAAK,CAAC,CAAC;IACxB,IAAI,CAACC,MAAM,GAAG;MACZR,GAAG,EAAE;QACHQ,MAAM,EAAE;MACV,CAAC;MACDL,GAAG,EAAE;QACHK,MAAM,EAAE;MACV,CAAC;MACDC,IAAI,EAAE;QACJD,MAAM,EAAE;MACV;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;EAHE,IAAAE,aAAA,CAAAd,OAAA,EAAAL,mBAAA;IAAAoB,GAAA;IAAAC,KAAA,EAIA,SAAAC,eAAA,EAAyB;MACvB,OAAOC,IAAI,CAACC,KAAK,CAACC,WAAW,CAACC,GAAG,CAAC,CAAC,GAAG,IAAI,CAACC,cAAc,CAAC;IAC5D;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAP,GAAA;IAAAC,KAAA,EAKA,SAAAO,0BAAkCC,OAAoB,EAAoB;MACxE,IAAMC,aAAa,GAAGD,OAAO,CAACpB,GAAG,CAACsB,GAAG,CAAC,UAACC,GAAG;QAAA,OAAM;UAC9CC,QAAQ,EAAE,EAAE;UACZC,UAAU,EAAE,EAAE;UACdC,IAAI,EAAE,CAACH,GAAG;QACZ,CAAC;MAAA,CAAC,CAAC;;MAEH;MACA;MACA;MACA,IAAMI,aAAa,GAAGP,OAAO,CAACjB,GAAG,CAACmB,GAAG,CAAC,UAACM,SAAiB,EAAK;QAC3D,OAAO;UACLJ,QAAQ,EAAE,oBAAoB;UAC9BC,UAAU,EAAE,mBAAmB;UAC/BC,IAAI,EAAE,CAAC,IAAAG,0BAAoB,EAACD,SAAS,EAAE,KAAK,CAAC;QAC/C,CAAC;MACH,CAAC,CAAC;MAEF,OAAO;QACLE,UAAU,KAAAC,MAAA,KAAAC,mBAAA,CAAApC,OAAA,EAAMyB,aAAa,OAAAW,mBAAA,CAAApC,OAAA,EAAK+B,aAAa,EAAC;QAChDM,oBAAoB,EAAE,CAAC;QACvBC,kBAAkB,EAAE;MACtB,CAAC;IACH;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAvB,GAAA;IAAAC,KAAA,EAKA,SAAAP,qBAA6BX,WAAwB,EAAE;MACrD,IAAI;QACF,IAAMyC,MAAM,GAAG,IAAI,CAAChB,yBAAyB,CAACzB,WAAW,CAAC;QAE1D,IAAM0C,cAAc,GAAG,IAAIC,iBAAiB,CAACF,MAAM,CAAC;QAEpD,OAAOC,cAAc;MACvB,CAAC,CAAC,OAAOE,mBAAmB,EAAE;QAC5BC,oBAAW,CAACC,MAAM,CAACC,IAAI,+EAErBH,mBACF,CAAC;QAED,OAAOI,SAAS;MAClB;IACF;;IAEA;AACF;AACA;EAFE;IAAA/B,GAAA;IAAAC,KAAA,EAGA,SAAA+B,UAAA,EAAY;MACV,OAAO,IAAI,CAACnC,MAAM;IACpB;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAG,GAAA;IAAAC,KAAA,EAKA,SAAAgC,oBAAA,EAA8B;MAC5B,IAAI,IAAI,CAACxC,EAAE,EAAE;QACX,IAAI,CAACA,EAAE,CAACyC,cAAc,GAAG,IAAI;QAC7B,IAAI,CAACzC,EAAE,CAAC0C,yBAAyB,GAAG,IAAI;QACxC,IAAI,CAAC1C,EAAE,CAAC2C,KAAK,CAAC,CAAC;MACjB;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAApC,GAAA;IAAAC,KAAA,EAKA,SAAAoC,wBAAA,EAAkC;MAChC,IAAI,CAAC1C,KAAK,CAAC2C,OAAO,CAAC,CAAC;IACtB;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAAtC,GAAA;IAAAC,KAAA,EAMA,SAAAsC,YAAoBC,QAAuB,EAAEC,QAAwB,EAAE;MACrE,IAAM5C,MAAM,GAAG,IAAI,CAACA,MAAM,CAAC2C,QAAQ,CAAC;MAEpC,IAAIC,QAAQ,EAAE;QACZ,IAAI5C,MAAM,CAAC6C,cAAc,EAAE;UACzB,IAAI,CAAC7C,MAAM,CAAC6C,cAAc,CAACC,QAAQ,CAACF,QAAQ,CAAC,EAAE;YAC7C5C,MAAM,CAAC6C,cAAc,CAACE,IAAI,CAACH,QAAQ,CAAC;UACtC;QACF,CAAC,MAAM;UACL5C,MAAM,CAAC6C,cAAc,GAAG,CAACD,QAAQ,CAAC;QACpC;MACF;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAzC,GAAA;IAAAC,KAAA,EAKA,SAAA4C,wCAAA,EAAkD;MAAA,IAAAC,KAAA;MAChD,IAAI,CAACrD,EAAE,CAAC0C,yBAAyB,GAAG,YAAM;QACxC,IAAOY,QAAQ,GAAIC,8BAAmB,CAA/BD,QAAQ;QAEf,IAAID,KAAI,CAACrD,EAAE,CAACwD,kBAAkB,KAAKF,QAAQ,EAAE;UAC3CD,KAAI,CAACb,mBAAmB,CAAC,CAAC;UAC1Ba,KAAI,CAACT,uBAAuB,CAAC,CAAC;QAChC;MACF,CAAC;IACH;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAArC,GAAA;IAAAC,KAAA,EAKA,SAAAiD,oBAAA,EAAuC;MAAA,IAAAC,MAAA;MACrC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAACC,KAAK,CACzB,UAACZ,QAAQ;QAAA,OACPW,MAAI,CAACtD,MAAM,CAAC2C,QAAQ,CAAC,CAAC3C,MAAM,KAAK,WAAW,IAAIsD,MAAI,CAACtD,MAAM,CAAC2C,QAAQ,CAAC,CAAC3C,MAAM,KAAK,UAAU;MAAA,CAC/F,CAAC;IACH;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAAG,GAAA;IAAAC,KAAA,EAOA,SAAAoD,mBAA2Bb,QAAuB,EAAEc,OAAe,EAAE;MACnE,IAAMzD,MAAM,GAAG,IAAI,CAACA,MAAM,CAAC2C,QAAQ,CAAC;MAEpC,IAAI3C,MAAM,CAAC0D,qBAAqB,KAAKxB,SAAS,EAAE;QAC9CH,oBAAW,CAACC,MAAM,CAAC2B,GAAG,EACpB;QAAA,kEAAApC,MAAA,CACkE,IAAI,CAACtC,IAAI,YAAAsC,MAAA,CAASoB,QAAQ,QAAApB,MAAA,CAAKkC,OAAO,OAC1G,CAAC;QACDzD,MAAM,CAAC0D,qBAAqB,GAAGD,OAAO;QACtCzD,MAAM,CAACA,MAAM,GAAG,WAAW;MAC7B;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAAG,GAAA;IAAAC,KAAA,EAKA,SAAAwD,6BAAA,EAAuC;MAAA,IAAAC,MAAA;MACrC,IAAI,CAACjE,EAAE,CAACyC,cAAc,GAAG,UAACyB,CAAC,EAAK;QAC9B,IAAMC,eAAe,GAAG;UACtBC,gBAAgB,EAAE,OAAO;UACzBC,KAAK,EAAE;QACT,CAAC;QAED,IAAIH,CAAC,CAACI,SAAS,EAAE;UACf,IAAIJ,CAAC,CAACI,SAAS,CAACC,IAAI,KAAKJ,eAAe,CAACC,gBAAgB,EAAE;YACzDH,MAAI,CAACL,kBAAkB,CAAC,KAAK,EAAEK,MAAI,CAACxD,cAAc,CAAC,CAAC,CAAC;YACrDwD,MAAI,CAACnB,WAAW,CAAC,KAAK,EAAEoB,CAAC,CAACI,SAAS,CAACE,OAAO,CAAC;UAC9C;UAEA,IAAIN,CAAC,CAACI,SAAS,CAACC,IAAI,KAAKJ,eAAe,CAACE,KAAK,EAAE;YAC9CJ,MAAI,CAACL,kBAAkB,CAAC,KAAK,EAAEK,MAAI,CAACxD,cAAc,CAAC,CAAC,CAAC;YACrD;YACA;UACF;;UAEA,IAAIwD,MAAI,CAACR,mBAAmB,CAAC,CAAC,EAAE;YAC9BQ,MAAI,CAACzB,mBAAmB,CAAC,CAAC;YAC1ByB,MAAI,CAACrB,uBAAuB,CAAC,CAAC;UAChC;QACF;MACF,CAAC;IACH;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAArC,GAAA;IAAAC,KAAA;MAAA,IAAAiE,MAAA,OAAAC,kBAAA,CAAAlF,OAAA,gBAAAmF,YAAA,CAAAnF,OAAA,CAAAoF,IAAA,CAMA,SAAAC,QAAA;QAAA,IAAAC,KAAA;QAAA,OAAAH,YAAA,CAAAnF,OAAA,CAAAuF,IAAA,UAAAC,SAAAC,QAAA;UAAA,kBAAAA,QAAA,CAAAC,IAAA,GAAAD,QAAA,CAAAE,IAAA;YAAA;cAAA,IACO,IAAI,CAACnF,EAAE;gBAAAiF,QAAA,CAAAE,IAAA;gBAAA;cAAA;cACVhD,oBAAW,CAACC,MAAM,CAACC,IAAI,gFAEvB,CAAC;cAAC,OAAA4C,QAAA,CAAAG,MAAA,WAEK,IAAI,CAAChF,MAAM;YAAA;cAGpB;cACA;cACA,IAAI,CAACA,MAAM,CAACR,GAAG,GAAG;gBAChBQ,MAAM,EAAE,IAAI,CAACT,UAAU,GAAG,CAAC,GAAG,aAAa,GAAG;cAChD,CAAC;cACD,IAAI,CAACS,MAAM,CAACL,GAAG,GAAG;gBAChBK,MAAM,EAAE,IAAI,CAACN,UAAU,GAAG,CAAC,GAAG,aAAa,GAAG;cAChD,CAAC;cAACmF,QAAA,CAAAC,IAAA;cAAAD,QAAA,CAAAE,IAAA;cAAA,OAGoB,IAAI,CAACnF,EAAE,CAACqF,WAAW,CAAC;gBAACC,mBAAmB,EAAE;cAAI,CAAC,CAAC;YAAA;cAA9DR,KAAK,GAAAG,QAAA,CAAAM,IAAA;cAEX,IAAI,CAACzE,cAAc,GAAGF,WAAW,CAACC,GAAG,CAAC,CAAC;;cAEvC;cACA;cACA,IAAI,CAACb,EAAE,CAACwF,mBAAmB,CAACV,KAAK,CAAC;cAACG,QAAA,CAAAE,IAAA;cAAA,OAE7B,IAAI,CAACM,mBAAmB,CAAC,CAAC;YAAA;cAAAR,QAAA,CAAAE,IAAA;cAAA;YAAA;cAAAF,QAAA,CAAAC,IAAA;cAAAD,QAAA,CAAAS,EAAA,GAAAT,QAAA;cAEhC9C,oBAAW,CAACC,MAAM,CAACC,IAAI,uDAAA4C,QAAA,CAAAS,EAA4D,CAAC;YAAC;cAAA,OAAAT,QAAA,CAAAG,MAAA,WAGhF,IAAI,CAAChF,MAAM;YAAA;YAAA;cAAA,OAAA6E,QAAA,CAAAU,IAAA;UAAA;QAAA,GAAAd,OAAA;MAAA,CACnB;MAAA,SAAAe,MAAA;QAAA,OAAAnB,MAAA,CAAAoB,KAAA,OAAAC,SAAA;MAAA;MAAA,OAAAF,KAAA;IAAA;IAED;AACF;AACA;AACA;AACA;IAJE;EAAA;IAAArF,GAAA;IAAAC,KAAA,EAKA,SAAAiF,oBAAA,EAA8B;MAAA,IAAAM,MAAA;MAC5B,IAAMC,OAAO,GAAG,IAAI,CAACtG,WAAW,GAAGR,kBAAkB,GAAGD,eAAe;MAEvE,IAAI,CAACmE,uCAAuC,CAAC,CAAC;MAC9C,IAAI,CAACY,4BAA4B,CAAC,CAAC;;MAEnC;MACAiC,UAAU,CAAC,YAAM;QACf,IAAOC,MAAM,GAAIC,2BAAgB,CAA1BD,MAAM;;QAEb;QACA,IAAIH,MAAI,CAAC/F,EAAE,CAACoG,eAAe,KAAKF,MAAM,EAAE;UACtCH,MAAI,CAACvD,mBAAmB,CAAC,CAAC;UAC1BuD,MAAI,CAACnD,uBAAuB,CAAC,CAAC;QAChC;MACF,CAAC,EAAEoD,OAAO,CAAC;MAEX,OAAO,IAAI,CAAC9F,KAAK,CAACmG,OAAO;IAC3B;EAAC;EAAA,OAAAlH,mBAAA;AAAA"}

package/dist/reachability/index.d.ts

@@ -1,14 +1,48 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+import ReachabilityRequest from './request';
+import { ClusterReachability, ClusterReachabilityResult } from './clusterReachability';
+export type ReachabilityMetrics = {
+    reachability_public_udp_success: number;
+    reachability_public_udp_failed: number;
+    reachability_public_tcp_success: number;
+    reachability_public_tcp_failed: number;
+    reachability_vmn_udp_success: number;
+    reachability_vmn_udp_failed: number;
+    reachability_vmn_tcp_success: number;
+    reachability_vmn_tcp_failed: number;
+};
+/**
+ * This is the type that matches what backend expects us to send to them. It is a bit weird, because
+ * it uses strings instead of booleans and numbers, but that's what they require.
+ */
+export type TransportResultForBackend = {
+    reachable?: 'true' | 'false';
+    latencyInMilliseconds?: string;
+    clientMediaIPs?: string[];
+    untested?: 'true';
+};
+export type ReachabilityResultForBackend = {
+    udp: TransportResultForBackend;
+    tcp: TransportResultForBackend;
+    xtls: TransportResultForBackend;
+};
+export type ReachabilityResultsForBackend = Record<string, ReachabilityResultForBackend>;
+export type ReachabilityResults = Record<string, ClusterReachabilityResult & {
+    isVideoMesh?: boolean;
+}>;
 /**
  * @class Reachability
  * @export
  */
 export default class Reachability {
+    namespace: string;
     webex: object;
-    reachabilityRequest: any;
-    clusterLatencyResults: any;
+    reachabilityRequest: ReachabilityRequest;
+    clusterReachability: {
+        [key: string]: ClusterReachability;
+    };
     /**
      * Creates an instance of Reachability.
      * @param {object} webex
@@ -16,87 +50,45 @@ export default class Reachability {
      */
     constructor(webex: object);
     /**
-     * fetches reachability data
-     * @returns {Object} reachability data
-     * @public
-     * @async
-     * @memberof Reachability
-     */
-    gatherReachability(): Promise<unknown>;
-    /**
-     * fetches reachability data and checks for cluster reachability
-     * @returns {boolean}
+     * 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
      */
-    isAnyClusterReachable(): boolean;
+    gatherReachability(): Promise<ReachabilityResults>;
     /**
-     * Generate peerConnection config settings
-     * @param {object} cluster
-     * @returns {object} peerConnectionConfig
-     * @private
-     * @memberof Reachability
+     * Returns statistics about last reachability results. The returned value is an object
+     * with a flat list of properties so that it can be easily sent with metrics
+     *
+     * @returns {Promise} Promise with metrics values, it never rejects/throws.
      */
-    private buildPeerConnectionConfig;
+    getReachabilityMetrics(): Promise<ReachabilityMetrics>;
     /**
-     * Creates an RTCPeerConnection
-     * @param {object} cluster
-     * @returns {RTCPeerConnection} peerConnection
-     * @private
-     * @memberof Reachability
+     * Maps our internal transport result to the format that backend expects
+     * @param {TransportResult} transportResult
+     * @returns {TransportResultForBackend}
      */
-    private createPeerConnection;
+    private mapTransportResultToBackendDataFormat;
     /**
-     * Gets total elapsed time
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {Number} Milliseconds
-     * @private
-     * @memberof Reachability
+     * Reachability results as an object in the format that backend expects
+     *
+     * @returns {any} reachability results that need to be sent to the backend
      */
-    private getElapsedTime;
+    getReachabilityResults(): Promise<ReachabilityResultsForBackend | undefined>;
     /**
-     * creates offer and generates localSDP
-     * @param {object} clusterList cluster List
-     * @returns {Promise} Reachability latency results
-     * @private
+     * fetches reachability data and checks for cluster reachability
+     * @returns {boolean}
+     * @public
      * @memberof Reachability
      */
-    private getLocalSDPForClusters;
+    isAnyPublicClusterReachable(): Promise<boolean>;
     /**
      * Get list of all unreachable clusters
      * @returns {array} Unreachable clusters
      * @private
      * @memberof Reachability
      */
-    private getUnreachablClusters;
-    /**
-     * Attach an event handler for the icegatheringstatechange
-     * event and measure latency.
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private handleIceGatheringStateChange;
-    /**
-     * Attach an event handler for the icecandidate
-     * event and measure latency.
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private handleOnIceCandidate;
-    /**
-     * An event handler on an RTCPeerConnection when the state of the ICE
-     * candidate gathering process changes. Used to measure connection
-     * speed.
-     * @private
-     * @param {RTCPeerConnection} peerConnection
-     * @param {number} timeout
-     * @returns {Promise}
-     */
-    private iceGatheringState;
+    private getUnreachableClusters;
     /**
      * Make a log of unreachable clusters.
      * @returns {undefined}
@@ -105,35 +97,9 @@ export default class Reachability {
      */
     private logUnreachableClusters;
     /**
-     * Calculates time to establish connection
-     * @param {array} iceResults iceResults
-     * @returns {object} reachabilityMap
-     * @private
-     * @memberof Reachability
-     */
-    private parseIceResultsToReachabilityResults;
-    /**
-     * fetches reachability data
-     * @param {object} clusterList
-     * @returns {Promise<localSDPData>} reachability check results
-     * @private
-     * @memberof Reachability
-     */
-    private performReachabilityCheck;
-    /**
-     * Records latency and closes the peerConnection
-     * @param {RTCPeerConnection} peerConnection
-     * @param {number} elapsed Latency in milliseconds
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private setLatencyAndClose;
-    /**
-     * utility function
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
+     * Performs reachability checks for all clusters
+     * @param {ClusterList} clusterList
+     * @returns {Promise<ReachabilityResults>} reachability check results
      */
-    private setup;
+    private performReachabilityChecks;
 }