@webex/plugin-meetings 3.0.0-beta.41 → 3.0.0-beta.43

package/src/multistream/receiveSlotManager.ts

@@ -1,11 +1,13 @@
 /* eslint-disable valid-jsdoc */
 /* eslint-disable import/prefer-default-export */
-import {MediaType} from '@webex/internal-media-core';
-
+import {MediaType, ReceiveSlot as WcmeReceiveSlot} from '@webex/internal-media-core';
 import LoggerProxy from '../common/logs/logger-proxy';
-import Meeting from '../meeting';
 
-import {CSI, ReceiveSlot} from './receiveSlot';
+import {FindMemberIdCallback, ReceiveSlot} from './receiveSlot';
+
+export type CreateSlotCallback = (mediaType: MediaType) => Promise<WcmeReceiveSlot>;
+
+export type {CSI, FindMemberIdCallback} from './receiveSlot';
 
 /**
  * Manages all receive slots used by a meeting. WMCE receive slots cannot be ever deleted,
@@ -16,13 +18,18 @@ export class ReceiveSlotManager {
 
   private freeSlots: {[key in MediaType]: ReceiveSlot[]};
 
-  private meeting: Meeting;
+  private createSlotCallback: CreateSlotCallback;
+
+  private findMemberIdByCsiCallback: FindMemberIdCallback;
 
   /**
    * Constructor
    * @param {Meeting} meeting
    */
-  constructor(meeting) {
+  constructor(
+    createSlotCallback: CreateSlotCallback,
+    findMemberIdByCsiCallback: FindMemberIdCallback
+  ) {
     this.allocatedSlots = {
       [MediaType.AudioMain]: [],
       [MediaType.VideoMain]: [],
@@ -35,7 +42,8 @@ export class ReceiveSlotManager {
       [MediaType.AudioSlides]: [],
       [MediaType.VideoSlides]: [],
     };
-    this.meeting = meeting;
+    this.createSlotCallback = createSlotCallback;
+    this.findMemberIdByCsiCallback = findMemberIdByCsiCallback;
   }
 
   /**
@@ -45,10 +53,6 @@ export class ReceiveSlotManager {
    * @returns {Promise<ReceiveSlot>}
    */
   async allocateSlot(mediaType: MediaType): Promise<ReceiveSlot> {
-    if (!this.meeting?.mediaProperties?.webrtcMediaConnection) {
-      return Promise.reject(new Error('Webrtc media connection is missing'));
-    }
-
     // try to use one of the free ones
     const availableSlot = this.freeSlots[mediaType].pop();
 
@@ -61,15 +65,9 @@ export class ReceiveSlotManager {
     }
 
     // we have to create a new one
-    const wcmeReceiveSlot =
-      await this.meeting.mediaProperties.webrtcMediaConnection.createReceiveSlot(mediaType);
-
-    const receiveSlot = new ReceiveSlot(
-      mediaType,
-      wcmeReceiveSlot,
-      // @ts-ignore
-      (csi: CSI) => this.meeting.members.findMemberByCsi(csi)?.id
-    );
+    const wcmeReceiveSlot = await this.createSlotCallback(mediaType);
+
+    const receiveSlot = new ReceiveSlot(mediaType, wcmeReceiveSlot, this.findMemberIdByCsiCallback);
 
     this.allocatedSlots[mediaType].push(receiveSlot);
     LoggerProxy.logger.log(`new receive slot allocated: ${receiveSlot.id}`);

package/test/unit/spec/controls-options-manager/index.js

@@ -119,6 +119,62 @@ describe('plugin-meetings', () => {
                     });
                   });
             });
