@webex/plugin-meetings 3.0.0-beta.9 → 3.0.0-bnr.0

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

@@ -6,7 +6,6 @@ import ParameterError from '../common/errors/parameter';
 
 import PersonalMeetingRoomRequest from './request';
 
-
 /**
  * @class PersonalMeetingRoom
  */
@@ -36,7 +35,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {Object}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.pmr = null;
     /**
      * The pmr sip Uri
@@ -44,7 +43,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {String}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.sipUri = null;
     /**
      * The pmr link
@@ -52,7 +51,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {String}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.link = null;
     /**
      * The pmr server object
@@ -60,7 +59,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {Object}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.userId = null;
     /**
      * The pmr name
@@ -68,7 +67,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {String}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.name = null;
     /**
      * The meeting info request server interface
@@ -76,7 +75,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {MeetingInfo}
      * @private
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.meetingInfo = attrs.meetingInfo;
     /**
      * The pmr server request interface
@@ -84,7 +83,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {Object}
      * @private
      * @memberof PersonalMeetingRoom
-    */
+     */
     // @ts-ignore
     this.personalMeetingRoomRequest = new PersonalMeetingRoomRequest({}, options);
   }
@@ -98,20 +97,19 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    * @public
    * @memberof PersonalMeetingRoom
    */
