@webex/plugin-meetings 2.60.1-next.7 → 2.60.1-next.9

package/src/meeting/index.ts

@@ -233,6 +233,13 @@ export enum ScreenShareFloorStatus {
   RELEASED = 'floor_released',
 }
 
+type FetchMeetingInfoParams = {
+  password?: string;
+  captchaCode?: string;
+  extraParams?: Record<string, any>;
+  sendCAevents?: boolean;
+};
+
 /**
  * MediaDirection
  * @typedef {Object} MediaDirection
@@ -615,6 +622,8 @@ export default class Meeting extends StatelessWebexPlugin {
   environment: string;
   namespace = MEETINGS;
   allowMediaInLobby: boolean;
+  localShareInstanceId: string;
+  remoteShareInstanceId: string;
   turnDiscoverySkippedReason: string;
   turnServerUsed: boolean;
   areVoiceaEventsSetup = false;
@@ -1323,6 +1332,24 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.keepAliveTimerId = null;
 
+    /**
+     * id for tracking Local Share instances in Call Analyzer
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Meeting
+     */
+    this.localShareInstanceId = null;
+
+    /**
+     * id for tracking Remote Share instances in Call Analyzer
+     * @instance
+     * @type {String}
+     * @private
+     * @memberof Meeting
+     */
+    this.remoteShareInstanceId = null;
+
     /**
      * The class that helps to control recording functions: start, stop, pause, resume, etc
      * @instance
@@ -1477,6 +1504,97 @@ export default class Meeting extends StatelessWebexPlugin {
     this.callStateForMetrics.correlationId = correlationId;
   }
 
+  /**
+   * Set meeting info and trigger `MEETING_INFO_AVAILABLE` event
+   * @param {any} info
+   * @param {string} [meetingLookupUrl] Lookup url, defined when the meeting info fetched
+   * @returns {void}
+   */
+  private setMeetingInfo(info, meetingLookupUrl) {
+    this.meetingInfo = info ? {...info, meetingLookupUrl} : null;
+    this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.NONE;
+
+    this.requiredCaptcha = null;
+    if (
+      this.passwordStatus === PASSWORD_STATUS.REQUIRED ||
+      this.passwordStatus === PASSWORD_STATUS.VERIFIED
+    ) {
+      this.passwordStatus = PASSWORD_STATUS.VERIFIED;
+    } else {
+      this.passwordStatus = PASSWORD_STATUS.NOT_REQUIRED;
+    }
+
+    Trigger.trigger(
+      this,
+      {
+        file: 'meetings',
+        function: 'fetchMeetingInfo',
+      },
+      EVENT_TRIGGERS.MEETING_INFO_AVAILABLE
+    );
+
+    this.updateMeetingActions();
+  }
+
+  /**
+   * Add pre-fetched meeting info
+   *
+   * The passed meeting info should be be complete, e.g.: fetched after password or captcha provided
+   *
+   * @param {Object} meetingInfo - Complete meeting info
+   * @param {FetchMeetingInfoParams} fetchParams - Fetch parameters for validation
+   * @param {String|undefined} meetingLookupUrl - Lookup url, defined when the meeting info fetched
+   * @returns {Promise<void>}
+   */
+  public async injectMeetingInfo(
+    meetingInfo: any,
+    fetchParams: FetchMeetingInfoParams,
+    meetingLookupUrl: string | undefined
+  ): Promise<void> {
+    await this.prepForFetchMeetingInfo(fetchParams, 'injectMeetingInfo');
+
+    this.parseMeetingInfo(meetingInfo, this.destination);
+    this.setMeetingInfo(meetingInfo, meetingLookupUrl);
+  }
+
+  /**
+   * Validate fetch parameters and clear the fetchMeetingInfoTimeout timeout
+   *
+   * @param {FetchMeetingInfoParams} fetchParams - fetch parameters for validation
+   * @param {String} caller - Name of the caller for logging
+   *
+   * @returns {Promise<void>}
+   * @private
+   */
+  private prepForFetchMeetingInfo(
+    {password = null, captchaCode = null, extraParams = {}}: FetchMeetingInfoParams,
+    caller: string
+  ): Promise<void> {
+    // when fetch meeting info is called directly by the client, we want to clear out the random timer for sdk to do it
+    if (this.fetchMeetingInfoTimeoutId) {
+      clearTimeout(this.fetchMeetingInfoTimeoutId);
+      this.fetchMeetingInfoTimeoutId = undefined;
+    }
+    if (captchaCode && !this.requiredCaptcha) {
+      return Promise.reject(
+        new Error(`${caller}() called with captchaCode when captcha was not required`)
+      );
+    }
+    if (
+      password &&
+      this.passwordStatus !== PASSWORD_STATUS.REQUIRED &&
+      this.passwordStatus !== PASSWORD_STATUS.UNKNOWN
+    ) {
+      return Promise.reject(
+        new Error(`${caller}() called with password when password was not required`)
+      );
+    }
+
+    this.meetingInfoExtraParams = cloneDeep(extraParams);
+
+    return Promise.resolve();
+  }
+
   /**
    * Internal method for fetching meeting info
    *
@@ -1507,29 +1625,8 @@ export default class Meeting extends StatelessWebexPlugin {
         {meetingId: this.id, sendCAevents}
       );
 
-      this.parseMeetingInfo(info, this.destination);
-      this.meetingInfo = info ? {...info.body, meetingLookupUrl: info?.url} : null;
-      this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.NONE;
-      this.requiredCaptcha = null;
-      if (
-        this.passwordStatus === PASSWORD_STATUS.REQUIRED ||
-        this.passwordStatus === PASSWORD_STATUS.VERIFIED
-      ) {
-        this.passwordStatus = PASSWORD_STATUS.VERIFIED;
-      } else {
-        this.passwordStatus = PASSWORD_STATUS.NOT_REQUIRED;
-      }
-
-      Trigger.trigger(
-        this,
-        {
-          file: 'meetings',
-          function: 'fetchMeetingInfo',
-        },
-        EVENT_TRIGGERS.MEETING_INFO_AVAILABLE
-      );
-
-      this.updateMeetingActions();
+      this.parseMeetingInfo(info?.body, this.destination, info?.errors);
+      this.setMeetingInfo(info?.body, info?.url);
 
       return Promise.resolve();
     } catch (err) {
@@ -1673,46 +1770,13 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    * @returns {Promise}
    */
