@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.200

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, 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';
 
@@ -16,29 +15,44 @@ describe('plugin-meetings', () => {
 
   const fakeLocus = {info: 'this is a fake locus'};
 
-  beforeEach(() => {
+  const createFakeLocalTrack = (id, muted) => {
+    return {
+      id,
+      setMuted: sinon.stub(),
+      setServerMuted: sinon.stub(),
+      setUnmuteAllowed: sinon.stub(),
+      muted,
+    };
+  };
+
+  beforeEach(async () => {
     meeting = {
       mediaProperties: {
-        audioTrack: 'fake audio track',
-        videoTrack: 'fake video track'
+        audioTrack: createFakeLocalTrack('fake audio track', false),
+        videoTrack: createFakeLocalTrack('fake video track', false),
       },
       remoteMuted: false,
       unmuteAllowed: true,
+      remoteVideoMuted: false,
+      unmuteVideoAllowed: true,
+
       locusInfo: {
-        onFullLocus: sinon.stub()
+        handleLocusDelta: 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});
 
     originalRemoteUpdateAudioVideo = MeetingUtil.remoteUpdateAudioVideo;
 
     MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves(fakeLocus);
-    Media.setLocalTrack = sinon.stub();
+
+    audio = createMuteState(AUDIO, meeting, true);
+    video = createMuteState(VIDEO, meeting, true);
+
+    await testUtils.flushPromises();
   });
 
   afterEach(() => {
@@ -46,63 +60,61 @@ 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, {}));
-    });
-
-    it('does not create a video instance if we are not sending video', async () => {
-      assert.isNull(createMuteState(VIDEO, meeting, {sendVideo: false}));
-      assert.isNull(createMuteState(VIDEO, meeting, {}));
-    });
-
     it('takes into account current remote mute status when instantiated', async () => {
       // simulate being already remote muted
       meeting.remoteMuted = true;
-      // create a new MuteState intance
-      audio = createMuteState(AUDIO, meeting, {sendAudio: true});
+
+      // create a new MuteState instance
+      audio = createMuteState(AUDIO, meeting, true);
+
+      await testUtils.flushPromises();
 
       assert.isTrue(audio.isMuted());
-      assert.isFalse(audio.isSelf());
+      assert.isTrue(audio.isRemotelyMuted());
 
       // now check the opposite case
       meeting.remoteMuted = false;
 
-      // create a new MuteState intance
-      audio = createMuteState(AUDIO, meeting, {sendAudio: true});
+      // create a new MuteState instance
+      audio = createMuteState(AUDIO, meeting, true);
 
-      assert.isFalse(audio.isMuted());
-      assert.isFalse(audio.isSelf());
+      await testUtils.flushPromises();
+
+      assert.isTrue(audio.isMuted()); // because we start with no track
+      assert.isFalse(audio.isRemotelyMuted());
     });
 
     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
-      video = createMuteState(VIDEO, meeting, {sendVideo: true});
+      // setup fields related to video remote state
+      meeting.remoteVideoMuted = false;
+      meeting.unmuteVideoAllowed = false;
 
-      assert.isFalse(video.isMuted());
+      // create a new video MuteState instance
+      video = createMuteState(VIDEO, meeting, true);
+
+      await testUtils.flushPromises();
+
+      assert.isTrue(video.isMuted()); // because we start with no track
+      assert.isFalse(video.isRemotelyMuted());
       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());
+      assert.isFalse(audio.isRemotelyMuted());
 
       // simulate remote mute
-      audio.handleServerRemoteMuteUpdate(true, true);
+      audio.handleServerRemoteMuteUpdate(meeting, true, true);
 
-      assert.isTrue(audio.isMuted());
-      assert.isFalse(audio.isSelf());
+      assert.isTrue(audio.isRemotelyMuted());
     });
 
     it('does local unmute if localAudioUnmuteRequired is received', async () => {
-      // first we need to mute
-      await audio.handleClientRequest(meeting, true);
+      // first we need to mute have the local track muted
+      meeting.mediaProperties.audioTrack.muted = true;
+      audio.handleLocalTrackChange(meeting);
 
       assert.isTrue(audio.isMuted());
-      assert.isTrue(audio.isSelf());
 
       MeetingUtil.remoteUpdateAudioVideo.resetHistory();
 
@@ -110,169 +122,162 @@ 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.setServerMuted, false, 'localUnmuteRequired');
 
       // and local unmute was sent to server
       assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
-      assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, false, undefined, meeting);
+      assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, false, undefined);
 
       assert.isFalse(audio.isMuted());
