@webex/plugin-meetings 2.60.0-next.1 → 2.60.0-next.11

package/src/meeting-info/meeting-info-v2.ts

@@ -216,6 +216,10 @@ export default class MeetingInfoV2 {
           installedOrgID,
         };
 
+        if (installedOrgID) {
+          body.installedOrgID = installedOrgID;
+        }
+
         const uri = this.webex.meetings.preferredWebexSite
           ? `https://${this.webex.meetings.preferredWebexSite}/wbxappapi/v2/meetings/spaceInstant`
           : '';

package/src/meeting-info/utilv2.ts

@@ -203,25 +203,12 @@ MeetingInfoUtil.getDestinationType = async (from) => {
         return Promise.resolve(options);
       }
     );
-  } else if (hydraId && hydraId.room) {
-    options.type = _CONVERSATION_URL_;
-    try {
-      await webex.internal.services.waitForCatalog('postauth');
-
-      const serviceUrl = webex.internal.services.getServiceUrlFromClusterId(
-        {
-          cluster: hydraId.cluster,
-        },
-        webex
-      );
-
-      options.destination = hydraId.destination
-        ? `${serviceUrl}/conversations/${hydraId.destination}`
-        : serviceUrl;
-    } catch (e) {
-      LoggerProxy.logger.error(`Meeting-info:util#getDestinationType --> ${e}`);
-      throw e;
-    }
+  } else if (hydraId.room) {
+    LoggerProxy.logger.error(
+      `Meeting-info:util#getDestinationType --> Using the space ID as a destination is no longer supported. Please refer to the [migration guide](https://github.com/webex/webex-js-sdk/wiki/Migration-to-Unified-Space-Meetings) to migrate to use the meeting ID or SIP address.`
+    );
+    // Error code 30105 added as Space ID deprecated as of beta, Please refer migration guide.
+    throw new SpaceIDDeprecatedError();
   } else {
     LoggerProxy.logger.warn(`Meeting-info:util#getDestinationType --> ${meetingInfoError}`);
     throw new ParameterError(`${meetingInfoError}`);

package/src/meetings/collection.ts

@@ -60,4 +60,17 @@ export default class MeetingCollection extends Collection {
 
     return null;
   }
+
+  /**
+   * Gets the meeting that has a webrtc media connection
+   * NOTE: this function assumes there is no more than 1 such meeting
+   *
+   * @returns {Meeting} first meeting found, else undefined
+   * @public
+   * @memberof MeetingCollection
+   */
+  public getActiveWebrtcMeeting() {
+    // @ts-ignore
+    return find(this.meetings, (meeting) => meeting.mediaProperties.webrtcMediaConnection);
+  }
 }

package/src/meetings/index.ts