-  public async fetchMeetingInfo({
-    password = null,
-    captchaCode = null,
-    extraParams = {},
-    sendCAevents = false,
-  }: {
-    password?: string;
-    captchaCode?: string;
-    extraParams?: Record<string, any>;
-    sendCAevents?: boolean;
-  }) {
-    // when fetch meeting info is called directly by the client, we want to clear out the random timer for sdk to do it
-    if (this.fetchMeetingInfoTimeoutId) {
-      clearTimeout(this.fetchMeetingInfoTimeoutId);
-      this.fetchMeetingInfoTimeoutId = undefined;
-    }
-    if (captchaCode && !this.requiredCaptcha) {
-      return Promise.reject(
-        new Error('fetchMeetingInfo() called with captchaCode when captcha was not required')
-      );
-    }
-    if (
-      password &&
-      this.passwordStatus !== PASSWORD_STATUS.REQUIRED &&
-      this.passwordStatus !== PASSWORD_STATUS.UNKNOWN
-    ) {
-      return Promise.reject(
-        new Error('fetchMeetingInfo() called with password when password was not required')
-      );
-    }
-
-    this.meetingInfoExtraParams = cloneDeep(extraParams);
+  public async fetchMeetingInfo(options: FetchMeetingInfoParams) {
+    await this.prepForFetchMeetingInfo(options, 'fetchMeetingInfo');
 
     return this.fetchMeetingInfoInternal({
       destination: this.destination,
       destinationType: this.destinationType,
-      password,
-      captchaCode,
-      extraParams,
-      sendCAevents,
+      ...options,
     });
   }
 
@@ -2367,16 +2431,6 @@ export default class Meeting extends StatelessWebexPlugin {
       }
     );
 