-      assert.isFalse(audio.isSelf());
     });
 
-    it('rejects client request in progress if localAudioUnmuteRequired is received', async () => {
-      let clientPromiseResolved = false;
-      let clientPromiseRejected = false;
-
-      // first we need to mute and make that request last forever
-      let serverResponseResolve;
-
-      MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-        serverResponseResolve = resolve;
-      }));
+    it('does local video unmute if localVideoUnmuteRequired is received', async () => {
+      // first we need to mute
+      meeting.mediaProperties.videoTrack.muted = true;
+      video.handleLocalTrackChange(meeting);
 
-      audio.handleClientRequest(meeting, true)
-        .then(() => {
-          clientPromiseResolved = true;
-        })
-        .catch(() => {
-          clientPromiseRejected = true;
-        });
+      assert.isTrue(video.isMuted());
 
       MeetingUtil.remoteUpdateAudioVideo.resetHistory();
 
       // now simulate server requiring us to locally unmute
-      audio.handleServerLocalUnmuteRequired(meeting);
+      video.handleServerLocalUnmuteRequired(meeting);
       await testUtils.flushPromises();
 
-      // the original client request should have been rejected by now
-      assert.isTrue(clientPromiseRejected);
-      assert.isFalse(clientPromiseResolved);
-
-      // now make the server respond to the original mute request
-      serverResponseResolve();
-      await testUtils.flushPromises();
+      // check that local track was unmuted
+      assert.calledWith(meeting.mediaProperties.videoTrack.setServerMuted, false, 'localUnmuteRequired');
 
-      // local unmute should be sent to server
+      // and local unmute was sent to server
       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);
+      assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, undefined, false);
 
-      assert.isFalse(audio.isMuted());
-      assert.isFalse(audio.isSelf());
+      assert.isFalse(video.isMuted());
     });
 
-    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);
+    describe('#isLocallyMuted()', () => {
+      it('does not consider remote mute status for audio', async () => {
+        // simulate being already remote muted
+        meeting.remoteMuted = true;
 
-        // even when calling mute when it's already muted should still call setLocalTrack
-        audio.handleClientRequest(meeting, true);
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.audioTrack);
+        // create a new MuteState instance
+        audio = createMuteState(AUDIO, meeting, true);
+        audio.handleLocalTrackChange(meeting);
 
-        // unmute
-        audio.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.audioTrack);
+        await testUtils.flushPromises();
 
-        // even when calling unmute when it's already unmuted should still call setLocalTrack
-        audio.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.audioTrack);
+        assert.isFalse(audio.isLocallyMuted());
       });
 
-      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);
+      it('does not consider remote mute status for video', async () => {
+        // simulate being already remote muted
+        meeting.remoteVideoMuted = true;
 
-        // even when calling mute when it's already muted should still call setLocalTrack
-        video.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.videoTrack);
+        // create a new MuteState instance
+        video = createMuteState(VIDEO, meeting, true);
+        video.handleLocalTrackChange(meeting);
 
-        // unmute
-        video.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.videoTrack);
+        await testUtils.flushPromises();
 
-        // even when calling unmute when it's already unmuted should still call setLocalTrack
-        video.handleClientRequest(meeting, false);
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.videoTrack);
+        assert.isFalse(video.isLocallyMuted());
       });
+    });
 
