@webex/plugin-meetings 3.0.0-beta.337 → 3.0.0-beta.339

package/dist/types/reachability/index.d.ts

@@ -1,6 +1,8 @@
 /*!
  * 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;
@@ -11,29 +13,25 @@ export type ReachabilityMetrics = {
     reachability_vmn_tcp_success: number;
     reachability_vmn_tcp_failed: number;
 };
-export type TransportResult = {
+/**
+ * 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';
 };
-type ReachabilityResult = {
-    udp: TransportResult;
-    tcp: TransportResult;
-    xtls: {
-        untested: 'true';
-    };
+export type ReachabilityResultForBackend = {
+    udp: TransportResultForBackend;
+    tcp: TransportResultForBackend;
+    xtls: TransportResultForBackend;
 };
-export type ReachabilityResults = Record<string, ReachabilityResult>;
-type InternalReachabilityResults = Record<string, ReachabilityResult & {
+export type ReachabilityResultsForBackend = Record<string, ReachabilityResultForBackend>;
+export type ReachabilityResults = Record<string, ClusterReachabilityResult & {
     isVideoMesh?: boolean;
 }>;
-export type ICECandidateResult = {
-    clusterId: string;
-    isVideoMesh: boolean;
-    elapsed?: string | null;
-    publicIPs?: string[];
-};
 /**
  * @class Reachability
  * @export
@@ -41,8 +39,10 @@ export type ICECandidateResult = {
 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
@@ -50,13 +50,12 @@ export default class Reachability {
      */
     constructor(webex: object);
     /**
-     * fetches reachability data
-     * @returns {Object} reachability data
+     * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
+     * @returns {Promise<ReachabilityResults>} reachability results
      * @public
-     * @async
      * @memberof Reachability
      */
-    gatherReachability(): Promise<InternalReachabilityResults>;
+    gatherReachability(): Promise<ReachabilityResults>;
     /**
      * 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
@@ -64,12 +63,18 @@ export default class Reachability {
      * @returns {Promise} Promise with metrics values, it never rejects/throws.
      */
     getReachabilityMetrics(): Promise<ReachabilityMetrics>;
+    /**
+     * Maps our internal transport result to the format that backend expects
+     * @param {TransportResult} transportResult
+     * @returns {TransportResultForBackend}
+     */
+    private mapTransportResultToBackendDataFormat;
     /**
      * Reachability results as an object in the format that backend expects
      *
      * @returns {any} reachability results that need to be sent to the backend
      */
-    getReachabilityResults(): Promise<ReachabilityResults | undefined>;
+    getReachabilityResults(): Promise<ReachabilityResultsForBackend | undefined>;
     /**
      * fetches reachability data and checks for cluster reachability
      * @returns {boolean}
@@ -77,73 +82,13 @@ export default class Reachability {
      * @memberof Reachability
      */
     isAnyPublicClusterReachable(): Promise<boolean>;
-    /**
-     * Generate peerConnection config settings
-     * @param {object} cluster
-     * @returns {object} peerConnectionConfig
-     * @private
-     * @memberof Reachability
-     */
-    private buildPeerConnectionConfig;
-    /**
-     * Creates an RTCPeerConnection
-     * @param {object} cluster
-     * @returns {RTCPeerConnection} peerConnection
-     * @private
-     * @memberof Reachability
-     */
-    private createPeerConnection;
-    /**
-     * Gets total elapsed time
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {Number} Milliseconds
-     * @private
-     * @memberof Reachability
-     */
-    private getElapsedTime;
-    /**
-     * creates offer and generates localSDP
-     * @param {object} clusterList cluster List
-     * @returns {Promise} Reachability latency results
-     * @private
-     * @memberof Reachability
-     */
-    private getLocalSDPForClusters;
     /**
      * 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 {boolean} isVideoMesh
-     * @returns {Promise}
-     */
-    private iceGatheringState;
+    private getUnreachableClusters;
     /**
      * Make a log of unreachable clusters.
      * @returns {undefined}
@@ -152,43 +97,9 @@ export default class Reachability {
      */
     private logUnreachableClusters;
     /**
-     * Calculates time to establish connection
-     * @param {Array<ICECandidateResult>} iceResults iceResults
-     * @returns {object} reachabilityMap
-     * @protected
-     * @memberof Reachability
-     */
-    protected parseIceResultsToInternalReachabilityResults(iceResults: Array<ICECandidateResult>): InternalReachabilityResults;
-    /**
-     * fetches reachability data
-     * @param {object} clusterList
-     * @returns {Promise<InternalReachabilityResults>} reachability check results
-     * @private
-     * @memberof Reachability
-     */
-    private performReachabilityCheck;
-    /**
-     * Adds public IP (client media IPs)
-     * @param {RTCPeerConnection} peerConnection
-     * @param {string} publicIP
-     * @returns {void}
-     */
-    protected addPublicIP(peerConnection: RTCPeerConnection, publicIP?: string | null): void;
-    /**
-     * 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;
 }
-export {};

package/dist/types/reachability/util.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a stun url to a turn url
+ *
+ * @param {string} stunUrl url of a stun server
+ * @param {'tcp'|'udp'} protocol what protocol to use for the turn server
+ * @returns {string} url of a turn server
+ */
+export declare function convertStunUrlToTurn(stunUrl: string, protocol: 'udp' | 'tcp'): string;