-    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_JOIN_BREAKOUT_FROM_MAIN, ({mainLocusUrl}) => {
-      this.meetingRequest.getLocusStatusByUrl(mainLocusUrl).catch((error) => {
-        // clear main session cache when attendee join into breakout and forbidden to get locus from main locus url,
-        // which means main session is not active for the attendee
-        if (error?.statusCode === 403) {
-          this.locusInfo.clearMainSessionLocusCache();
-        }
-      });
-    });
-
     this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED, ({entryExitTone}) => {
       Trigger.trigger(
         this,
@@ -2611,6 +2665,8 @@ export default class Meeting extends StatelessWebexPlugin {
         switch (newShareStatus) {
           case SHARE_STATUS.REMOTE_SHARE_ACTIVE: {
             const sendStartedSharingRemote = () => {
+              this.remoteShareInstanceId = contentShare.shareInstanceId;
+
               Trigger.trigger(
                 this,
                 {
@@ -2621,7 +2677,7 @@ export default class Meeting extends StatelessWebexPlugin {
                 {
                   memberId: contentShare.beneficiaryId,
                   url: contentShare.url,
-                  shareInstanceId: contentShare.shareInstanceId,
+                  shareInstanceId: this.remoteShareInstanceId,
                   annotationInfo: contentShare.annotation,
                 }
               );
@@ -2658,6 +2714,7 @@ export default class Meeting extends StatelessWebexPlugin {
               name: 'client.share.floor-granted.local',
               payload: {
                 mediaType: 'share',
+                shareInstanceId: this.localShareInstanceId,
               },
               options: {meetingId: this.id},
             });
@@ -2700,6 +2757,8 @@ export default class Meeting extends StatelessWebexPlugin {
       } else if (newShareStatus === SHARE_STATUS.REMOTE_SHARE_ACTIVE) {
         // if we got here, then some remote participant has stolen
         // the presentation from another remote participant
+        this.remoteShareInstanceId = contentShare.shareInstanceId;
+
         Trigger.trigger(
           this,
           {
@@ -2710,7 +2769,7 @@ export default class Meeting extends StatelessWebexPlugin {
           {
             memberId: contentShare.beneficiaryId,
             url: contentShare.url,
-            shareInstanceId: contentShare.shareInstanceId,
+            shareInstanceId: this.remoteShareInstanceId,
             annotationInfo: contentShare.annotation,
           }
         );
@@ -3328,30 +3387,40 @@ export default class Meeting extends StatelessWebexPlugin {
   /**
    * Sets the meeting info on the class instance
    * @param {Object} meetingInfo
-   * @param {Object} meetingInfo.body
-   * @param {String} meetingInfo.body.conversationUrl
-   * @param {String} meetingInfo.body.locusUrl
-   * @param {String} meetingInfo.body.sipUri
-   * @param {Object} meetingInfo.body.owner
+   * @param {String} meetingInfo.conversationUrl
+   * @param {String} meetingInfo.locusUrl
+   * @param {String} meetingInfo.sipUri
+   * @param {String} [meetingInfo.sipUrl]
+   * @param {String} [meetingInfo.sipMeetingUri]
+   * @param {String} [meetingInfo.meetingNumber]
+   * @param {String} [meetingInfo.meetingJoinUrl]
+   * @param {String} [meetingInfo.hostId]
+   * @param {String} [meetingInfo.permissionToken]
+   * @param {String} [meetingInfo.channel]
+   * @param {Object} meetingInfo.owner
    * @param {Object | String} destination locus object with meeting data or destination string (sip url, meeting link, etc)
+   * @param {Object | String} errors Meeting info request error
    * @returns {undefined}
    * @private
    * @memberof Meeting
    */
   parseMeetingInfo(
-    meetingInfo:
-      | {
-          body: {
-            conversationUrl: string;
-            locusUrl: string;
-            sipUri: string;
-            owner: object;
-          };
-        }
-      | any,
-    destination: object | string | null = null
+    meetingInfo: {
+      conversationUrl: string;
+      locusUrl: string;
+      sipUri: string;
+      owner: object;
+      sipUrl?: string;
+      sipMeetingUri?: string;
+      meetingNumber?: string;
+      meetingJoinUrl?: string;
+      hostId?: string;
+      permissionToken?: string;
+      channel?: string;
+    },
+    destination: object | string | null = null,
+    errors: any = undefined
   ) {
-    const webexMeetingInfo = meetingInfo?.body;
     // We try to use as much info from Locus meeting object, stored in destination
 
     let locusMeetingObject;
@@ -3361,40 +3430,31 @@ export default class Meeting extends StatelessWebexPlugin {
     }
 
     // MeetingInfo will be undefined for 1:1 calls
-    if (
-      locusMeetingObject ||
-      (webexMeetingInfo && !(meetingInfo?.errors && meetingInfo?.errors.length > 0))
-    ) {
+    if (locusMeetingObject || (meetingInfo && !(errors?.length > 0))) {
       this.conversationUrl =
-        locusMeetingObject?.conversationUrl ||
-        webexMeetingInfo?.conversationUrl ||
-        this.conversationUrl;
-      this.locusUrl = locusMeetingObject?.url || webexMeetingInfo?.locusUrl || this.locusUrl;
+        locusMeetingObject?.conversationUrl || meetingInfo?.conversationUrl || this.conversationUrl;
+      this.locusUrl = locusMeetingObject?.url || meetingInfo?.locusUrl || this.locusUrl;
       // @ts-ignore - config coming from registerPlugin
       this.setSipUri(
         // @ts-ignore
         this.config.experimental.enableUnifiedMeetings
-          ? locusMeetingObject?.info.sipUri || webexMeetingInfo?.sipUrl
-          : locusMeetingObject?.info.sipUri || webexMeetingInfo?.sipMeetingUri || this.sipUri
+          ? locusMeetingObject?.info.sipUri || meetingInfo?.sipUrl
+          : locusMeetingObject?.info.sipUri || meetingInfo?.sipMeetingUri || this.sipUri
       );
       // @ts-ignore - config coming from registerPlugin
       if (this.config.experimental.enableUnifiedMeetings) {
-        this.meetingNumber =
-          locusMeetingObject?.info.webExMeetingId || webexMeetingInfo?.meetingNumber;
-        this.meetingJoinUrl = webexMeetingInfo?.meetingJoinUrl;
+        this.meetingNumber = locusMeetingObject?.info.webExMeetingId || meetingInfo?.meetingNumber;
+        this.meetingJoinUrl = meetingInfo?.meetingJoinUrl;
       }
       this.owner =
-        locusMeetingObject?.info.owner ||
-        webexMeetingInfo?.owner ||
-        webexMeetingInfo?.hostId ||
-        this.owner;
-      this.permissionToken = webexMeetingInfo?.permissionToken;
-      this.setPermissionTokenPayload(webexMeetingInfo?.permissionToken);
+        locusMeetingObject?.info.owner || meetingInfo?.owner || meetingInfo?.hostId || this.owner;
+      this.permissionToken = meetingInfo?.permissionToken;
+      this.setPermissionTokenPayload(meetingInfo?.permissionToken);
       this.setSelfUserPolicies();
       // Need to populate environment when sending CA event
-      this.environment = locusMeetingObject?.info.channel || webexMeetingInfo?.channel;
+      this.environment = locusMeetingObject?.info.channel || meetingInfo?.channel;
     }
-    MeetingUtil.parseInterpretationInfo(this, webexMeetingInfo);
+    MeetingUtil.parseInterpretationInfo(this, meetingInfo);
   }
 
   /**
@@ -5534,7 +5594,6 @@ export default class Meeting extends StatelessWebexPlugin {
                 seq: event.roapMessage.seq,
                 tieBreaker: event.roapMessage.tieBreaker,
                 meeting: this, // or can pass meeting ID
-                reconnect: this.reconnectionManager.isReconnectInProgress(),
               })
               .then(({roapAnswer}) => {
                 if (roapAnswer) {
@@ -5851,7 +5910,10 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media.tx.start',
-        payload: {mediaType: data.type},
+        payload: {
+          mediaType: data.type,
+          shareInstanceId: data.type === 'share' ? this.localShareInstanceId : undefined,
+        },
         options: {
           meetingId: this.id,
         },
@@ -5861,7 +5923,10 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media.tx.stop',
-        payload: {mediaType: data.type},
+        payload: {
+          mediaType: data.type,
+          shareInstanceId: data.type === 'share' ? this.localShareInstanceId : undefined,
+        },
         options: {
           meetingId: this.id,
         },
@@ -5880,7 +5945,10 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media.rx.start',
-        payload: {mediaType: data.type},
+        payload: {
+          mediaType: data.type,
+          shareInstanceId: data.type === 'share' ? this.remoteShareInstanceId : undefined,
+        },
         options: {
           meetingId: this.id,
         },
@@ -5890,7 +5958,10 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media.rx.stop',
-        payload: {mediaType: data.type},
+        payload: {
+          mediaType: data.type,
+          shareInstanceId: data.type === 'share' ? this.remoteShareInstanceId : undefined,
+        },
         options: {
           meetingId: this.id,
         },
@@ -7136,11 +7207,14 @@ export default class Meeting extends StatelessWebexPlugin {
       if (content && this.shareStatus !== SHARE_STATUS.LOCAL_SHARE_ACTIVE) {
         // @ts-ignore
         this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.share.initiated',
+          name: 'client.share.floor-grant.request',
           payload: {
             mediaType: 'share',
+            shareInstanceId: this.localShareInstanceId,
+          },
+          options: {
+            meetingId: this.id,
           },
-          options: {meetingId: this.id},
         });
 
         return this.meetingRequest
@@ -7171,6 +7245,19 @@ export default class Meeting extends StatelessWebexPlugin {
               stack: error.stack,
             });
 
+            // @ts-ignore
+            this.webex.internal.newMetrics.submitClientEvent({
+              name: 'client.share.floor-granted.local',
+              payload: {
+                mediaType: 'share',
+                errors: MeetingUtil.getChangeMeetingFloorErrorPayload(error.message),
+                shareInstanceId: this.localShareInstanceId,
+              },
+              options: {
+                meetingId: this.id,
+              },
+            });
+
             this.screenShareFloorState = ScreenShareFloorStatus.RELEASED;
 
             return Promise.reject(error);
@@ -7222,6 +7309,7 @@ export default class Meeting extends StatelessWebexPlugin {
         name: 'client.share.stopped',
         payload: {
           mediaType: 'share',
+          shareInstanceId: this.localShareInstanceId,
         },
         options: {meetingId: this.id},
       });
@@ -8104,6 +8192,17 @@ export default class Meeting extends StatelessWebexPlugin {
     }
 
     if (floorRequestNeeded) {
+      this.localShareInstanceId = uuid.v4();
+
+      // @ts-ignore
+      this.webex.internal.newMetrics.submitClientEvent({
+        name: 'client.share.initiated',
+        payload: {
+          mediaType: 'share',
+          shareInstanceId: this.localShareInstanceId,
+        },
+        options: {meetingId: this.id},
+      });
       // we're sending the http request to Locus to request the screen share floor
       // only after the SDP update, because that's how it's always been done for transcoded meetings
       // and also if sharing from the start, we need confluence to have been created

package/src/meeting/request.ts

@@ -185,6 +185,13 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       deviceCapabilities.push(ANNOTATION.ANNOTATION_ON_SHARE_SUPPORTED);
     }
 
+    // append installationId to device config if it exists
+    // @ts-ignore
+    if (this.webex.internal.device.config.installationId) {
+      // @ts-ignore
+      body.device.installationId = this.webex.internal.device.config.installationId;
+    }
+
     if (locale) {
       body.locale = locale;
     }

package/src/meeting/util.ts

@@ -13,6 +13,7 @@ import {
   FULL_STATE,
   SELF_POLICY,
   EVENT_TRIGGERS,
+  LOCAL_SHARE_ERRORS,
   IP_VERSION,
 } from '../constants';
 import BrowserDetection from '../common/browser-detection';
@@ -692,6 +693,102 @@ const MeetingUtil = {
       EVENT_TRIGGERS.MEETING_INTERPRETATION_UPDATE
     );
   },
+
+  /**
+   * Returns a CA-recognized error payload for the specified raw error message/reason.
+   *
+   * New errors can be added to this function for handling in the future
+   *
+   * @param {String} reason the raw error message
+   * @returns {Array<object>} an array of payload objects
+   */
+  getChangeMeetingFloorErrorPayload: (reason: string) => {
+    const errorPayload = {
+      errorDescription: reason,
+      name: 'locus.response',
+      shownToUser: false,
+    };
+    if (reason.includes(LOCAL_SHARE_ERRORS.UNDEFINED)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'signaling',
+          errorCode: 1100,
+        },
+      ];
+    }
+    if (reason.includes(LOCAL_SHARE_ERRORS.DEVICE_NOT_JOINED)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'signaling',
+          errorCode: 4050,
+        },
+      ];
+    }
+    if (reason.includes(LOCAL_SHARE_ERRORS.NO_MEDIA_FOR_DEVICE)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'media',
+          errorCode: 2048,
+        },
+      ];
+    }
+    if (reason.includes(LOCAL_SHARE_ERRORS.NO_CONFLUENCE_ID)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'signaling',
+          errorCode: 4064,
+        },
+      ];
+    }
+    if (reason.includes(LOCAL_SHARE_ERRORS.CONTENT_SHARING_DISABLED)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'expected',
+          errorCode: 4065,
+        },
+      ];
+    }
+    if (reason.includes(LOCAL_SHARE_ERRORS.LOCUS_PARTICIPANT_DNE)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'signaling',
+          errorCode: 4066,
+        },
+      ];
+    }
+    if (reason.includes(LOCAL_SHARE_ERRORS.CONTENT_REQUEST_WHILE_PENDING_WHITEBOARD)) {
+      return [
+        {
+          ...errorPayload,
+          fatal: true,
+          category: 'expected',
+          errorCode: 4067,
+        },
+      ];
+    }
+
+    // return unknown error
+    return [
+      {
+        ...errorPayload,
+        fatal: true,
+        category: 'signaling',
+        errorCode: 1100,
+      },
+    ];
+  },
 };
 
 export default MeetingUtil;