@webex/plugin-meetings 2.19.3 → 2.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "2.19.3",
+  "version": "2.20.0",
   "description": "",
   "license": "MIT",
   "contributors": [
@@ -24,15 +24,15 @@
   },
   "dependencies": {
     "@babel/runtime-corejs2": "^7.14.8",
-    "@webex/webex-core": "2.19.3",
-    "@webex/internal-plugin-mercury": "2.19.3",
-    "@webex/internal-plugin-conversation": "2.19.3",
+    "@webex/webex-core": "2.20.0",
+    "@webex/internal-plugin-mercury": "2.20.0",
+    "@webex/internal-plugin-conversation": "2.20.0",
     "webrtc-adapter": "^7.7.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2",
     "global": "^4.4.0",
     "ip-anonymize": "^0.1.0",
-    "@webex/common": "2.19.3",
+    "@webex/common": "2.20.0",
     "bowser": "^2.11.0",
     "sdp-transform": "^2.12.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -284,6 +284,7 @@ export const EVENT_TRIGGERS = {
   MEETING_SELF_UNMUTED_BY_OTHERS: 'meeting:self:unmutedByOthers',
   MEETING_SELF_REQUESTED_TO_UNMUTE: 'meeting:self:requestedToUnmute',
   MEETING_SELF_PHONE_AUDIO_UPDATE: 'meeting:self:phoneAudioUpdate',
+  MEETING_CONTROLS_LAYOUT_UPDATE: 'meeting:layout:update',
   MEMBERS_UPDATE: 'members:update',
   MEMBERS_CONTENT_UPDATE: 'members:content:update',
   MEMBERS_HOST_UPDATE: 'members:host:update',
@@ -486,6 +487,7 @@ export const LOCUS = {
 
 export const LOCUSINFO = {
   EVENTS: {
+    CONTROLS_MEETING_LAYOUT_UPDATED: 'CONTROLS_MEETING_LAYOUT_UPDATED',
     CONTROLS_RECORDING_UPDATED: 'CONTROLS_RECORDING_UPDATED',
     CONTROLS_MEETING_TRANSCRIBE_UPDATED: 'CONTROLS_MEETING_TRANSCRIBE_UPDATED',
     CONTROLS_MEETING_CONTAINER_UPDATED: 'CONTROLS_MEETING_CONTAINER_UPDATED',

package/src/locus-info/index.js

@@ -927,6 +927,17 @@ export default class LocusInfo extends EventsScope {
         this.compareAndUpdateFlags.compareHostAndSelf = false;
       }
 
+      if (parsedSelves.updates.layoutChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf'
+          },
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
+          {layout: parsedSelves.current.layout}
+        );
+      }
+
       if (parsedSelves.updates.isMediaInactiveOrReleased) {
         this.emitScoped(
           {

package/src/locus-info/selfUtils.js

@@ -58,12 +58,15 @@ SelfUtils.parse = (self, deviceId) => {
       removed: self.removed,
       roles: SelfUtils.getRoles(self),
       isUserUnadmitted: self.state === _IDLE_ && joinedWith?.intent?.type === _WAIT_,
+      layout: SelfUtils.getLayout(self)
     };
   }
 
   return null;
 };
 
+SelfUtils.getLayout = (self) => (Array.isArray(self?.controls?.layouts) ? self.controls.layouts[0].type : undefined);
+
 SelfUtils.getRoles = (self) => (self?.controls?.role?.roles || []).reduce((roles, role) => {
   if (role.hasRole) {
     roles.push(role.type);
@@ -85,6 +88,7 @@ SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
   updates.moderatorChanged = SelfUtils.moderatorChanged(previous, current);
   updates.isMediaInactiveOrReleased = SelfUtils.wasMediaInactiveOrReleased(previous, current);
   updates.isUserObserving = SelfUtils.isDeviceObserving(previous, current);
+  updates.layoutChanged = SelfUtils.layoutChanged(previous, current);
 
   updates.isMediaInactive = SelfUtils.isMediaInactive(previous, current);
   updates.audioStateChange = previous?.currentMediaStatus.audio !== current.currentMediaStatus.audio;
@@ -105,6 +109,15 @@ SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
 */
 SelfUtils.isJoined = (self) => self?.state === _JOINED_;
 
+/**
+ * Validate if the Meeting Layout Controls Layout has changed.
+ *
+ * @param {Self} previous - Previous self state
+ * @param {Self} current - Current self state [per event]
+ * @returns {boolean} - If the MEeting Layout Controls Layout has changed.
+ */
+SelfUtils.layoutChanged = (previous, current) => current?.layout && previous?.layout !== current?.layout;
+
 
 SelfUtils.isMediaInactive = (previous, current) => {
   if (

package/src/meeting/index.js

@@ -5216,6 +5216,20 @@ export default class Meeting extends StatelessWebexPlugin {
     }
     this.lastVideoLayoutInfo = cloneDeep(layoutInfo);
 
+    this.locusInfo.once(LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED, (envelope) => {
+      Trigger.trigger(
+        this,
+        {
+          file: 'meeting/index',
+          function: 'changeVideoLayout',
+        },
+        EVENT_TRIGGERS.MEETING_CONTROLS_LAYOUT_UPDATE,
+        {
+          layout: envelope.layout
+        }
+      );
+    });
+
     return this.meetingRequest
       .changeVideoLayoutDebounced({
         locusUrl: this.locusInfo.self.url,

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

@@ -428,6 +428,52 @@ describe('plugin-meetings', () => {
     });
 
     describe('#updateSelf', () => {
+      it('should trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls change', () => {
+        const layoutType = 'EXAMPLE TYPE';
+
+        locusInfo.self = undefined;
+        const selfWithLayoutChanged = cloneDeep(self);
+
+        selfWithLayoutChanged.controls.layouts = [{
+          type: layoutType,
+        }];
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateSelf(selfWithLayoutChanged, []);
+
+        assert.calledWith(locusInfo.emitScoped, {
+          file: 'locus-info',
+          function: 'updateSelf'
+        },
+        LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
+        {layout: layoutType});
+      });
+
+      it('should not trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls did not change', () => {
+        const layoutType = 'EXAMPLE TYPE';
+
+        locusInfo.self = undefined;
+        const selfWithLayoutChanged = cloneDeep(self);
+
+        selfWithLayoutChanged.controls.layouts = [{
+          type: layoutType,
+        }];
+
+        // Set the layout prior to stubbing to validate it does not change.
+        locusInfo.updateSelf(selfWithLayoutChanged, []);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        locusInfo.updateSelf(selfWithLayoutChanged, []);
+
+        assert.neverCalledWith(locusInfo.emitScoped, {
+          file: 'locus-info',
+          function: 'updateSelf'
+        },
+        LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
+        {layout: layoutType});
+      });
+
       it('should trigger MEDIA_INACTIVITY on server media inactivity', () => {
         locusInfo.self = self;
 

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

@@ -1,5 +1,6 @@
 import {assert} from '@webex/test-helper-chai';
 import Sinon from 'sinon';
+import {cloneDeep} from 'lodash';
 
 import SelfUtils from '@webex/plugin-meetings/src/locus-info/selfUtils';
 
@@ -7,6 +8,23 @@ import {self} from './selfConstant';
 
 describe('plugin-meetings', () => {
   describe('selfUtils', () => {
+    describe('layoutChanged', () => {
+      it('should return true if the layout has changed', () => {
+        const parsedSelf = SelfUtils.parse(self);
+        const clonedSelf = cloneDeep(parsedSelf);
+
+        clonedSelf.layout = 'DIFFERENT';
+
+        assert.deepEqual(SelfUtils.layoutChanged(parsedSelf, clonedSelf), true);
+      });
+
+      it('should return false if the layout has not changed', () => {
+        const parsedSelf = SelfUtils.parse(self);
+
+        assert.deepEqual(SelfUtils.layoutChanged(parsedSelf, parsedSelf), false);
+      });
+    });
+
     describe('parse', () => {
       it('parse calls getRoles and returns the resulting roles', () => {
         const getRolesSpy = Sinon.spy(SelfUtils, 'getRoles');
@@ -17,6 +35,28 @@ describe('plugin-meetings', () => {
 
         assert.deepEqual(parsedSelf.roles, ['PRESENTER']);
       });
+
+      it('calls getLayout and returns the resulting layout', () => {
+        const spy = Sinon.spy(SelfUtils, 'getLayout');
+        const parsedSelf = SelfUtils.parse(self);
+
+        assert.calledWith(spy, self);
+        assert.deepEqual(parsedSelf.layout, self.controls.layouts[0].type);
+      });
+    });
+
+    describe('getLayout', () => {
+      it('should get supplied layout', () => {
+        assert.deepEqual(SelfUtils.getLayout(self), self.controls.layouts[0].type);
+      });
+
+      it('should return undefined if the new self does not have a provided layout', () => {
+        const mutatedSelf = cloneDeep(self);
+
+        delete mutatedSelf.controls.layouts;
+
+        assert.deepEqual(SelfUtils.getLayout(mutatedSelf), undefined);
+      });
     });
 
     describe('getRoles', () => {

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

@@ -10,6 +10,17 @@ import {assert} from '@webex/test-helper-chai';
 import {Credentials} from '@webex/webex-core';
 import Support from '@webex/internal-plugin-support';
 import MockWebex from '@webex/test-helper-mock-webex';
+import {
+  FLOOR_ACTION,
+  SHARE_STATUS,
+  MEETING_INFO_FAILURE_REASON,
+  PASSWORD_STATUS,
+  EVENTS,
+  EVENT_TRIGGERS,
+  _SIP_URI_,
+  _MEETING_ID_,
+  LOCUSINFO,
+} from '@webex/plugin-meetings/src/constants';
 
 import * as StatsAnalyzerModule from '@webex/plugin-meetings/src/statsAnalyzer';
 import EventsScope from '@webex/plugin-meetings/src/common/events/events-scope';
@@ -31,16 +42,6 @@ import TriggerProxy from '@webex/plugin-meetings/src/common/events/trigger-proxy
 import BrowserDetection from '@webex/plugin-meetings/src/common/browser-detection';
 import Metrics from '@webex/plugin-meetings/src/metrics';
 import {eventType} from '@webex/plugin-meetings/src/metrics/config';
-import {
-  FLOOR_ACTION,
-  SHARE_STATUS,
-  MEETING_INFO_FAILURE_REASON,
-  PASSWORD_STATUS,
-  EVENTS,
-  EVENT_TRIGGERS,
-  _SIP_URI_,
-  _MEETING_ID_,
-} from '@webex/plugin-meetings/src/constants';
 import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
 
 import locus from '../fixture/locus';
@@ -1912,6 +1913,15 @@ describe('plugin-meetings', () => {
             };
           });
 
+          it('should listen once for CONTROLS_MEETING_LAYOUT_UPDATED', async () => {
+            // const spy = sinon.spy(TriggerProxy, 'trigger');
+            const spy = sinon.spy(meeting.locusInfo, 'once');
+
+            await meeting.changeVideoLayout('Equal');
+
+            assert.calledWith(spy, LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED);
+          });
+
           it('should have receiveVideo true and remote video track should exist', () => {
             assert.equal(meeting.mediaProperties.mediaDirection.receiveVideo, true);
             assert.exists(meeting.mediaProperties.remoteVideoTrack);