-  public claim(link: string, pin: string, preferred: boolean = true) {
+  public claim(link: string, pin: string, preferred = true) {
     const options = {
       // @ts-ignore
       userId: this.webex.internal.device.userId,
       passcode: pin,
       meetingAddress: link,
-      preferred
+      preferred,
     };
 
     return this.personalMeetingRoomRequest.claimPmr(options).then((pmr) => {
       if (pmr && pmr.body) {
         this.set(pmr.body);
-      }
-      else {
+      } else {
         return Promise.reject(new ParameterError('No PMR body provided. PMR values not updated.'));
       }
 
@@ -143,15 +141,13 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    */
   public get() {
     const options = {
-      type: _PERSONAL_ROOM_
-
+      type: _PERSONAL_ROOM_,
     };
 
     return this.meetingInfo.fetchMeetingInfo(options).then((pmr) => {
       if (pmr && pmr.body && pmr.body.isPmr) {
         this.set(pmr.body);
-      }
-      else {
+      } else {
         return Promise.reject(new TypeError('The PMR requested is NOT a PMR. PMR values not set.'));
       }
 

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

@@ -6,7 +6,6 @@ import ParameterError from '../common/errors/parameter';
 
 import PersonalMeetingRoomUtil from './util';
 
-
 /**
  * @class MeetingInfoRequest
  */
@@ -20,8 +19,16 @@ export default class PersonalMeetingRoomRequest extends StatelessWebexPlugin {
    * @memberof PersonalMeetingRoomRequest
    */
   claimPmr(options: any) {
-    if (!options || !options.userId || !options.passcode || !options.meetingAddress || !options.preferred) {
-      throw new ParameterError('Claiming a PMR should be done with userId, passcode, preferred, and meetingAddress in options.');
+    if (
+      !options ||
+      !options.userId ||
+      !options.passcode ||
+      !options.meetingAddress ||
+      !options.preferred
+    ) {
+      throw new ParameterError(
+        'Claiming a PMR should be done with userId, passcode, preferred, and meetingAddress in options.'
+      );
     }
     const validPin = PersonalMeetingRoomUtil.getClaimPmrPin(options.passcode);
 

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

@@ -6,7 +6,7 @@ import {
   CMR_MEETINGS,
   CLAIM,
   HECATE,
-  WEBEX_DOT_COM
+  WEBEX_DOT_COM,
 } from '../constants';
 
 const PersonalMeetingRoomUtil: any = {};
@@ -42,8 +42,8 @@ PersonalMeetingRoomUtil.getClaimedRequestParams = (link, pin, options) => ({
     userId: options.userId,
     passcode: pin,
     preferred: options.preferred,
-    meetingAddress: link
-  }
+    meetingAddress: link,
+  },
 });
 
 export default PersonalMeetingRoomUtil;

package/src/reachability/index.ts

@@ -7,22 +7,20 @@
 import _ from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  ICE_GATHERING_STATE,
-  CONNECTION_STATE,
-  REACHABILITY
-} from '../constants';
+import {ICE_GATHERING_STATE, CONNECTION_STATE, REACHABILITY} from '../constants';
 
 import ReachabilityRequest from './request';
 
 const DEFAULT_TIMEOUT = 3000;
 const VIDEO_MESH_TIMEOUT = 1000;
 
+export type ICECandidateResult = {clusterId: string; elapsed?: string | null; publicIPs?: string[]};
 /**
  * @class Reachability
  * @export
  */
 export default class Reachability {
+  namespace = REACHABILITY.namespace;
   webex: object;
   reachabilityRequest: any;
   clusterLatencyResults: any;
@@ -54,7 +52,6 @@ export default class Reachability {
     this.clusterLatencyResults = {};
   }
 
-
   /**
    * fetches reachability data
    * @returns {Object} reachability data
@@ -66,30 +63,40 @@ export default class Reachability {
     this.setup();
 
     // Remove stored reachability results to ensure no stale data
-    if (window?.localStorage?.removeItem) {
-      window.localStorage.removeItem(REACHABILITY.localStorage);
-    }
-    else {
-      LoggerProxy.logger.error('Reachability:index#gatherReachability --> Error in accessing LocalStorage.');
-
-      return {};
-    }
+    // @ts-ignore
+    await this.webex.boundedStorage.del(this.namespace, REACHABILITY.localStorageResult);
+    // @ts-ignore
+    await this.webex.boundedStorage.del(this.namespace, REACHABILITY.localStorageJoinCookie);
 
     // Fetch clusters and measure latency
     try {
-      const clusters = await this.reachabilityRequest.getClusters();
+      const {clusters, joinCookie} = await this.reachabilityRequest.getClusters();
 
       // Perform Reachability Check
       const results = await this.performReachabilityCheck(clusters);
 
-      window.localStorage.setItem(REACHABILITY.localStorage, JSON.stringify(results));
+      // @ts-ignore
+      await this.webex.boundedStorage.put(
+        this.namespace,
+        REACHABILITY.localStorageResult,
+        JSON.stringify(results)
+      );
+      // @ts-ignore
+      await this.webex.boundedStorage.put(
+        this.namespace,
+        REACHABILITY.localStorageJoinCookie,
+        JSON.stringify(joinCookie)
+      );
 
-      LoggerProxy.logger.log('Reachability:index#gatherReachability --> Reachability checks completed');
+      LoggerProxy.logger.log(
+        'Reachability:index#gatherReachability --> Reachability checks completed'
+      );
 
       return results;
-    }
-    catch (getClusterError) {
-      LoggerProxy.logger.error(`Reachability:index#gatherReachability --> Error in calling getClusters(): ${getClusterError}`);
+    } catch (getClusterError) {
+      LoggerProxy.logger.error(
+        `Reachability:index#gatherReachability --> Error in calling getClusters(): ${getClusterError}`
+      );
 
       return {};
     }
@@ -101,25 +108,30 @@ export default class Reachability {
    * @public
    * @memberof Reachability
    */
-  isAnyClusterReachable() {
+  async isAnyClusterReachable() {
     let reachable = false;
-    const reachabilityData = window.localStorage.getItem(REACHABILITY.localStorage);
+    // @ts-ignore
+    const reachabilityData = await this.webex.boundedStorage
+      .get(this.namespace, REACHABILITY.localStorageResult)
+      .catch(() => {});
 
     if (reachabilityData) {
       try {
         const reachabilityResults = JSON.parse(reachabilityData);
 
-        reachable = Object.values(reachabilityResults).some((result: any) => result.udp?.reachable === 'true' || result.tcp?.reachable === 'true');
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Roap:request#attachReachabilityData --> Error in parsing reachability data: ${e}`);
+        reachable = Object.values(reachabilityResults).some(
+          (result: any) => result.udp?.reachable === 'true' || result.tcp?.reachable === 'true'
+        );
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `Roap:request#attachReachabilityData --> Error in parsing reachability data: ${e}`
+        );
       }
     }
 
     return reachable;
   }
 
-
   /**
    * Generate peerConnection config settings
    * @param {object} cluster
@@ -128,25 +140,19 @@ export default class Reachability {
    * @memberof Reachability
    */
   private buildPeerConnectionConfig(cluster: any) {
-    const iceServers = _.uniq([
-      ...cluster.udp,
-      ...cluster.tcp
-    ]).map((url) => ({
+    const iceServers = _.uniq([...cluster.udp, ...cluster.tcp]).map((url) => ({
       username: '',
       credential: '',
-      urls: [url]
+      urls: [url],
     }));
 
     return {
-      iceServers: [
-        ...iceServers
-      ],
+      iceServers: [...iceServers],
       iceCandidatePoolSize: '0',
-      iceTransportPolicy: 'all'
+      iceTransportPolicy: 'all',
     };
   }
 
-
   /**
    * Creates an RTCPeerConnection
    * @param {object} cluster
@@ -164,15 +170,15 @@ export default class Reachability {
       peerConnection.key = key;
 
       return peerConnection;
-    }
-    catch (peerConnectionError) {
-      LoggerProxy.logger.log(`Reachability:index#createPeerConnection --> Error creating peerConnection: ${peerConnectionError}`);
+    } catch (peerConnectionError) {
+      LoggerProxy.logger.log(
+        `Reachability:index#createPeerConnection --> Error creating peerConnection: ${peerConnectionError}`
+      );
 
       return null;
     }
   }
 
-
   /**
    * Gets total elapsed time
    * @param {RTCPeerConnection} peerConnection
@@ -188,7 +194,6 @@ export default class Reachability {
     return Date.now() - startTime;
   }
 
-
   /**
    * creates offer and generates localSDP
    * @param {object} clusterList cluster List
@@ -209,10 +214,14 @@ export default class Reachability {
       peerConnection.begin = Date.now();
       peerConnection.setLocalDescription(description);
 
-      return this.iceGatheringState(peerConnection, cluster.isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT)
-        .catch((iceGatheringStateError) => {
-          LoggerProxy.logger.log(`Reachability:index#getLocalSDPForClusters --> Error in getLocalSDP : ${iceGatheringStateError}`);
-        });
+      return this.iceGatheringState(
+        peerConnection,
+        cluster.isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT
+      ).catch((iceGatheringStateError) => {
+        LoggerProxy.logger.log(
+          `Reachability:index#getLocalSDPForClusters --> Error in getLocalSDP : ${iceGatheringStateError}`
+        );
+      });
     });
 
     return Promise.all(clusters)
@@ -225,7 +234,6 @@ export default class Reachability {
       });
   }
 
-
   /**
    * Get list of all unreachable clusters
    * @returns {array} Unreachable clusters
@@ -247,7 +255,6 @@ export default class Reachability {
     return unreachableList;
   }
 
-
   /**
    * Attach an event handler for the icegatheringstatechange
    * event and measure latency.
@@ -264,13 +271,16 @@ export default class Reachability {
         const elapsed = this.getElapsedTime(peerConnection);
 
         // @ts-ignore
-        LoggerProxy.logger.log(`Reachability:index#onIceGatheringStateChange --> Successfully pinged ${peerConnection.key}:`, elapsed);
+        LoggerProxy.logger.log(
+          // @ts-ignore
+          `Reachability:index#onIceGatheringStateChange --> Successfully pinged ${peerConnection.key}:`,
+          elapsed
+        );
         this.setLatencyAndClose(peerConnection, elapsed);
       }
     };
   }
 
-
   /**
    * Attach an event handler for the icecandidate
    * event and measure latency.
@@ -286,8 +296,13 @@ export default class Reachability {
       if (e.candidate && String(e.candidate.type).toLowerCase() === SERVER_REFLEXIVE) {
         const elapsed = this.getElapsedTime(peerConnection);
 
-        // @ts-ignore
-        LoggerProxy.logger.log(`Reachability:index#onIceCandidate --> Successfully pinged ${peerConnection.key}:`, elapsed);
+        LoggerProxy.logger.log(
+          // @ts-ignore
+          `Reachability:index#onIceCandidate --> Successfully pinged ${peerConnection.key}:`,
+          elapsed
+        );
+        // order is important
+        this.addPublicIP(peerConnection, e.candidate.address);
         this.setLatencyAndClose(peerConnection, elapsed);
       }
     };
@@ -305,12 +320,13 @@ export default class Reachability {
   private iceGatheringState(peerConnection: RTCPeerConnection, timeout: number) {
     const ELAPSED = 'elapsed';
 
-    return new Promise((resolve) => {
+    return new Promise<ICECandidateResult>((resolve) => {
       const peerConnectionProxy = new window.Proxy(peerConnection, {
+        // eslint-disable-next-line require-jsdoc
         get(target, property) {
           const targetMember = target[property];
 
-          if (typeof (targetMember) === 'function') {
+          if (typeof targetMember === 'function') {
             return targetMember.bind(target);
           }
 
@@ -320,14 +336,14 @@ export default class Reachability {
           // only intercept elapsed property
           if (property === ELAPSED) {
             // @ts-ignore
-            resolve({clusterId: peerConnection.key, elapsed: value});
+            resolve({clusterId: peerConnection.key, publicIPs: target.publicIPs, elapsed: value});
 
             return true;
           }
 
           // pass thru
           return window.Reflect.set(target, property, value);
-        }
+        },
       });
 
       // Using peerConnection proxy so handle functions below
@@ -341,13 +357,14 @@ export default class Reachability {
 
         // Close any open peerConnections
         if (peerConnectionProxy.connectionState !== CLOSED) {
+          // order is important
+          this.addPublicIP(peerConnectionProxy, null);
           this.setLatencyAndClose(peerConnectionProxy, null);
         }
       }, timeout);
     });
   }
 
-
   /**
    * Make a log of unreachable clusters.
    * @returns {undefined}
@@ -358,44 +375,49 @@ export default class Reachability {
     const list = this.getUnreachablClusters();
 
     list.forEach((cluster) => {
-      LoggerProxy.logger.log(`Reachability:index#logUnreachableClusters --> No ice candidate for ${cluster}.`);
+      LoggerProxy.logger.log(
+        `Reachability:index#logUnreachableClusters --> No ice candidate for ${cluster}.`
+      );
     });
   }
 
-
   /**
    * Calculates time to establish connection
-   * @param {array} iceResults iceResults
+   * @param {Array<ICECandidateResult>} iceResults iceResults
    * @returns {object} reachabilityMap
-   * @private
+   * @protected
    * @memberof Reachability
    */
-  private parseIceResultsToReachabilityResults(iceResults: Array<any>) {
+  protected parseIceResultsToReachabilityResults(iceResults: Array<ICECandidateResult>) {
     const reachabilityMap = {};
 
-    iceResults.forEach(({clusterId, elapsed}) => {
-      let latencyResult;
+    iceResults.forEach(({clusterId, elapsed, publicIPs}) => {
+      const latencyResult = {};
 
-      if (elapsed === null) {
-        latencyResult = {reachable: 'false'};
-      }
-      else {
-        latencyResult = {
+      if (!elapsed) {
+        Object.assign(latencyResult, {reachable: 'false'});
+      } else {
+        Object.assign(latencyResult, {
           reachable: 'true',
-          latencyInMilliseconds: (elapsed).toString()
-        };
+          latencyInMilliseconds: elapsed.toString(),
+        });
+      }
+
+      if (publicIPs) {
+        Object.assign(latencyResult, {
+          clientMediaIPs: publicIPs,
+        });
       }
 
       reachabilityMap[clusterId] = {
         udp: latencyResult,
-        tcp: latencyResult
+        tcp: latencyResult,
       };
     });
 
     return reachabilityMap;
   }
 
-
   /**
    * fetches reachability data
    * @param {object} clusterList
@@ -413,20 +435,49 @@ export default class Reachability {
         .then((localSDPData) => {
           if (!localSDPData || !Object.keys(localSDPData).length) {
             // TODO: handle the error condition properly and try retry
-            LoggerProxy.logger.log('Reachability:index#performReachabilityCheck --> Local SDP is empty or has missing elements..returning');
+            LoggerProxy.logger.log(
+              'Reachability:index#performReachabilityCheck --> Local SDP is empty or has missing elements..returning'
+            );
             resolve({});
-          }
-          else {
+          } else {
             resolve(localSDPData);
           }
         })
         .catch((error) => {
-          LoggerProxy.logger.error(`Reachability:index#performReachabilityCheck --> Error in getLocalSDPForClusters: ${error}`);
+          LoggerProxy.logger.error(
+            `Reachability:index#performReachabilityCheck --> Error in getLocalSDPForClusters: ${error}`
+          );
           resolve({});
         });
     });
   }
 
+  /**
+   * Adds public IP (client media IPs)
+   * @param {RTCPeerConnection} peerConnection
+   * @param {string} publicIP
+   * @returns {void}
+   */
+  protected addPublicIP(peerConnection: RTCPeerConnection, publicIP?: string | null) {
+    const modifiedPeerConnection: RTCPeerConnection & {publicIPs?: string[]} = peerConnection;
+    const {CLOSED} = CONNECTION_STATE;
+
+    if (modifiedPeerConnection.connectionState === CLOSED) {
+      LoggerProxy.logger.log(
+        `Reachability:index#addPublicIP --> Attempting to set publicIP of ${publicIP} on closed peerConnection.`
+      );
+    }
+
+    if (publicIP) {
+      if (modifiedPeerConnection.publicIPs) {
+        modifiedPeerConnection.publicIPs.push(publicIP);
+      } else {
+        modifiedPeerConnection.publicIPs = [publicIP];
+      }
+    } else {
+      modifiedPeerConnection.publicIPs = null;
+    }
+  }
 
   /**
    * Records latency and closes the peerConnection
@@ -446,7 +497,9 @@ export default class Reachability {
     const intialState = {[REACHABLE]: 0, [UNREACHABLE]: 0};
 
     if (peerConnection.connectionState === CLOSED) {
-      LoggerProxy.logger.log(`Reachability:index#setLatencyAndClose --> Attempting to set latency of ${elapsed} on closed peerConnection.`);
+      LoggerProxy.logger.log(
+        `Reachability:index#setLatencyAndClose --> Attempting to set latency of ${elapsed} on closed peerConnection.`
+      );
 
       return;
     }
@@ -462,7 +515,6 @@ export default class Reachability {
     peerConnection.elapsed = elapsed;
   }
 
-
   /**
    * utility function
    * @returns {undefined}