+
+            describe('Mute/Unmute All', () => {
+              let manager;
+              beforeEach(() => {
+                request = {
+                  request: sinon.stub().returns(Promise.resolve()),
+                };
+
+                manager = new ControlsOptionsManager(request);
+
+                manager.set({
+                  locusUrl: 'test/id',
+                  displayHints: [],
+                })
+              });
+
+              it('rejects when correct display hint is not present mutedEnabled=false', () => {  
+                const result = manager.setMuteAll(false, false, false);
+
+                assert.notCalled(request.request);
+
+                assert.isRejected(result);
+              });
+
+              it('rejects when correct display hint is not present mutedEnabled=true', () => {  
+                const result = manager.setMuteAll(true, false, false);
+
+                assert.notCalled(request.request);
+
+                assert.isRejected(result);
+              });
+
+              it('can set mute all when the display hint is available mutedEnabled=true', () => {
+                manager.setDisplayHints(['MUTE_ALL', 'ENABLE_HARD_MUTE', 'ENABLE_MUTE_ON_ENTRY']);
+
+                const result = manager.setMuteAll(true, true, true);
+
+                assert.calledWith(request.request, {  uri: 'test/id/controls',
+                body: { audio: { muted: true, disallowUnmute: true, muteOnEntry: true } },
+                method: HTTP_VERBS.PATCH});
+
+                assert.deepEqual(result, request.request.firstCall.returnValue);
+              });
+
+              it('can set mute all when the display hint is available mutedEnabled=false', () => {
+                manager.setDisplayHints(['UNMUTE_ALL', 'DISABLE_HARD_MUTE', 'DISABLE_MUTE_ON_ENTRY']);
+
+                const result = manager.setMuteAll(false, false, false);
+
+                assert.calledWith(request.request, {  uri: 'test/id/controls',
+                body: { audio: { muted: false, disallowUnmute: false, muteOnEntry: false } },
+                method: HTTP_VERBS.PATCH});
+
+                assert.deepEqual(result, request.request.firstCall.returnValue);
+              });
+            });
           });
     });
 });

package/test/unit/spec/controls-options-manager/util.js

@@ -61,6 +61,26 @@ describe('plugin-meetings', () => {
               });
             });
 
+            describe('canSetMuteAll', () => {
+              it('can mute all', () => {
+                locusInfo.parsedLocus.info.userDisplayHints.push('MUTE_ALL');
+
+                assert.equal(ControlsOptionsUtil.canSetMuted(locusInfo.parsedLocus.info.userDisplayHints), true);
+              });
+
+              it('can unmute all', () => {
+                locusInfo.parsedLocus.info.userDisplayHints.push('UNMUTE_ALL');
+
+                assert.equal(ControlsOptionsUtil.canUnsetMuted(locusInfo.parsedLocus.info.userDisplayHints), true);
+              });
+              it('rejects when correct display hint is not present', () => {
+                assert.equal(ControlsOptionsUtil.canSetMuted(locusInfo.parsedLocus.info.userDisplayHints), false);
+              });
+
+              it('rejects when correct display hint is not present', () => {
+                assert.equal(ControlsOptionsUtil.canUnsetMuted(locusInfo.parsedLocus.info.userDisplayHints), false);
+              });
+            });
         });
     });
 });

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

