@webex/plugin-meetings 3.8.0-next.5 → 3.8.0-next.7

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,7 +167,7 @@ describe('LocusMediaRequest.send()', () => {
 
     webexRequestStub.resetHistory();
     mockWebex.internal.newMetrics.submitClientEvent.resetHistory();
-  }
+  };
 
   const checkMetrics = (expectedMetrics: boolean = true) => {
     if (expectedMetrics) {
@@ -170,7 +187,7 @@ describe('LocusMediaRequest.send()', () => {
     } else {
       assert.notCalled(mockWebex.internal.newMetrics.submitClientEvent);
     }
-  }
+  };
 
   it('sends a roap message', async () => {
     const result = await sendRoapMessage('OFFER');
@@ -181,6 +198,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),
     });
 
     checkMetrics();
@@ -210,6 +229,8 @@ 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);
@@ -228,6 +249,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 +260,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,6 +279,8 @@ 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);
@@ -277,6 +300,8 @@ 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);
@@ -296,6 +321,8 @@ 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();
@@ -328,10 +355,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 +369,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 +393,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 +417,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 +443,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 +473,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 +500,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 +525,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 +536,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),
       });
     });
-
   });
-})
+});