@@ -49,7 +49,7 @@ import {
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import MeetingInfo from '../meeting-info';
 import MeetingInfoV2 from '../meeting-info/meeting-info-v2';
-import Meeting from '../meeting';
+import Meeting, {CallStateForMetrics} from '../meeting';
 import PersonalMeetingRoom from '../personal-meeting-room';
 import Reachability from '../reachability';
 import Request from './request';
@@ -1025,13 +1025,14 @@ export default class Meetings extends WebexPlugin {
   }
 
   /**
-   * Create a meeting.
+   * Create a meeting or return an existing meeting.
    * @param {string} destination - sipURL, phonenumber, or locus object}
    * @param {string} [type] - the optional specified type, such as locusId
    * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
-   * @param {string} correlationId - the optional specified correlationId
+   * @param {string} correlationId - the optional specified correlationId (callStateForMetrics.correlationId can be provided instead)
    * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
+   * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1042,7 +1043,8 @@ export default class Meetings extends WebexPlugin {
     useRandomDelayForInfo = false,
     infoExtraParams = {},
     correlationId: string = undefined,
-    failOnMissingMeetingInfo = false
+    failOnMissingMeetingInfo = false,
+    callStateForMetrics: CallStateForMetrics = undefined
   ) {
     // TODO: type should be from a dictionary
 
@@ -1050,6 +1052,10 @@ export default class Meetings extends WebexPlugin {
     // type. This must be performed prior to determining if the meeting is
     // found in the collection, as we mutate the destination for hydra person
     // id values.
+    if (correlationId) {
+      callStateForMetrics = {...(callStateForMetrics || {}), correlationId};
+    }
+
     return (
       this.meetingInfo
         .fetchInfoOptions(destination, type)
@@ -1096,7 +1102,7 @@ export default class Meetings extends WebexPlugin {
               type,
               useRandomDelayForInfo,
               infoExtraParams,
-              correlationId,
+              callStateForMetrics,
               failOnMissingMeetingInfo
             ).then((createdMeeting: any) => {
               // If the meeting was successfully created.
@@ -1143,6 +1149,7 @@ export default class Meetings extends WebexPlugin {
               return Promise.resolve(createdMeeting);
             });
           }
+          meeting.setCallStateForMetrics(callStateForMetrics);
 
           // Return the existing meeting.
           return Promise.resolve(meeting);
@@ -1155,7 +1162,7 @@ export default class Meetings extends WebexPlugin {
    * @param {String} type see create()
    * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
-   * @param {String} correlationId the optional specified correlationId
+   * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
    * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
    * @returns {Promise} a new meeting instance complete with meeting info and destination
    * @private
@@ -1166,7 +1173,7 @@ export default class Meetings extends WebexPlugin {
     type: string = null,
     useRandomDelayForInfo = false,
     infoExtraParams = {},
-    correlationId: string = undefined,
+    callStateForMetrics: CallStateForMetrics = undefined,
     failOnMissingMeetingInfo = false
   ) {
     const meeting = new Meeting(
@@ -1181,7 +1188,7 @@ export default class Meetings extends WebexPlugin {
         meetingInfoProvider: this.meetingInfo,
         destination,
         destinationType: type,
-        correlationId,
+        callStateForMetrics,
       },
       {
         // @ts-ignore
@@ -1219,7 +1226,7 @@ export default class Meetings extends WebexPlugin {
           () =>
             meeting.fetchMeetingInfo({
               extraParams: infoExtraParams,
-              sendCAevents: !!correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+              sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
             }),
           waitingTime
         );
@@ -1227,7 +1234,7 @@ export default class Meetings extends WebexPlugin {
       } else {
         await meeting.fetchMeetingInfo({
           extraParams: infoExtraParams,
-          sendCAevents: !!correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+          sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
         });
       }
     } catch (err) {
@@ -1467,4 +1474,15 @@ export default class Meetings extends WebexPlugin {
   getLogger() {
     return LoggerProxy.get();
   }
+
+  /**
+   * Returns the first meeting it finds that has the webrtc media connection created.
+   * Useful for debugging in the console.
+   *
+   * @private
+   * @returns {Meeting} Meeting object that has a webrtc media connection, else undefined
+   */
+  getActiveWebrtcMeeting() {
+    return this.meetingCollection.getActiveWebrtcMeeting();
+  }
 }

package/src/metrics/constants.ts