-      it('returns correct value in isMuted()/isSelf() methods after client mute/unmute requests', async () => {
-        // mute
-        audio.handleClientRequest(meeting, true);
+    describe('handling local track mute events', () => {
+
+      beforeEach(async () => {
+        audio.handleLocalTrackChange(meeting);
+        video.handleLocalTrackChange(meeting);
 
+        await testUtils.flushPromises();
+      });
+
+      const simulateAudioMuteChange = async (muteValue) => {
+        meeting.mediaProperties.audioTrack.muted = muteValue;
+        audio.handleLocalTrackMuteStateChange(meeting, muteValue);
+
+        await testUtils.flushPromises();
+      }
+
+      const simulateVideoMuteChange = async (muteValue) => {
+        meeting.mediaProperties.videoTrack.muted = muteValue;
+        video.handleLocalTrackMuteStateChange(meeting, muteValue);
+
+        await testUtils.flushPromises();
+      }
+
+      it('returns correct value in isMuted() methods after local track is muted/unmuted', async () => {
+        // mute
+        await simulateAudioMuteChange(true);
         assert.isTrue(audio.isMuted());
-        assert.isTrue(audio.isSelf());
 
         // unmute
-        audio.handleClientRequest(meeting, false);
-
+        await simulateAudioMuteChange(false);
         assert.isFalse(audio.isMuted());
-        assert.isFalse(audio.isSelf());
       });
 
       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);
+        await simulateAudioMuteChange(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('resolves client request promise once the server is updated', async () => {
-        let clientPromiseResolved = false;
+      it('does video remote unmute when unmuting and remote mute is on', async () => {
+        // simulate remote mute
+        video.handleServerRemoteMuteUpdate(meeting, true, true);
 
-        let serverResponseResolve;
+        // unmute
+        await simulateVideoMuteChange(false);
 
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-          serverResponseResolve = resolve;
-        }));
+        // check that remote unmute was sent to server
+        assert.calledOnce(meeting.members.muteMember);
+        assert.calledWith(meeting.members.muteMember, meeting.members.selfId, false, false);
 
-        audio.handleClientRequest(meeting, true)
-          .then(() => {
-            clientPromiseResolved = true;
-          });
+        assert.isFalse(video.isMuted());
+      });
+
+      it('does not video remote unmute when unmuting and remote mute is off', async () => {
+        // simulate remote mute
+        video.handleServerRemoteMuteUpdate(meeting, false, true);
 
-        // do a small delay to make sure that the client promise doesn't resolve in that time
-        await testUtils.waitUntil(200);
-        assert.isFalse(clientPromiseResolved);
+        // unmute
+        await simulateVideoMuteChange(false);
 
-        // now allow the server response to arrive, this should trigger the client promise to get resolved
-        serverResponseResolve();
-        await testUtils.flushPromises();
+        // check that remote unmute was not sent to server
+        assert.notCalled(meeting.members.muteMember);
 
-        assert.isTrue(clientPromiseResolved);
+        assert.isFalse(video.isMuted());
       });
 
-      it('rejects client request promise if server request for local mute fails', async () => {
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve, reject) => {
-          reject();
-        }));
+      it('calls setServerMuted with "clientRequestFailed" when server request for local mute fails', async () => {
+        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().rejects(new Error('fake error'));
+
+        await simulateAudioMuteChange(true);
 
-        assert.isRejected(audio.handleClientRequest(meeting, true));
+        assert.calledOnceWithExactly(meeting.mediaProperties.audioTrack.setServerMuted , false, 'clientRequestFailed');
       });
 
-      it('rejects client request promise if server request for remote mute fails', async () => {
+      it('calls setServerMuted with "clientRequestFailed" 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);
+
+        await testUtils.flushPromises();
 
         // setup the stub to simulate server error response
         meeting.members.muteMember = sinon.stub().rejects();
+        meeting.mediaProperties.audioTrack.setServerMuted.resetHistory();
 
-        // try to unmute - it should fail
-        await assert.isRejected(audio.handleClientRequest(meeting, false));
+        await simulateAudioMuteChange(false);
+
+        assert.calledOnceWithExactly(meeting.mediaProperties.audioTrack.setServerMuted , true, 'clientRequestFailed');
 
         // even though remote mute update in the server failed, isMuted() should still return true,
         // because of local mute
@@ -282,16 +287,19 @@ 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);
-        audio.handleClientRequest(meeting, false);
-        audio.handleClientRequest(meeting, true);
-        audio.handleClientRequest(meeting, false);
-        audio.handleClientRequest(meeting, true);
+        // the track is initially unmuted
+        // simulate many mute changes with the last one matching the first one
+        await simulateAudioMuteChange(true);
+        await simulateAudioMuteChange(false);
+        await simulateAudioMuteChange(true);
+        await simulateAudioMuteChange(false);
+        await simulateAudioMuteChange(true);
 
         // so far there should have been only 1 request to server (because our stub hasn't resolved yet
         // and MuteState sends only 1 server request at a time)
@@ -306,112 +314,275 @@ describe('plugin-meetings', () => {
         assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
       });
 
-      it('queues up server requests when multiple client requests are received', async () => {
+      it('queues up server requests when multiple mute changes happen to local track', async () => {
         let serverResponseResolve;
 
-        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(new Promise((resolve) => {
-          serverResponseResolve = resolve;
-        }));
-
-        let firstClientPromiseResolved = false;
-        let secondClientPromiseResolved = false;
+        MeetingUtil.remoteUpdateAudioVideo = sinon.stub().returns(
+          new Promise((resolve) => {
+            serverResponseResolve = resolve;
+          })
+        );
 
         // 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;
-          });
-
-        await testUtils.flushPromises();
+        await simulateAudioMuteChange(true);
+        await simulateAudioMuteChange(false);
 
         assert.calledOnce(MeetingUtil.remoteUpdateAudioVideo);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, true, undefined, meeting);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, true, undefined);
 
         // now allow the first request to complete
         serverResponseResolve();
         await testUtils.flushPromises();
-        assert.isTrue(firstClientPromiseResolved);
 
         // that should trigger the second server request to be sent
         assert.calledTwice(MeetingUtil.remoteUpdateAudioVideo);
-        assert.strictEqual(false, MeetingUtil.remoteUpdateAudioVideo.getCall(1).args[0]);
-        assert.strictEqual(undefined, MeetingUtil.remoteUpdateAudioVideo.getCall(1).args[1]);
-        assert.strictEqual(meeting, MeetingUtil.remoteUpdateAudioVideo.getCall(1).args[2]);
+        assert.deepEqual([meeting, false, undefined], MeetingUtil.remoteUpdateAudioVideo.getCall(1).args);
 
         serverResponseResolve();
-        await testUtils.flushPromises();
-
-        assert.isTrue(secondClientPromiseResolved);
-      });
-
-      it('rejects client request to unmute if hard mute is used', (done) => {
-        audio.handleServerRemoteMuteUpdate(true, false);
-
-        audio.handleClientRequest(meeting, false)
-          .then(() => {
-            done(new Error('expected handleClientRequest to fail, but it did not!'));
-          })
-          .catch((e) => {
-            assert.isTrue(e instanceof PermissionError);
-            done();
-          });
       });
 
       it('does not send remote mute for video', async () => {
         // mute
-        await video.handleClientRequest(meeting, true);
+        await simulateVideoMuteChange(true);
 
         assert.isTrue(video.isMuted());
-        assert.isTrue(video.isSelf());
 
         // check local mute is done, but not remote one
-        assert.calledWith(Media.setLocalTrack, false, meeting.mediaProperties.videoTrack);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, undefined, true, meeting);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, undefined, true);
         assert.notCalled(meeting.members.muteMember);
 
-        Media.setLocalTrack.resetHistory();
         MeetingUtil.remoteUpdateAudioVideo.resetHistory();
         meeting.members.muteMember.resetHistory();
 
         // unmute
-        await video.handleClientRequest(meeting, false);
+        await simulateVideoMuteChange(false);
 
         assert.isFalse(video.isMuted());
-        assert.isFalse(video.isSelf());
 
-        assert.calledWith(Media.setLocalTrack, true, meeting.mediaProperties.videoTrack);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, undefined, false, meeting);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, undefined, false);
         assert.notCalled(meeting.members.muteMember);
       });
 
