@webex/plugin-meetings 3.8.1 → 3.9.0-next.10

package/test/unit/spec/meeting/request.js

@@ -826,4 +826,75 @@ describe('plugin-meetings', () => {
       });
     });
   });
+
+  describe('#synchronizeStage', () => {
+    [
+      ['an unset stage', {overrideDefault: false}],
+      [
+        'a minimally set stage',
+        {
+          overrideDefault: true,
+          lockAttendeeViewOnStageOnly: false,
+          stageParameters: {
+            activeSpeakerProportion: 0.5,
+            showActiveSpeaker: {show: false, order: 0},
+            stageManagerType: 0,
+          },
+        },
+      ],
+      [
+        'a fully set stage',
+        {
+          overrideDefault: true,
+          lockAttendeeViewOnStageOnly: true,
+          stageParameters: {
+            activeSpeakerProportion: 0.6,
+            importantParticipants: [
+              {mainCsi: 11111111, participantId: uuidv4(), order: 1},
+              {mainCsi: 22222222, participantId: uuidv4(), order: 2},
+              {mainCsi: 33333333, participantId: uuidv4(), order: 3},
+              {mainCsi: 44444444, participantId: uuidv4(), order: 4},
+              {mainCsi: 55555555, participantId: uuidv4(), order: 5},
+              {mainCsi: 66666666, participantId: uuidv4(), order: 6},
+              {mainCsi: 77777777, participantId: uuidv4(), order: 7},
+              {mainCsi: 88888888, participantId: uuidv4(), order: 8},
+            ],
+            showActiveSpeaker: {show: true, order: 0},
+            stageManagerType: 7,
+          },
+          customLayouts: {
+            background: {url: `https://test.wbx2.com/background/${uuidv4()}.jpg`},
+            logo: {url: `https://test.wbx2.com/logo/${uuidv4()}.png`, position: 'UpperMiddle'},
+          },
+          nameLabelStyle: {
+            accentColor: '#00A3FF',
+            background: {color: 'rgba(0, 163, 255, 1)'},
+            border: {color: 'rgba(0, 163, 255, 1)'},
+            content: {
+              displayName: {color: 'rgba(255, 255, 255, 0.95)'},
+              subtitle: {color: 'rgba(255, 255, 255, 0.7)'},
+            },
+            decoration: {color: 'rgba(255, 255, 255, 0.95)'},
+            fadeOut: {delay: 15},
+            type: 'PrimaryInverted',
+          },
+        },
+      ],
+    ].forEach(([description, videoLayout]) => {
+      it(`sends request to synchronize the stage with ${description} video layout`, async () => {
+        const locusUrl = `https://locus-test.wbx2.com/locus/api/v1/loci/${uuidv4()}`;
+
+        const synchronizePromise = meetingsRequest.synchronizeStage(locusUrl, videoLayout);
+
+        assert.exists(synchronizePromise.then);
+        await synchronizePromise;
+
+        checkRequest({
+          method: 'PATCH',
+          uri: `${locusUrl}/controls`,
+          body: {videoLayout},
+        });
+      });
+    });
+  });
 });

package/test/unit/spec/meeting/utils.js

@@ -3,12 +3,14 @@ import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import Meetings from '@webex/plugin-meetings';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
-import {LOCAL_SHARE_ERRORS} from '@webex/plugin-meetings/src/constants';
+import {LOCAL_SHARE_ERRORS, PASSWORD_STATUS} from '@webex/plugin-meetings/src/constants';
 import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
 import LoggerConfig from '@webex/plugin-meetings/src/common/logs/logger-config';
 import {SELF_POLICY, IP_VERSION} from '@webex/plugin-meetings/src/constants';
 import MockWebex from '@webex/test-helper-mock-webex';
 import * as BrowserDetectionModule from '@webex/plugin-meetings/src/common/browser-detection';
