@webex/plugin-meetings 3.0.0-beta.11 → 3.0.0-beta.111

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

@@ -1,8 +1,7 @@
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
-import createMuteState from '@webex/plugin-meetings/src/meeting/muteState';
-import Media from '@webex/plugin-meetings/src/media/index';
+import {createMuteState} 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';
 
@@ -16,29 +15,41 @@ describe('plugin-meetings', () => {
 
   const fakeLocus = {info: 'this is a fake locus'};
 
+  const createFakeLocalTrack = (id) => {
+    return {
+      id,
+      setMuted: sinon.stub(),
+      setServerMuted: sinon.stub(),
+      setUnmuteAllowed: sinon.stub(),
+     };
+  };
+
   beforeEach(() => {
     meeting = {
       mediaProperties: {
-        audioTrack: 'fake audio track',
-        videoTrack: 'fake video track'
+        audioTrack: createFakeLocalTrack('fake audio track'),
+        videoTrack: createFakeLocalTrack('fake video track'),
       },
       remoteMuted: false,
       unmuteAllowed: true,
+      remoteVideoMuted: false,
+      unmuteVideoAllowed: true,
+
       locusInfo: {
-        onFullLocus: sinon.stub()
+        onFullLocus: sinon.stub(),
       },
       members: {
         selfId: 'fake self id',
-        muteMember: sinon.stub().resolves()
-      }
+        muteMember: sinon.stub().resolves(),
+      },
     };
-    audio = createMuteState(AUDIO, meeting, {sendAudio: true});
-    video = createMuteState(VIDEO, meeting, {sendVideo: true});
+
+    audio = createMuteState(AUDIO, meeting, {sendAudio: true}, true);
+    video = createMuteState(VIDEO, meeting, {sendVideo: true}, true);
 
     originalRemoteUpdateAudioVideo = MeetingUtil.remoteUpdateAudioVideo;
 
     MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves(fakeLocus);
-    Media.setLocalTrack = sinon.stub();
   });
 
   afterEach(() => {
@@ -47,8 +58,8 @@ describe('plugin-meetings', () => {
 
   describe('mute state library', () => {
     it('does not create an audio instance if we are not sending audio', async () => {
-      assert.isNull(createMuteState(AUDIO, meeting, {sendAudio: false}));
-      assert.isNull(createMuteState(AUDIO, meeting, {}));
+      assert.isNull(createMuteState(AUDIO, meeting, {sendAudio: false}, true));
+      assert.isNull(createMuteState(AUDIO, meeting, {}, true));
     });
 
     it('does not create a video instance if we are not sending video', async () => {
@@ -76,22 +87,23 @@ describe('plugin-meetings', () => {
     });
 
     it('initialises correctly for video', async () => {
-      // setup fields related to audio remote state
-      meeting.remoteMuted = true;
-      meeting.unmuteAllowed = false;
-      // create a new video MuteState intance
+      // setup fields related to video remote state
+      meeting.remoteVideoMuted = false;
+      meeting.unmuteVideoAllowed = false;
+
+      // create a new video MuteState instance
       video = createMuteState(VIDEO, meeting, {sendVideo: true});
 
       assert.isFalse(video.isMuted());
       assert.isFalse(video.state.server.remoteMute);
-      assert.isTrue(video.state.server.unmuteAllowed);
+      assert.isFalse(video.state.server.unmuteAllowed);
     });
 
     it('takes remote mute into account when reporting current state', async () => {
       assert.isFalse(audio.isMuted());
 
       // simulate remote mute
-      audio.handleServerRemoteMuteUpdate(true, true);
+      audio.handleServerRemoteMuteUpdate(meeting, true, true);
 
       assert.isTrue(audio.isMuted());
       assert.isFalse(audio.isSelf());
@@ -110,8 +122,8 @@ describe('plugin-meetings', () => {
       audio.handleServerLocalUnmuteRequired(meeting);
       await testUtils.flushPromises();
 
-      // check that local track was enabled
-      assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.audioTrack);
+      // check that local track was unmuted
+      assert.calledWith(meeting.mediaProperties.audioTrack.setMuted, false);
 
       // and local unmute was sent to server
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
@@ -128,11 +140,14 @@ describe('plugin-meetings', () => {
       // first we need to mute and make that request last forever
       let serverResponseResolve;
 
-      MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-        serverResponseResolve = resolve;
-      }));
+      MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(
+        new Promise((resolve) => {
+          serverResponseResolve = resolve;
+        })
+      );
 
-      audio.handleClientRequest(meeting, true)
+      audio
+        .handleClientRequest(meeting, true)
         .then(() => {
           clientPromiseResolved = true;
         })
@@ -158,48 +173,92 @@ describe('plugin-meetings', () => {
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
       assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, false, undefined, meeting);
 
-      // and local track should be enabled
-      assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.audioTrack);
+      // and local track should be unmuted
+      assert.calledWith(meeting.mediaProperties.audioTrack.setMuted, false);
 
       assert.isFalse(audio.isMuted());
       assert.isFalse(audio.isSelf());
     });
 
+    it('does local video unmute if localVideoUnmuteRequired is received', async () => {
+      // first we need to mute
+      await video.handleClientRequest(meeting, true);
+
+      assert.isTrue(video.isMuted());
+      assert.isTrue(video.isSelf());
+
+      MeetingUtil.remoteUpdateAudioVideo.resetHistory();
+
+      // now simulate server requiring us to locally unmute
+      video.handleServerLocalUnmuteRequired(meeting);
+      await testUtils.flushPromises();
+
+      // check that local track was unmuted
+      assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, false);
+
+      // and local unmute was sent to server
+      assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
+      assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, undefined, false, meeting);
+
+      assert.isFalse(video.isMuted());
+      assert.isFalse(video.isSelf());
+    });
+
+    describe('#isLocallyMuted()', () => {
+      it('does not consider remote mute status for audio', async () => {
+        // simulate being already remote muted
+        meeting.remoteMuted = true;
+        // create a new MuteState intance
+        audio = createMuteState(AUDIO, meeting, {sendAudio: true});
+
+        assert.isFalse(audio.isLocallyMuted());
+      });
+
+      it('does not consider remote mute status for video', async () => {
+        // simulate being already remote muted
+        meeting.remoteVideoMuted = true;
+        // create a new MuteState intance
+        video = createMuteState(VIDEO, meeting, {sendVideo: true});
+
+        assert.isFalse(video.isLocallyMuted());
+      });
+    });
+
     describe('#handleClientRequest', () => {
       it('disables/enables the local audio track when audio is muted/unmuted', async () => {
         // mute
         audio.handleClientRequest(meeting, true);
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.audioTrack);
+        assert.calledWith(meeting.mediaProperties.audioTrack.setMuted, true);
 
-        // even when calling mute when it's already muted should still call setLocalTrack
+        // even when calling mute when it's already muted should still call setMuted
         audio.handleClientRequest(meeting, true);
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.audioTrack);
+        assert.calledWith(meeting.mediaProperties.audioTrack.setMuted, true);
 
         // unmute
         audio.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.audioTrack);
+        assert.calledWith(meeting.mediaProperties.audioTrack.setMuted, false);
 
-        // even when calling unmute when it's already unmuted should still call setLocalTrack
+        // even when calling unmute when it's already unmuted should still call setMuted
         audio.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.audioTrack);
+        assert.calledWith(meeting.mediaProperties.audioTrack.setMuted, false);
       });
 
       it('disables/enables the local video track when video is muted/unmuted', async () => {
         // mute
         video.handleClientRequest(meeting, true);
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.videoTrack);
+        assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, true);
 
-        // even when calling mute when it's already muted should still call setLocalTrack
+        // even when calling mute when it's already muted should still call setMuted
         video.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.videoTrack);
+        assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, true);
 
         // unmute
         video.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.videoTrack);
+        assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, false);
 
-        // even when calling unmute when it's already unmuted should still call setLocalTrack
+        // even when calling unmute when it's already unmuted should still call setMuted
         video.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.videoTrack);
