@webex/plugin-meetings 3.6.0 → 3.7.0-next.10

package/test/unit/spec/meeting/locusMediaRequest.ts

@@ -34,12 +34,19 @@ describe('LocusMediaRequest.send()', () => {
       'wjfkm.wjfkm.*': {udp:{reachable: true}, tcp:{reachable:false}},
       '1eb65fdf-9643-417f-9974-ad72cae0e10f.59268c12-7a04-4b23-a1a1-4c74be03019a.*': {udp:{reachable: false}, tcp:{reachable:true}},
     },
-    joinCookie: {
-      anycastEntryPoint: 'aws-eu-west-1',
-      clientIpAddress: 'some ip',
-      timeShot: '2023-05-23T08:03:49Z',
-    },
-    ipVersion: IP_VERSION.only_ipv4,
+    clientMediaPreferences: {
+      preferTranscoding: false,
+      joinCookie: {
+        anycastEntryPoint: 'aws-eu-west-1',
+        clientIpAddress: 'some ip',
+        timeShot: '2023-05-23T08:03:49Z',
+      },
+      ipver: IP_VERSION.only_ipv4,
+      reachability: {
+        version: '1',
+        result: 'some fake reachability result',
+      }
+    }
   };
 
   const createExpectedRoapBody = (expectedMessageType, expectedMute:{audioMuted: boolean, videoMuted: boolean}) => {
@@ -53,12 +60,16 @@ describe('LocusMediaRequest.send()', () => {
         }
       ],
       clientMediaPreferences: {
-        preferTranscoding: true,
+        preferTranscoding: false,
         ipver: 4,
         joinCookie: {
           anycastEntryPoint: 'aws-eu-west-1',
           clientIpAddress: 'some ip',
           timeShot: '2023-05-23T08:03:49Z'
+        },
+        reachability: {
+          version: '1',
+          result: 'some fake reachability result',
         }
       }
     };
@@ -87,10 +98,6 @@ describe('LocusMediaRequest.send()', () => {
           localSdp: `{"audioMuted":${expectedMute.audioMuted},"videoMuted":${expectedMute.videoMuted}}`,
         },
       ],
