@webex/plugin-meetings 3.3.1-next.4 → 3.3.1-next.41

package/src/metrics/index.ts

@@ -65,6 +65,50 @@ class Metrics {
       tags: metricTags,
     });
   }
+
+  /**
+   * Flattens an object into one that has no nested properties. Each level of nesting is represented
+   * by "_" in the flattened object property names.
+   * This function is needed, because Amplitude doesn't allow passing nested objects as metricFields.
+   * Use this function for metricFields before calling sendBehavioralMetric() if you want to send
+   * nested objects in your metrics.
+   *
+   * If the function is called with a literal, it returns an object with a single property "value"
+   * and the literal value in it.
+   *
+   * @param {any} payload object you want to flatten
+   * @param {string} prefix string prefix prepended to any property names in flatten object
+   * @returns {Object}
+   */
+  prepareMetricFields(payload: any = {}, prefix = '') {
+    let output = {};
+
+    if (Array.isArray(payload)) {
+      payload.forEach((item, index) => {
+        const propName = prefix.length > 0 ? `${prefix}_${index}` : `${index}`;
+
+        output = {...output, ...this.prepareMetricFields(item, propName)};
+      });
+
+      return output;
+    }
+
+    if (typeof payload !== 'object' || payload === null) {
+      if (prefix.length > 0) {
+        return {[prefix]: payload};
+      }
+
+      return {value: payload};
+    }
+
+    Object.entries(payload).forEach(([key, value]) => {
+      const propName = prefix.length > 0 ? `${prefix}_${key}` : key;
+
+      output = {...output, ...this.prepareMetricFields(value, propName)};
+    });
+
+    return output;
+  }
 }
 
 // Export Metrics singleton ---------------------------------------------------

package/src/personal-meeting-room/index.ts

@@ -1,7 +1,7 @@
 // @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
-import {MEETINGS, _PERSONAL_ROOM_} from '../constants';
+import {MEETINGS, DESTINATION_TYPE} from '../constants';
 import ParameterError from '../common/errors/parameter';
 
 import PersonalMeetingRoomRequest from './request';
