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

package/test/unit/spec/locus-info/selfUtils.js

@@ -33,6 +33,24 @@ describe('plugin-meetings', () => {
         assert.calledWith(getRolesSpy, self);
 
         assert.deepEqual(parsedSelf.roles, ['PRESENTER']);
+        assert.deepEqual(parsedSelf.breakoutSessions, {
+          active: [
+            {
+              name: 'Breakout session 2',
+              groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+              sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+              sessionType: 'BREAKOUT',
+            },
+          ],
+          allowed: [
+            {
+              name: 'Breakout session 2',
+              groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+              sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+              sessionType: 'BREAKOUT',
+            },
+          ],
+        });
       });
 
       it('calls getLayout and returns the resulting layout', () => {
@@ -58,9 +76,107 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('getBreakoutSessions', () => {
+      it('should return breakout sessions', () => {
+        assert.deepEqual(
+          SelfUtils.getBreakoutSessions({controls: {breakout: {sessions: 'SESSIONS'}}}),
+          'SESSIONS'
+        );
+      });
+    });
+
+    describe('breakoutsChanged', () => {
+      it('should return true if breakouts have changed', () => {
+        const current = {
+          breakoutSessions: {
+            allowed: [
+              {
+                name: 'Breakout session 2',
+                groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                sessionType: 'BREAKOUT',
+              },
+            ],
+          },
+          breakout: {},
+        };
+        const previous = {
+          breakoutSessions: {
+            active: [
+              {
+                name: 'Breakout session 2',
+                groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                sessionType: 'BREAKOUT',
+              },
+            ],
+          },
+          breakout: {},
+        };
+
+        assert.isTrue(SelfUtils.breakoutsChanged(previous, current));
+      });
+
+      it('should return false if breakouts have not changed', () => {
+        const current = {
+          breakoutSessions: {
+            active: [
+              {
+                name: 'Breakout session 2',
+                groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                sessionType: 'BREAKOUT',
+              },
+            ],
+          },
+          breakout: {},
+        };
+        const previous = {
+          breakoutSessions: {
+            active: [
+              {
+                name: 'Breakout session 2',
+                groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                sessionType: 'BREAKOUT',
+              },
+            ],
+          },
+          breakout: {},
+        };
+
+        assert.isFalse(SelfUtils.breakoutsChanged(previous, current));
+      });
+
+      it('should return false if no breakouts in current', () => {
+        const current = {
+          breakoutSessions: {
+          },
+        };
+        const previous = {
+          breakoutSessions: {
+            active: [
+              {
+                name: 'Breakout session 2',
+                groupId: '0e73abb8-5584-49d8-be8d-806d2a8247ca',
+                sessionId: '1cf41ab1-2e57-4d95-b7e9-5613acddfb0f',
+                sessionType: 'BREAKOUT',
+              },
+            ],
+          },
+          breakout: {},
+        };
+
+        assert.isFalse(SelfUtils.breakoutsChanged(previous, current));
+      });
+    });
+
     describe('canNotViewTheParticipantList', () => {
       it('should return the correct value', () => {
-        assert.equal(SelfUtils.canNotViewTheParticipantList(self), self.canNotViewTheParticipantList);
+        assert.equal(
+          SelfUtils.canNotViewTheParticipantList(self),
+          self.canNotViewTheParticipantList
+        );
       });
 
       it('should return false if the new self does not have a value', () => {
@@ -90,17 +206,23 @@ describe('plugin-meetings', () => {
       it('get roles works', () => {
         assert.deepEqual(SelfUtils.getRoles(self), ['PRESENTER']);
 
-        assert.deepEqual(SelfUtils.getRoles({
-          controls: {
-            role: {roles: [{type: 'SOME_ARBITRARY_ROLE', hasRole: true}]}
-          }
-        }), ['SOME_ARBITRARY_ROLE']);
-
-        assert.deepEqual(SelfUtils.getRoles({
-          controls: {
-            role: {roles: [{type: 'SOME_ARBITRARY_ROLE', hasRole: false}]}
-          }
-        }), []);
+        assert.deepEqual(
+          SelfUtils.getRoles({
+            controls: {
+              role: {roles: [{type: 'SOME_ARBITRARY_ROLE', hasRole: true}]},
+            },
+          }),
+          ['SOME_ARBITRARY_ROLE']
+        );
+
+        assert.deepEqual(
+          SelfUtils.getRoles({
+            controls: {
+              role: {roles: [{type: 'SOME_ARBITRARY_ROLE', hasRole: false}]},
+            },
+          }),
+          []
+        );
 
         assert.deepEqual(SelfUtils.getRoles({}), []);
         assert.deepEqual(SelfUtils.getRoles(), []);
@@ -129,6 +251,55 @@ describe('plugin-meetings', () => {
           assert.equal(updates.canNotViewTheParticipantListChanged, false);
         });
       });
+
+      describe('localAudioUnmuteRequestedByServer', () => {
+        it('should return localAudioUnmuteRequestedByServer = false when requestedToUnmute = false', () => {
+          const clonedSelf = cloneDeep(self);
+
+          const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+          assert.equal(updates.localAudioUnmuteRequestedByServer, false);
+        });
+
+        it('should return localAudioUnmuteRequestedByServer = true when first request is made with requestedToUnmute = true', () => {
+          const clonedSelf = cloneDeep(self);
+
+          //request to unmute with timestamp
+          clonedSelf.controls.audio.requestedToUnmute = true;
+          clonedSelf.controls.audio.lastModifiedRequestedToUnmute = '2023-06-16T18:25:04.369Z';
+
+          const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+          assert.equal(updates.localAudioUnmuteRequestedByServer, true);
+        });
+
+        it('should return localAudioUnmuteRequestedByServer = true when requestedToUnmute = true and new requests lastModifiedRequestedToUnmute timestamp is greater than old one', () => {
+          self.controls.audio.requestedToUnmute = true;
+          self.controls.audio.lastModifiedRequestedToUnmute = '2023-06-16T18:25:04.369Z';
+          const clonedSelf = cloneDeep(self);
+
+          //request to unmute with timestamp
+          clonedSelf.controls.audio.requestedToUnmute = true;
+          clonedSelf.controls.audio.lastModifiedRequestedToUnmute = '2023-06-16T19:25:04.369Z';
+
+          const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+          assert.equal(updates.localAudioUnmuteRequestedByServer, true);
+        });
+
+        it('should return localAudioUnmuteRequestedByServer = false when requestedToUnmute but lastModifiedRequestedToUnmute timestamps are same', () => {
+          self.controls.audio.requestedToUnmute = true;
+          self.controls.audio.lastModifiedRequestedToUnmute = '2023-06-16T18:25:04.369Z';
+          const clonedSelf = cloneDeep(self);
+
+          clonedSelf.controls.audio.requestedToUnmute = true;
+          clonedSelf.controls.audio.lastModifiedRequestedToUnmute = '2023-06-16T18:25:04.369Z'
+
+          const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+          assert.equal(updates.localAudioUnmuteRequestedByServer, false);
+        });
+      });
     });
 
     describe('isSharingBlocked', () => {
@@ -173,4 +344,117 @@ describe('plugin-meetings', () => {
       assert.deepEqual(SelfUtils.isJoined(customSelf), false);
     });
   });
+
+  describe('videoMutedByOthersChanged', () => {
+    it('returns true if changed', () => {
+      assert.equal(
+        SelfUtils.videoMutedByOthersChanged({remoteVideoMuted: true}, {remoteVideoMuted: false}),
+        true
+      );
+    });
+
+    it('returns true if changed from undefined', () => {
+      assert.equal(SelfUtils.videoMutedByOthersChanged({}, {remoteVideoMuted: false}), true);
+    });
+
+    it('returns false if not changed', () => {
+      assert.equal(
+        SelfUtils.videoMutedByOthersChanged({remoteVideoMuted: false}, {remoteVideoMuted: false}),
+        false
+      );
+    });
+  });
+
+  describe('getReplacedBreakoutMoveId', () => {
+    const deviceId = 'https://wdm-a.wbx2.com/wdm/api/v1/devices/20eabde3-4254-48da-9a24';
+    const breakoutMoveId = 'e5caeb2c-ffcc-4e06-a08a-1122e7710398';
+    const clonedSelf = cloneDeep(self);
+
+    it('get breakoutMoveId works', () => {
+
+      assert.deepEqual(SelfUtils.getReplacedBreakoutMoveId(self, deviceId), breakoutMoveId);
+
+    });
+
+    it('replaces is empty', () => {
+
+      clonedSelf.devices[0].replaces = undefined;
+      assert.deepEqual(SelfUtils.getReplacedBreakoutMoveId(clonedSelf, deviceId), null);
+
+    });
+
+    it('no self or self.devices is not array', () => {
+
+      assert.deepEqual(SelfUtils.getReplacedBreakoutMoveId(undefined, deviceId), null);
+
+      clonedSelf.devices =     {
+        url: 'https://wdm-a.wbx2.com/wdm/api/v1/devices/20eabde3-4254-48da-9a24',
+        deviceType: 'WEB',
+        mediaSessionsExternal: false,
+        replaces: [
+          {
+            breakoutMoveId: 'e5caeb2c-ffcc-4e06-a08a-1122e7710398',
+            lastActive: '2023-05-04T07:14:32.068Z',
+            locusUrl: 'https://locus-alpha-apdx.prod.meetapi.webex.com/locus/api/v1/loci/495061ca-7b3c-3b77-85ff-4e1bd58600d1',
+            replacedAt: '2023-05-04T07:16:04.905Z',
+            sessionId: 'be3147d4-c318-86d8-7611-8d24beaaca8d',
+          }
+        ],
+        state: 'JOINED',
+      };
+      assert.deepEqual(SelfUtils.getReplacedBreakoutMoveId(clonedSelf, deviceId), null);
+    });
+  });
+
+  describe('isRolesChanged', () => {
+    it('should return false if new self is null', () => {
+      const parsedSelf = SelfUtils.parse(self);
+
+      assert.deepEqual(SelfUtils.isRolesChanged(parsedSelf, null), false);
+    });
+
+    it('should return true if self roles has changed', () => {
+      const parsedSelf = SelfUtils.parse(self);
+      const clonedSelf = cloneDeep(parsedSelf);
+
+      clonedSelf.roles = ['COHOST'];
+
+      assert.deepEqual(SelfUtils.isRolesChanged(parsedSelf, clonedSelf), true);
+    });
+
+    it('should return false if self roles has not changed', () => {
+      const parsedSelf = SelfUtils.parse(self);
+      const clonedSelf = cloneDeep(parsedSelf);
+
+      clonedSelf.roles = ['PRESENTER'];
+
+      assert.deepEqual(SelfUtils.isRolesChanged(parsedSelf, clonedSelf), false);
+    });
+  });
+
+  describe('interpretationChanged', () => {
+    it('should return false if new self is null', () => {
+      const parsedSelf = SelfUtils.parse(self);
+
+      assert.deepEqual(SelfUtils.interpretationChanged(parsedSelf, null), false);
+    });
+
+    it('should return true if interpretation info has changed', () => {
+      const parsedSelf = SelfUtils.parse(self);
+      const clonedSelf = cloneDeep(parsedSelf);
+
+      clonedSelf.interpretation.sourceLanguage = 'ja';
+
+      assert.deepEqual(SelfUtils.interpretationChanged(parsedSelf, clonedSelf), true);
+    });
+
+    it('should return false if interpretation info  has not changed', () => {
+      const parsedSelf = SelfUtils.parse(self);
+      const clonedSelf = cloneDeep(parsedSelf);
+
+      clonedSelf.interpretation.sourceLanguage = 'en';
+
+      assert.deepEqual(SelfUtils.interpretationChanged(parsedSelf, clonedSelf), false);
+    });
+  });
 });

package/test/unit/spec/media/index.ts

@@ -1,18 +1,32 @@
-import * as internalMediaModule from '@webex/plugin-meetings/src/media/internal-media-core-wrapper';
+import * as internalMediaModule from '@webex/internal-media-core';
 import Media from '@webex/plugin-meetings/src/media/index';
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 import StaticConfig from '@webex/plugin-meetings/src/common/config';
+import {forEach} from 'lodash';
+import MockWebex from '@webex/test-helper-mock-webex';
 
 describe('createMediaConnection', () => {
+  const webex = MockWebex();
+
   const fakeRoapMediaConnection = {
     id: 'roap media connection',
   };
   const fakeAudioTrack = {
     id: 'audio track',
+    underlyingTrack: 'underlying audio track',
   };
   const fakeVideoTrack = {
     id: 'video track',
+    underlyingTrack: 'underlying video track',
+  };
+  const fakeShareVideoTrack = {
+    id: 'share video track',
+    underlyingTrack: 'underlying share video track',
+  };
+  const fakeShareAudioTrack = {
+    id: 'share audio track',
+    underlyingTrack: 'underlying share audio track',
   };
 
   afterEach(() => {
@@ -29,32 +43,30 @@ describe('createMediaConnection', () => {
     const ENABLE_EXTMAP = false;
     const ENABLE_RTX = true;
 
-    Media.createMediaConnection(
-      {
+    Media.createMediaConnection(false, 'some debug id', webex, 'meetingId', {
+      mediaProperties: {
         mediaDirection: {
-          sendAudio: true,
+          sendAudio: false,
           sendVideo: true,
           sendShare: false,
-          receiveAudio: true,
+          receiveAudio: false,
           receiveVideo: true,
           receiveShare: true,
         },
         audioTrack: fakeAudioTrack,
         videoTrack: fakeVideoTrack,
-        shareTrack: null,
+        shareVideoTrack: null,
+        shareAudioTrack: null,
       },
-      {
-        isMultistream: false,
-        remoteQualityLevel: 'HIGH',
-        enableRtx: ENABLE_RTX,
-        enableExtmap: ENABLE_EXTMAP,
-        turnServerInfo: {
-          url: 'turn server url',
-          username: 'turn username',
-          password: 'turn password',
-        },
-      }
-    );
+      remoteQualityLevel: 'HIGH',
+      enableRtx: ENABLE_RTX,
+      enableExtmap: ENABLE_EXTMAP,
+      turnServerInfo: {
+        url: 'turn server url',
+        username: 'turn username',
+        password: 'turn password',
+      },
+    });
     assert.calledOnce(roapMediaConnectionConstructorStub);
     assert.calledWith(
       roapMediaConnectionConstructorStub,
@@ -82,19 +94,19 @@ describe('createMediaConnection', () => {
         },
       },
       {
-        send: {
-          audio: fakeAudioTrack,
-          video: fakeVideoTrack,
-          screenShareVideo: null,
+        localTracks: {
+          audio: fakeAudioTrack.underlyingTrack,
+          video: fakeVideoTrack.underlyingTrack,
+          screenShareVideo: undefined,
         },
-        receive: {
-          audio: true,
-          video: true,
-          screenShareVideo: true,
-          remoteQualityLevel: 'HIGH',
+        direction: {
+          audio: 'inactive',
+          video: 'sendrecv',
+          screenShareVideo: 'recvonly',
         },
+        remoteQualityLevel: 'HIGH',
       },
-      'mc'
+      'some debug id'
     );
   });
 
@@ -103,17 +115,24 @@ describe('createMediaConnection', () => {
       .stub(internalMediaModule, 'MultistreamRoapMediaConnection')
       .returns(fakeRoapMediaConnection);
 
-    Media.createMediaConnection(
-      {},
-      {
-        isMultistream: true,
-        turnServerInfo: {
-          url: 'turn server url',
-          username: 'turn username',
-          password: 'turn password',
+    Media.createMediaConnection(true, 'some debug id', webex, 'meeting id', {
+      mediaProperties: {
+        mediaDirection: {
+          sendAudio: true,
+          sendVideo: true,
+          sendShare: false,
+          receiveAudio: true,
+          receiveVideo: true,
+          receiveShare: true,
         },
-      }
-    );
+      },
+      turnServerInfo: {
+        url: 'turn server url',
+        username: 'turn username',
+        password: 'turn password',
+      },
+      bundlePolicy: 'max-bundle',
+    });
     assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
     assert.calledWith(
       multistreamRoapMediaConnectionConstructorStub,
@@ -125,31 +144,108 @@ describe('createMediaConnection', () => {
             credential: 'turn password',
           },
         ],
+        enableMainAudio: true,
+        enableMainVideo: true,
+        bundlePolicy: 'max-bundle',
       },
-      'mc'
+      'meeting id'
     );
   });
 
+  forEach([
+    {sendAudio: true, receiveAudio: true, sendVideo: true, receiveVideo: true, enableMainAudio: true, enableMainVideo: true,},
+    {sendAudio: true, receiveAudio: false, sendVideo: true, receiveVideo: false, enableMainAudio: true, enableMainVideo: true,},
+    {sendAudio: false, receiveAudio: true, sendVideo: false, receiveVideo: true, enableMainAudio: true, enableMainVideo: true,},
+    {sendAudio: false, receiveAudio: false, sendVideo: false, receiveVideo: false, enableMainAudio: false, enableMainVideo: false,},
+  ], ({sendAudio, sendVideo, receiveAudio, receiveVideo, enableMainAudio, enableMainVideo}) => {
+    it(`sets enableMainVideo to ${enableMainVideo} and enableMainAudio to ${enableMainAudio} when sendAudio: ${sendAudio} sendVideo: ${sendVideo} receiveAudio: ${receiveAudio} receiveVideo: ${receiveVideo}`, () => {
+      const multistreamRoapMediaConnectionConstructorStub = sinon
+        .stub(internalMediaModule, 'MultistreamRoapMediaConnection')
+        .returns(fakeRoapMediaConnection);
+
+        Media.createMediaConnection(true, 'some debug id', webex, 'meeting id', {
+          mediaProperties: {
+            mediaDirection: {
+              sendAudio,
+              sendVideo,
+              sendShare: false,
+              receiveAudio,
+              receiveVideo,
+              receiveShare: true,
+            },
+          },
+        });
+        assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
+        assert.calledWith(
+          multistreamRoapMediaConnectionConstructorStub,
+          {
+            iceServers: [],
+            enableMainAudio,
+            enableMainVideo,
+          },
+          'meeting id'
+        );
+      });
+    }
+  );
+
   it('passes empty ICE servers array to MultistreamRoapMediaConnection if turnServerInfo is undefined (multistream enabled)', () => {
     const multistreamRoapMediaConnectionConstructorStub = sinon
       .stub(internalMediaModule, 'MultistreamRoapMediaConnection')
       .returns(fakeRoapMediaConnection);
 
-    Media.createMediaConnection(
-      {},
-      {
-        isMultistream: true,
-        turnServerInfo: undefined,
-      }
-    );
+    Media.createMediaConnection(true, 'debug string', webex, 'meeting id', {
+      mediaProperties: {
+        mediaDirection: {
+          sendAudio: true,
+          sendVideo: true,
+          sendShare: false,
+          receiveAudio: true,
+          receiveVideo: true,
+          receiveShare: true,
+        },
+      },
+    });
     assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
     assert.calledWith(
       multistreamRoapMediaConnectionConstructorStub,
       {
         iceServers: [],
+        enableMainAudio: true,
+        enableMainVideo: true,
       },
-      'mc'
+      'meeting id'
     );
+
+    it('does not pass bundlePolicy to MultistreamRoapMediaConnection if bundlePolicy is undefined', () => {
+      const multistreamRoapMediaConnectionConstructorStub = sinon
+        .stub(internalMediaModule, 'MultistreamRoapMediaConnection')
+        .returns(fakeRoapMediaConnection);
+
+      Media.createMediaConnection(true, 'debug string', webex, 'meeting id', {
+        mediaProperties: {
+          mediaDirection: {
+            sendAudio: true,
+            sendVideo: true,
+            sendShare: false,
+            receiveAudio: true,
+            receiveVideo: true,
+            receiveShare: true,
+          },
+        },
+        bundlePolicy: undefined,
+      });
+      assert.calledOnce(multistreamRoapMediaConnectionConstructorStub);
+      assert.calledWith(
+        multistreamRoapMediaConnectionConstructorStub,
+        {
+          iceServers: [],
+          enableMainAudio: true,
+          enableMainVideo: true,
+        },
+        'meeting id'
+      );
+    });
   });
 
   it('passes empty ICE servers array to RoapMediaConnection if turnServerInfo is undefined (multistream disabled)', () => {
@@ -162,8 +258,8 @@ describe('createMediaConnection', () => {
     const ENABLE_EXTMAP = false;
     const ENABLE_RTX = true;
 
-    Media.createMediaConnection(
-      {
+    Media.createMediaConnection(false, 'some debug id', webex, 'meeting id', {
+      mediaProperties: {
         mediaDirection: {
           sendAudio: true,
           sendVideo: true,
@@ -174,16 +270,14 @@ describe('createMediaConnection', () => {
         },
         audioTrack: fakeAudioTrack,
         videoTrack: null,
-        shareTrack: fakeVideoTrack,
+        shareVideoTrack: fakeShareVideoTrack,
+        shareAudioTrack: fakeShareAudioTrack,
       },
-      {
-        isMultistream: false,
-        remoteQualityLevel: 'HIGH',
-        enableRtx: ENABLE_RTX,
-        enableExtmap: ENABLE_EXTMAP,
-        turnServerInfo: undefined,
-      }
-    );
+      remoteQualityLevel: 'HIGH',
+      enableRtx: ENABLE_RTX,
+      enableExtmap: ENABLE_EXTMAP,
+      turnServerInfo: undefined,
+    });
     assert.calledOnce(roapMediaConnectionConstructorStub);
     assert.calledWith(
       roapMediaConnectionConstructorStub,
@@ -205,19 +299,19 @@ describe('createMediaConnection', () => {
         },
       },
       {
-        send: {
-          audio: fakeAudioTrack,
-          video: null,
-          screenShareVideo: fakeVideoTrack,
+        localTracks: {
+          audio: fakeAudioTrack.underlyingTrack,
+          video: undefined,
+          screenShareVideo: fakeShareVideoTrack.underlyingTrack,
         },
-        receive: {
-          audio: true,
-          video: true,
-          screenShareVideo: true,
-          remoteQualityLevel: 'HIGH',
+        direction: {
+          audio: 'sendrecv',
+          video: 'sendrecv',
+          screenShareVideo: 'sendrecv',
         },
+        remoteQualityLevel: 'HIGH',
       },
-      'mc'
+      'some debug id'
     );
   });
 });