-      it('sends correct audio value when sending local mute for video', async () => {
+      it('sends undefined value for the other media type when sending local mute', async () => {
         // make sure the meeting object has mute state machines for both audio and video
         meeting.audio = audio;
         meeting.video = video;
 
-        // mute audio -> request sent to server should have video unmuted
-        await audio.handleClientRequest(meeting, true);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, true, false, meeting);
+        // mute audio -> the call to remoteUpdateAudioVideo should have video undefined
+        await simulateAudioMuteChange(true);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, true, undefined);
         MeetingUtil.remoteUpdateAudioVideo.resetHistory();
 
-        // now mute video -> request sent to server should have mute for both audio and video
-        await video.handleClientRequest(meeting, true);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, true, true, meeting);
+        // now mute video -> the call to remoteUpdateAudioVideo should have mute for video and undefined for audio
+        await simulateVideoMuteChange(true);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, undefined, true);
         MeetingUtil.remoteUpdateAudioVideo.resetHistory();
 
-        // now unmute the audio -> request sent to server should still have video muted
-        await audio.handleClientRequest(meeting, false);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, false, true, meeting);
+        // now unmute the audio -> the call to remoteUpdateAudioVideo should have video undefined
+        await simulateAudioMuteChange(false);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, false, undefined);
         MeetingUtil.remoteUpdateAudioVideo.resetHistory();
 
