@webex/plugin-meetings 2.30.2 → 2.31.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "2.30.2",
+  "version": "2.31.1",
   "description": "",
   "license": "MIT",
   "contributors": [
@@ -24,29 +24,29 @@
     ]
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "2.30.2",
-    "@webex/test-helper-chai": "2.30.2",
-    "@webex/test-helper-mocha": "2.30.2",
-    "@webex/test-helper-mock-webex": "2.30.2",
-    "@webex/test-helper-retry": "2.30.2",
-    "@webex/test-helper-test-users": "2.30.2",
+    "@webex/plugin-meetings": "2.31.1",
+    "@webex/test-helper-chai": "2.31.1",
+    "@webex/test-helper-mocha": "2.31.1",
+    "@webex/test-helper-mock-webex": "2.31.1",
+    "@webex/test-helper-retry": "2.31.1",
+    "@webex/test-helper-test-users": "2.31.1",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "2.30.2",
+    "@webex/common": "2.31.1",
     "@webex/internal-media-core": "^0.0.7-beta",
-    "@webex/internal-plugin-conversation": "2.30.2",
-    "@webex/internal-plugin-device": "2.30.2",
-    "@webex/internal-plugin-mercury": "2.30.2",
-    "@webex/internal-plugin-metrics": "2.30.2",
-    "@webex/internal-plugin-support": "2.30.2",
-    "@webex/internal-plugin-user": "2.30.2",
-    "@webex/plugin-people": "2.30.2",
-    "@webex/plugin-rooms": "2.30.2",
-    "@webex/webex-core": "2.30.2",
+    "@webex/internal-plugin-conversation": "2.31.1",
+    "@webex/internal-plugin-device": "2.31.1",
+    "@webex/internal-plugin-mercury": "2.31.1",
+    "@webex/internal-plugin-metrics": "2.31.1",
+    "@webex/internal-plugin-support": "2.31.1",
+    "@webex/internal-plugin-user": "2.31.1",
+    "@webex/plugin-people": "2.31.1",
+    "@webex/plugin-rooms": "2.31.1",
+    "@webex/webex-core": "2.31.1",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
     "dotenv": "^4.0.0",

package/src/constants.ts

@@ -286,7 +286,10 @@ 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_SELF_CANNOT_VIEW_PARTICIPANT_LIST: 'meeting:self:cannotViewParticipantList',
+  MEETING_SELF_IS_SHARING_BLOCKED: 'meeting:self:isSharingBlocked',
   MEETING_CONTROLS_LAYOUT_UPDATE: 'meeting:layout:update',
+  MEETING_ENTRY_EXIT_TONE_UPDATE: 'meeting:entryExitTone:update',
   MEMBERS_UPDATE: 'members:update',
   MEMBERS_CONTENT_UPDATE: 'members:content:update',
   MEMBERS_HOST_UPDATE: 'members:host:update',
@@ -494,6 +497,7 @@ export const LOCUSINFO = {
     CONTROLS_RECORDING_UPDATED: 'CONTROLS_RECORDING_UPDATED',
     CONTROLS_MEETING_TRANSCRIBE_UPDATED: 'CONTROLS_MEETING_TRANSCRIBE_UPDATED',
     CONTROLS_MEETING_CONTAINER_UPDATED: 'CONTROLS_MEETING_CONTAINER_UPDATED',
+    CONTROLS_ENTRY_EXIT_TONE_UPDATED: 'CONTROLS_ENTRY_EXIT_TONE_UPDATED',
     SELF_UNADMITTED_GUEST: 'SELF_UNADMITTED_GUEST',
     SELF_ADMITTED_GUEST: 'SELF_ADMITTED_GUEST',
     SELF_REMOTE_MUTE_STATUS_UPDATED: 'SELF_REMOTE_MUTE_STATUS_UPDATED',
@@ -510,7 +514,9 @@ export const LOCUSINFO = {
     MEETING_UNLOCKED: 'MEETING_UNLOCKED',
     SELF_OBSERVING: 'SELF_OBSERVING',
     DISCONNECT_DUE_TO_INACTIVITY: 'DISCONNECT_DUE_TO_INACTIVITY',
-    EMBEDDED_APPS_UPDATED: 'EMBEDDED_APPS_UPDATED'
+    EMBEDDED_APPS_UPDATED: 'EMBEDDED_APPS_UPDATED',
+    SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE: 'SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE',
+    SELF_IS_SHARING_BLOCKED_CHANGE: 'SELF_IS_SHARING_BLOCKED_CHANGE',
   }
 };
 

package/src/locus-info/controlsUtils.js

@@ -42,13 +42,17 @@ ControlsUtils.parse = (controls) => {
     };
   }
 
