@webex/plugin-meetings 3.8.0 → 3.8.1-next.1

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

@@ -1,14 +1,18 @@
 import 'jsdom-global/register';
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
-import { cloneDeep } from 'lodash';
-
+import {cloneDeep} from 'lodash';
+import {EventEmitter} from 'events';
 import MockWebex from '@webex/test-helper-mock-webex';
 import Meetings from '@webex/plugin-meetings';
-import { LocalMuteRequest, LocusMediaRequest, RoapRequest } from "@webex/plugin-meetings/src/meeting/locusMediaRequest";
+import {
+  LocalMuteRequest,
+  LocusMediaRequest,
+  RoapRequest,
+} from '@webex/plugin-meetings/src/meeting/locusMediaRequest';
 import testUtils from '../../../utils/testUtils';
-import { Defer } from '@webex/common';
-import { IP_VERSION } from '../../../../src/constants';
+import {Defer} from '@webex/common';
+import {IP_VERSION} from '../../../../src/constants';
 
 describe('LocusMediaRequest.send()', () => {
   let locusMediaRequest: LocusMediaRequest;
@@ -16,10 +20,10 @@ describe('LocusMediaRequest.send()', () => {
   let mockWebex;
 
   const fakeLocusResponse = {
-    locus: { something: 'whatever'}
+    locus: {something: 'whatever'},
   };
 
-  const exampleRoapRequestBody:RoapRequest = {
+  const exampleRoapRequestBody: RoapRequest = {
     type: 'RoapMessage',
     mediaId: 'mediaId',
     selfUrl: 'fakeMeetingSelfUrl',
@@ -31,8 +35,11 @@ describe('LocusMediaRequest.send()', () => {
       tieBreaker: 0xfffffffe,
     },
     reachability: {
-      'wjfkm.wjfkm.*': {udp:{reachable: true}, tcp:{reachable:false}},
-      '1eb65fdf-9643-417f-9974-ad72cae0e10f.59268c12-7a04-4b23-a1a1-4c74be03019a.*': {udp:{reachable: false}, tcp:{reachable:true}},
+      'wjfkm.wjfkm.*': {udp: {reachable: true}, tcp: {reachable: false}},
+      '1eb65fdf-9643-417f-9974-ad72cae0e10f.59268c12-7a04-4b23-a1a1-4c74be03019a.*': {
+        udp: {reachable: false},
+        tcp: {reachable: true},
+      },
     },
     clientMediaPreferences: {
       preferTranscoding: false,
@@ -45,19 +52,22 @@ describe('LocusMediaRequest.send()', () => {
       reachability: {
         version: '1',
         result: 'some fake reachability result',
-      }
-    }
+      },
+    },
   };
 
-  const createExpectedRoapBody = (expectedMessageType, expectedMute:{audioMuted: boolean, videoMuted: boolean}) => {
+  const createExpectedRoapBody = (
+    expectedMessageType,
+    expectedMute: {audioMuted: boolean; videoMuted: boolean}
+  ) => {
     return {
-      device: { url: 'deviceUrl', deviceType: 'deviceType', regionCode: 'regionCode' },
+      device: {url: 'deviceUrl', deviceType: 'deviceType', regionCode: 'regionCode'},
       correlationId: 'correlationId',
       localMedias: [
         {
           localSdp: `{"audioMuted":${expectedMute.audioMuted},"videoMuted":${expectedMute.videoMuted},"roapMessage":{"messageType":"${expectedMessageType}","sdps":["sdp"],"version":"2","seq":1,"tieBreaker":4294967294},"reachability":{"wjfkm.wjfkm.*":{"udp":{"reachable":true},"tcp":{"reachable":false}},"1eb65fdf-9643-417f-9974-ad72cae0e10f.59268c12-7a04-4b23-a1a1-4c74be03019a.*":{"udp":{"reachable":false},"tcp":{"reachable":true}}}}`,
-          mediaId: 'mediaId'
-        }
+          mediaId: 'mediaId',
+        },
       ],
       clientMediaPreferences: {
         preferTranscoding: false,
@@ -65,24 +75,27 @@ describe('LocusMediaRequest.send()', () => {
         joinCookie: {
           anycastEntryPoint: 'aws-eu-west-1',
           clientIpAddress: 'some ip',
-          timeShot: '2023-05-23T08:03:49Z'
+          timeShot: '2023-05-23T08:03:49Z',
         },
         reachability: {
           version: '1',
           result: 'some fake reachability result',
-        }
-      }
+        },
+      },
     };
   };
 
-  const exampleLocalMuteRequestBody:LocalMuteRequest = {
+  const exampleLocalMuteRequestBody: LocalMuteRequest = {
     type: 'LocalMute',
     mediaId: 'mediaId',
     selfUrl: 'fakeMeetingSelfUrl',
     muteOptions: {},
   };
 
-  const createExpectedLocalMuteBody = (expectedMute:{audioMuted: boolean, videoMuted: boolean}, sequence = undefined) => {
+  const createExpectedLocalMuteBody = (
+    expectedMute: {audioMuted: boolean; videoMuted: boolean},
+    sequence = undefined
+  ) => {
     const body: any = {
       device: {
         url: 'deviceUrl',
@@ -116,33 +129,37 @@ describe('LocusMediaRequest.send()', () => {
 
     mockWebex.internal = {
       newMetrics: {
-        submitClientEvent: sinon.stub()
+        submitClientEvent: sinon.stub(),
       },
     };
 
-    locusMediaRequest = new LocusMediaRequest({
-      device: {
-        url: 'deviceUrl',
-        deviceType: 'deviceType',
-        regionCode: 'regionCode',
+    locusMediaRequest = new LocusMediaRequest(
+      {
+        device: {
+          url: 'deviceUrl',
+          deviceType: 'deviceType',
+          regionCode: 'regionCode',
+        },
+        correlationId: 'correlationId',
+        meetingId: 'meetingId',
+        preferTranscoding: true,
       },
-      correlationId: 'correlationId',
-      meetingId: 'meetingId',
-      preferTranscoding: true,
-    }, {
-      parent: mockWebex,
-    });
+      {
+        parent: mockWebex,
+      }
+    );
     webexRequestStub = sinon.stub(locusMediaRequest, 'request').resolves(fakeLocusResponse);
-  })
+  });
 
-  const sendLocalMute = (muteOptions, overrides={}) => locusMediaRequest.send({...exampleLocalMuteRequestBody, ...overrides, muteOptions});
+  const sendLocalMute = (muteOptions, overrides = {}) =>
+    locusMediaRequest.send({...exampleLocalMuteRequestBody, ...overrides, muteOptions});
 
   const sendRoapMessage = (messageType) => {
     const request = cloneDeep(exampleRoapRequestBody);
 
     request.roapMessage.messageType = messageType;
     return locusMediaRequest.send(request);
-  }
+  };
 
   /** Helper function that makes sure the LocusMediaRequest.confluenceState is 'created' */
   const ensureConfluenceCreated = async () => {
@@ -150,27 +167,7 @@ describe('LocusMediaRequest.send()', () => {
 
     webexRequestStub.resetHistory();
     mockWebex.internal.newMetrics.submitClientEvent.resetHistory();
-  }
-
-  const checkMetrics = (expectedMetrics: boolean = true) => {
-    if (expectedMetrics) {
-      assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
-        name: 'client.locus.media.request',
-        options: {
-          meetingId: 'meetingId',
-        },
-      });
-
-      assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
-        name: 'client.locus.media.response',
-        options: {
-          meetingId: 'meetingId',
-        },
-      });
-    } else {
-      assert.notCalled(mockWebex.internal.newMetrics.submitClientEvent);
-    }
-  }
+  };
 
   it('sends a roap message', async () => {
     const result = await sendRoapMessage('OFFER');
@@ -181,9 +178,9 @@ describe('LocusMediaRequest.send()', () => {
       method: 'PUT',
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedRoapBody('OFFER', {audioMuted: true, videoMuted: true}),
+      upload: sinon.match.instanceOf(EventEmitter),
+      download: sinon.match.instanceOf(EventEmitter),
     });
-
-    checkMetrics();
   });
 
   it('sends correct metric event when roap message fails', async () => {
@@ -210,9 +207,9 @@ describe('LocusMediaRequest.send()', () => {
       method: 'PUT',
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: false}),
+      upload: sinon.match.instanceOf(EventEmitter),
+      download: sinon.match.instanceOf(EventEmitter),
     });
-
-    checkMetrics(false);
   });
 
   it('sends a local mute request with sequence', async () => {
@@ -228,6 +225,8 @@ describe('LocusMediaRequest.send()', () => {
       method: 'PUT',
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: false}, sequence),
+      upload: sinon.match.instanceOf(EventEmitter),
+      download: sinon.match.instanceOf(EventEmitter),
     });
   });
 
@@ -237,15 +236,13 @@ describe('LocusMediaRequest.send()', () => {
     let result1;
     let result2;
 
-    const promise1 = sendLocalMute({audioMuted: true, videoMuted: false})
-      .then((result) => {
-        result1 = result;
-      });
+    const promise1 = sendLocalMute({audioMuted: true, videoMuted: false}).then((result) => {
+      result1 = result;
+    });
 
-    const promise2 = sendLocalMute({audioMuted: false, videoMuted: true})
-      .then((result) => {
-        result2 = result;
-      });
+    const promise2 = sendLocalMute({audioMuted: false, videoMuted: true}).then((result) => {
+      result2 = result;
+    });
 
     await testUtils.flushPromises();
 
@@ -258,9 +255,9 @@ describe('LocusMediaRequest.send()', () => {
       method: 'PUT',
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: true}),
+      upload: sinon.match.instanceOf(EventEmitter),
+      download: sinon.match.instanceOf(EventEmitter),
     });
-
-    checkMetrics(false);
   });
 
   it('sends a local mute request with the last audio/video mute values', async () => {
@@ -277,9 +274,9 @@ describe('LocusMediaRequest.send()', () => {
       method: 'PUT',
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedLocalMuteBody({audioMuted: true, videoMuted: false}),
+      upload: sinon.match.instanceOf(EventEmitter),
+      download: sinon.match.instanceOf(EventEmitter),
     });
-
-    checkMetrics(false);
   });
 
   it('sends only roap when roap and local mute are requested', async () => {
@@ -296,9 +293,9 @@ describe('LocusMediaRequest.send()', () => {
       method: 'PUT',
       uri: 'fakeMeetingSelfUrl/media',
       body: createExpectedRoapBody('OFFER', {audioMuted: true, videoMuted: false}),
+      upload: sinon.match.instanceOf(EventEmitter),
+      download: sinon.match.instanceOf(EventEmitter),
     });
-
-    checkMetrics();
   });
 
   describe('queueing', () => {
@@ -328,10 +325,10 @@ describe('LocusMediaRequest.send()', () => {
      * after the processing cycle from which it was called is finished.
      * This helper function waits for this to happen - it's needed, because we're using
      * fake timers in these tests
-    */
+     */
     const ensureQueueProcessingIsStarted = () => {
       clock.tick(1);
-    }
+    };
     it('queues requests if there is one already in progress', async () => {
       results.push(sendRoapMessage('OFFER'));
 
@@ -342,6 +339,8 @@ describe('LocusMediaRequest.send()', () => {
         method: 'PUT',
         uri: 'fakeMeetingSelfUrl/media',
         body: createExpectedRoapBody('OFFER', {audioMuted: true, videoMuted: true}),
+        upload: sinon.match.instanceOf(EventEmitter),
+        download: sinon.match.instanceOf(EventEmitter),
       });
 
       webexRequestStub.resetHistory();
@@ -364,6 +363,8 @@ describe('LocusMediaRequest.send()', () => {
         method: 'PUT',
         uri: 'fakeMeetingSelfUrl/media',
         body: createExpectedRoapBody('OK', {audioMuted: true, videoMuted: true}),
+        upload: sinon.match.instanceOf(EventEmitter),
+        download: sinon.match.instanceOf(EventEmitter),
       });
 
       // promise returned by the first call to send OFFER should be resolved by now
@@ -386,6 +387,8 @@ describe('LocusMediaRequest.send()', () => {
         method: 'PUT',
         uri: 'fakeMeetingSelfUrl/media',
         body: createExpectedRoapBody('OFFER', {audioMuted: false, videoMuted: false}),
+        upload: sinon.match.instanceOf(EventEmitter),
+        download: sinon.match.instanceOf(EventEmitter),
       });
 
       webexRequestStub.resetHistory();
@@ -410,6 +413,8 @@ describe('LocusMediaRequest.send()', () => {
         method: 'PUT',
         uri: 'fakeMeetingSelfUrl/media',
         body: createExpectedRoapBody('OK', {audioMuted: false, videoMuted: true}),
+        upload: sinon.match.instanceOf(EventEmitter),
+        download: sinon.match.instanceOf(EventEmitter),
       });
 
       // promise returned by the first call to send OFFER should be resolved by now
@@ -438,16 +443,17 @@ describe('LocusMediaRequest.send()', () => {
 
         ensureQueueProcessingIsStarted();
 
-        sendLocalMute({audioMuted: false, videoMuted: true})
-          .then((response) => {
-            result = response;
-          });
+        sendLocalMute({audioMuted: false, videoMuted: true}).then((response) => {
+          result = response;
+        });
 
         // only roap offer should have been sent so far
         assert.calledOnceWithExactly(webexRequestStub, {
           method: 'PUT',
           uri: 'fakeMeetingSelfUrl/media',
           body: createExpectedRoapBody('OFFER', {audioMuted: true, videoMuted: true}),
+          upload: sinon.match.instanceOf(EventEmitter),
+          download: sinon.match.instanceOf(EventEmitter),
         });
         assert.equal(result, undefined); // sendLocalMute shouldn't resolve yet, as the request should be queued
         assert.equal(locusMediaRequest.isConfluenceCreated(), false);
@@ -464,10 +470,12 @@ describe('LocusMediaRequest.send()', () => {
           method: 'PUT',
           uri: 'fakeMeetingSelfUrl/media',
           body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: true}),
+          upload: sinon.match.instanceOf(EventEmitter),
+          download: sinon.match.instanceOf(EventEmitter),
         });
 
         // check also the result once Locus replies to local mute
-        const fakeLocusResponse = { response: 'ok'};
+        const fakeLocusResponse = {response: 'ok'};
         requestsToLocus[1].resolve(fakeLocusResponse);
         await testUtils.flushPromises();
         assert.deepEqual(result, fakeLocusResponse);
@@ -487,10 +495,9 @@ describe('LocusMediaRequest.send()', () => {
       assert.equal(locusMediaRequest.isConfluenceCreated(), true);
 
       // now send local mute
-      sendLocalMute({audioMuted: false, videoMuted: true})
-        .then((response) => {
-          result = response;
-        });
+      sendLocalMute({audioMuted: false, videoMuted: true}).then((response) => {
+        result = response;
+      });
 
       ensureQueueProcessingIsStarted();
 
@@ -499,8 +506,9 @@ describe('LocusMediaRequest.send()', () => {
         method: 'PUT',
         uri: 'fakeMeetingSelfUrl/media',
         body: createExpectedLocalMuteBody({audioMuted: false, videoMuted: true}),
+        upload: sinon.match.instanceOf(EventEmitter),
+        download: sinon.match.instanceOf(EventEmitter),
       });
     });
-
   });
-})
+});

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