+        assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, false);
       });
 
       it('returns correct value in isMuted()/isSelf() methods after client mute/unmute requests', async () => {
@@ -218,32 +277,62 @@ describe('plugin-meetings', () => {
 
       it('does remote unmute when unmuting and remote mute is on', async () => {
         // simulate remote mute
-        audio.handleServerRemoteMuteUpdate(true, true);
+        audio.handleServerRemoteMuteUpdate(meeting, true, true);
 
         // unmute
         await audio.handleClientRequest(meeting, false);
 
         // check that remote unmute was sent to server
         assert.calledOnce(meeting.members.muteMember);
-        assert.calledWith(meeting.members.muteMember, meeting.members.selfId, false);
+        assert.calledWith(meeting.members.muteMember, meeting.members.selfId, false, true);
 
         assert.isFalse(audio.isMuted());
         assert.isFalse(audio.isSelf());
       });
 
+      it('does video remote unmute when unmuting and remote mute is on', async () => {
+        // simulate remote mute
+        video.handleServerRemoteMuteUpdate(meeting, true, true);
+
+        // unmute
+        await video.handleClientRequest(meeting, false);
+
+        // check that remote unmute was sent to server
+        assert.calledOnce(meeting.members.muteMember);
+        assert.calledWith(meeting.members.muteMember, meeting.members.selfId, false, false);
+
+        assert.isFalse(video.isMuted());
+        assert.isFalse(video.isSelf());
+      });
+
+      it('does not video remote unmute when unmuting and remote mute is off', async () => {
+        // simulate remote mute
+        video.handleServerRemoteMuteUpdate(meeting, false, true);
+
+        // unmute
+        await video.handleClientRequest(meeting, false);
+
+        // check that remote unmute was sent to server
+        assert.notCalled(meeting.members.muteMember);
+
+        assert.isFalse(video.isMuted());
+        assert.isFalse(video.isSelf());
+      });
+
       it('resolves client request promise once the server is updated', async () => {
         let clientPromiseResolved = false;
 
         let serverResponseResolve;
 
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-          serverResponseResolve = resolve;
-        }));
+        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(
+          new Promise((resolve) => {
+            serverResponseResolve = resolve;
+          })
+        );
 
-        audio.handleClientRequest(meeting, true)
-          .then(() => {
-            clientPromiseResolved = true;
-          });
+        audio.handleClientRequest(meeting, true).then(() => {
+          clientPromiseResolved = true;
+        });
 
         // do a small delay to make sure that the client promise doesn't resolve in that time
         await testUtils.waitUntil(200);
@@ -257,16 +346,18 @@ describe('plugin-meetings', () => {
       });
 
       it('rejects client request promise if server request for local mute fails', async () => {
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve, reject) => {
-          reject();
-        }));
+        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(
+          new Promise((resolve, reject) => {
+            reject();
+          })
+        );
 
         assert.isRejected(audio.handleClientRequest(meeting, true));
       });
 
       it('rejects client request promise if server request for remote mute fails', async () => {
         // we only send remote mute requests when we're unmuting, so first we need to do a remote mute
-        audio.handleServerRemoteMuteUpdate(true, true);
+        audio.handleServerRemoteMuteUpdate(meeting, true, true);
 
         // setup the stub to simulate server error response
         meeting.members.muteMember = sinon.stub().rejects();
@@ -282,9 +373,11 @@ describe('plugin-meetings', () => {
       it('does not send a server request if client state matches the server', async () => {
         let serverResponseResolve;
 
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-          serverResponseResolve = resolve;
-        }));
+        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(
+          new Promise((resolve) => {
+            serverResponseResolve = resolve;
+          })
+        );
 
         // simulate many client requests, with the last one matching the initial one
         audio.handleClientRequest(meeting, true);
@@ -309,22 +402,22 @@ describe('plugin-meetings', () => {
       it('queues up server requests when multiple client requests are received', async () => {
         let serverResponseResolve;
 
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-          serverResponseResolve = resolve;
-        }));
+        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(
+          new Promise((resolve) => {
+            serverResponseResolve = resolve;
+          })
+        );
 
         let firstClientPromiseResolved = false;
         let secondClientPromiseResolved = false;
 
         // 2 client requests, one after another without waiting for first one to resolve
-        audio.handleClientRequest(meeting, true)
-          .then(() => {
-            firstClientPromiseResolved = true;
-          });
-        audio.handleClientRequest(meeting, false)
-          .then(() => {
-            secondClientPromiseResolved = true;
-          });
+        audio.handleClientRequest(meeting, true).then(() => {
+          firstClientPromiseResolved = true;
+        });
+        audio.handleClientRequest(meeting, false).then(() => {
+          secondClientPromiseResolved = true;
+        });
 
         await testUtils.flushPromises();
 
@@ -349,9 +442,10 @@ describe('plugin-meetings', () => {
       });
 
       it('rejects client request to unmute if hard mute is used', (done) => {
-        audio.handleServerRemoteMuteUpdate(true, false);
+        audio.handleServerRemoteMuteUpdate(meeting, true, false);
 
-        audio.handleClientRequest(meeting, false)
+        audio
+          .handleClientRequest(meeting, false)
           .then(() => {
             done(new Error('expected handleClientRequest to fail, but it did not!'));
           })
@@ -369,11 +463,11 @@ describe('plugin-meetings', () => {
         assert.isTrue(video.isSelf());
 
         // check local mute is done, but not remote one
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.videoTrack);
+        assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, true);
         assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, undefined, true, meeting);
         assert.notCalled(meeting.members.muteMember);
 
-        Media.setLocalTrack.resetHistory();
+        meeting.mediaProperties.videoTrack.setMuted.resetHistory();
         MeetingUtil.remoteUpdateAudioVideo.resetHistory();
         meeting.members.muteMember.resetHistory();
 
@@ -383,7 +477,7 @@ describe('plugin-meetings', () => {
         assert.isFalse(video.isMuted());
         assert.isFalse(video.isSelf());
 
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.videoTrack);
+        assert.calledWith(meeting.mediaProperties.videoTrack.setMuted, false);
         assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, undefined, false, meeting);
         assert.notCalled(meeting.members.muteMember);
       });
@@ -415,3 +509,207 @@ describe('plugin-meetings', () => {
     });
   });
 });