+  if (controls && controls.entryExitTone) {
+    parsedControls.entryExitTone = controls.entryExitTone.enabled ? controls.entryExitTone.mode : null;
+  }
+
   return parsedControls;
 };
 
 /**
  * parses and returns previous state vs current state and triggers the changes.
- * @param {LocusControl} oldControls previous state
- * @param {LocusControl} newControls current state
+ * @param {LocusControls} oldControls previous state
+ * @param {LocusControls} newControls current state
  * @returns {Object} combination of state plus the changes
  */
 ControlsUtils.getControls = (oldControls, newControls) => {
@@ -74,6 +78,10 @@ ControlsUtils.getControls = (oldControls, newControls) => {
       hasTranscribeChanged: current?.transcribe &&
           !isEqual(previous?.transcribe?.transcribing, current?.transcribe?.transcribing) && // upon first join, previous?.record?.recording = undefined; thus, never going to be equal and will always return true
           (previous?.transcribe?.transcribing || current?.transcribe?.transcribing), // therefore, condition added to prevent false firings of #meeting:recording:stopped upon first joining a meeting
+
+      hasEntryExitToneChanged: !!(newControls.entryExitTone &&
+          !isEqual(previous?.entryExitTone, current?.entryExitTone) &&
+          (previous?.entryExitTone || current?.entryExitTone)),
     }
   };
 };

package/src/locus-info/index.js

@@ -645,6 +645,7 @@ export default class LocusInfo extends EventsScope {
           hasRecordingPausedChanged,
           hasMeetingContainerChanged,
           hasTranscribeChanged,
+          hasEntryExitToneChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -710,6 +711,23 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasEntryExitToneChanged) {
+        const {entryExitTone} = current;
+
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
+          {
+            entryExitTone
+          }
+        );
+
+        this.updateMeeting({entryExitTone});
+      }
+
       this.controls = controls;
     }
   }
@@ -1116,6 +1134,28 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (parsedSelves.updates.canNotViewTheParticipantListChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
+          {canNotViewTheParticipantList: parsedSelves.current.canNotViewTheParticipantList}
+        );
+      }
+
+      if (parsedSelves.updates.isSharingBlockedChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
+          {isSharingBlocked: parsedSelves.current.isSharingBlocked}
+        );
+      }
+
       this.emitScoped(
         {
           file: 'locus-info',

package/src/locus-info/selfUtils.js

@@ -58,7 +58,9 @@ SelfUtils.parse = (self, deviceId) => {
       removed: self.removed,
       roles: SelfUtils.getRoles(self),
       isUserUnadmitted: self.state === _IDLE_ && joinedWith?.intent?.type === _WAIT_,
-      layout: SelfUtils.getLayout(self)
+      layout: SelfUtils.getLayout(self),
+      canNotViewTheParticipantList: SelfUtils.canNotViewTheParticipantList(self),
+      isSharingBlocked: SelfUtils.isSharingBlocked(self)
     };
   }
 
@@ -75,6 +77,10 @@ SelfUtils.getRoles = (self) => (self?.controls?.role?.roles || []).reduce((roles
   return roles;
 }, []);
 
+SelfUtils.canNotViewTheParticipantList = (self) => !!self?.canNotViewTheParticipantList;
+
+SelfUtils.isSharingBlocked = (self) => !!self?.isSharingBlocked;
+
 SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
   const previous = oldSelf && SelfUtils.parse(oldSelf, deviceId);
   const current = newSelf && SelfUtils.parse(newSelf, deviceId);
@@ -95,6 +101,9 @@ SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
   updates.videoStateChange = previous?.currentMediaStatus.video !== current.currentMediaStatus.video;
   updates.shareStateChange = previous?.currentMediaStatus.share !== current.currentMediaStatus.share;
 
+  updates.canNotViewTheParticipantListChanged = previous?.canNotViewTheParticipantList !== current.canNotViewTheParticipantList;
+  updates.isSharingBlockedChanged = previous?.isSharingBlocked !== current.isSharingBlocked;
+
   return {
     previous,
     current,

package/src/meeting/index.js

@@ -1589,6 +1589,19 @@ export default class Meeting extends StatelessWebexPlugin {
           );
         }
       });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