+import PasswordError from '@webex/plugin-meetings/src/common/errors/password-error';
+import CaptchaError from '@webex/plugin-meetings/src/common/errors/captcha-error';
 
 describe('plugin-meetings', () => {
   let webex;
@@ -57,6 +59,10 @@ describe('plugin-meetings', () => {
       meeting.getWebexObject = sinon.stub().returns(webex);
       meeting.simultaneousInterpretation = {cleanUp: sinon.stub()};
       meeting.trigger = sinon.stub();
+      meeting.webex = webex;
+      meeting.webex.internal.newMetrics.callDiagnosticMetrics =
+      meeting.webex.internal.newMetrics.callDiagnosticMetrics || {};
+      meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId = sinon.stub();
     });
 
     afterEach(() => {
@@ -81,6 +87,10 @@ describe('plugin-meetings', () => {
         assert.calledOnce(meeting.breakouts.cleanUp);
         assert.calledOnce(meeting.simultaneousInterpretation.cleanUp);
         assert.calledOnce(webex.internal.device.meetingEnded);
+        assert.calledOnceWithExactly(
+          meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId,
+          meeting.correlationId
+        );
       });
 
       it('do clean up on meeting object with LLM disabled', async () => {
@@ -98,6 +108,10 @@ describe('plugin-meetings', () => {
         assert.calledOnce(meeting.breakouts.cleanUp);
         assert.calledOnce(meeting.simultaneousInterpretation.cleanUp);
         assert.calledOnce(webex.internal.device.meetingEnded);
+        assert.calledOnceWithExactly(
+          meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId,
+          meeting.correlationId
+        );
       });
 
       it('do clean up on meeting object with no config', async () => {
@@ -114,6 +128,10 @@ describe('plugin-meetings', () => {
         assert.calledOnce(meeting.breakouts.cleanUp);
         assert.calledOnce(meeting.simultaneousInterpretation.cleanUp);
         assert.calledOnce(webex.internal.device.meetingEnded);
+        assert.calledOnceWithExactly(
+          meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId,
+          meeting.correlationId
+        );
       });
     });
 
@@ -622,6 +640,28 @@ describe('plugin-meetings', () => {
 
         assert.equal(parameter.locusClusterUrl, 'locusClusterUrl');
       });
+
+      it('should post client event with error when join fails', async () => {
+        const joinError = new Error('Join failed');
+        meeting.meetingRequest.joinMeeting.rejects(joinError);
+        meeting.meetingInfo = { meetingLookupUrl: 'test-lookup-url' };
+
+        try {
+          await MeetingUtil.joinMeeting(meeting, {});
+          assert.fail('Expected joinMeeting to throw an error');
+        } catch (error) {
+          assert.equal(error, joinError);
+          
+          // Verify error client event was submitted
+          assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.locus.join.response',
+            payload: {
+              identifiers: { meetingLookupUrl: 'test-lookup-url' },
+            },
+            options: { meetingId: meeting.id, rawError: joinError },
+          });
+        }
+      });
     });
 
     describe('joinMeetingOptions', () => {
@@ -661,6 +701,82 @@ describe('plugin-meetings', () => {
           joinMeetingSpy.restore();
         }
       });
+
+      it('should submit client event and reject with PasswordError when password is required', async () => {
+        const meeting = {
+          id: 'meeting-id',
+          passwordStatus: PASSWORD_STATUS.REQUIRED,
+          resourceId: null,
+          requiredCaptcha: null,
+          getWebexObject: sinon.stub().returns(webex),
+        };
+
+        try {
+          await MeetingUtil.joinMeetingOptions(meeting, {});
+          assert.fail('Expected joinMeetingOptions to throw PasswordError');
+        } catch (error) {
+          assert.instanceOf(error, PasswordError);
+          
+          // Verify client event was submitted with error details
+          assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.meetinginfo.response',
+            options: {
+              meetingId: meeting.id,
+            },
+            payload: {
+              errors: [
+                {
+                  fatal: false,
+                  category: 'expected',
+                  name: 'other',
+                  shownToUser: false,
+                  errorCode: error.code,
+                  errorDescription: error.name,
+                  rawErrorMessage: error.sdkMessage,
+                },
+              ],
+            },
+          });
+        }
+      });
+
+      it('should submit client event and reject with CaptchaError when captcha is required', async () => {
+        const meeting = {
+          id: 'meeting-id',
+          passwordStatus: null,
+          resourceId: null,
+          requiredCaptcha: {captchaId: 'test-captcha'},
+          getWebexObject: sinon.stub().returns(webex),
+        };
+
+        try {
+          await MeetingUtil.joinMeetingOptions(meeting, {});
+          assert.fail('Expected joinMeetingOptions to throw CaptchaError');
+        } catch (error) {
+          assert.instanceOf(error, CaptchaError);
+          
+          // Verify client event was submitted with error details
+          assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.meetinginfo.response',
+            options: {
+              meetingId: meeting.id,
+            },
+            payload: {
+              errors: [
+                {
+                  fatal: false,
+                  category: 'expected',
+                  name: 'other',
+                  shownToUser: false,
+                  errorCode: error.code,
+                  errorDescription: error.name,
+                  rawErrorMessage: error.sdkMessage,
+                },
+              ],
+            },
+          });
+        }
+      });
     });
 
     describe('getUserDisplayHintsFromLocusInfo', () => {
@@ -850,6 +966,11 @@ describe('plugin-meetings', () => {
       {functionName: 'isClosedCaptionActive', displayHint: 'CAPTION_STATUS_ACTIVE'},
       {functionName: 'canStartManualCaption', displayHint: 'MANUAL_CAPTION_START'},
       {functionName: 'canStopManualCaption', displayHint: 'MANUAL_CAPTION_STOP'},
+
+      {functionName: 'isLocalRecordingStarted',displayHint:'LOCAL_RECORDING_STATUS_STARTED'},
+      {functionName: 'isLocalRecordingStopped', displayHint: 'LOCAL_RECORDING_STATUS_STOPPED'},
+      {functionName: 'isLocalRecordingPaused', displayHint: 'LOCAL_RECORDING_STATUS_PAUSED'},
+
       {functionName: 'isManualCaptionActive', displayHint: 'MANUAL_CAPTION_STATUS_ACTIVE'},
       {functionName: 'isWebexAssistantActive', displayHint: 'WEBEX_ASSISTANT_STATUS_ACTIVE'},
       {functionName: 'canViewCaptionPanel', displayHint: 'ENABLE_CAPTION_PANEL'},

package/test/unit/spec/meetings/index.js

@@ -189,6 +189,7 @@ describe('plugin-meetings', () => {
           },
           callDiagnosticMetrics: {
             clearErrorCache: sinon.stub(),
+            clearEventLimits: sinon.stub(),
           },
         },
       });
@@ -1716,6 +1717,7 @@ describe('plugin-meetings', () => {
               {file: 'meetings', function: 'fetchMeetingInfo'},
               'meeting:meetingInfoAvailable'
             );
+            assert.equal(webex.meetings.meetingCollection.get(meeting.id), meeting);
           };
 
           it('creates the meeting from a successful meeting info fetch promise testing', async () => {

package/test/unit/spec/members/index.js

@@ -176,6 +176,56 @@ describe('plugin-meetings', () => {
         assert.calledOnce(MembersUtil.isInvalidInvitee);
         assert.isFalse(MembersUtil.isInvalidInvitee({email: 'sip:test@cisco.com'}), 'SIP email should be valid');
       });
+
+      it('should skip email validation if skipEmailValidation is true', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        await members.addMember({email: '8618578675309', skipEmailValidation: true});
+        
+        assert.notCalled(MembersUtil.isInvalidInvitee);
+      });
+
+      it('should not skip email validation if skipEmailValidation is not equal true', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        await members.addMember({email: '86185786@ds.com'});
+        
+        assert.called(MembersUtil.isInvalidInvitee);
+      });
+
+      it('should accept valid phone with isInternalNumber', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        await members.addMember({phoneNumber: '+8618578675309', isInternalNumber: false});
+        
+        assert.calledOnce(MembersUtil.isInvalidInvitee);
+        assert.isFalse(MembersUtil.isInvalidInvitee({ phoneNumber: '+8618578675309', isInternalNumber: false }));
+        assert.isTrue(MembersUtil.isInvalidInvitee({ phoneNumber: '18578675309', isInternalNumber: false }));
+        assert.isFalse(MembersUtil.isInvalidInvitee({phoneNumber: '18578675309', isInternalNumber: true}));
+        assert.isTrue(MembersUtil.isInvalidInvitee({phoneNumber: '+8618578675309', isInternalNumber: true}));
+      });
+
+      it('should not crash if params is undefined', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        try {
+          await members.addMember(undefined);
+        } catch (err) {
+          assert.instanceOf(err, ParameterError);
+
+          assert.equal(err.message, 'The invitee must be defined with either a valid email, emailAddress or phoneNumber property.');
+        }
+              
+        assert.called(MembersUtil.isInvalidInvitee);
+      });
     });
 
     describe('#admitMembers', () => {
@@ -465,29 +515,38 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('#cancelSIPInvite', () => {
+    describe('#cancelInviteByMemberId', () => {
       const memberId = uuid.v4();
-      it('should invoke cancelSIPInviteOptions from MembersUtil when cancelSIPInvite is called with valid params', async () => {
-        sandbox.spy(MembersUtil, 'cancelSIPInviteOptions');
+      it('should invoke cancelInviteByMemberIdOptions from MembersUtil when cancelInviteByMemberId is called with valid params', async () => {
+        sandbox.spy(MembersUtil, 'cancelInviteByMemberIdOptions');
 
         const members = createMembers({url: url1});
 
-        await members.cancelSIPInvite({memberId});
-        assert.calledOnce(MembersUtil.cancelSIPInviteOptions);
+        await members.cancelInviteByMemberId({memberId});
+        assert.calledOnce(MembersUtil.cancelInviteByMemberIdOptions);
+      });
+
+      it('should invoke cancelInviteByMemberIdOptions from MembersUtil when cancelInviteByMemberId is called with isInternalNumber', async () => {
+        sandbox.spy(MembersUtil, 'cancelInviteByMemberIdOptions');
+
+        const members = createMembers({url: url1});
+
+        await members.cancelInviteByMemberId({memberId, isInternalNumber: true});
+        assert.calledOnce(MembersUtil.cancelInviteByMemberIdOptions);
       });
 
       it('should throw a rejection if there is no locus url', async () => {
         const members = createMembers({url: false});
 
-        assert.isRejected(members.cancelSIPInvite({memberId}));
+        assert.isRejected(members.cancelInviteByMemberId({memberId}));
       });
       
       it('should throw a rejection if memberId is not provided', async () => {
         const members = createMembers({url: url1});
 
-        assert.isRejected(members.cancelSIPInvite({}));
-        assert.isRejected(members.cancelSIPInvite({memberId: null}));
-        assert.isRejected(members.cancelSIPInvite({memberId: undefined}));
+        assert.isRejected(members.cancelInviteByMemberId({}));
+        assert.isRejected(members.cancelInviteByMemberId({memberId: null}));
+        assert.isRejected(members.cancelInviteByMemberId({memberId: undefined}));
       });
     });
 
@@ -914,7 +973,8 @@ describe('plugin-meetings', () => {
         expectedMemberId,
         expectedRequestingParticipantId,
         expectedAlias,
-        expectedLocusUrl
+        expectedLocusUrl,
+        expectedSuffix
       ) => {
         await assert.isFulfilled(resultPromise);
         assert.calledOnceWithExactly(
@@ -922,13 +982,15 @@ describe('plugin-meetings', () => {
           expectedMemberId,
           expectedRequestingParticipantId,
           expectedAlias,
-          expectedLocusUrl
+          expectedLocusUrl,
+          expectedSuffix
         );
         assert.calledOnceWithExactly(spies.editDisplayNameMember, {
           memberId: expectedMemberId,
           requestingParticipantId: expectedRequestingParticipantId,
           alias: expectedAlias,
           locusUrl: expectedLocusUrl,
+          suffix: expectedSuffix,
         });
         assert.strictEqual(resultPromise, spies.editDisplayNameMember.getCall(0).returnValue);
       };
@@ -958,6 +1020,31 @@ describe('plugin-meetings', () => {
       });
 
       it('should make the correct request when called with respective parameters', async () => {
+        const requestingParticipantId = uuid.v4();
+        const memberId = uuid.v4();
+        const alias = 'aliasName';
+        const suffix = 'suffixName';
+        const {members, spies} = setup(url1);
+
+        const resultPromise = members.editDisplayName(
+          memberId,
+          requestingParticipantId,
+          alias,
+          suffix
+        );
+
+        await checkValid(
+          resultPromise,
+          spies,
+          memberId,
+          requestingParticipantId,
+          alias,
+          url1,
+          suffix
+        );
+      });
+
+      it('should make the correct request when called with respective parameters - no suffix', async () => {
         const requestingParticipantId = uuid.v4();
         const memberId = uuid.v4();
         const alias = 'aliasName';

package/test/unit/spec/members/request.js

@@ -221,7 +221,7 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('#cancelSIPInvite', () => {
+    describe('#cancelInviteByMemberId', () => {
       const memberId = uuid.v4();
       it('sends a PUT to the locus endpoint', async () => {
         const options = {
@@ -231,7 +231,7 @@ describe('plugin-meetings', () => {
           locusUrl: url1,
         };
 
-        await membersRequest.cancelSIPInvite(options);
+        await membersRequest.cancelInviteByMemberId(options);
 
         checkRequest({
           method: 'PUT',
@@ -429,6 +429,61 @@ describe('plugin-meetings', () => {
           },
         });
       });
+
+      it('sends a POST request to the locus endpoint with suffix empty string', async () => {
+        const locusUrl = url1;
+        const memberId = 'test1';
+        const requestingParticipantId = 'test2';
+        const aliasValue = 'alias';
+
+        const options = {
+          memberId,
+          requestingParticipantId,
+          alias: aliasValue,
+          locusUrl,
+          suffix: '',
+        };
+
+        await membersRequest.editDisplayNameMember(options);
+
+        checkRequest({
+          method: 'POST',
+          uri: `${locusUrl}/participant/${memberId}/alias`,
+          body: {
+            aliasValue,
+            requestingParticipantId,
+            suffixValue: '',
+          },
+        });
+      });
+
+      it('sends a POST request to the locus endpoint with suffixValue', async () => {
+        const locusUrl = url1;
+        const memberId = 'test1';
+        const requestingParticipantId = 'test2';
+        const aliasValue = 'alias';
+        const suffixValue = 'suffix';
+
+        const options = {
+          memberId,
+          requestingParticipantId,
+          alias: aliasValue,
+          locusUrl,
+          suffix: suffixValue,
+        };
+
+        await membersRequest.editDisplayNameMember(options);
+
+        checkRequest({
+          method: 'POST',
+          uri: `${locusUrl}/participant/${memberId}/alias`,
+          body: {
+            aliasValue,
+            requestingParticipantId,
+            suffixValue,
+          },
+        });
+      });
     });
 
     describe('#moveToLobby', () => {