+
+describe('#init, #handleLocalTrackChange', () => {
+  let meeting;
+  let muteState;
+  let setServerMutedSpy;
+  let setMutedSpy, setUnmuteAllowedSpy;
+  const fakeLocus = {info: 'this is a fake locus'};
+
+  const createFakeLocalTrack = (id, muted) => {
+    return {
+      id,
+      setMuted: sinon.stub(),
+      setServerMuted: sinon.stub(),
+      setUnmuteAllowed: sinon.stub(),
+      muted,
+    };
+  };
+
+  const setup = (mediaType, remoteMuted = false, muted = false, defineTracks = true) => {
+
+    const remoteMuteField = mediaType === AUDIO ? 'remoteMuted' : 'remoteVideoMuted';
+
+    meeting = {
+      mediaProperties: {
+        audioTrack: defineTracks ? createFakeLocalTrack('fake audio track', muted) : undefined,
+        videoTrack: defineTracks ? createFakeLocalTrack('fake video track', muted) : undefined,
+      },
+      [remoteMuteField]: remoteMuted,
+      unmuteAllowed: true,
+      unmuteVideoAllowed: true,
+
+      locusInfo: {
+        onFullLocus: sinon.stub(),
+      },
+      members: {
+        selfId: 'fake self id',
+        muteMember: sinon.stub().resolves(),
+      },
+    };
+
+    const direction = mediaType === AUDIO ? {sendAudio: true} : {sendVideo: true};
+    sinon.spy(MeetingUtil, 'remoteUpdateAudioVideo');
+    muteState = createMuteState(mediaType, meeting, direction, false);
+  }
+
+   const setupSpies = (mediaType) => {
+    setUnmuteAllowedSpy = mediaType === AUDIO ? meeting.mediaProperties.audioTrack?.setUnmuteAllowed : meeting.mediaProperties.videoTrack?.setUnmuteAllowed;
+    setServerMutedSpy = mediaType === AUDIO ? meeting.mediaProperties.audioTrack?.setServerMuted : meeting.mediaProperties.videoTrack?.setServerMuted;
+    setMutedSpy = mediaType === AUDIO ? meeting.mediaProperties.audioTrack?.setMuted : meeting.mediaProperties.videoTrack?.setMuted;
+
+    clearSpies();
+  };
+
+  const clearSpies = () => {
+    setUnmuteAllowedSpy?.resetHistory();
+    setServerMutedSpy?.resetHistory();
+    setMutedSpy?.resetHistory();
+  };
+  const tests = [
+    {mediaType: AUDIO, title: 'audio'},
+    {mediaType: VIDEO, title: 'video'}
+  ];
+
+  tests.forEach(({mediaType, title}) =>
+    describe(title, () => {
+
+      afterEach(() => {
+        sinon.restore();
+      });
+
+      describe('#handleLocalTrackChange',() => {
+
+         it('calls init()', async () => {
+          setup(mediaType);
+          const spy = sinon.spy(muteState, 'init');
+          muteState.handleLocalTrackChange(meeting);
+          assert.calledOnceWithExactly(spy, meeting);
+        });
+      });
+
+      describe('#init', () => {
+
+        afterEach(() => {
+          sinon.restore();
+        });
+
+        it('nothing goes bad when track is undefined', async () => {
+          setup(mediaType, false, false, false);
+          setupSpies(mediaType);
+          
+          muteState.init(meeting);
+          
+          assert.isFalse(muteState.state.client.localMute);
+        });
+  
+        it('tests when track muted is true and remoteMuted is false', async () => {
+          setup(mediaType, false, true);
+          setupSpies(mediaType);
+          
+          muteState.init(meeting);
+  
+          assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
+          assert.notCalled(setServerMutedSpy);
+          assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
+          assert.isTrue(muteState.state.client.localMute);
+        });
+
+          
+        it('tests when track muted is false and remoteMuted is false', async () => {
+          setup(mediaType, false, false);
+          setupSpies(mediaType);
+          muteState.state.server.localMute = true;
+          
+          muteState.init(meeting);
+  
+          assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
+          assert.notCalled(setServerMutedSpy);
+          assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
+          assert.isFalse(muteState.state.client.localMute);
+        });
+  
+        it('tests when remoteMuted is true', async () => {
+          // testing that muteLocalTrack is called
+          setup(mediaType, true);
+          setupSpies(mediaType);
+
+          muteState.init(meeting);
+          
+          assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
+          assert.calledOnceWithExactly(setServerMutedSpy, true, 'remotelyMuted');
+        });
+      });
+
+      describe('#handleLocalTrackMuteStateChange', () => {
+
+        afterEach(() => {
+          sinon.restore();
+        });
+
+        it('checks when ignoreMuteStateChange is true nothing changes', () => {
+          setup(mediaType, false, false);
+          muteState.ignoreMuteStateChange= true;
+
+          muteState.handleLocalTrackMuteStateChange(meeting, true);
+          assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+
+          assert.isFalse(muteState.state.client.localMute);
+        });
+
+        it('tests localMute - true to false', () => {
+          setup(mediaType, false, true);
+
+          muteState.handleLocalTrackMuteStateChange(meeting, false);
+          assert.equal(muteState.state.client.localMute, false);
+          assert.called(MeetingUtil.remoteUpdateAudioVideo);
+        });
+
+        it('tests localMute - false to true', () => {
+          setup(mediaType, false, false);
+
+          muteState.handleLocalTrackMuteStateChange(meeting, true);
+          assert.equal(muteState.state.client.localMute, true);
+          assert.called(MeetingUtil.remoteUpdateAudioVideo);
+        });
+      });
+
+      describe('#applyClientStateLocally', () => {
+
+        afterEach(() => {
+          sinon.restore();
+        });
+
+        it('checks when sdkOwnsLocalTrack is false', () => {
+          setup(mediaType);
+          setupSpies(mediaType);
+          muteState.sdkOwnsLocalTrack= false;
+
+          muteState.applyClientStateLocally(meeting, 'somereason');
+          assert.calledOnceWithExactly(setServerMutedSpy, muteState.state.client.localMute, 'somereason');
+          assert.notCalled(setMutedSpy);
+        });
+
+        it('checks when sdkOwnsLocalTrack is true', () => {
+          setup(mediaType);
+          setupSpies(mediaType);
+          muteState.sdkOwnsLocalTrack= true;
+
+          muteState.applyClientStateLocally(meeting, 'somereason');
+          assert.notCalled(setServerMutedSpy);
+          assert.calledOnceWithExactly(setMutedSpy, muteState.state.client.localMute);
+        });
+
+        it('checks nothing explodes when tracks are undefined', () => {
+          setup(mediaType, false, false, false);
+          setupSpies(mediaType);
+          muteState.sdkOwnsLocalTrack= true;
+
+          muteState.applyClientStateLocally(meeting, 'somereason');
+        });
+      });
+
+    })
+  );
+});