@webex/plugin-meetings 3.9.0-next.2 → 3.9.0-next.20

package/src/members/index.ts

@@ -74,7 +74,11 @@ import {Invitee} from '../meeting/type';
  * @memberof Members
  */
 
-type UpdatedMembers = {added: Array<Member>; updated: Array<Member>};
+type UpdatedMembers = {
+  added: Array<Member>;
+  updated: Array<Member>;
+  removedIds?: Array<string>; // removed member ids
+};
 /**
  * @class Members
  */
@@ -384,12 +388,18 @@ export default class Members extends StatelessWebexPlugin {
    * when new participant updates come in, both delta and full participants, update them in members collection
    * delta object in the event will have {updated, added} and full will be the full membersCollection
    * @param {Object} payload
-   * @param {Object} payload.participants
+   * @param {Object} payload.participants new/updated participants
+   * @param {Boolean} payload.isReplace whether to replace the whole members collection
+   * @param {Object} payload.removedParticipantIds ids of the removed participants
    * @returns {undefined}
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload: {participants: object; isReplace?: boolean}) {
+  locusParticipantsUpdate(payload: {
+    participants: object;
+    isReplace?: boolean;
+    removedParticipantIds?: Array<string>;
+  }) {
     if (payload) {
       if (payload.isReplace) {
         this.clearMembers();
@@ -547,10 +557,22 @@ export default class Members extends StatelessWebexPlugin {
   private handleMembersUpdate(membersUpdate: UpdatedMembers) {
     this.constructMembers(membersUpdate.updated, true);
     this.constructMembers(membersUpdate.added, false);
+    this.removeMembers(membersUpdate.removedIds);
 
     return this.membersCollection.getAll();
   }
 
+  /**
+   * removes members from the collection
+   * @param {Array<string>} removedMembers removed members ids
+   * @returns {void}
+   */
+  private removeMembers(removedMembers: Array<string>) {
+    removedMembers.forEach((memberId) => {
+      this.membersCollection.remove(memberId);
+    });
+  }
+
   /**
    * set members to the member collection from each updated/added lists as passed in
    * @param {Array} list
@@ -600,6 +622,10 @@ export default class Members extends StatelessWebexPlugin {
     }
     const memberUpdate = this.update(payload.participants);
 
+    // this code depends on memberIds being the same as participantIds
+    // if MemberUtil.extractId() ever changes, this will need to be updated
+    memberUpdate.removedIds = payload.removedParticipantIds || [];
+
     return memberUpdate;
   }
 
@@ -1181,11 +1207,17 @@ export default class Members extends StatelessWebexPlugin {
    * @param {string} memberId - id of the participant who is receiving request
    * @param {string} requestingParticipantId - id of the participant who is sending request (optional)
    * @param {string} [alias] - alias name
+   * @param {string} [suffix] - name suffix (optional)
    * @returns {Promise}
    * @public
    * @memberof Members
    */
-  public editDisplayName(memberId: string, requestingParticipantId: string, alias: string) {
+  public editDisplayName(
+    memberId: string,
+    requestingParticipantId: string,
+    alias: string,
+    suffix?: string
+  ) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError(
@@ -1205,7 +1237,8 @@ export default class Members extends StatelessWebexPlugin {
       memberId,
       requestingParticipantId,
       alias,
-      locusUrl
+      locusUrl,
+      suffix
     );
 
     return this.membersRequest.editDisplayNameMember(options);

package/src/members/util.ts

@@ -190,13 +190,21 @@ const MembersUtil = {
    * @param {String} requestingParticipantId id of the participant who is sending request (optional)
    * @param {String} alias alias name
    * @param {String} locusUrl url
+   * @param {String} suffix optional suffix
    * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
    */
-  generateEditDisplayNameMemberOptions: (memberId, requestingParticipantId, alias, locusUrl) => ({
+  generateEditDisplayNameMemberOptions: (
     memberId,
     requestingParticipantId,
     alias,
     locusUrl,
+    suffix
+  ) => ({
+    memberId,
+    requestingParticipantId,
+    alias,
+    locusUrl,
+    suffix,
   }),
 
   getMuteMemberRequestParams: (options) => {
@@ -301,10 +309,18 @@ const MembersUtil = {
    * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
    */
   editDisplayNameMemberRequestParams: (options) => {
-    const body = {
+    const body: {
+      aliasValue: string;
+      requestingParticipantId: string;
+      suffixValue?: string;
+    } = {
       aliasValue: options.alias,
       requestingParticipantId: options.requestingParticipantId,
     };
+
+    if (options.suffix !== undefined) {
+      body.suffixValue = options.suffix;
+    }
     const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${ALIAS}`;
 
     return {

package/src/metrics/constants.ts

@@ -86,6 +86,7 @@ const BEHAVIORAL_METRICS = {
   VERIFY_REGISTRATION_ID_SUCCESS: 'js_sdk_verify_registrationId_success',
   VERIFY_REGISTRATION_ID_ERROR: 'js_sdk_verify_registrationId_error',
   JOIN_FORBIDDEN_ERROR: 'js_sdk_join_forbidden_error',
+  MEDIA_ISSUE_DETECTED: 'js_sdk_media_issue_detected',
 };
 
 export {BEHAVIORAL_METRICS as default};

package/src/reachability/index.ts

@@ -923,10 +923,10 @@ export default class Reachability extends EventsScope {
 
       // update expected results counters to include this cluster
       this.expectedResultsCount[cluster.isVideoMesh ? 'videoMesh' : 'public'].udp +=
-        cluster.udp.length;
+        cluster.udp.length > 0 ? 1 : 0;
       if (!cluster.isVideoMesh) {
-        this.expectedResultsCount.public.tcp += cluster.tcp.length;
-        this.expectedResultsCount.public.xtls += cluster.xtls.length;
+        this.expectedResultsCount.public.tcp += cluster.tcp.length > 0 ? 1 : 0;
+        this.expectedResultsCount.public.xtls += cluster.xtls.length > 0 ? 1 : 0;
       }
     });
 

package/test/unit/spec/locus-info/index.js

@@ -772,7 +772,7 @@ describe('plugin-meetings', () => {
           },
         };
         locusInfo.emitScoped = sinon.stub();
-        locusInfo.updateParticipants({});
+        locusInfo.updateParticipants({}, []);
 
         // if this assertion fails, double-check the attributes used in
         // the updateParticipants function in locus-info/index.js
@@ -790,6 +790,7 @@ describe('plugin-meetings', () => {
             selfId: '2',
             hostId: '3',
             isReplace: undefined,
+            removedParticipantIds: [],
           }
         );
         // note: in a real use case, recordingId, selfId, and hostId would all be the same
@@ -814,7 +815,7 @@ describe('plugin-meetings', () => {
         };
 
         locusInfo.emitScoped = sinon.stub();
-        locusInfo.updateParticipants({}, true);
+        locusInfo.updateParticipants({}, [], true);
 
         assert.calledWith(
           locusInfo.emitScoped,
@@ -830,6 +831,7 @@ describe('plugin-meetings', () => {
             selfId: '2',
             hostId: '3',
             isReplace: true,
+            removedParticipantIds: [],
           }
         );
       });
@@ -847,7 +849,7 @@ describe('plugin-meetings', () => {
         ];
 
         locusInfo.emitScoped = sinon.stub();
-        locusInfo.updateParticipants(failureParticipant);
+        locusInfo.updateParticipants(failureParticipant, []);
         assert.calledWith(
           locusInfo.emitScoped,
           {
@@ -2038,6 +2040,18 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#handleLocusAPIResponse', () => {
+      it('calls handleLocusDelta', () => {
+        const fakeLocus = {eventType: LOCUSEVENT.DIFFERENCE};
+
+        sinon.stub(locusInfo, 'handleLocusDelta');
+
+        locusInfo.handleLocusAPIResponse(mockMeeting, {locus: fakeLocus});
+
+        assert.calledWith(locusInfo.handleLocusDelta, fakeLocus, mockMeeting);
+      });
+    });
+
     describe('#LocusDeltaEvents', () => {
       const fakeMeeting = 'fakeMeeting';
       let sandbox = null;
@@ -2050,7 +2064,7 @@ describe('plugin-meetings', () => {
 
         fakeLocus = {
           meeting: true,
-          participants: true,
+          participants: [],
           url: 'newLocusUrl',
           syncUrl: 'newSyncUrl',
         };
@@ -2369,23 +2383,23 @@ describe('plugin-meetings', () => {
 
       it('applyLocusDeltaData handles LOCUS_URL_CHANGED action correctly', () => {
         const {LOCUS_URL_CHANGED} = LocusDeltaParser.loci;
-        const fakeDeltaLocus = {id: 'fake delta locus'};
+        const fakeFullLocus = {
+          url: 'new full loci url',
+        };
         const meeting = {
           meetingRequest: {
-            getLocusDTO: sandbox.stub().resolves({body: fakeDeltaLocus}),
+            getLocusDTO: sandbox.stub().resolves({body: fakeFullLocus}),
           },
           locusInfo: {
             handleLocusDelta: sandbox.stub(),
           },
-          locusUrl: 'current locus url',
+          locusUrl: 'current BO session locus url',
         };
 
-        locusInfo.locusParser.workingCopy = {
-          syncUrl: 'current sync url',
-        };
+        locusInfo.locusParser.workingCopy = null;
 
         locusInfo.applyLocusDeltaData(LOCUS_URL_CHANGED, fakeLocus, meeting);
-        assert.calledOnceWithExactly(meeting.meetingRequest.getLocusDTO, {url: 'current sync url'});
+        assert.calledOnceWithExactly(meeting.meetingRequest.getLocusDTO, {url: fakeLocus.url});
       });
 
       describe('edge cases for sync failing', () => {
@@ -2525,7 +2539,7 @@ describe('plugin-meetings', () => {
       });
 
       it('onDeltaLocus handle delta data', () => {
-        fakeLocus.participants = {};
+        fakeLocus.participants = [];
         const fakeBreakout = {
           sessionId: 'sessionId',
           groupId: 'groupId',
@@ -2542,11 +2556,11 @@ describe('plugin-meetings', () => {
         };
         locusInfo.updateParticipants = sinon.stub();
         locusInfo.onDeltaLocus(fakeLocus);
-        assert.calledWith(locusInfo.updateParticipants, {}, false);
+        assert.calledWith(locusInfo.updateParticipants, [], undefined, false);
 
         fakeLocus.controls.breakout.sessionId = 'sessionId2';
         locusInfo.onDeltaLocus(fakeLocus);
-        assert.calledWith(locusInfo.updateParticipants, {}, true);
+        assert.calledWith(locusInfo.updateParticipants, [], undefined, true);
       });
 
       it('onDeltaLocus merges delta participants with existing participants', () => {
@@ -2563,7 +2577,7 @@ describe('plugin-meetings', () => {
           existingParticipants,
           FAKE_DELTA_PARTICIPANTS
         );
-        assert.calledWith(locusInfo.updateParticipants, FAKE_DELTA_PARTICIPANTS, false);
+        assert.calledWith(locusInfo.updateParticipants, FAKE_DELTA_PARTICIPANTS, undefined, false);
       });
 
       [true, false].forEach((isDelta) =>
@@ -3074,6 +3088,7 @@ describe('plugin-meetings', () => {
               id: 'test person id',
             },
           },
+          participants: [],
         });
 
         updateLocusInfoStub.resetHistory();

package/test/unit/spec/locus-info/parser.js

@@ -253,7 +253,8 @@ describe('locus-info/parser', () => {
     });
     
     it('replaces current loci when the locus URL changes and incoming sequence is later, even when baseSequence doesn\'t match', () => {
-      const {USE_INCOMING} = LocusDeltaParser.loci;
+      const {LOCUS_URL_CHANGED} = LocusDeltaParser.loci;
+      sandbox.stub(LocusDeltaParser, 'compare').returns(LOCUS_URL_CHANGED);
 
       parser.queue.dequeue = sandbox.stub().returns(NEW_LOCI);
       parser.onDeltaAction = sandbox.stub();
@@ -262,7 +263,7 @@ describe('locus-info/parser', () => {
 
       parser.processDeltaEvent();
 
-      assert.equal(parser.workingCopy, NEW_LOCI);
+      assert.equal(parser.workingCopy, null);
     });
 
     it('does not replace current loci when the locus URL changes but incoming sequence is not later', () => {

package/test/unit/spec/media/properties.ts

@@ -6,6 +6,8 @@ import * as tsSdpModule from '@webex/ts-sdp';
 import MediaProperties from '@webex/plugin-meetings/src/media/properties';
 import {Defer} from '@webex/common';
 import MediaConnectionAwaiter from '../../../../src/media/MediaConnectionAwaiter';
+import Metrics from '../../../../src/metrics';
+import BEHAVIORAL_METRICS from '../../../../src/metrics/constants';
 
 describe('MediaProperties', () => {
   let mediaProperties;
@@ -389,4 +391,139 @@ describe('MediaProperties', () => {
       });
     });
   });
+
+  // issue types and subtypes used in these tests are just examples
+  // they don't reflect real issue types/subtypes used in production
+  describe('sendMediaIssueMetric', () => {
+    let sendBehavioralMetricStub;
+    let clock;
+
+    beforeEach(() => {
+      clock = sinon.useFakeTimers();
+      sendBehavioralMetricStub = sinon.stub(Metrics, 'sendBehavioralMetric');
+    });
+
+    afterEach(() => {
+      clock.restore();
+    });
+
+    it('should send a behavioral metric with correct parameters', () => {
+      const issueType = 'audio';
+      const issueSubType = 'packet-loss';
+      const correlationId = 'test-correlation-id-123';
+
+      mediaProperties.sendMediaIssueMetric(issueType, issueSubType, correlationId);
+
+      assert.calledOnce(sendBehavioralMetricStub);
+      assert.calledWith(sendBehavioralMetricStub, BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED, {
+        correlationId,
+        'audio_packet-loss': 1,
+      });
+    });
+
+    it('should increment count while being throttled and reset it once metric goes out', () => {
+      const issueType = 'video';
+      const issueSubType = 'freeze';
+      const correlationId = 'test-correlation-id';
+
+      // Call multiple times with same issue type/subtype
+      mediaProperties.sendMediaIssueMetric(issueType, issueSubType, correlationId);
+      mediaProperties.sendMediaIssueMetric(issueType, issueSubType, correlationId);
+      mediaProperties.sendMediaIssueMetric(issueType, issueSubType, correlationId);
+
+      // First call should go through immediately, subsequent calls are throttled
+      assert.calledOnce(sendBehavioralMetricStub);
+      assert.calledWith(sendBehavioralMetricStub, BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED, {
+        correlationId,
+        video_freeze: 1, // Only the first call goes through due to throttling
+      });
+      sendBehavioralMetricStub.resetHistory();
+
+      assert.equal(mediaProperties.mediaIssueCounters['video_freeze'], 2); // counter should be reset after the first metric goes out, hence only 2 not 3 here
+
+      clock.tick(5 * 60 * 1000); // Advance time by 5 minutes to expire throttle
+
+      assert.calledOnceWithExactly(
+        sendBehavioralMetricStub,
+        BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED,
+        {
+          correlationId,
+          video_freeze: 2,
+        }
+      );
+    });
+
+    it('should track different issue types separately in counters', () => {
+      const correlationId = 'test-correlation-id';
+
+      // Send different issue types
+      mediaProperties.sendMediaIssueMetric('audio', 'packet-loss', correlationId);
+      mediaProperties.sendMediaIssueMetric('video', 'freeze', correlationId);
+      mediaProperties.sendMediaIssueMetric('audio', 'packet-loss', correlationId);
+      mediaProperties.sendMediaIssueMetric('audio', 'packet-loss', correlationId);
+      mediaProperties.sendMediaIssueMetric('audio', 'packet-loss', correlationId);
+      mediaProperties.sendMediaIssueMetric('video', 'freeze', correlationId);
+
+      // First call should go through immediately, subsequent calls are throttled
+      assert.calledOnceWithExactly(
+        sendBehavioralMetricStub,
+        BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED,
+        {
+          correlationId,
+          'audio_packet-loss': 1,
+        }
+      );
+
+      // But the counters should be tracked separately
+      assert.equal(mediaProperties.mediaIssueCounters['audio_packet-loss'], 3);
+      assert.equal(mediaProperties.mediaIssueCounters['video_freeze'], 2);
+
+      sendBehavioralMetricStub.resetHistory();
+
+      clock.tick(5 * 60 * 1000); // Advance time by 5 minutes to expire throttle
+
+      assert.calledOnceWithExactly(
+        sendBehavioralMetricStub,
+        BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED,
+        {
+          correlationId,
+          video_freeze: 2,
+          'audio_packet-loss': 3,
+        }
+      );
+    });
+
+    it('should flush throttled metrics when unsetPeerConnection is called', () => {
+      const issueType = 'share';
+      const issueSubType = 'connection-lost';
+      const correlationId = 'test-correlation-id';
+
+      // Send metrics multiple times
+      mediaProperties.sendMediaIssueMetric(issueType, issueSubType, correlationId);
+      mediaProperties.sendMediaIssueMetric(issueType, issueSubType, correlationId);
+
+      // First call should go through immediately
+      assert.calledOnceWithExactly(
+        sendBehavioralMetricStub,
+        BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED,
+        {
+          correlationId,
+          'share_connection-lost': 1,
+        }
+      );
+      sendBehavioralMetricStub.resetHistory();
+
+      // Call unsetPeerConnection which should flush throttled metrics
+      mediaProperties.unsetPeerConnection();
+
+      assert.calledOnceWithExactly(
+        sendBehavioralMetricStub,
+        BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED,
+        {
+          correlationId,
+          'share_connection-lost': 1,
+        }
+      );
+    });
+  });
 });

package/test/unit/spec/meeting/in-meeting-actions.ts

@@ -38,6 +38,7 @@ describe('plugin-meetings', () => {
         isManualCaptionActive: null,
         isPremiseRecordingEnabled: null,
         isSaveTranscriptsEnabled: null,
+        isSpokenLanguageAutoDetectionEnabled: null,
         isWebexAssistantActive: null,
         canViewCaptionPanel: null,
         isRealTimeTranslationEnabled: null,
@@ -151,6 +152,7 @@ describe('plugin-meetings', () => {
       'isManualCaptionActive',
       'isPremiseRecordingEnabled',
       'isSaveTranscriptsEnabled',
+      'isSpokenLanguageAutoDetectionEnabled',
       'isWebexAssistantActive',
       'canViewCaptionPanel',
       'isRealTimeTranslationEnabled',