package/dist/webinar/index.js

@@ -62,7 +62,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
   updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
-  version: "3.0.0-beta.337"
+  version: "3.0.0-beta.339"
 });
 var _default = Webinar;
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.337",
+  "version": "3.0.0-beta.339",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -33,12 +33,12 @@
   },
   "devDependencies": {
     "@peculiar/webcrypto": "^1.4.3",
-    "@webex/plugin-meetings": "3.0.0-beta.337",
-    "@webex/test-helper-chai": "3.0.0-beta.337",
-    "@webex/test-helper-mocha": "3.0.0-beta.337",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.337",
-    "@webex/test-helper-retry": "3.0.0-beta.337",
-    "@webex/test-helper-test-users": "3.0.0-beta.337",
+    "@webex/plugin-meetings": "3.0.0-beta.339",
+    "@webex/test-helper-chai": "3.0.0-beta.339",
+    "@webex/test-helper-mocha": "3.0.0-beta.339",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.339",
+    "@webex/test-helper-retry": "3.0.0-beta.339",
+    "@webex/test-helper-test-users": "3.0.0-beta.339",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -47,19 +47,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.337",
-    "@webex/internal-media-core": "2.2.3",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.337",
-    "@webex/internal-plugin-device": "3.0.0-beta.337",
-    "@webex/internal-plugin-llm": "3.0.0-beta.337",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.337",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.337",
-    "@webex/internal-plugin-support": "3.0.0-beta.337",
-    "@webex/internal-plugin-user": "3.0.0-beta.337",
-    "@webex/media-helpers": "3.0.0-beta.337",
-    "@webex/plugin-people": "3.0.0-beta.337",
-    "@webex/plugin-rooms": "3.0.0-beta.337",
-    "@webex/webex-core": "3.0.0-beta.337",
+    "@webex/common": "3.0.0-beta.339",
+    "@webex/internal-media-core": "2.2.4",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.339",
+    "@webex/internal-plugin-device": "3.0.0-beta.339",
+    "@webex/internal-plugin-llm": "3.0.0-beta.339",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.339",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.339",
+    "@webex/internal-plugin-support": "3.0.0-beta.339",
+    "@webex/internal-plugin-user": "3.0.0-beta.339",
+    "@webex/media-helpers": "3.0.0-beta.339",
+    "@webex/plugin-people": "3.0.0-beta.339",
+    "@webex/plugin-rooms": "3.0.0-beta.339",
+    "@webex/webex-core": "3.0.0-beta.339",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/config.ts

@@ -88,6 +88,7 @@ export default {
       enableMediaNegotiatedEvent: false,
       enableUnifiedMeetings: true,
       enableAdhocMeetings: true,
+      enableTcpReachability: false,
     },
     degradationPreferences: {
       maxMacroblocksLimit: 8192,

package/src/reachability/clusterReachability.ts

@@ -0,0 +1,320 @@
+import {Defer} from '@webex/common';
+
+import LoggerProxy from '../common/logs/logger-proxy';
+import {ClusterNode} from './request';
+import {convertStunUrlToTurn} from './util';
+
+import {ICE_GATHERING_STATE, CONNECTION_STATE} from '../constants';
+
+const DEFAULT_TIMEOUT = 3000;
+const VIDEO_MESH_TIMEOUT = 1000;
+
+// result for a specific transport protocol (like udp or tcp)
+export type TransportResult = {
+  result: 'reachable' | 'unreachable' | 'untested';
+  latencyInMilliseconds?: number; // amount of time it took to get the first ICE candidate
+  clientMediaIPs?: string[];
+};
+
+// reachability result for a specific media cluster
+export type ClusterReachabilityResult = {
+  udp: TransportResult;
+  tcp: TransportResult;
+  xtls: TransportResult;
+};
+
+/**
+ * A class that handles reachability checks for a single cluster.
+ */
+export class ClusterReachability {
+  private numUdpUrls: number;
+  private numTcpUrls: number;
+  private result: ClusterReachabilityResult;
+  private pc?: RTCPeerConnection;
+  private defer: Defer; // this defer is resolved once reachability checks for this cluster are completed
+  private startTimestamp: number;
+  public readonly isVideoMesh: boolean;
+  public readonly name;
+
+  /**
+   * Constructor for ClusterReachability
+   * @param {string} name cluster name
+   * @param {ClusterNode} clusterInfo information about the media cluster
+   */
+  constructor(name: string, clusterInfo: ClusterNode) {
+    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 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
+   */
+  private getElapsedTime() {
+    return Math.round(performance.now() - this.startTimestamp);
+  }
+
+  /**
+   * Generate peerConnection config settings
+   * @param {ClusterNode} cluster
+   * @returns {RTCConfiguration} peerConnectionConfig
+   */
+  private buildPeerConnectionConfig(cluster: ClusterNode): RTCConfiguration {
+    const udpIceServers = cluster.udp.map((url) => ({
+      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()).
+    const tcpIceServers = cluster.tcp.map((urlString: string) => {
+      return {
+        username: 'webexturnreachuser',
+        credential: 'webexturnreachpwd',
+        urls: [convertStunUrlToTurn(urlString, 'tcp')],
+      };
+    });
+
+    return {
+      iceServers: [...udpIceServers, ...tcpIceServers],
+      iceCandidatePoolSize: 0,
+      iceTransportPolicy: 'all',
+    };
+  }
+
+  /**
+   * Creates an RTCPeerConnection
+   * @param {ClusterNode} clusterInfo information about the media cluster
+   * @returns {RTCPeerConnection} peerConnection
+   */
+  private createPeerConnection(clusterInfo: ClusterNode) {
+    try {
+      const config = this.buildPeerConnectionConfig(clusterInfo);
+
+      const peerConnection = new RTCPeerConnection(config);
+
+      return peerConnection;
+    } catch (peerConnectionError) {
+      LoggerProxy.logger.warn(
+        `Reachability:index#createPeerConnection --> Error creating peerConnection:`,
+        peerConnectionError
+      );
+
+      return undefined;
+    }
+  }
+
+  /**
+   * @returns {ClusterReachabilityResult} reachability result for this cluster
+   */
+  getResult() {
+    return this.result;
+  }
+
+  /**
+   * Closes the peerConnection
+   *
+   * @returns {void}
+   */
+  private 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}
+   */
+  private finishReachabilityCheck() {
+    this.defer.resolve();
+  }
+
+  /**
+   * Adds public IP (client media IPs)
+   * @param {string} protocol
+   * @param {string} publicIP
+   * @returns {void}
+   */
+  private addPublicIP(protocol: 'udp' | 'tcp', publicIP?: string | null) {
+    const 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}
+   */
+  private registerIceGatheringStateChangeListener() {
+    this.pc.onicegatheringstatechange = () => {
+      const {COMPLETE} = ICE_GATHERING_STATE;
+
+      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
+   */
+  private haveWeGotAllResults(): boolean {
+    return ['udp', 'tcp'].every(
+      (protocol) =>
+        this.result[protocol].result === 'reachable' || this.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}
+   */
+  private storeLatencyResult(protocol: 'udp' | 'tcp', latency: number) {
+    const result = this.result[protocol];
+
+    if (result.latencyInMilliseconds === undefined) {
+      LoggerProxy.logger.log(
+        // @ts-ignore
+        `Reachability:index#storeLatencyResult --> Successfully reached ${this.name} over ${protocol}: ${latency}ms`
+      );
+      result.latencyInMilliseconds = latency;
+      result.result = 'reachable';
+    }
+  }
+
+  /**
+   * Registers a listener for the icecandidate event
+   *
+   * @returns {void}
+   */
+  private registerIceCandidateListener() {
+    this.pc.onicecandidate = (e) => {
+      const CANDIDATE_TYPES = {
+        SERVER_REFLEXIVE: 'srflx',
+        RELAY: 'relay',
+      };
+
+      if (e.candidate) {
+        if (e.candidate.type === CANDIDATE_TYPES.SERVER_REFLEXIVE) {
+          this.storeLatencyResult('udp', this.getElapsedTime());
+          this.addPublicIP('udp', e.candidate.address);
+        }
+
+        if (e.candidate.type === CANDIDATE_TYPES.RELAY) {
+          this.storeLatencyResult('tcp', this.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 (this.haveWeGotAllResults()) {
+          this.closePeerConnection();
+          this.finishReachabilityCheck();
+        }
+      }
+    };
+  }
+
+  /**
+   * Starts the process of doing UDP and TCP reachability checks on the media cluster.
+   * XTLS reachability checking is not supported.
+   *
+   * @returns {Promise}
+   */
+  async start(): Promise<ClusterReachabilityResult> {
+    if (!this.pc) {
+      LoggerProxy.logger.warn(
+        `Reachability:ClusterReachability#start --> Error: peerConnection is undefined`
+      );
+
+      return this.result;
+    }
+
+    // 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',
+    };
+
+    try {
+      const offer = await this.pc.createOffer({offerToReceiveAudio: true});
+
+      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);
+
+      await this.gatherIceCandidates();
+    } catch (error) {
+      LoggerProxy.logger.warn(`Reachability:ClusterReachability#start --> Error: `, error);
+    }
+
+    return this.result;
+  }
+
+  /**
+   * 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
+   */
+  private gatherIceCandidates() {
+    const timeout = this.isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT;
+
+    this.registerIceGatheringStateChangeListener();
+    this.registerIceCandidateListener();
+
+    // Set maximum timeout
+    setTimeout(() => {
+      const {CLOSED} = CONNECTION_STATE;
+
+      // Close any open peerConnections
+      if (this.pc.connectionState !== CLOSED) {
+        this.closePeerConnection();
+        this.finishReachabilityCheck();
+      }
+    }, timeout);
+
+    return this.defer.promise;
+  }
+}