-      clientMediaPreferences: {
-        preferTranscoding: true,
-        ipver: undefined,
-      },
     };
 
     if (sequence) {

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

@@ -151,7 +151,7 @@ describe('plugin-meetings', () => {
       meeting.mediaProperties.audioStream.setServerMuted = sinon.stub().callsFake((muted) => {
         meeting.mediaProperties.audioStream.userMuted = muted;
       });
-      audio.handleServerLocalUnmuteRequired(meeting);
+      audio.handleServerLocalUnmuteRequired(meeting, true);
 
       await testUtils.flushPromises();
 
@@ -161,6 +161,8 @@ describe('plugin-meetings', () => {
         false,
         'localUnmuteRequired'
       );
+      // and unmuteAllowed was updated
+      assert.calledWith(meeting.mediaProperties.audioStream.setUnmuteAllowed, true);
 
       // and local unmute was sent to server
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
@@ -184,7 +186,7 @@ describe('plugin-meetings', () => {
       meeting.mediaProperties.audioStream.setServerMuted = sinon.stub().callsFake((muted) => {
         meeting.mediaProperties.audioStream.userMuted = muted;
       });
-      audio.handleServerLocalUnmuteRequired(meeting);
+      audio.handleServerLocalUnmuteRequired(meeting, true);
 
       await testUtils.flushPromises();
 
@@ -215,7 +217,7 @@ describe('plugin-meetings', () => {
       meeting.mediaProperties.videoStream.setServerMuted = sinon.stub().callsFake((muted) => {
         meeting.mediaProperties.videoStream.userMuted = muted;
       });
-      video.handleServerLocalUnmuteRequired(meeting);
+      video.handleServerLocalUnmuteRequired(meeting, true);
 
       await testUtils.flushPromises();
 
@@ -225,6 +227,8 @@ describe('plugin-meetings', () => {
         false,
         'localUnmuteRequired'
       );
+      // and unmuteAllowed was updated
+      assert.calledWith(meeting.mediaProperties.videoStream.setUnmuteAllowed, true);
 
       // and local unmute was sent to server
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
@@ -248,7 +252,7 @@ describe('plugin-meetings', () => {
       meeting.mediaProperties.videoStream.setServerMuted = sinon.stub().callsFake((muted) => {
         meeting.mediaProperties.videoStream.userMuted = muted;
       });
-      video.handleServerLocalUnmuteRequired(meeting);
+      video.handleServerLocalUnmuteRequired(meeting, true);
 
       await testUtils.flushPromises();
 

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

@@ -196,6 +196,7 @@ describe('plugin-meetings', () => {
         const permissionToken = 'permission-token';
         const installationId = 'installationId';
         const reachability = 'reachability';
+        const clientMediaPreferences = 'clientMediaPreferences';
 
         await meetingsRequest.joinMeeting({
           locusUrl,
@@ -204,6 +205,7 @@ describe('plugin-meetings', () => {
           roapMessage,
           reachability,
           permissionToken,
+          clientMediaPreferences
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
 
@@ -214,6 +216,7 @@ describe('plugin-meetings', () => {
         assert.equal(requestParams.body.device.countryCode, 'US');
         assert.equal(requestParams.body.permissionToken, 'permission-token');
         assert.equal(requestParams.body.device.regionCode, 'WEST-COAST');
+        assert.equal(requestParams.body.clientMediaPreferences, 'clientMediaPreferences');
         assert.include(requestParams.body.device.localIp, '127.0.0');
         assert.deepEqual(requestParams.body.localMedias, [
           {localSdp: '{"roapMessage":"roap-message","reachability":"reachability"}'},
@@ -386,32 +389,6 @@ describe('plugin-meetings', () => {
 
         assert.deepEqual(requestParams.body.alias, undefined);
       });
-
-      it('includes joinCookie and ipver correctly', async () => {
-        const locusUrl = 'locusURL';
-        const deviceUrl = 'deviceUrl';
-        const correlationId = 'random-uuid';
-        const roapMessage = 'roap-message';
-        const permissionToken = 'permission-token';
-
-        await meetingsRequest.joinMeeting({
-          locusUrl,
-          deviceUrl,
-          correlationId,
-          roapMessage,
-          permissionToken,
-          ipVersion: IP_VERSION.ipv4_and_ipv6,
-        });
-        const requestParams = meetingsRequest.request.getCall(0).args[0];
-
-        assert.equal(requestParams.method, 'POST');
-        assert.equal(requestParams.uri, `${locusUrl}/participant?alternateRedirect=true`);
-        assert.deepEqual(requestParams.body.clientMediaPreferences, {
-          joinCookie: {anycastEntryPoint: 'aws-eu-west-1'},
-          preferTranscoding: true,
-          ipver: 1,
-        });
-      });
     });
 
     describe('#pstn', () => {

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

@@ -22,6 +22,12 @@ describe('plugin-meetings', () => {
           meetings: Meetings,
         },
       });
+
+      webex.meetings.reachability = {
+        getReachabilityReportToAttachToRoap: sinon.stub().resolves({}),
+        getClientMediaPreferences: sinon.stub().resolves({}),
+      };  
+
       const logger = {
         info: sandbox.stub(),
         log: sandbox.stub(),
@@ -39,6 +45,7 @@ describe('plugin-meetings', () => {
       meeting.cleanupLocalStreams = sinon.stub().returns(Promise.resolve());
       meeting.closeRemoteStreams = sinon.stub().returns(Promise.resolve());
       meeting.closePeerConnections = sinon.stub().returns(Promise.resolve());
+      meeting.stopPeriodicLogUpload = sinon.stub();
 
       meeting.unsetRemoteStreams = sinon.stub();
       meeting.unsetPeerConnections = sinon.stub();
@@ -64,6 +71,7 @@ describe('plugin-meetings', () => {
         assert.calledOnce(meeting.cleanupLocalStreams);
         assert.calledOnce(meeting.closeRemoteStreams);
         assert.calledOnce(meeting.closePeerConnections);
+        assert.calledOnce(meeting.stopPeriodicLogUpload);
 
         assert.calledOnce(meeting.unsetRemoteStreams);
         assert.calledOnce(meeting.unsetPeerConnections);
@@ -408,17 +416,39 @@ describe('plugin-meetings', () => {
       });
 
       it('#Should call `meetingRequest.joinMeeting', async () => {
+        meeting.isMultistream = true;
+
+        const FAKE_REACHABILITY_REPORT = {
+          id: 'fake reachability report',
+        };
+        const FAKE_CLIENT_MEDIA_PREFERENCES = {
+          id: 'fake client media preferences',
+        };
+  
+        webex.meetings.reachability.getReachabilityReportToAttachToRoap.resolves(FAKE_REACHABILITY_REPORT);
+        webex.meetings.reachability.getClientMediaPreferences.resolves(FAKE_CLIENT_MEDIA_PREFERENCES);
+        
+        sinon
+          .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4')
+          .get(() => true);
+        sinon
+          .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6')
+          .get(() => true);
+          
         await MeetingUtil.joinMeeting(meeting, {
           reachability: 'reachability',
           roapMessage: 'roapMessage',
         });
 
+        assert.calledOnceWithExactly(webex.meetings.reachability.getReachabilityReportToAttachToRoap);
+        assert.calledOnceWithExactly(webex.meetings.reachability.getClientMediaPreferences, meeting.isMultistream, IP_VERSION.ipv4_and_ipv6);
+
         assert.calledOnce(meeting.meetingRequest.joinMeeting);
         const parameter = meeting.meetingRequest.joinMeeting.getCall(0).args[0];
 
         assert.equal(parameter.inviteeAddress, 'meetingJoinUrl');
-        assert.equal(parameter.preferTranscoding, true);
-        assert.equal(parameter.reachability, 'reachability');
+        assert.equal(parameter.reachability, FAKE_REACHABILITY_REPORT);
+        assert.equal(parameter.clientMediaPreferences, FAKE_CLIENT_MEDIA_PREFERENCES);
         assert.equal(parameter.roapMessage, 'roapMessage');
 
         assert.calledOnce(meeting.setLocus)
@@ -445,6 +475,29 @@ describe('plugin-meetings', () => {
         });
       });
 
+      it('should handle failed reachability report retrieval', async () => {
+        webex.meetings.reachability.getReachabilityReportToAttachToRoap.rejects(
+          new Error('fake error')
+        );
+        await MeetingUtil.joinMeeting(meeting, {});
+        // Verify meeting join still proceeds
+        assert.calledOnce(meeting.meetingRequest.joinMeeting);
+      });
+
+      it('should handle failed clientMediaPreferences retrieval', async () => {
+        webex.meetings.reachability.getClientMediaPreferences.rejects(new Error('fake error'));
+        meeting.isMultistream = true;
+        await MeetingUtil.joinMeeting(meeting, {});
+        // Verify meeting join still proceeds
+        assert.calledOnce(meeting.meetingRequest.joinMeeting);
+        const parameter = meeting.meetingRequest.joinMeeting.getCall(0).args[0];
+        assert.deepEqual(parameter.clientMediaPreferences, {
+          preferTranscoding: false,
+          ipver: 0,
+          joinCookie: undefined,
+        });
+      });
+
       it('#Should call meetingRequest.joinMeeting with breakoutsSupported=true when passed in as true', async () => {
         await MeetingUtil.joinMeeting(meeting, {
           breakoutsSupported: true,
@@ -480,17 +533,6 @@ describe('plugin-meetings', () => {
         assert.deepEqual(parameter.deviceCapabilities, ['TEST']);
       });
 
-      it('#Should call meetingRequest.joinMeeting with preferTranscoding=false when multistream is enabled', async () => {
-        meeting.isMultistream = true;
-        await MeetingUtil.joinMeeting(meeting, {});
-
-        assert.calledOnce(meeting.meetingRequest.joinMeeting);
-        const parameter = meeting.meetingRequest.joinMeeting.getCall(0).args[0];
-
-        assert.equal(parameter.inviteeAddress, 'meetingJoinUrl');
-        assert.equal(parameter.preferTranscoding, false);
-      });
-
       it('#Should fallback sipUrl if meetingJoinUrl does not exists', async () => {
         meeting.meetingJoinUrl = undefined;
         meeting.sipUri = 'sipUri';
@@ -1013,7 +1055,21 @@ describe('plugin-meetings', () => {
           assert.equal(MeetingUtil.getIpVersion(webex), expectedOutput);
         });
 
-        it(`returns undefined when supportsIpV4=${supportsIpV4} and supportsIpV6=${supportsIpV6} and browser is firefox`, () => {
+        it(`returns ${expectedOutput} when supportsIpV4=${supportsIpV4} and supportsIpV6=${supportsIpV6} for Firefox if config is enabled`, () => {
+          sinon
+            .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4')
+            .get(() => supportsIpV4);
+          sinon
+            .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6')
+            .get(() => supportsIpV6);
+
+          webex.config.meetings.backendIpv6NativeSupport = true;
+          isBrowserStub.callsFake((name) => name === 'firefox');
+
+          assert.equal(MeetingUtil.getIpVersion(webex), expectedOutput);
+        });
+
+        it(`returns undefined when supportsIpV4=${supportsIpV4} and supportsIpV6=${supportsIpV6}, config disabled and browser is firefox`, () => {
           sinon
             .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4')
             .get(() => supportsIpV4);
@@ -1021,6 +1077,7 @@ describe('plugin-meetings', () => {
             .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6')
             .get(() => supportsIpV6);
 
+          webex.config.meetings.backendIpv6NativeSupport = false;
           isBrowserStub.callsFake((name) => name === 'firefox');
 
           assert.equal(MeetingUtil.getIpVersion(webex), undefined);

package/test/unit/spec/meeting-info/meetinginfov2.js

@@ -18,6 +18,7 @@ import MeetingInfo, {
   MeetingInfoV2CaptchaError,
   MeetingInfoV2AdhocMeetingError,
   MeetingInfoV2PolicyError,
+  MeetingInfoV2WebinarRegistrationError,
 } from '@webex/plugin-meetings/src/meeting-info/meeting-info-v2';
 import MeetingInfoUtil from '@webex/plugin-meetings/src/meeting-info/utilv2';
 import Metrics from '@webex/plugin-meetings/src/metrics';
@@ -888,6 +889,42 @@ describe('plugin-meetings', () => {
           });
         }
       );
+
+      forEach(
+        [
+          {errorCode: 403021},
+          {errorCode: 403022},
+          {errorCode: 403024},
+        ],
+        ({errorCode}) => {
+          it(`should throw a MeetingInfoV2WebinarRegistrationError for error code ${errorCode}`, async () => {
+            const message = 'a message';
+            const meetingInfoData = {meetingInfo: {registrationUrl: 'registrationUrl'}};
+
+            webex.request = sinon.stub().rejects({
+              statusCode: 403,
+              body: {message, code: errorCode, data: {meetingInfo: meetingInfoData}},
+            });
+            try {
+              await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID);
+              assert.fail('createAdhocSpaceMeeting should have thrown, but has not done that');
+            } catch (err) {
+              assert.instanceOf(err, MeetingInfoV2WebinarRegistrationError);
+              assert.deepEqual(err.message, `${message}, code=${errorCode}`);
+              assert.equal(err.wbxAppApiCode, errorCode);
+              assert.deepEqual(err.meetingInfo, meetingInfoData);
+
+              assert(Metrics.sendBehavioralMetric.calledOnce);
+              assert.calledWith(
+                Metrics.sendBehavioralMetric,
+                BEHAVIORAL_METRICS.WEBINAR_REGISTRATION_ERROR,
+                {code: errorCode}
+              );
+
+            }
+          });
+        }
+      );
     });
   });
 });

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

@@ -131,9 +131,9 @@ describe('plugin-meetings', () => {
         logger,
         people: {
           _getMe: sinon.stub().resolves({
-            type: 'validuser', 
+            type: 'validuser',
           }),
-        }
+        },
       });
 
       startReachabilityStub = sinon.stub(webex.meetings, 'startReachability').resolves();
@@ -345,6 +345,22 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#_toggleIpv6BackendNativeSupport', () => {
+      it('should have _toggleIpv6BackendNativeSupport', () => {
+        assert.equal(typeof webex.meetings._toggleIpv6BackendNativeSupport, 'function');
+      });
+
+      describe('success', () => {
+        it('should update meetings config accordingly', () => {
+          webex.meetings._toggleIpv6BackendNativeSupport(true);
+          assert.equal(webex.meetings.config.backendIpv6NativeSupport, true);
+
+          webex.meetings._toggleIpv6BackendNativeSupport(false);
+          assert.equal(webex.meetings.config.backendIpv6NativeSupport, false);
+        });
+      });
+    });
+
     describe('Public API Contracts', () => {
       describe('#register', () => {
         it('emits an event and resolves when register succeeds', async () => {
@@ -1969,6 +1985,8 @@ describe('plugin-meetings', () => {
             const meetingIds = {
               meetingId: meeting.id,
               correlationId: meeting.correlationId,
+              roles: meeting.roles,
+              callStateForMetrics: meeting.callStateForMetrics,
             };
 
             webex.meetings.destroy(meeting, test1);
@@ -2005,6 +2023,8 @@ describe('plugin-meetings', () => {
 
             assert.equal(deletedMeetingInfo.id, meetingIds.meetingId);
             assert.equal(deletedMeetingInfo.correlationId, meetingIds.correlationId);
+            assert.equal(deletedMeetingInfo.roles, meetingIds.roles);
+            assert.equal(deletedMeetingInfo.callStateForMetrics, meetingIds.callStateForMetrics);
           });
         });
 
@@ -2061,7 +2081,22 @@ describe('plugin-meetings', () => {
           ]);
         });
 
-        const setup = ({me = { type: 'validuser'}, user} = {}) => {
+        it('should handle failure to get user information if scopes are insufficient', async () => {
+          loggerProxySpy = sinon.spy(LoggerProxy.logger, 'error');
+          Object.assign(webex.people, {
+            _getMe: sinon.stub().returns(Promise.reject()),
+          });
+
+          await webex.meetings.fetchUserPreferredWebexSite();
+
+          assert.equal(webex.meetings.preferredWebexSite, '');
+          assert.calledOnceWithExactly(
+            loggerProxySpy,
+            'Failed to retrieve user information. No preferredWebexSite will be set'
+          );
+        });
+
+        const setup = ({me = {type: 'validuser'}, user} = {}) => {
           loggerProxySpy = sinon.spy(LoggerProxy.logger, 'error');
           assert.deepEqual(webex.internal.services._getCatalog().getAllowedDomains(), []);
 
@@ -2077,14 +2112,14 @@ describe('plugin-meetings', () => {
 
           Object.assign(webex.people, {
             _getMe: sinon.stub().returns(Promise.resolve(me)),
-        });
+          });
         };
 
         it('should not call request.getMeetingPreferences if user is a guest', async () => {
           setup({me: {type: 'appuser'}});
-      
+
           await webex.meetings.fetchUserPreferredWebexSite();
-      
+
           assert.equal(webex.meetings.preferredWebexSite, '');
           assert.deepEqual(webex.internal.services._getCatalog().getAllowedDomains(), []);
           assert.notCalled(webex.internal.services.getMeetingPreferences);

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

@@ -660,17 +660,20 @@ describe('plugin-meetings', () => {
         resultPromise,
         spies,
         expectedRequestingMemberId,
-        expectedLocusUrl
+        expectedLocusUrl,
+        expectedRoles,
       ) => {
         await assert.isFulfilled(resultPromise);
         assert.calledOnceWithExactly(
           spies.generateLowerAllHandsMemberOptions,
           expectedRequestingMemberId,
-          expectedLocusUrl
+          expectedLocusUrl,
+          expectedRoles,
         );
         assert.calledOnceWithExactly(spies.lowerAllHandsMember, {
           requestingParticipantId: expectedRequestingMemberId,
           locusUrl: expectedLocusUrl,
+          ...(expectedRoles !== undefined && { roles: expectedRoles })
         });
         assert.strictEqual(resultPromise, spies.lowerAllHandsMember.getCall(0).returnValue);
       };
@@ -707,6 +710,26 @@ describe('plugin-meetings', () => {
 
         await checkValid(resultPromise, spies, requestingMemberId, url1);
       });
+
+      it('should make the correct request when called with valid requestingMemberId and roles', async () => {
+        const requestingMemberId = 'test-member-id';
+        const roles = ['panelist', 'attendee'];
+        const { members, spies } = setup('test-locus-url');
+
+        const resultPromise = members.lowerAllHands(requestingMemberId, roles);
+
+        await checkValid(resultPromise, spies, requestingMemberId, 'test-locus-url', roles);
+      });
+
+      it('should handle an empty roles array correctly', async () => {
+        const requestingMemberId = 'test-member-id';
+        const roles = [];
+        const { members, spies } = setup('test-locus-url');
+
+        const resultPromise = members.lowerAllHands(requestingMemberId, roles);
+
+        await checkValid(resultPromise, spies, requestingMemberId, 'test-locus-url', roles);
+      });
     });
 
     describe('#editDisplayName', () => {

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

@@ -225,7 +225,7 @@ describe('plugin-meetings', () => {
     });
 
     describe('#assignRolesMember', () => {
-      it('sends a PATCH to the locus endpoint', async () => {
+      it('sends a assignRolesMember PATCH to the locus endpoint', async () => {
         const locusUrl = url1;
         const memberId = 'test1';
         const roles = [
@@ -255,7 +255,7 @@ describe('plugin-meetings', () => {
     });
 
     describe('#raiseHand', () => {
-      it('sends a PATCH to the locus endpoint', async () => {
+      it('sends a raiseOrLowerHandMember PATCH to the locus endpoint', async () => {
         const locusUrl = url1;
         const memberId = 'test1';
 
@@ -319,7 +319,7 @@ describe('plugin-meetings', () => {
         assert.strictEqual(result, requestResponse);
       });
 
-      it('sends a PATCH to the locus endpoint', async () => {
+      it('sends a lowerAllHandsMember PATCH to the locus endpoint', async () => {
         const locusUrl = url1;
         const memberId = 'test1';
 
@@ -348,6 +348,40 @@ describe('plugin-meetings', () => {
           },
         });
       });
+
+      it('sends a lowerAllHandsMember PATCH to the locus endpoint with roles', async () => {
+        const locusUrl = url1;
+        const memberId = 'test1';
+        const roles = ['attendee'];
+
+        const options = {
+          requestingParticipantId: memberId,
+          locusUrl,
+          roles,
+        };
+
+        const getRequestParamsSpy = sandbox.spy(membersUtil, 'getLowerAllHandsMemberRequestParams');
+
+        await membersRequest.lowerAllHandsMember(options);
+
+        assert.calledOnceWithExactly(getRequestParamsSpy, {
+          requestingParticipantId: memberId,
+          locusUrl: url1,
+          roles: ['attendee'],
+        });
+
+        checkRequest({
+          method: 'PATCH',
+          uri: `${locusUrl}/controls`,
+          body: {
+            hand: {
+              raised: false,
+              roles: ['attendee'],
+            },
+            requestingParticipantId: memberId,
+          },
+        });
+      });
     });
 
     describe('#editDisplayName', () => {