-        // unmute video -> request sent to server should have both audio and video unmuted
-        await video.handleClientRequest(meeting, false);
-        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, false, false, meeting);
+        // unmute video -> the call to remoteUpdateAudioVideo should have both audio undefined
+        await simulateVideoMuteChange(false);
+        assert.calledWith(MeetingUtil.remoteUpdateAudioVideo, meeting, undefined, false);
       });
     });
+
+    describe('#init, #handleLocalTrackChange', () => {
+      let meeting;
+      let muteState;
+      let setServerMutedSpy;
+      let setMutedSpy, setUnmuteAllowedSpy;
+
+      const setupMeeting = (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 setup = async (mediaType, remoteMuted = false, muted = false, defineTracks = true) => {
+
+        setupMeeting(mediaType, remoteMuted, muted, defineTracks);
+
+        muteState = createMuteState(mediaType, meeting, true);
+        muteState.handleLocalTrackChange(meeting);
+
+        await testUtils.flushPromises();
+
+        MeetingUtil.remoteUpdateAudioVideo.resetHistory();
+      }
+
+      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, () => {
+          let originalRemoteUpdateAudioVideo;
+
+          beforeEach(() => {
+            originalRemoteUpdateAudioVideo = MeetingUtil.remoteUpdateAudioVideo;
+            MeetingUtil.remoteUpdateAudioVideo = sinon.stub().resolves({info: 'fake locus'});
+          });
+
+          afterEach(() => {
+            MeetingUtil.remoteUpdateAudioVideo = originalRemoteUpdateAudioVideo;
+            sinon.restore();
+          });
+
+          describe('#handleLocalTrackChange',() => {
+
+            it('calls init()', async () => {
+              await setup(mediaType);
+              const spy = sinon.spy(muteState, 'init');
+              muteState.handleLocalTrackChange(meeting);
+              assert.calledOnceWithExactly(spy, meeting);
+            });
+          });
+
+          describe('#init', () => {
+
+            // does the setup by calling new MuteState() so that MuteState.init() doesn't get called
+            const setupWithoutInit = async (mediaType, remoteMuted = false, muted = false, defineTracks = true) => {
+
+              setupMeeting(mediaType, remoteMuted, muted, defineTracks);
+
+              muteState = new MuteState(mediaType, meeting, true);
+            }
+
+            it('nothing goes bad when track is undefined', async () => {
+              await setupWithoutInit(mediaType, false, false, false);
+              setupSpies(mediaType);
+
+              muteState.init(meeting);
+
+              assert.isTrue(muteState.state.client.localMute);
+            });
+
+            it('tests when track muted is true and remoteMuted is false', async () => {
+              await setupWithoutInit(mediaType, false, true);
+              setupSpies(mediaType);
+
+              muteState.init(meeting);
+
+              assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
+              assert.notCalled(setServerMutedSpy);
+              assert.notCalled(MeetingUtil.remoteUpdateAudioVideo);
+              assert.isTrue(muteState.state.client.localMute);
+            });
+
+
+            it('tests when track muted is false and remoteMuted is false', async () => {
+              await setupWithoutInit(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
+              await setupWithoutInit(mediaType, true);
+              setupSpies(mediaType);
+
+              muteState.init(meeting);
+
+              assert.calledWith(setUnmuteAllowedSpy, muteState.state.server.unmuteAllowed);
+              assert.calledOnceWithExactly(setServerMutedSpy, true, 'remotelyMuted');
+            });
+          });
+
+          describe('#handleLocalTrackMuteStateChange', () => {
+
+            it('checks when ignoreMuteStateChange is true nothing changes', async () => {
+              await 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', async () => {
+              await 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', async () => {
+              await 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('calls setServerMuted on the track', async () => {
+              await setup(mediaType);
+              setupSpies(mediaType);
+
+              muteState.applyClientStateLocally(meeting, 'somereason');
+              assert.calledOnceWithExactly(setServerMutedSpy, muteState.state.client.localMute, 'somereason');
+              assert.notCalled(setMutedSpy);
+            });
+
+            it('nothing explodes when tracks are undefined', async () => {
+              await setup(mediaType, false, false, false);
+              setupSpies(mediaType);
+
+              muteState.applyClientStateLocally(meeting, 'somereason');
+            });
+          });
+
+        })
+      );
+    });
+
   });
 });