@@ -9,6 +9,7 @@ const BEHAVIORAL_METRICS = {
   JOIN_FAILURE: 'js_sdk_join_failures',
   ADD_MEDIA_SUCCESS: 'js_sdk_add_media_success',
   ADD_MEDIA_FAILURE: 'js_sdk_add_media_failures',
+  ADD_MEDIA_RETRY: 'js_sdk_add_media_retry',
   ROAP_MERCURY_EVENT_RECEIVED: 'js_sdk_roap_mercury_received',
   CONNECTION_SUCCESS: 'js_sdk_connection_success',
   CONNECTION_FAILURE: 'js_sdk_connection_failures',
@@ -25,9 +26,11 @@ const BEHAVIORAL_METRICS = {
   MEETING_MEDIA_INACTIVE: 'js_sdk_meeting_media_inactive',
   MEETING_RECONNECT_FAILURE: 'js_sdk_meeting_reconnect_failures',
   MEETING_MAX_REJOIN_FAILURE: 'js_sdk_meeting_max_rejoin_failure',
+  MEETING_SHARE_SUCCESS: 'js_sdk_meeting_share_success',
   MEETING_SHARE_FAILURE: 'js_sdk_meeting_share_failures',
   MEETING_START_WHITEBOARD_SHARE_FAILURE: 'js_sdk_meeting_start_whiteboard_share_failures',
   MEETING_STOP_WHITEBOARD_SHARE_FAILURE: 'js_sdk_meeting_stop_whiteboard_share_failures',
+  MEETING_SHARE_VIDEO_MUTE_STATE_CHANGE: 'js_sdk_meeting_share_video_mute_state_change',
   MUTE_AUDIO_FAILURE: 'js_sdk_mute_audio_failures',
   MUTE_VIDEO_FAILURE: 'js_sdk_mute_video_failures',
   SET_MEETING_QUALITY_FAILURE: 'js_sdk_set_meeting_quality_failures',

package/src/reconnection-manager/index.ts

@@ -14,13 +14,14 @@ import {
   _CALL_,
   _LEFT_,
   _ID_,
+  RECONNECTION_STATE,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
-import ReconnectionError from '../common/errors/reconnection';
 import ReconnectInProgress from '../common/errors/reconnection-in-progress';
 import Metrics from '../metrics';
 import Meeting from '../meeting';
 import {MediaRequestManager} from '../multistream/mediaRequestManager';
+import ReconnectionError from '../common/errors/reconnection';
 
 /**
  * Used to indicate that the reconnect logic needs to be retried.
@@ -96,7 +97,7 @@ export default class ReconnectionManager {
 
     /**
      * @instance
-     * @type {String}
+     * @type {RECONNECTION_STATE}
      * @private
      * @memberof ReconnectionManager
      */
@@ -227,7 +228,6 @@ export default class ReconnectionManager {
    */
   public cleanUp() {
     this.reset();
-    this.meeting = null;
   }
 
   /**
@@ -265,6 +265,18 @@ export default class ReconnectionManager {
     return this.status === RECONNECTION.STATE.IN_PROGRESS;
   }
 
+  /**
+   * Sets the reconnection status
+   *
+   * @public
+   * @param {RECONNECTION_STATE} status
+   * @memberof ReconnectionManager
+   * @returns {undefined}
+   */
+  public setStatus(status: RECONNECTION_STATE) {
+    this.status = status;
+  }
+
   /**
    * @returns {Boolean}
    * @throws {ReconnectionError}
@@ -337,73 +349,55 @@ export default class ReconnectionManager {
       });
     }
 
-    return this.executeReconnection({networkDisconnect})
-      .then(() => {
-        LoggerProxy.logger.info('ReconnectionManager:index#reconnect --> Reconnection successful.');
+    return this.executeReconnection({networkDisconnect}).catch((reconnectError) => {
+      if (reconnectError instanceof NeedsRetryError) {
         LoggerProxy.logger.info(
-          'ReconnectionManager:index#reconnect --> Sending reconnect success metric.'
+          'ReconnectionManager:index#reconnect --> Reconnection not successful, retrying.'
         );
+        // Reset our reconnect status since we are looping back to the beginning
+        this.status = RECONNECTION.STATE.DEFAULT_STATUS;
 
-        // @ts-ignore
-        this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.media.recovered',
-          payload: {
-            recoveredBy: 'new',
-          },
-          options: {
-            meetingId: this.meeting.id,
-          },
-        });
-      })
-      .catch((reconnectError) => {
-        if (reconnectError instanceof NeedsRetryError) {
-          LoggerProxy.logger.info(
-            'ReconnectionManager:index#reconnect --> Reconnection not successful, retrying.'
-          );
-          // Reset our reconnect status since we are looping back to the beginning
-          this.status = RECONNECTION.STATE.DEFAULT_STATUS;
-
-          // This is a network retry, so we should not log START metrics again
-          return this.reconnect({networkDisconnect: true, networkRetry: true});
-        }
+        // This is a network retry, so we should not log START metrics again
+        return this.reconnect({networkDisconnect: true, networkRetry: true});
+      }
 
-        // Reconnect has failed
-        LoggerProxy.logger.error(
-          'ReconnectionManager:index#reconnect --> Reconnection failed.',
-          reconnectError.message
-        );
-        LoggerProxy.logger.info(
-          'ReconnectionManager:index#reconnect --> Sending reconnect abort metric.'
-        );
+      // Reconnect has failed
+      LoggerProxy.logger.error(
+        'ReconnectionManager:index#reconnect --> Reconnection failed.',
+        reconnectError.message
+      );
+      LoggerProxy.logger.info(
+        'ReconnectionManager:index#reconnect --> Sending reconnect abort metric.'
+      );
 
-        // @ts-ignore
-        this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.call.aborted',
-          payload: {
-            errors: [
-              {
-                category: 'expected',
-                errorCode: 2008,
-                fatal: true,
-                name: 'media-engine',
-                shownToUser: false,
-              },
-            ],
-          },
-          options: {
-            meetingId: this.meeting.id,
-          },
-        });
-        if (reconnectError instanceof NeedsRejoinError) {
-          // send call aborded event with catogery as expected as we are trying to rejoin
+      // @ts-ignore
+      this.webex.internal.newMetrics.submitClientEvent({
+        name: 'client.call.aborted',
+        payload: {
+          errors: [
+            {
+              category: 'expected',
+              errorCode: 2008,
+              fatal: true,
+              name: 'media-engine',
+              shownToUser: false,
+            },
+          ],
+        },
+        options: {
+          meetingId: this.meeting.id,
+        },
+      });
+      if (reconnectError instanceof NeedsRejoinError) {
+        // send call aborded event with catogery as expected as we are trying to rejoin
 
-          if (this.autoRejoinEnabled) {
-            return this.rejoinMeeting(reconnectError.wasSharing);
-          }
+        if (this.autoRejoinEnabled) {
+          return this.rejoinMeeting(reconnectError.wasSharing);
         }
+      }
 
-        throw reconnectError;
-      });
+      throw reconnectError;
+    });
   }
 
   /**
@@ -485,14 +479,13 @@ export default class ReconnectionManager {
       const media = await this.reconnectMedia();
 
       LoggerProxy.logger.log(
-        'ReconnectionManager:index#executeReconnection --> Media reestablished'
+        'ReconnectionManager:index#executeReconnection --> webRTC media connection renewed and local sdp offer sent'
       );
-      this.status = RECONNECTION.STATE.COMPLETE;
 
       return media;
     } catch (error) {
       LoggerProxy.logger.error(
-        'ReconnectionManager:index#executeReconnection --> Media reestablishment failed'
+        'ReconnectionManager:index#executeReconnection --> failed to renew webRTC media connection or initiate offer'
       );
       this.status = RECONNECTION.STATE.FAILURE;
 
@@ -559,9 +552,7 @@ export default class ReconnectionManager {
    * @memberof ReconnectionManager
    */
   async reconnectMedia() {
-    LoggerProxy.logger.log(
-      'ReconnectionManager:index#reconnectMedia --> Begin reestablishment of media'
-    );
+    LoggerProxy.logger.log('ReconnectionManager:index#reconnectMedia --> do turn discovery');
 
     // do the TURN server discovery again and ignore reachability results since the TURN server might change
     const turnServerResult = await this.meeting.roap.doTurnDiscovery(this.meeting, true, true);
@@ -576,6 +567,10 @@ export default class ReconnectionManager {
       });
     }
 
+    LoggerProxy.logger.log(
+      'ReconnectionManager:index#reconnectMedia --> renew webRTC media connection and send local sdp offer'
+    );
+
     await this.meeting.mediaProperties.webrtcMediaConnection.reconnect(iceServers);
 
     // resend media requests

package/src/rtcMetrics/index.ts

@@ -1,3 +1,5 @@
+/* eslint-disable class-methods-use-this */
+import {CallDiagnosticUtils} from '@webex/internal-plugin-metrics';
 import RTC_METRICS from './constants';
 
 /**
@@ -55,6 +57,9 @@ export default class RtcMetrics {
    */
   addMetrics(data) {
     if (data.payload.length) {
+      if (data.name === 'stats-report') {
+        data.payload = data.payload.map(this.anonymizeIp);
+      }
       this.metricsQueue.push(data);
     }
   }
@@ -69,6 +74,25 @@ export default class RtcMetrics {
     clearInterval(this.intervalId);
   }
 
+  /**
+   * Anonymize IP addresses.
+   *
+   * @param {array} stats - An RTCStatsReport organized into an array of strings.
+   * @returns {string}
+   */
+  anonymizeIp(stats: string): string {
+    const data = JSON.parse(stats);
+    // on local and remote candidates, anonymize the last 4 bits.
+    if (data.type === 'local-candidate' || data.type === 'remote-candidate') {
+      data.ip = CallDiagnosticUtils.anonymizeIPAddress(data.ip) || undefined;
+      data.address = CallDiagnosticUtils.anonymizeIPAddress(data.address) || undefined;
+      data.relatedAddress =
+        CallDiagnosticUtils.anonymizeIPAddress(data.relatedAddress) || undefined;
+    }
+
+    return JSON.stringify(data);
+  }
+
   /**
    * Send metrics to the metrics service.
    *