@@ -2,7 +2,6 @@ import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
 import {createMuteState, MuteState} from '@webex/plugin-meetings/src/meeting/muteState';
-import PermissionError from '@webex/plugin-meetings/src/common/errors/permission';
 import {AUDIO, VIDEO} from '@webex/plugin-meetings/src/constants';
 
 import testUtils from '../../../utils/testUtils';
@@ -39,7 +38,6 @@ describe('plugin-meetings', () => {
       unmuteAllowed: true,
       remoteVideoMuted: false,
       unmuteVideoAllowed: true,
-
       locusInfo: {
         handleLocusDelta: sinon.stub(),
       },
@@ -778,5 +776,78 @@ describe('plugin-meetings', () => {
         })
       );
     });
+
+    describe('#enable', () => {
+      let locusLocalMuteStub;
+      let locusRemoteMuteStub;
+
+      const resetStubHistory = () => {
+        locusLocalMuteStub.resetHistory();
+        locusRemoteMuteStub.resetHistory();
+      };
+
+      beforeEach(async () => {
+        locusLocalMuteStub = MeetingUtil.remoteUpdateAudioVideo;
+        locusRemoteMuteStub = meeting.members.muteMember;
+
+        // initialise the MuteState with the stream
+        audio.handleLocalStreamChange(meeting);
+        await testUtils.flushPromises();
+
+        resetStubHistory();
+      });
+
+      it('does not do anything if current state is already the same', async () => {
+        // set it up so that we are remotely muted (so that a sync to server would do a remote unmute)
+        audio.handleServerRemoteMuteUpdate(meeting, true, true);
+
+        // audio is already enabled and we call to enable it again
+        audio.enable(meeting, true);
+        await testUtils.flushPromises();
+
+        // nothing should happen (especially no remote unmute)
+        assert.notCalled(locusRemoteMuteStub);
+        assert.notCalled(locusLocalMuteStub);
+
+        // now disable audio
+        audio.enable(meeting, false);
+        await testUtils.flushPromises();
+
+        resetStubHistory();
+
+        // disable it again
+        audio.enable(meeting, false);
+        await testUtils.flushPromises();
+
+        // nothing should happen
+        assert.notCalled(locusRemoteMuteStub);
+        assert.notCalled(locusLocalMuteStub);
+      });
+
+      it('does necessary local and remote mute changes when called with a new state', async () => {
+        // initial state is audio enabled with nothing muted
+
+        // now we disable audio
+        audio.enable(meeting, false);
+        await testUtils.flushPromises();
+
+        // so only a local mute should be done
+        assert.notCalled(locusRemoteMuteStub);
+        assert.calledWith(locusLocalMuteStub, meeting, true, undefined);
+
+        resetStubHistory();
+
+        // now simulate additionally a remote mute
+        audio.state.server.remoteMute = true;
+
+        // and enable audio back
+        audio.enable(meeting, true);
+        await testUtils.flushPromises();
+
+        // both local and remote unmute should be done
+        assert.calledWith(locusRemoteMuteStub, meeting.members.selfId, false, true);
+        assert.calledWith(locusLocalMuteStub, meeting, false, undefined);
+      });
+    });
   });
 });

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