@@ -141,7 +141,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    */
   public get() {
     const options = {
-      type: _PERSONAL_ROOM_,
+      type: DESTINATION_TYPE.PERSONAL_ROOM,
     };
 
     return this.meetingInfo.fetchMeetingInfo(options).then((pmr) => {

package/src/reachability/clusterReachability.ts

@@ -3,11 +3,9 @@ import {Defer} from '@webex/common';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {ClusterNode} from './request';
 import {convertStunUrlToTurn, convertStunUrlToTurnTls} from './util';
+import EventsScope from '../common/events/events-scope';
 
-import {ICE_GATHERING_STATE, CONNECTION_STATE} from '../constants';
-
-const DEFAULT_TIMEOUT = 3000;
-const VIDEO_MESH_TIMEOUT = 1000;
+import {CONNECTION_STATE, Enum, ICE_GATHERING_STATE} from '../constants';
 
 // result for a specific transport protocol (like udp or tcp)
 export type TransportResult = {
@@ -23,10 +21,32 @@ export type ClusterReachabilityResult = {
   xtls: TransportResult;
 };
 
+// data for the Events.resultReady event
+export type ResultEventData = {
+  protocol: 'udp' | 'tcp' | 'xtls';
+  result: 'reachable' | 'unreachable' | 'untested';
+  latencyInMilliseconds: number; // amount of time it took to get the ICE candidate
+  clientMediaIPs?: string[];
+};
+
+// data for the Events.clientMediaIpsUpdated event
+export type ClientMediaIpsUpdatedEventData = {
+  protocol: 'udp' | 'tcp' | 'xtls';
+  clientMediaIPs: string[];
+};
+
+export const Events = {
+  resultReady: 'resultReady', // emitted when a cluster is reached successfully using specific protocol
+  clientMediaIpsUpdated: 'clientMediaIpsUpdated', // emitted when more public IPs are found after resultReady was already sent for a given protocol
+} as const;
+
+export type Events = Enum<typeof Events>;
+
 /**
  * A class that handles reachability checks for a single cluster.
+ * It emits events from Events enum
  */
-export class ClusterReachability {
+export class ClusterReachability extends EventsScope {
   private numUdpUrls: number;
   private numTcpUrls: number;
   private numXTlsUrls: number;
@@ -43,6 +63,7 @@ export class ClusterReachability {
    * @param {ClusterNode} clusterInfo information about the media cluster
    */
   constructor(name: string, clusterInfo: ClusterNode) {
+    super();
     this.name = name;
     this.isVideoMesh = clusterInfo.isVideoMesh;
     this.numUdpUrls = clusterInfo.udp.length;
@@ -162,23 +183,54 @@ export class ClusterReachability {
     this.defer.resolve();
   }
 
+  /**
+   * Aborts the cluster reachability checks by closing the peer connection
+   *
+   * @returns {void}
+   */
+  public abort() {
+    const {CLOSED} = CONNECTION_STATE;
+
+    if (this.pc.connectionState !== CLOSED) {
+      this.closePeerConnection();
+      this.finishReachabilityCheck();
+    }
+  }
+
   /**
    * Adds public IP (client media IPs)
    * @param {string} protocol
    * @param {string} publicIP
    * @returns {void}
    */
-  private addPublicIP(protocol: 'udp' | 'tcp', publicIP?: string | null) {
+  private addPublicIP(protocol: 'udp' | 'tcp' | 'xtls', publicIP?: string | null) {
     const result = this.result[protocol];
 
     if (publicIP) {
+      let ipAdded = false;
+
       if (result.clientMediaIPs) {
         if (!result.clientMediaIPs.includes(publicIP)) {
           result.clientMediaIPs.push(publicIP);
+          ipAdded = true;
         }
       } else {
         result.clientMediaIPs = [publicIP];
+        ipAdded = true;
       }
+
+      if (ipAdded)
+        this.emit(
+          {
+            file: 'clusterReachability',
+            function: 'addPublicIP',
+          },
+          Events.clientMediaIpsUpdated,
+          {
+            protocol,
+            clientMediaIPs: result.clientMediaIPs,
+          }
+        );
     }
   }
 
@@ -211,22 +263,43 @@ export class ClusterReachability {
   }
 
   /**
-   * Stores the latency in the result for the given protocol and marks it as reachable
+   * Saves the latency in the result for the given protocol and marks it as reachable,
+   * emits the "resultReady" event if this is the first result for that protocol,
+   * emits the "clientMediaIpsUpdated" event if we already had a result and only found
+   * a new client IP
    *
    * @param {string} protocol
    * @param {number} latency
+   * @param {string|null} [publicIp]
    * @returns {void}
    */
-  private storeLatencyResult(protocol: 'udp' | 'tcp' | 'xtls', latency: number) {
+  private saveResult(protocol: 'udp' | 'tcp' | 'xtls', latency: number, publicIp?: string | null) {
     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`
+        `Reachability:index#saveResult --> Successfully reached ${this.name} over ${protocol}: ${latency}ms`
       );
       result.latencyInMilliseconds = latency;
       result.result = 'reachable';
+      if (publicIp) {
+        result.clientMediaIPs = [publicIp];
+      }
+
+      this.emit(
+        {
+          file: 'clusterReachability',
+          function: 'saveResult',
+        },
+        Events.resultReady,
+        {
+          protocol,
+          ...result,
+        }
+      );
+    } else {
+      this.addPublicIP(protocol, publicIp);
     }
   }
 
@@ -243,15 +316,16 @@ export class ClusterReachability {
         RELAY: 'relay',
       };
 
+      const latencyInMilliseconds = this.getElapsedTime();
+
       if (e.candidate) {
         if (e.candidate.type === CANDIDATE_TYPES.SERVER_REFLEXIVE) {
-          this.storeLatencyResult('udp', this.getElapsedTime());
-          this.addPublicIP('udp', e.candidate.address);
+          this.saveResult('udp', latencyInMilliseconds, e.candidate.address);
         }
 
         if (e.candidate.type === CANDIDATE_TYPES.RELAY) {
           const protocol = e.candidate.port === TURN_TLS_PORT ? 'xtls' : 'tcp';
-          this.storeLatencyResult(protocol, this.getElapsedTime());
+          this.saveResult(protocol, latencyInMilliseconds);
           // 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
         }
@@ -314,22 +388,9 @@ export class ClusterReachability {
    * @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;
   }
 }

package/src/reachability/index.ts

@@ -3,8 +3,9 @@
  */
 
 /* eslint-disable class-methods-use-this */
-import {mapValues} from 'lodash';
+import {isEqual, mapValues, mean} from 'lodash';
 
+import {Defer} from '@webex/common';
 import LoggerProxy from '../common/logs/logger-proxy';
 import MeetingUtil from '../meeting/util';
 
@@ -12,10 +13,16 @@ import {REACHABILITY} from '../constants';
 
 import ReachabilityRequest, {ClusterList} from './request';
 import {
+  ClientMediaIpsUpdatedEventData,
   ClusterReachability,
   ClusterReachabilityResult,
+  Events,
+  ResultEventData,
   TransportResult,
 } from './clusterReachability';
+import EventsScope from '../common/events/events-scope';
+import BEHAVIORAL_METRICS from '../metrics/constants';
+import Metrics from '../metrics';
 
 export type ReachabilityMetrics = {
   reachability_public_udp_success: number;
@@ -60,11 +67,16 @@ export type ReachabilityResults = Record<
   }
 >;
 
+// timeouts in seconds
+const DEFAULT_TIMEOUT = 3;
+const VIDEO_MESH_TIMEOUT = 1;
+const OVERALL_TIMEOUT = 15;
+
 /**
  * @class Reachability
  * @export
  */
-export default class Reachability {
+export default class Reachability extends EventsScope {
   namespace = REACHABILITY.namespace;
   webex: object;
   reachabilityRequest: ReachabilityRequest;
@@ -72,12 +84,22 @@ export default class Reachability {
     [key: string]: ClusterReachability;
   };
 
+  reachabilityDefer?: Defer;
+
+  vmnTimer?: ReturnType<typeof setTimeout>;
+  publicCloudTimer?: ReturnType<typeof setTimeout>;
+  overallTimer?: ReturnType<typeof setTimeout>;
+
+  expectedResultsCount = {videoMesh: {udp: 0}, public: {udp: 0, tcp: 0, xtls: 0}};
+  resultsCount = {videoMesh: {udp: 0}, public: {udp: 0, tcp: 0, xtls: 0}};
+
   /**
    * Creates an instance of Reachability.
    * @param {object} webex
    * @memberof Reachability
    */
   constructor(webex: object) {
+    super();
     this.webex = webex;
 
     /**
@@ -105,15 +127,6 @@ export default class Reachability {
         MeetingUtil.getIpVersion(this.webex)
       );
 
-      // Perform Reachability Check
-      const results = await this.performReachabilityChecks(clusters);
-
-      // @ts-ignore
-      await this.webex.boundedStorage.put(
-        this.namespace,
-        REACHABILITY.localStorageResult,
-        JSON.stringify(results)
-      );
       // @ts-ignore
       await this.webex.boundedStorage.put(
         this.namespace,
@@ -121,11 +134,12 @@ export default class Reachability {
         JSON.stringify(joinCookie)
       );
 
-      LoggerProxy.logger.log(
-        'Reachability:index#gatherReachability --> Reachability checks completed'
-      );
+      this.reachabilityDefer = new Defer();
+
+      // Perform Reachability Check
+      await this.performReachabilityChecks(clusters);
 
-      return results;
+      return this.reachabilityDefer.promise;
     } catch (error) {
       LoggerProxy.logger.error(`Reachability:index#gatherReachability --> Error:`, error);
 
@@ -395,16 +409,210 @@ export default class Reachability {
     });
   }
 
+  /**
+   * Returns true if we've obtained all the reachability results for all the public clusters
+   * In other words, it means that all public clusters are reachable over each protocol,
+   * because we only get a "result" if we managed to reach a cluster
+   *
+   * @returns {boolean}
+   */
+  private areAllPublicClusterResultsReady() {
+    return isEqual(this.expectedResultsCount.public, this.resultsCount.public);
+  }
+
+  /**
+   * Returns true if we've obtained all the reachability results for all the clusters
+   *
+   * @returns {boolean}
+   */
+  private areAllResultsReady() {
+    return isEqual(this.expectedResultsCount, this.resultsCount);
+  }
+
+  /**
+   * Resolves the promise returned by gatherReachability() method
+   * @returns {void}
+   */
+  private resolveReachabilityPromise() {
+    if (this.vmnTimer) {
+      clearTimeout(this.vmnTimer);
+    }
+    if (this.publicCloudTimer) {
+      clearTimeout(this.publicCloudTimer);
+    }
+
+    this.logUnreachableClusters();
+    this.reachabilityDefer?.resolve();
+  }
+
+  /**
+   * Aborts all cluster reachability checks that are in progress
+   *
+   * @returns {void}
+   */
+  private abortClusterReachability() {
+    Object.values(this.clusterReachability).forEach((clusterReachability) => {
+      clusterReachability.abort();
+    });
+  }
+
+  /**
+   * Helper function for calculating min/max/average values of latency
+   *
+   * @param {Array<any>} results
+   * @param {string} protocol
+   * @param {boolean} isVideoMesh
+   * @returns {{min:number, max: number, average: number}}
+   */
+  protected getStatistics(
+    results: Array<ClusterReachabilityResult & {isVideoMesh: boolean}>,
+    protocol: 'udp' | 'tcp' | 'xtls',
+    isVideoMesh: boolean
+  ) {
+    const values = results
+      .filter((result) => result.isVideoMesh === isVideoMesh)
+      .filter((result) => result[protocol].result === 'reachable')
+      .map((result) => result[protocol].latencyInMilliseconds);
+
+    if (values.length === 0) {
+      return {
+        min: -1,
+        max: -1,
+        average: -1,
+      };
+    }
+
+    return {
+      min: Math.min(...values),
+      max: Math.max(...values),
+      average: mean(values),
+    };
+  }
+
+  /**
+   * Sends a metric with all the statistics about how long reachability took
+   *
+   * @returns {void}
+   */
+  protected async sendMetric() {
+    const results = [];
+
+    Object.values(this.clusterReachability).forEach((clusterReachability) => {
+      results.push({
+        ...clusterReachability.getResult(),
+        isVideoMesh: clusterReachability.isVideoMesh,
+      });
+    });
+
+    const stats = {
+      vmn: {
+        udp: this.getStatistics(results, 'udp', true),
+      },
+      public: {
+        udp: this.getStatistics(results, 'udp', false),
+        tcp: this.getStatistics(results, 'tcp', false),
+        xtls: this.getStatistics(results, 'xtls', false),
+      },
+    };
+    Metrics.sendBehavioralMetric(
+      BEHAVIORAL_METRICS.REACHABILITY_COMPLETED,
+      Metrics.prepareMetricFields(stats)
+    );
+  }
+
+  /**
+   * Starts all the timers used for various timeouts
+   *
+   * @returns {void}
+   */
+  private startTimers() {
+    this.vmnTimer = setTimeout(() => {
+      this.vmnTimer = undefined;
+      // if we are only missing VMN results, then we don't want to wait for them any longer
+      // as they are likely to fail if users are not on corporate network
+      if (this.areAllPublicClusterResultsReady()) {
+        LoggerProxy.logger.log(
+          'Reachability:index#startTimers --> Reachability checks timed out (VMN timeout)'
+        );
+
+        this.resolveReachabilityPromise();
+      }
+    }, VIDEO_MESH_TIMEOUT * 1000);
+
+    this.publicCloudTimer = setTimeout(() => {
+      this.publicCloudTimer = undefined;
+
+      LoggerProxy.logger.log(
+        `Reachability:index#startTimers --> Reachability checks timed out (${DEFAULT_TIMEOUT}s)`
+      );
+
+      // resolve the promise, so that the client won't be blocked waiting on meetings.register() for too long
+      this.resolveReachabilityPromise();
+    }, DEFAULT_TIMEOUT * 1000);
+
+    this.overallTimer = setTimeout(() => {
+      this.overallTimer = undefined;
+      this.abortClusterReachability();
+      this.emit(
+        {
+          file: 'reachability',
+          function: 'overallTimer timeout',
+        },
+        'reachability:done',
+        {}
+      );
+      this.sendMetric();
+
+      LoggerProxy.logger.log(
+        `Reachability:index#startTimers --> Reachability checks fully timed out (${OVERALL_TIMEOUT}s)`
+      );
+    }, OVERALL_TIMEOUT * 1000);
+  }
+
+  /**
+   * Stores given reachability results in local storage
+   *
+   * @param {ReachabilityResults} results
+   * @returns {Promise<void>}
+   */
+  private async storeResults(results: ReachabilityResults) {
+    // @ts-ignore
+    await this.webex.boundedStorage.put(
+      this.namespace,
+      REACHABILITY.localStorageResult,
+      JSON.stringify(results)
+    );
+  }
+
+  /**
+   * Resets all the internal counters that keep track of the results
+   *
+   * @returns {void}
+   */
+  private resetResultCounters() {
+    this.expectedResultsCount.videoMesh.udp = 0;
+    this.expectedResultsCount.public.udp = 0;
+    this.expectedResultsCount.public.tcp = 0;
+    this.expectedResultsCount.public.xtls = 0;
+
+    this.resultsCount.videoMesh.udp = 0;
+    this.resultsCount.public.udp = 0;
+    this.resultsCount.public.tcp = 0;
+    this.resultsCount.public.xtls = 0;
+  }
+
   /**
    * Performs reachability checks for all clusters
    * @param {ClusterList} clusterList
-   * @returns {Promise<ReachabilityResults>} reachability check results
+   * @returns {Promise<void>} promise that's resolved as soon as the checks are started
    */
-  private async performReachabilityChecks(clusterList: ClusterList): Promise<ReachabilityResults> {
+  private async performReachabilityChecks(clusterList: ClusterList) {
     const results: ReachabilityResults = {};
 
+    this.clusterReachability = {};
+
     if (!clusterList || !Object.keys(clusterList).length) {
-      return Promise.resolve(results);
+      return;
     }
 
     LoggerProxy.logger.log(
@@ -417,7 +625,11 @@ export default class Reachability {
       } reachability checks`
     );
 
-    const clusterReachabilityChecks = Object.keys(clusterList).map((key) => {
+    this.resetResultCounters();
+    this.startTimers();
+
+    // sanitize the urls in the clusterList
+    Object.keys(clusterList).forEach((key) => {
       const cluster = clusterList[key];
 
       // Linus doesn't support TCP reachability checks on video mesh nodes
@@ -429,6 +641,7 @@ export default class Reachability {
         cluster.tcp = [];
       }
 
+      // Linus doesn't support xTLS reachability checks on video mesh nodes
       const includeTlsReachability =
         // @ts-ignore
         this.webex.config.meetings.experimental.enableTlsReachability && !cluster.isVideoMesh;
@@ -437,18 +650,94 @@ export default class Reachability {
         cluster.xtls = [];
       }
 
-      this.clusterReachability[key] = new ClusterReachability(key, cluster);
+      // initialize the result for this cluster
+      results[key] = {
+        udp: {result: cluster.udp.length > 0 ? 'unreachable' : 'untested'},
+        tcp: {result: cluster.tcp.length > 0 ? 'unreachable' : 'untested'},
+        xtls: {result: cluster.xtls.length > 0 ? 'unreachable' : 'untested'},
+        isVideoMesh: cluster.isVideoMesh,
+      };
+
+      // update expected results counters to include this cluster
+      this.expectedResultsCount[cluster.isVideoMesh ? 'videoMesh' : 'public'].udp +=
+        cluster.udp.length;
+      if (!cluster.isVideoMesh) {
+        this.expectedResultsCount.public.tcp += cluster.tcp.length;
+        this.expectedResultsCount.public.xtls += cluster.xtls.length;
+      }
+    });
+
+    const isFirstResult = {
+      udp: true,
+      tcp: true,
+      xtls: true,
+    };
+
+    // save the initialized results (in case we don't get any "resultReady" events at all)
+    await this.storeResults(results);
 
-      return this.clusterReachability[key].start().then((result) => {
-        results[key] = result;
-        results[key].isVideoMesh = cluster.isVideoMesh;
+    // now start the reachability on all the clusters
+    Object.keys(clusterList).forEach((key) => {
+      const cluster = clusterList[key];
+
+      this.clusterReachability[key] = new ClusterReachability(key, cluster);
+      this.clusterReachability[key].on(Events.resultReady, async (data: ResultEventData) => {
+        const {protocol, result, clientMediaIPs, latencyInMilliseconds} = data;
+
+        if (isFirstResult[protocol]) {
+          this.emit(
+            {
+              file: 'reachability',
+              function: 'resultReady event handler',
+            },
+            'reachability:firstResultAvailable',
+            {
+              protocol,
+            }
+          );
+          isFirstResult[protocol] = false;
+        }
+        this.resultsCount[cluster.isVideoMesh ? 'videoMesh' : 'public'][protocol] += 1;
+
+        const areAllResultsReady = this.areAllResultsReady();
+
+        results[key][protocol].result = result;
+        results[key][protocol].clientMediaIPs = clientMediaIPs;
+        results[key][protocol].latencyInMilliseconds = latencyInMilliseconds;
+
+        await this.storeResults(results);
+
+        if (areAllResultsReady) {
+          clearTimeout(this.overallTimer);
+          this.overallTimer = undefined;
+          this.emit(
+            {
+              file: 'reachability',
+              function: 'performReachabilityChecks',
+            },
+            'reachability:done',
+            {}
+          );
+          this.sendMetric();
+
+          LoggerProxy.logger.log(
+            `Reachability:index#gatherReachability --> Reachability checks fully completed`
+          );
+          this.resolveReachabilityPromise();
+        }
       });
-    });
 
-    await Promise.all(clusterReachabilityChecks);
+      // clientMediaIps can be updated independently from the results, so we need to listen for them too
+      this.clusterReachability[key].on(
+        Events.clientMediaIpsUpdated,
+        async (data: ClientMediaIpsUpdatedEventData) => {
+          results[key][data.protocol].clientMediaIPs = data.clientMediaIPs;
 
-    this.logUnreachableClusters();
+          await this.storeResults(results);
+        }
+      );
 
-    return results;
+      this.clusterReachability[key].start(); // not awaiting on purpose
+    });
   }
 }