+      ({entryExitTone}) => {
+        Trigger.trigger(
+          this,
+          {
+            file: 'meeting/index',
+            function: 'setupLocusControlsListener'
+          },
+          EVENT_TRIGGERS.MEETING_ENTRY_EXIT_TONE_UPDATE,
+          {entryExitTone}
+        );
+      });
   }
 
   /**
@@ -2072,6 +2085,34 @@ export default class Meeting extends StatelessWebexPlugin {
         });
       }
     });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE, (payload) => {
+      Trigger.trigger(
+        this,
+        {
+          file: 'meeting/index',
+          function: 'setUpLocusInfoSelfListener'
+        },
+        EVENT_TRIGGERS.MEETING_SELF_CANNOT_VIEW_PARTICIPANT_LIST,
+        {
+          payload
+        }
+      );
+    });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE, (payload) => {
+      Trigger.trigger(
+        this,
+        {
+          file: 'meeting/index',
+          function: 'setUpLocusInfoSelfListener'
+        },
+        EVENT_TRIGGERS.MEETING_SELF_IS_SHARING_BLOCKED,
+        {
+          payload
+        }
+      );
+    });
   }
 
   /**

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

@@ -0,0 +1,82 @@
+import {assert} from '@webex/test-helper-chai';
+import ControlsUtils from '@webex/plugin-meetings/src/locus-info/controlsUtils';
+
+const defaultControls = {
+  entryExitTone: {
+    enabled: true,
+    mode: 'foo',
+  }
+};
+
+describe('plugin-meetings', () => {
+  describe('controlsUtils', () => {
+    describe('parse', () => {
+      it('parses entryExitTone', () => {
+        const parsedControls = ControlsUtils.parse(defaultControls);
+
+        assert.equal(parsedControls.entryExitTone, 'foo');
+      });
+
+      it('parses entryExitTone when disabled', () => {
+        const parsedControls = ControlsUtils.parse({
+          entryExitTone: {
+            enabled: false,
+            mode: 'foo',
+          }
+        });
+
+        assert.equal(parsedControls.entryExitTone, null);
+      });
+
+      it('handles no entryExitTone', () => {
+        const parsedControls = ControlsUtils.parse({});
+
+        assert.equal(parsedControls.entryExitTone, null);
+      });
+
+      it('handles no controls', () => {
+        const parsedControls = ControlsUtils.parse();
+
+        assert.equal(parsedControls.entryExitTone, null);
+      });
+    });
+  });
+
+  describe('getControls', () => {
+    it('returns hasEntryExitToneChanged = true when mode changed', () => {
+      const newControls = {
+        entryExitTone: {
+          enabled: true,
+          mode: 'bar',
+        }
+      };
+      const {updates} = ControlsUtils.getControls(defaultControls, newControls);
+
+      assert.equal(updates.hasEntryExitToneChanged, true);
+    });
+
+    it('returns hasEntryExitToneChanged = true when enabled changed', () => {
+      const newControls = {
+        entryExitTone: {
+          enabled: false,
+          mode: 'foo',
+        }
+      };
+      const {updates} = ControlsUtils.getControls(defaultControls, newControls);
+
+      assert.equal(updates.hasEntryExitToneChanged, true);
+    });
+
+    it('returns hasEntryExitToneChanged = false when nothing changed', () => {
+      const newControls = {
+        entryExitTone: {
+          enabled: true,
+          mode: 'foo',
+        }
+      };
+      const {updates} = ControlsUtils.getControls(defaultControls, newControls);
+
+      assert.equal(updates.hasEntryExitToneChanged, false);
+    });
+  });
+});

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

@@ -81,6 +81,7 @@ describe('plugin-meetings', () => {
           meetingContainer: {
             meetingContainerUrl: 'http://new-url.com',
           },
+          entryExitTone: {enabled: true, mode: 'foo'},
         };
       });
 
@@ -368,6 +369,35 @@ describe('plugin-meetings', () => {
           {meetingContainerUrl: 'http://new-url.com'}
         );
       });
+
+      it('should update the entryExitTone when changed', () => {
+        locusInfo.controls = {};
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateControls(newControls);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
+          {entryExitTone: 'foo'}
+        );
+      });
+
+      it('should not update the entryExitTone when unchanged', () => {
+        locusInfo.controls = {entryExitTone: {enabled: true, mode: 'foo'}};
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateControls(newControls);
+
+        locusInfo.emitScoped.getCalls().forEach((x) => {
+          // check that no calls in emitScoped are for CONTROLS_ENTRY_EXIT_TONE_UPDATED
+          assert.notEqual(x.args[1], LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED);
+        });
+      });
     });
 
     describe('#updateParticipants()', () => {
@@ -767,6 +797,98 @@ describe('plugin-meetings', () => {
           LOCUSINFO.EVENTS.SELF_OBSERVING
         );
       });
+
+      it('should not trigger SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE when not updated', () => {
+        const selfClone = cloneDeep(self);
+
+        selfClone.canNotViewTheParticipantList = false; // same
+
+        // Set the layout prior to stubbing to validate it does not change.
+        locusInfo.updateSelf(self, []);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        locusInfo.updateSelf(selfClone, []);
+
+        assert.neverCalledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
+          {canNotViewTheParticipantList: false}
+        );
+      });
+
+      it('should trigger SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE when updated', () => {
+        const selfClone = cloneDeep(self);
+
+        selfClone.canNotViewTheParticipantList = true; // different
+
+        // Set the layout prior to stubbing to validate it does not change.
+        locusInfo.updateSelf(self, []);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        locusInfo.updateSelf(selfClone, []);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE,
+          {canNotViewTheParticipantList: true}
+        );
+      });
+
+      it('should not trigger SELF_IS_SHARING_BLOCKED_CHANGE when not updated', () => {
+        const selfClone = cloneDeep(self);
+
+        selfClone.isSharingBlocked = false; // same
+
+        // Set the layout prior to stubbing to validate it does not change.
+        locusInfo.updateSelf(self, []);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        locusInfo.updateSelf(selfClone, []);
+
+        assert.neverCalledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
+          {isSharingBlocked: false}
+        );
+      });
+
+      it('should trigger SELF_IS_SHARING_BLOCKED_CHANGE when updated', () => {
+        const selfClone = cloneDeep(self);
+
+        selfClone.isSharingBlocked = true; // different
+
+        // Set the layout prior to stubbing to validate it does not change.
+        locusInfo.updateSelf(self, []);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        locusInfo.updateSelf(selfClone, []);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_IS_SHARING_BLOCKED_CHANGE,
+          {isSharingBlocked: true}
+        );
+      });
     });
 
     describe('#updateMeetingInfo', () => {

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

@@ -154,7 +154,9 @@ export const self = {
   resourceGuest: false,
   moderator: true,
   panelist: false,
-  mediaBaseUrl: 'https://locus.meet-a.prod.meetapi.webex.com/locus/api/v1/loci/4e073f82-f5b6-31e5-93b3/participant/e0d54e94-226c-3290-b75a-/media'
+  mediaBaseUrl: 'https://locus.meet-a.prod.meetapi.webex.com/locus/api/v1/loci/4e073f82-f5b6-31e5-93b3/participant/e0d54e94-226c-3290-b75a-/media',
+  canNotViewTheParticipantList: false,
+  isSharingBlocked: false,
 };
 
 export const selfWithInactivity = {

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

@@ -1,7 +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';
 
 import {self} from './selfConstant';
@@ -59,6 +58,34 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('canNotViewTheParticipantList', () => {
+      it('should return the correct value', () => {
+        assert.equal(SelfUtils.canNotViewTheParticipantList(self), self.canNotViewTheParticipantList);
+      });
+
+      it('should return false if the new self does not have a value', () => {
+        const mutatedSelf = cloneDeep(self);
+
+        delete mutatedSelf.canNotViewTheParticipantList;
+
+        assert.equal(SelfUtils.canNotViewTheParticipantList(mutatedSelf), false);
+      });
+    });
+
+    describe('isSharingBlocked', () => {
+      it('should return the correct value', () => {
+        assert.equal(SelfUtils.isSharingBlocked(self), self.isSharingBlocked);
+      });
+
+      it('should return false if the new self does not have a value', () => {
+        const mutatedSelf = cloneDeep(self);
+
+        delete mutatedSelf.isSharingBlocked;
+
+        assert.equal(SelfUtils.isSharingBlocked(mutatedSelf), false);
+      });
+    });
+
     describe('getRoles', () => {
       it('get roles works', () => {
         assert.deepEqual(SelfUtils.getRoles(self), ['PRESENTER']);
@@ -79,6 +106,52 @@ describe('plugin-meetings', () => {
         assert.deepEqual(SelfUtils.getRoles(), []);
       });
     });
+
+    describe('getSelves', () => {
+      describe('canNotViewTheParticipantListChanged', () => {
+        it('should return canNotViewTheParticipantListChanged = true when changed', () => {
+          const clonedSelf = cloneDeep(self);
+
+          clonedSelf.canNotViewTheParticipantList = true; // different
+
+          const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+          assert.equal(updates.canNotViewTheParticipantListChanged, true);
+        });
+
+        it('should return canNotViewTheParticipantListChanged = false when unchanged', () => {
+          const clonedSelf = cloneDeep(self);
+
+          clonedSelf.canNotViewTheParticipantList = false; // same
+
+          const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+          assert.equal(updates.canNotViewTheParticipantListChanged, false);
+        });
+      });
+    });
+
+    describe('isSharingBlocked', () => {
+      it('should return isSharingBlockedChanged = true when changed', () => {
+        const clonedSelf = cloneDeep(self);
+
+        clonedSelf.isSharingBlocked = true; // different
+
+        const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+        assert.equal(updates.isSharingBlockedChanged, true);
+      });
+
+      it('should return isSharingBlockedChanged = false when unchanged', () => {
+        const clonedSelf = cloneDeep(self);
+
+        clonedSelf.isSharingBlocked = false; // same
+
+        const {updates} = SelfUtils.getSelves(self, clonedSelf);
+
+        assert.equal(updates.isSharingBlockedChanged, false);
+      });
+    });
   });
 
   describe('isJoined', () => {