@@ -17,6 +17,8 @@ describe('plugin-meetings', () => {
         canUnsetMuteOnEntry: null,
         canSetDisallowUnmute: null,
         canUnsetDisallowUnmute: null,
+        canSetMuted: null,
+        canUnsetMuted: null,
         canStopRecording: null,
         canRaiseHand: null,
         canLowerAllHands: null,

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

@@ -23,7 +23,7 @@ import {
   PC_BAIL_TIMEOUT,
 } from '@webex/plugin-meetings/src/constants';
 import * as InternalMediaCoreModule from '@webex/internal-media-core';
-import {ConnectionState, Event, Errors, ErrorType, LocalTrackEvents, RemoteTrackType} from '@webex/internal-media-core';
+import {ConnectionState, Event, Errors, ErrorType, LocalTrackEvents, RemoteTrackType, MediaType} from '@webex/internal-media-core';
 import * as StatsAnalyzerModule from '@webex/plugin-meetings/src/statsAnalyzer';
 import * as MuteStateModule from '@webex/plugin-meetings/src/meeting/muteState';
 import EventsScope from '@webex/plugin-meetings/src/common/events/events-scope';
@@ -47,8 +47,8 @@ import BrowserDetection from '@webex/plugin-meetings/src/common/browser-detectio
 import Metrics from '@webex/plugin-meetings/src/metrics';
 import {trigger, eventType} from '@webex/plugin-meetings/src/metrics/config';
 import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
-import {IceGatheringFailed} from '@webex/plugin-meetings/src/common/errors/webex-errors';
 import {MediaRequestManager} from '@webex/plugin-meetings/src/multistream/mediaRequestManager';
+import * as ReceiveSlotManagerModule from '@webex/plugin-meetings/src/multistream/receiveSlotManager';
 
 import LLM from '@webex/internal-plugin-llm';
 import Mercury from '@webex/internal-plugin-mercury';
@@ -274,6 +274,86 @@ describe('plugin-meetings', () => {
           assert.instanceOf(meeting.mediaRequestManagers.screenShareAudio, MediaRequestManager);
           assert.instanceOf(meeting.mediaRequestManagers.screenShareVideo, MediaRequestManager);
         });
+
+        describe('creates ReceiveSlot manager instance', () => {
+          let mockReceiveSlotManagerCtor;
+          let providedCreateSlotCallback;
+          let providedFindMemberIdByCsiCallback;
+
+          beforeEach(() => {
+            mockReceiveSlotManagerCtor = sinon.stub(ReceiveSlotManagerModule, 'ReceiveSlotManager').callsFake((createSlotCallback, findMemberIdByCsiCallback) => {
+              providedCreateSlotCallback = createSlotCallback;
+              providedFindMemberIdByCsiCallback = findMemberIdByCsiCallback;
+
+              return {updateMemberIds: sinon.stub()};
+            });
+
+            meeting = new Meeting(
+              {
+                userId: uuid1,
+                resource: uuid2,
+                deviceUrl: uuid3,
+                locus: {url: url1},
+                destination: testDestination,
+                destinationType: _MEETING_ID_,
+              },
+              {
+                parent: webex,
+              }
+            );
+
+            meeting.mediaProperties.webrtcMediaConnection = {createReceiveSlot: sinon.stub()};
+          });
+
+          it('calls ReceiveSlotManager constructor', () => {
+            assert.calledOnce(mockReceiveSlotManagerCtor);
+            assert.isDefined(providedCreateSlotCallback);
+            assert.isDefined(providedFindMemberIdByCsiCallback);
+          });
+
+          it('calls createReceiveSlot on the webrtc media connection in the createSlotCallback', async () => {
+            assert.isDefined(providedCreateSlotCallback);
+
+            await providedCreateSlotCallback(MediaType.VideoMain);
+
+            assert.calledOnce(meeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+            assert.calledWith(meeting.mediaProperties.webrtcMediaConnection.createReceiveSlot, MediaType.VideoMain);
+          });
+
+          it('rejects createSlotCallback if there is no webrtc media connection', () => {
+            assert.isDefined(providedCreateSlotCallback);
+
+            meeting.mediaProperties.webrtcMediaConnection.createReceiveSlot.rejects({});
+
+            assert.isRejected(providedCreateSlotCallback(MediaType.VideoMain));
+          });
+
+          it('calls findMemberByCsi in findMemberIdByCsiCallback and returns the right value', () => {
+            assert.isDefined(providedFindMemberIdByCsiCallback);
+
+            const fakeMember = {id: 'aaa-bbb'};
+
+            sinon.stub(meeting.members, 'findMemberByCsi').returns(fakeMember)
+
+            const memberId = providedFindMemberIdByCsiCallback(123);
+
+            assert.calledOnce(meeting.members.findMemberByCsi);
+            assert.calledWith(meeting.members.findMemberByCsi, 123);
+            assert.equal(memberId, fakeMember.id);
+          });
+
+          it('returns undefined if findMemberByCsi does not find the member', () => {
+            assert.isDefined(providedFindMemberIdByCsiCallback);
+
+            sinon.stub(meeting.members, 'findMemberByCsi').returns(undefined)
+
+            const memberId = providedFindMemberIdByCsiCallback(123);
+
+            assert.calledOnce(meeting.members.findMemberByCsi);
+            assert.calledWith(meeting.members.findMemberByCsi, 123);
+            assert.equal(memberId, undefined);
+          });
+        })
       });
       describe('#invite', () => {
         it('should have #invite', () => {

package/test/unit/spec/multistream/receiveSlotManager.ts

@@ -6,26 +6,17 @@ import {ReceiveSlotManager} from '@webex/plugin-meetings/src/multistream/receive
 import * as ReceiveSlotModule from '@webex/plugin-meetings/src/multistream/receiveSlot';
 
 describe('ReceiveSlotManager', () => {
-  let fakeMeeting;
   let fakeWcmeSlot;
   let fakeReceiveSlots;
   let mockReceiveSlotCtor;
   let receiveSlotManager;
+  let createSlotCallbackStub;
+  let findMemberIdCallbackStub;
 
   beforeEach(() => {
     fakeWcmeSlot = {
       id: 'fake wcme slot',
     };
-    fakeMeeting = {
-      mediaProperties: {
-        webrtcMediaConnection: {
-          createReceiveSlot: sinon.stub().resolves(fakeWcmeSlot),
-        },
-      },
-      members: {
-        findMemberByCsi: sinon.stub(),
-      },
-    };
     fakeReceiveSlots = [];
     mockReceiveSlotCtor = sinon.stub(ReceiveSlotModule, 'ReceiveSlot').callsFake((mediaType) => {
       const fakeReceiveSlot = {
@@ -39,7 +30,10 @@ describe('ReceiveSlotManager', () => {
       return fakeReceiveSlot;
     });
 
-    receiveSlotManager = new ReceiveSlotManager(fakeMeeting);
+    createSlotCallbackStub = sinon.stub().resolves(fakeWcmeSlot);
+    findMemberIdCallbackStub = sinon.stub();
+
+    receiveSlotManager = new ReceiveSlotManager(createSlotCallbackStub, findMemberIdCallbackStub);
   });
 
   afterEach(() => {
@@ -47,7 +41,7 @@ describe('ReceiveSlotManager', () => {
   });
 
   it('rejects if there is no media connection', async () => {
-    fakeMeeting.mediaProperties.webrtcMediaConnection = null;
+    createSlotCallbackStub.rejects(new Error('Webrtc media connection is missing'));
 
     assert.isRejected(
       receiveSlotManager.allocateSlot(MediaType.VideoMain),
@@ -60,14 +54,14 @@ describe('ReceiveSlotManager', () => {
 
     const slot = await receiveSlotManager.allocateSlot(MediaType.VideoMain);
 
-    assert.calledOnce(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.calledOnce(createSlotCallbackStub);
     assert.calledWith(
-      fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot,
+      createSlotCallbackStub,
       MediaType.VideoMain
     );
 
     assert.calledOnce(mockReceiveSlotCtor);
-    assert.calledWith(mockReceiveSlotCtor, MediaType.VideoMain, fakeWcmeSlot, sinon.match.func);
+    assert.calledWith(mockReceiveSlotCtor, MediaType.VideoMain, fakeWcmeSlot, findMemberIdCallbackStub);
     assert.strictEqual(slot, fakeReceiveSlots[0]);
 
     assert.deepEqual(receiveSlotManager.getStats(), {
@@ -79,7 +73,7 @@ describe('ReceiveSlotManager', () => {
   it('reuses previously freed slot when allocateSlot() is called and a free slot is available', async () => {
     const slot1 = await receiveSlotManager.allocateSlot(MediaType.VideoMain);
 
-    assert.calledOnce(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.calledOnce(createSlotCallbackStub);
     assert.calledOnce(mockReceiveSlotCtor);
     assert.strictEqual(slot1, fakeReceiveSlots[0]);
 
@@ -91,13 +85,13 @@ describe('ReceiveSlotManager', () => {
       numFreeSlots: {'VIDEO-MAIN': 1},
     });
 
-    fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot.resetHistory();
+    createSlotCallbackStub.resetHistory();
     mockReceiveSlotCtor.resetHistory();
 
     // allocate another slot, this time the previous one should be returned instead of allocating any new ones
     const slot2 = await receiveSlotManager.allocateSlot(MediaType.VideoMain);
 
-    assert.notCalled(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.notCalled(createSlotCallbackStub);
     assert.notCalled(mockReceiveSlotCtor);
 
     // verify that in fact we got the same slot again
@@ -112,7 +106,7 @@ describe('ReceiveSlotManager', () => {
   it('does not reuse any slots after reset() is called', async () => {
     const slot1 = await receiveSlotManager.allocateSlot(MediaType.VideoMain);
 
-    assert.calledOnce(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.calledOnce(createSlotCallbackStub);
     assert.calledOnce(mockReceiveSlotCtor);
     assert.strictEqual(slot1, fakeReceiveSlots[0]);
 
@@ -121,7 +115,7 @@ describe('ReceiveSlotManager', () => {
     receiveSlotManager.reset();
 
     // reset the mocks and set the ReceiveSlot constructor to return a different slot
-    fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot.resetHistory();
+    createSlotCallbackStub.resetHistory();
     mockReceiveSlotCtor.resetHistory();
 
     assert.deepEqual(receiveSlotManager.getStats(), {numAllocatedSlots: {}, numFreeSlots: {}});
@@ -129,7 +123,7 @@ describe('ReceiveSlotManager', () => {
     // allocate another slot, because we called reset(), the old free slot should not be reused
     const slot2 = await receiveSlotManager.allocateSlot(MediaType.VideoMain);
 
-    assert.calledOnce(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.calledOnce(createSlotCallbackStub);
     assert.calledOnce(mockReceiveSlotCtor);
 
     // verify that in fact we got a brand new slot
@@ -144,25 +138,25 @@ describe('ReceiveSlotManager', () => {
   it('does not reuse slots if they have different media type', async () => {
     const slot1 = await receiveSlotManager.allocateSlot(MediaType.VideoMain);
 
-    assert.calledOnce(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.calledOnce(createSlotCallbackStub);
     assert.calledOnce(mockReceiveSlotCtor);
 
     receiveSlotManager.releaseSlot(slot1);
 
-    fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot.resetHistory();
+    createSlotCallbackStub.resetHistory();
     mockReceiveSlotCtor.resetHistory();
 
     // allocate another slot, this time for main audio, so it should be a completely new slot
     const slot2 = await receiveSlotManager.allocateSlot(MediaType.AudioMain);
 
-    assert.calledOnce(fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot);
+    assert.calledOnce(createSlotCallbackStub);
     assert.calledWith(
-      fakeMeeting.mediaProperties.webrtcMediaConnection.createReceiveSlot,
+      createSlotCallbackStub,
       MediaType.AudioMain
     );
 
     assert.calledOnce(mockReceiveSlotCtor);
-    assert.calledWith(mockReceiveSlotCtor, MediaType.AudioMain, fakeWcmeSlot, sinon.match.func);
+    assert.calledWith(mockReceiveSlotCtor, MediaType.AudioMain, fakeWcmeSlot, findMemberIdCallbackStub);
 
     // verify that in fact we got a brand new slot
     assert.strictEqual(slot2, fakeReceiveSlots[1]);