@webex/plugin-meetings 2.60.0 → 2.60.1-next.2

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;
 }