@webex/plugin-meetings 3.11.0-next.2 → 3.11.0-next.21

package/src/meeting/util.ts

@@ -1,4 +1,5 @@
 import {LocalCameraStream, LocalMicrophoneStream} from '@webex/media-helpers';
+import url from 'url';
 
 import {cloneDeep} from 'lodash';
 import {MeetingNotActiveError, UserNotJoinedError} from '../common/errors/webex-errors';
@@ -32,6 +33,7 @@ const MeetingUtil = {
     // First todo: add check for existance
     parsed.locus = response.body.locus;
     parsed.dataSets = response.body.dataSets;
+    parsed.metadata = response.body.metaData;
     parsed.mediaConnections = response.body.mediaConnections;
     parsed.locusUrl = parsed.locus.url;
     parsed.locusId = parsed.locus.url.split('/').pop();
@@ -47,6 +49,124 @@ const MeetingUtil = {
     return parsed;
   },
 
+  /**
+   * Sanitizes a WebSocket URL by extracting only protocol, host, and pathname
+   * Returns concatenated protocol + host + pathname for safe logging
+   * Note: This is used for logging only; URL matching uses partial matching via _urlsPartiallyMatch
+   * @param {string} urlString - The URL to sanitize
+   * @returns {string} Sanitized URL or empty string if parsing fails
+   */
+  sanitizeWebSocketUrl: (urlString: string): string => {
+    if (!urlString || typeof urlString !== 'string') {
+      return '';
+    }
+
+    try {
+      const parsedUrl = url.parse(urlString);
+      const protocol = parsedUrl.protocol || '';
+      const host = parsedUrl.host || '';
+
+      // If we don't have at least protocol and host, it's not a valid URL
+      if (!protocol || !host) {
+        return '';
+      }
+
+      const pathname = parsedUrl.pathname || '';
+
+      // Strip trailing slash if pathname is just '/'
+      const normalizedPathname = pathname === '/' ? '' : pathname;
+
+      return `${protocol}//${host}${normalizedPathname}`;
+    } catch (error) {
+      LoggerProxy.logger.warn(
+        `Meeting:util#sanitizeWebSocketUrl --> unable to parse URL: ${error}`
+      );
+
+      return '';
+    }
+  },
+
+  /**
+   * Checks if two URLs partially match using an endsWith approach
+   * Combines host and pathname, then checks if one ends with the other
+   * This handles cases where one URL goes through a proxy (e.g., /webproxy/) while the other is direct
+   * @param {string} url1 - First URL to compare
+   * @param {string} url2 - Second URL to compare
+   * @returns {boolean} True if one URL path ends with the other (partial match), false otherwise
+   */
+  _urlsPartiallyMatch: (url1: string, url2: string): boolean => {
+    if (!url1 || !url2) {
+      return false;
+    }
+
+    try {
+      const parsedUrl1 = url.parse(url1);
+      const parsedUrl2 = url.parse(url2);
+
+      const host1 = parsedUrl1.host || '';
+      const host2 = parsedUrl2.host || '';
+      const pathname1 = parsedUrl1.pathname || '';
+      const pathname2 = parsedUrl2.pathname || '';
+
+      // If either failed to parse, they don't match
+      if (!host1 || !host2 || !pathname1 || !pathname2) {
+        return false;
+      }
+
+      // Combine host and pathname for comparison
+      const combined1 = host1 + pathname1;
+      const combined2 = host2 + pathname2;
+
+      // Check if one combined path ends with the other (handles proxy URLs)
+      return combined1.endsWith(combined2) || combined2.endsWith(combined1);
+    } catch (e) {
+      LoggerProxy.logger.warn('Meeting:util#_urlsPartiallyMatch --> error comparing URLs', e);
+
+      return false;
+    }
+  },
+
+  /**
+   * Gets socket URL information for metrics, including whether the socket URLs match
+   * Uses partial matching to handle proxy URLs (e.g., URLs with /webproxy/ prefix)
+   * @param {Object} webex - The webex instance
+   * @returns {Object} Object with hasMismatchedSocket, mercurySocketUrl, and deviceSocketUrl properties
+   */
+  getSocketUrlInfo: (
+    webex: any
+  ): {hasMismatchedSocket: boolean; mercurySocketUrl: string; deviceSocketUrl: string} => {
+    try {
+      const mercuryUrl = webex?.internal?.mercury?.socket?.url;
+      const deviceUrl = webex?.internal?.device?.webSocketUrl;
+
+      const sanitizedMercuryUrl = MeetingUtil.sanitizeWebSocketUrl(mercuryUrl);
+      const sanitizedDeviceUrl = MeetingUtil.sanitizeWebSocketUrl(deviceUrl);
+
+      // Only report a mismatch if both URLs are present and they don't match
+      // If either URL is missing, we can't determine if there's a mismatch, so return false
+      let hasMismatchedSocket = false;
+      if (sanitizedMercuryUrl && sanitizedDeviceUrl) {
+        hasMismatchedSocket = !MeetingUtil._urlsPartiallyMatch(mercuryUrl, deviceUrl);
+      }
+
+      return {
+        hasMismatchedSocket,
+        mercurySocketUrl: sanitizedMercuryUrl,
+        deviceSocketUrl: sanitizedDeviceUrl,
+      };
+    } catch (error) {
+      LoggerProxy.logger.warn(
+        `Meeting:util#getSocketUrlInfo --> error getting socket URL info: ${error}`
+      );
+
+      return {
+        hasMismatchedSocket: false,
+        mercurySocketUrl: '',
+        deviceSocketUrl: '',
+      };
+    }
+  },
+
   remoteUpdateAudioVideo: (meeting, audioMuted?: boolean, videoMuted?: boolean) => {
     if (!meeting) {
       return Promise.reject(new ParameterError('You need a meeting object.'));
@@ -203,6 +323,7 @@ const MeetingUtil = {
         const parsed = MeetingUtil.parseLocusJoin(res);
         meeting.setLocus(parsed);
         meeting.isoLocalClientMeetingJoinTime = res?.headers?.date; // read from header if exist, else fall back to system clock : https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-555657
+        const socketUrlInfo = MeetingUtil.getSocketUrlInfo(webex);
         webex.internal.newMetrics.submitClientEvent({
           name: 'client.locus.join.response',
           payload: {
@@ -210,6 +331,9 @@ const MeetingUtil = {
             identifiers: {
               trackingId: res.headers.trackingid,
             },
+            eventData: {
+              ...socketUrlInfo,
+            },
           },
           options: {
             meetingId: meeting.id,
@@ -220,12 +344,19 @@ const MeetingUtil = {
         return parsed;
       })
       .catch((err) => {
+        const socketUrlInfo = MeetingUtil.getSocketUrlInfo(webex);
         webex.internal.newMetrics.submitClientEvent({
           name: 'client.locus.join.response',
           payload: {
             identifiers: {meetingLookupUrl: meeting.meetingInfo?.meetingLookupUrl},
+            eventData: {
+              ...socketUrlInfo,
+            },
+          },
+          options: {
+            meetingId: meeting.id,
+            rawError: err,
           },
-          options: {meetingId: meeting.id, rawError: err},
         });
 
         throw err;

package/src/meetings/index.ts

@@ -195,6 +195,8 @@ export default class Meetings extends WebexPlugin {
   preferredWebexSite: any;
   reachability: Reachability;
   registered: any;
+  registrationPromise: Promise<void>;
+  unregistrationPromise: Promise<void>;
   request: any;
   geoHintInfo: any;
   meetingInfo: any;
@@ -929,9 +931,20 @@ export default class Meetings extends WebexPlugin {
    * @returns {Promise} A promise that resolves when the step is completed.
    */
   executeRegistrationStep(step: () => Promise<any>, stepName: string) {
-    return step().then(() => {
-      this.registrationStatus[stepName] = true;
-    });
+    return step()
+      .then(() => {
+        LoggerProxy.logger.info(
+          `Meetings:index#executeRegistrationStep --> INFO, ${stepName} completed`
+        );
+        this.registrationStatus[stepName] = true;
+      })
+      .catch((error) => {
+        LoggerProxy.logger.error(
+          `Meetings:index#executeRegistrationStep --> ERROR, ${stepName} failed: ${error.message}`
+        );
+
+        return Promise.reject(error);
+      });
   }
 
   /**
@@ -944,7 +957,33 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   public register(deviceRegistrationOptions?: DeviceRegistrationOptions): Promise<any> {
-    this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
+    if (this.unregistrationPromise) {
+      LoggerProxy.logger.info(
+        'Meetings:index#register --> INFO, Meetings plugin unregistration in progress, waiting to register'
+      );
+
+      this.registrationPromise = this.unregistrationPromise
+        .catch(() => {}) // It doesn't matter what happened during unregistration
+        .finally(() => {
+          LoggerProxy.logger.info(
+            'Meetings:index#register --> INFO, Meetings plugin unregistration completed, proceeding to register'
+          );
+
+          this.registrationPromise = null;
+
+          return this.register(deviceRegistrationOptions);
+        });
+
+      return this.registrationPromise;
+    }
+
+    if (this.registrationPromise) {
+      LoggerProxy.logger.info(
+        'Meetings:index#register --> INFO, Meetings plugin registration in progress, returning existing promise'
+      );
+
+      return this.registrationPromise;
+    }
 
     // @ts-ignore
     if (!this.webex.canAuthorize) {
@@ -963,7 +1002,11 @@ export default class Meetings extends WebexPlugin {
       return Promise.resolve();
     }
 
-    return Promise.all([
+    LoggerProxy.logger.info('Meetings:index#register --> INFO, Registering Meetings plugin');
+
+    this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
+
+    this.registrationPromise = Promise.all([
       this.executeRegistrationStep(() => this.fetchUserPreferredWebexSite(), 'fetchWebexSite'),
       this.executeRegistrationStep(() => this.getGeoHint(), 'getGeoHint'),
       this.executeRegistrationStep(
@@ -1022,7 +1065,12 @@ export default class Meetings extends WebexPlugin {
         });
 
         return Promise.reject(error);
+      })
+      .finally(() => {
+        this.registrationPromise = null;
       });
+
+    return this.registrationPromise;
   }
 
   /**
@@ -1034,6 +1082,35 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   unregister() {
+    if (this.unregistrationPromise) {
+      LoggerProxy.logger.info(
+        'Meetings:index#unregister --> INFO, Meetings plugin unregistration in progress, returning existing promise'
+      );
+
+      return this.unregistrationPromise;
+    }
+
+    if (this.registrationPromise) {
+      LoggerProxy.logger.info(
+        'Meetings:index#unregister --> INFO, Meetings plugin registration in progress, waiting to unregister'
+      );
+
+      // Wait for registration to complete (success or failure), then call unregister again
+      this.unregistrationPromise = this.registrationPromise
+        .catch(() => {}) // It doesn't matter what happened during registration
+        .finally(() => {
+          LoggerProxy.logger.info(
+            'Meetings:index#unregister --> INFO, Meetings plugin registration completed, proceeding to unregister'
+          );
+
+          this.unregistrationPromise = null;
+
+          return this.unregister();
+        });
+
+      return this.unregistrationPromise;
+    }
+
     if (!this.registered) {
       LoggerProxy.logger.info(
         'Meetings:index#unregister --> INFO, Meetings plugin already unregistered'
@@ -1044,10 +1121,14 @@ export default class Meetings extends WebexPlugin {
 
     this.stopListeningForEvents();
 
-    return (
+    this.unregistrationPromise =
       // @ts-ignore
       this.webex.internal.mercury
-        .disconnect()
+        // Use code 3050 with a non-reconnecting reason to prevent Mercury auto-reconnect
+        // during unregister. Without this, disconnect() defaults to code 1000/"Done" which
+        // force-closes as "Done (forced)" - a normalReconnectReason that triggers auto-reconnect,
+        // causing a race condition with device.unregister().
+        .disconnect({code: 3050, reason: 'meetings unregister'})
         // @ts-ignore
         .then(() => this.webex.internal.device.unregister())
         .catch((error) => {
@@ -1077,7 +1158,11 @@ export default class Meetings extends WebexPlugin {
           this.registered = false;
           this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
         })
-    );
+        .finally(() => {
+          this.unregistrationPromise = null;
+        });
+
+    return this.unregistrationPromise;
   }
 
   /**

package/src/metrics/constants.ts

@@ -90,6 +90,7 @@ const BEHAVIORAL_METRICS = {
   MEDIA_ISSUE_DETECTED: 'js_sdk_media_issue_detected',
   LOCUS_CLASSIC_VS_HASH_TREE_MISMATCH: 'js_sdk_locus_classic_vs_hash_tree_mismatch',
   LOCUS_HASH_TREE_UNSUPPORTED_OPERATION: 'js_sdk_locus_hash_tree_unsupported_operation',
+  MEDIA_STILL_NOT_CONNECTED: 'js_sdk_media_still_not_connected',
 };
 
 export {BEHAVIORAL_METRICS as default};

package/src/multistream/mediaRequestManager.ts

@@ -356,7 +356,7 @@ export class MediaRequestManager {
             mr.receiveSlots.map((receiveSlot) => receiveSlot.wcmeReceiveSlot),
             this.getMaxPayloadBitsPerSecond(mr),
             mr.codecInfo && [
-              new WcmeCodecInfo(
+              WcmeCodecInfo.fromH264(
                 0x80,
                 new H264Codec(
                   mr.codecInfo.maxFs,

package/src/reactions/reactions.type.ts

@@ -40,6 +40,7 @@ export enum SkinToneType {
 }
 
 export type Sender = {
+  displayName: string;
   participantId: string;
 };
 

package/test/unit/spec/hashTree/hashTree.ts

@@ -652,4 +652,70 @@ describe('HashTree', () => {
       expect(() => hashTree.computeLeafHash(2)).to.not.throw();
     });
   });
+
+  describe('getItemVersion', () => {
+    it('should return version when item exists', () => {
+      const items: LeafDataItem[] = [
+        {type: 'participant', id: 1, version: 5},
+        {type: 'self', id: 2, version: 10},
+      ];
+      const hashTree = new HashTree(items, 4);
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.equal(5);
+      expect(hashTree.getItemVersion(2, 'self')).to.equal(10);
+    });
+
+    it('should return undefined when item does not exist', () => {
+      const items: LeafDataItem[] = [{type: 'participant', id: 1, version: 5}];
+      const hashTree = new HashTree(items, 4);
+
+      expect(hashTree.getItemVersion(999, 'participant')).to.be.undefined;
+    });
+
+    it('should return undefined when type does not match', () => {
+      const items: LeafDataItem[] = [{type: 'participant', id: 1, version: 5}];
+      const hashTree = new HashTree(items, 4);
+
+      expect(hashTree.getItemVersion(1, 'self')).to.be.undefined;
+    });
+
+    it('should return undefined for tree with 0 leaves', () => {
+      const hashTree = new HashTree([], 0);
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.be.undefined;
+    });
+
+    it('should return correct version when multiple items exist in same leaf', () => {
+      const items: LeafDataItem[] = [
+        {type: 'participant', id: 1, version: 3}, // leaf 1 (1 % 2 = 1)
+        {type: 'self', id: 3, version: 7}, // leaf 1 (3 % 2 = 1)
+        {type: 'locus', id: 5, version: 12}, // leaf 1 (5 % 2 = 1)
+      ];
+      const hashTree = new HashTree(items, 2);
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.equal(3);
+      expect(hashTree.getItemVersion(3, 'self')).to.equal(7);
+      expect(hashTree.getItemVersion(5, 'locus')).to.equal(12);
+    });
+
+    it('should return updated version after item is updated', () => {
+      const hashTree = new HashTree([{type: 'participant', id: 1, version: 5}], 4);
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.equal(5);
+
+      hashTree.putItem({type: 'participant', id: 1, version: 10});
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.equal(10);
+    });
+
+    it('should return undefined after item is removed', () => {
+      const hashTree = new HashTree([{type: 'participant', id: 1, version: 5}], 4);
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.equal(5);
+
+      hashTree.removeItem({type: 'participant', id: 1, version: 5});
+
+      expect(hashTree.getItemVersion(1, 'participant')).to.be.undefined;
+    });
+  });
 });