@@ -1,4 +1,5 @@
 import 'jsdom-global/register';
+import {v4 as uuidv4} from 'uuid';
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
@@ -205,7 +206,7 @@ describe('plugin-meetings', () => {
           roapMessage,
           reachability,
           permissionToken,
-          clientMediaPreferences
+          clientMediaPreferences,
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
 
@@ -630,6 +631,36 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#setPostMeetingDataConsent', () => {
+      [true, false].forEach((consent) => {
+        it(`sends request to set post meeting data consent with ${consent}`, async () => {
+          const locusUrl = `https://locus-test.wbx2.com/locus/api/v1/loci/${consent}`;
+          const selfId = uuidv4();
+          const deviceUrl = `https://wdm-test.wbx2.com/wdm/api/v1/devices/${consent}`;
+
+          const consentPromise = meetingsRequest.setPostMeetingDataConsent({
+            postMeetingDataConsent: consent,
+            locusUrl,
+            selfId,
+            deviceUrl,
+          });
+          assert.exists(consentPromise.then);
+          await consentPromise;
+
+          checkRequest({
+            method: 'PATCH',
+            uri: `${locusUrl}/participant/${selfId}/controls`,
+            body: {
+              consent: {
+                postMeetingDataConsent: consent,
+                deviceUrl,
+              },
+            },
+          });
+        });
+      });
+    });
+
     describe('#prepareLeaveMeetingRequestOptions', () => {
       it('returns expected result', async () => {
         const result = meetingsRequest.prepareLeaveMeetingRequestOptions({