@webex/plugin-meetings 2.38.2 → 2.39.1

package/src/controls-options-manager/index.ts

@@ -0,0 +1,183 @@
+import {camelCase} from 'lodash';
+import PermissionError from '../common/errors/permission';
+import {CONTROLS, HTTP_VERBS} from '../constants';
+import MeetingRequest from '../meeting/request';
+import LoggerProxy from '../common/logs/logger-proxy';
+import Setting from './enums';
+import Util from './util';
+import {CAN_SET, CAN_UNSET, ENABLED} from './constants';
+
+/**
+ * docs
+ * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html
+ * https://confluence-eng-gpk2.cisco.com/conf/display/LOCUS/Hard+Mute+and+Audio+Privacy#HardMuteandAudioPrivacy-SelfMuteonEntry
+ * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?spaceKey=UC&title=WEBEX-124454%3A+UCF%3A+Hard+mute+support+for+Teams+joining+Webex+meeting
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-180867
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-393351
+ */
+
+/**
+ * @description ControlsOptionsManager is responsible for handling the behavior of participant controls when somebody joins a meeting
+ * @export
+ * @private
+ * @class Recording
+ */
+export default class ControlsOptionsManager {
+  /**
+   * @instance
+   * @type {MeetingRequest}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private request: MeetingRequest;
+
+  /**
+   * @instance
+   * @type {Array}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private displayHints: Array<string> = [];
+
+  /**
+   * @instance
+   * @type {string}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private locusUrl: string;
+
+  /**
+   * @param {MeetingRequest} request
+   * @param {Object} options
+   * @constructor
+   * @memberof ControlsOptionsManager
+   */
+  constructor(
+    request: MeetingRequest,
+    options?: {
+      locusUrl: string;
+      displayHints?: Array<string>;
+    }
+  ) {
+    this.initialize(request);
+    this.set(options);
+  }
+
+  /**
+   * @param {MeetingRequest} request
+   * @returns {void}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private initialize(request: MeetingRequest) {
+    this.request = request;
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {void}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public set(options?: {locusUrl: string; displayHints?: Array<string>}) {
+    this.extract(options);
+  }
+
+  /**
+   * @param {string} url
+   * @returns {void}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public setLocusUrl(url: string) {
+    this.locusUrl = url;
+  }
+
+  /**
+   * @param {Array} hints
+   * @returns {void}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public setDisplayHints(hints: Array<string>) {
+    this.displayHints = hints;
+  }
+
+  /**
+   * @returns {string}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public getLocusUrl() {
+    return this.locusUrl;
+  }
+
+  /**
+   * @returns {Array}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public getDisplayHints() {
+    return this.displayHints;
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {void}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private extract(options?: {locusUrl: string; displayHints?: Array<string>}) {
+    this.setDisplayHints(options?.displayHints);
+    this.setLocusUrl(options?.locusUrl);
+  }
+
+  /**
+   * @param {Setting} setting
+   * @param {boolean} enabled
+   * @private
+   * @memberof ControlsOptionsManager
+   * @returns {Promise}
+   */
+  private setControls(setting: Setting, enabled: boolean): Promise<any> {
+    LoggerProxy.logger.log(`ControlsOptionsManager:index#setControls --> ${setting} [${enabled}]`);
+
+    if (Util?.[`${enabled ? CAN_SET : CAN_UNSET}${setting}`](this.displayHints)) {
+      // @ts-ignore
+      return this.request.request({
+        uri: `${this.locusUrl}/${CONTROLS}`,
+        body: {
+          [camelCase(setting)]: {
+            [ENABLED]: enabled,
+          },
+        },
+        method: HTTP_VERBS.PATCH,
+      });
+    }
+
+    return Promise.reject(
+      new PermissionError(`${setting} [${enabled}] not allowed, due to moderator property.`)
+    );
+  }
+
+  /**
+   * @public
+   * @param {boolean} enabled
+   * @memberof ControlsOptionsManager
+   * @returns {Promise}
+   */
+  public setMuteOnEntry(enabled: boolean): Promise<any> {
+    return this.setControls(Setting.muteOnEntry, enabled);
+  }
+
+  /**
+   * @public
+   * @param {boolean} enabled
+   * @memberof ControlsOptionsManager
+   * @returns {Promise}
+   */
+  public setDisallowUnmute(enabled: boolean): Promise<any> {
+    return this.setControls(Setting.disallowUnmute, enabled);
+  }
+}

package/src/controls-options-manager/util.ts

@@ -0,0 +1,20 @@
+import {DISPLAY_HINTS} from '../constants';
+
+const canSetMuteOnEntry = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.ENABLE_MUTE_ON_ENTRY);
+
+const canSetDisallowUnmute = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.ENABLE_HARD_MUTE);
+
+const canUnsetMuteOnEntry = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.DISABLE_MUTE_ON_ENTRY);
+
+const canUnsetDisallowUnmute = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.DISABLE_HARD_MUTE);
+
+export default {
+  canSetMuteOnEntry,
+  canSetDisallowUnmute,
+  canUnsetMuteOnEntry,
+  canUnsetDisallowUnmute,
+};

package/src/meeting/in-meeting-actions.ts

@@ -13,6 +13,10 @@ interface IInMeetingActions {
   canAdmitParticipant?: boolean;
   canLock?: boolean;
   canUnlock?: boolean;
+  canSetMuteOnEntry?: boolean;
+  canUnsetMuteOnEntry?: boolean;
+  canSetDisallowUnmute?: boolean;
+  canUnsetDisallowUnmute?: boolean;
   canAssignHost?: boolean;
   canStartRecording?: boolean;
   canPauseRecording?: boolean;
@@ -57,6 +61,14 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canStopRecording = null;
 
+  canSetMuteOnEntry = null;
+
+  canUnsetMuteOnEntry = null;
+
+  canSetDisallowUnmute = null;
+
+  canUnsetDisallowUnmute = null;
+
   canRaiseHand = null;
 
   canLowerAllHands = null;
@@ -93,6 +105,10 @@ export default class InMeetingActions implements IInMeetingActions {
     canLock: this.canLock,
     canUnlock: this.canUnlock,
     canAssignHost: this.canAssignHost,
+    canSetMuteOnEntry: this.canSetMuteOnEntry,
+    canUnsetMuteOnEntry: this.canUnsetMuteOnEntry,
+    canSetDisallowUnmute: this.canSetDisallowUnmute,
+    canUnsetDisallowUnmute: this.canUnsetDisallowUnmute,
     canStartRecording: this.canStartRecording,
     canPauseRecording: this.canPauseRecording,
     canResumeRecording: this.canResumeRecording,

package/src/meeting/index.ts

@@ -31,6 +31,7 @@ import MeetingRequest from './request';
 import Members from '../members/index';
 import MeetingUtil from './util';
 import RecordingUtil from '../recording-controller/util';
+import ControlsOptionsUtil from '../controls-options-manager/util';
 import MediaUtil from '../media/util';
 import Transcription from '../transcription';
 import PasswordError from '../common/errors/password-error';
@@ -90,6 +91,7 @@ import {Reaction, ReactionType, SkinToneType} from '../reactions/reactions.type'
 
 import InMeetingActions from './in-meeting-actions';
 import RecordingController from '../recording-controller';
+import ControlsOptionsManager from '../controls-options-manager';
 
 const {isBrowser} = BrowserDetection();
 
@@ -455,6 +457,7 @@ export default class Meeting extends StatelessWebexPlugin {
   queuedMediaUpdates: any[];
   recording: any;
   recordingController: RecordingController;
+  controlsOptionsManager: ControlsOptionsManager;
   requiredCaptcha: any;
   shareStatus: string;
   statsAnalyzer: StatsAnalyzer;
@@ -1002,6 +1005,18 @@ export default class Meeting extends StatelessWebexPlugin {
       displayHints: [],
     });
 
+    /**
+     * The class that helps to control recording functions: start, stop, pause, resume, etc
+     * @instance
+     * @type {ControlsOptionsManager}
+     * @public
+     * @memberof Meeting
+     */
+    this.controlsOptionsManager = new ControlsOptionsManager(this.meetingRequest, {
+      locusUrl: this.locusInfo?.url,
+      displayHints: [],
+    });
+
     this.setUpLocusInfoListeners();
     this.locusInfo.init(attrs.locus ? attrs.locus : {});
     this.hasJoinedOnce = false;
@@ -2020,6 +2035,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.locusUrl = payload;
       this.locusId = this.locusUrl?.split('/').pop();
       this.recordingController.setLocusUrl(this.locusUrl);
+      this.controlsOptionsManager.setLocusUrl(this.locusUrl);
     });
   }
 
@@ -2085,6 +2101,16 @@ export default class Meeting extends StatelessWebexPlugin {
           canAdmitParticipant: MeetingUtil.canAdmitParticipant(payload.info.userDisplayHints),
           canLock: MeetingUtil.canUserLock(payload.info.userDisplayHints),
           canUnlock: MeetingUtil.canUserUnlock(payload.info.userDisplayHints),
+          canSetDisallowUnmute: ControlsOptionsUtil.canSetDisallowUnmute(
+            payload.info.userDisplayHints
+          ),
+          canUnsetDisallowUnmute: ControlsOptionsUtil.canUnsetDisallowUnmute(
+            payload.info.userDisplayHints
+          ),
+          canSetMuteOnEntry: ControlsOptionsUtil.canSetMuteOnEntry(payload.info.userDisplayHints),
+          canUnsetMuteOnEntry: ControlsOptionsUtil.canUnsetMuteOnEntry(
+            payload.info.userDisplayHints
+          ),
           canStartRecording: RecordingUtil.canUserStart(payload.info.userDisplayHints),
           canStopRecording: RecordingUtil.canUserStop(payload.info.userDisplayHints),
           canPauseRecording: RecordingUtil.canUserPause(payload.info.userDisplayHints),
@@ -2113,6 +2139,7 @@ export default class Meeting extends StatelessWebexPlugin {
         });
 
         this.recordingController.setDisplayHints(payload.info.userDisplayHints);
+        this.controlsOptionsManager.setDisplayHints(payload.info.userDisplayHints);
 
         if (changed) {
           Trigger.trigger(
@@ -5526,6 +5553,28 @@ export default class Meeting extends StatelessWebexPlugin {
     return this.recordingController.startRecording();
   }
 
+  /**
+   * set the mute on entry flag for participants if you're the host
+   * @returns {Promise}
+   * @param {boolean} enabled
+   * @public
+   * @memberof Meeting
+   */
+  public setMuteOnEntry(enabled: boolean) {
+    return this.controlsOptionsManager.setMuteOnEntry(enabled);
+  }
+
+  /**
+   * set the disallow unmute flag for participants if you're the host
+   * @returns {Promise}
+   * @param {boolean} enabled
+   * @public
+   * @memberof Meeting
+   */
+  public setDisallowUnmute(enabled: boolean) {
+    return this.controlsOptionsManager.setDisallowUnmute(enabled);
+  }
+
   /**
    * End the recording of this meeting
    * @returns {Promise}

package/src/metrics/config.ts

@@ -481,15 +481,5 @@ export const errorObjects = {
 
 export const UNKNOWN = 'unknown';
 
-export const OS_NAME = {
-  WINDOWS: 'windows',
-  MAC: 'mac',
-  IOS: 'ios',
-  ANDROID: 'android',
-  CHROME: 'chrome',
-  LINUX: 'linux',
-  OTHERS: 'other',
-};
-
 export const CLIENT_NAME = 'webex-js-sdk';
 export const PLATFORM = 'Web';

package/src/metrics/index.ts

@@ -8,6 +8,7 @@ import uuid from 'uuid';
 import window from 'global/window';
 import anonymize from 'ip-anonymize';
 
+import {getOSNameInternal} from '@webex/internal-plugin-metrics';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {MEETING_ERRORS} from '../constants';
 import BrowserDetection from '../common/browser-detection';
@@ -16,22 +17,11 @@ import {
   error,
   eventType,
   errorCodes as ERROR_CODE,
-  OS_NAME,
   UNKNOWN,
   CLIENT_NAME,
   mediaType,
 } from './config';
 
-const OSMap = {
-  // @ts-ignore
-  'Chrome OS': OS_NAME.chrome,
-  macOS: OS_NAME.MAC,
-  Windows: OS_NAME.WINDOWS,
-  iOS: OS_NAME.IOS,
-  Android: OS_NAME.ANDROID,
-  Linux: OS_NAME.LINUX,
-};
-
 const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
 // Apply a CIDR /28 format to the IPV4 and /96 to the IPV6 addresses
@@ -205,7 +195,7 @@ class Metrics {
           localNetworkPrefix: anonymizeIPAddress(this.webex.meetings.geoHintInfo?.clientAddress),
           osVersion: getOSVersion() || 'unknown',
           subClientType: options.subClientType,
-          os: this.getOsName(),
+          os: getOSNameInternal(),
           browser: getBrowserName(),
           browserVersion: getBrowserVersion(),
         },
@@ -256,17 +246,6 @@ class Metrics {
     return payload;
   }
 
-  /**
-   * returns metrics friendly OS versions
-   * @param {String} osName Os name
-   * @returns {String}
-   * @private
-   * @memberof Metrics
-   */
-  private getOsName() {
-    return OSMap[getOSName()] ?? OS_NAME.OTHERS;
-  }
-
   /**
    * get the payload specific for a media quality event through call analyzer
    * @param {String} eventType the event name
@@ -311,7 +290,7 @@ class Metrics {
           clientType: options.clientType, // TODO: Only clientType: 'TEAMS_CLIENT' is whitelisted
           clientVersion: `${CLIENT_NAME}/${this.webex.version}`,
           localNetworkPrefix: anonymizeIPAddress(this.webex.meetings.geoHintInfo?.clientAddress),
-          os: this.getOsName(),
+          os: getOSNameInternal(),
           osVersion: getOSVersion() || UNKNOWN,
           subClientType: options.subClientType,
           browser: getBrowserName(),

package/test/unit/spec/controls-options-manager/index.js

@@ -0,0 +1,124 @@
+import ControlsOptionsManager from '@webex/plugin-meetings/src/controls-options-manager';
+import sinon from 'sinon';
+import {assert} from '@webex/test-helper-chai';
+import { HTTP_VERBS } from '@webex/plugin-meetings/src/constants';
+
+describe('plugin-meetings', () => {
+    describe('controls-options-manager tests', () => {
+        describe('index', () => {
+            let request;
+
+            describe('class tests', () => {
+                it('can set and extract new values later on', () => {
+                    const manager = new ControlsOptionsManager({});
+                    assert.isUndefined(manager.getLocusUrl());
+                    manager.set({
+                      locusUrl: 'test/id',
+                    })
+                    assert(manager.getLocusUrl(), 'test/id');
+                });
+            });
+
+            describe('Mute On Entry', () => {
+                let manager;
+            
+                beforeEach(() => {
+                  request = {
+                    request: sinon.stub().returns(Promise.resolve()),
+                  };
+
+                  manager = new ControlsOptionsManager(request);
+
+                  manager.set({
+                    locusUrl: 'test/id',
+                    displayHints: [],
+                  })
+                });
+
+                describe('setMuteOnEntry', () => {
+                    it('rejects when correct display hint is not present enabled=false', () => {  
+                      const result = manager.setMuteOnEntry(false);
+              
+                      assert.notCalled(request.request);
+              
+                      assert.isRejected(result);
+                    });
+
+                    it('rejects when correct display hint is not present enabled=true', () => {  
+                      const result = manager.setMuteOnEntry(true);
+              
+                      assert.notCalled(request.request);
+              
+                      assert.isRejected(result);
+                    });
+      
+                    it('can set mute on entry when the display hint is available enabled=true', () => {
+                      manager.setDisplayHints(['ENABLE_MUTE_ON_ENTRY']);
+              
+                      const result = manager.setMuteOnEntry(true);
+              
+                      assert.calledWith(request.request, {  uri: 'test/id/controls',
+                      body: { muteOnEntry: { enabled: true } },
+                      method: HTTP_VERBS.PATCH});
+              
+                      assert.deepEqual(result, request.request.firstCall.returnValue);
+                    });
+
+                    it('can set mute on entry when the display hint is available enabled=false', () => {
+                      manager.setDisplayHints(['DISABLE_MUTE_ON_ENTRY']);
+              
+                      const result = manager.setMuteOnEntry(false);
+              
+                      assert.calledWith(request.request, {  uri: 'test/id/controls',
+                      body: { muteOnEntry: { enabled: false } },
+                      method: HTTP_VERBS.PATCH});
+              
+                      assert.deepEqual(result, request.request.firstCall.returnValue);
+                    });
+                  });
+
+                  describe('setDisallowUnmute', () => {
+                    it('rejects when correct display hint is not present enabled=false', () => {  
+                      const result = manager.setDisallowUnmute(false);
+              
+                      assert.notCalled(request.request);
+              
+                      assert.isRejected(result);
+                    });
+
+                    it('rejects when correct display hint is not present enabled=true', () => {  
+                      const result = manager.setDisallowUnmute(true);
+              
+                      assert.notCalled(request.request);
+              
+                      assert.isRejected(result);
+                    });
+      
+                    it('can set mute on entry when the display hint is available enabled=true', () => {
+                      manager.setDisplayHints(['ENABLE_HARD_MUTE']);
+              
+                      const result = manager.setDisallowUnmute(true);
+              
+                      assert.calledWith(request.request, {  uri: 'test/id/controls',
+                      body: { disallowUnmute: { enabled: true } },
+                      method: HTTP_VERBS.PATCH});
+              
+                      assert.deepEqual(result, request.request.firstCall.returnValue);
+                    });
+
+                    it('can set mute on entry when the display hint is available enabled=false', () => {
+                      manager.setDisplayHints(['DISABLE_HARD_MUTE']);
+              
+                      const result = manager.setDisallowUnmute(false);
+              
+                      assert.calledWith(request.request, {  uri: 'test/id/controls',
+                      body: { disallowUnmute: { enabled: false } },
+                      method: HTTP_VERBS.PATCH});
+              
+                      assert.deepEqual(result, request.request.firstCall.returnValue);
+                    });
+                  });
+            });
+          });
+    });
+});

package/test/unit/spec/controls-options-manager/util.js

@@ -0,0 +1,66 @@
+import ControlsOptionsUtil from '@webex/plugin-meetings/src/controls-options-manager/util';
+import { assert } from 'chai';
+
+describe('plugin-meetings', () => {
+    describe('controls-option-manager tests', () => {
+        describe('util tests', () => {
+
+            let locusInfo;
+        
+            beforeEach(() => {
+              locusInfo = {
+                parsedLocus: {
+                  info: {
+                    userDisplayHints: [],
+                  },
+                },
+              };
+            });
+        
+            describe('canUserSetMuteOnEntry', () => {
+              it('can set mute on entry enable', () => {
+                locusInfo.parsedLocus.info.userDisplayHints.push('ENABLE_MUTE_ON_ENTRY');
+
+                assert.equal(ControlsOptionsUtil.canSetMuteOnEntry(locusInfo.parsedLocus.info.userDisplayHints), true);
+              });
+
+              it('can set mute on entry disable', () => {
+                locusInfo.parsedLocus.info.userDisplayHints.push('DISABLE_MUTE_ON_ENTRY');
+
+                assert.equal(ControlsOptionsUtil.canUnsetMuteOnEntry(locusInfo.parsedLocus.info.userDisplayHints), true);
+              });
+        
+              it('rejects when correct display hint is not present for setting mute on entry', () => {
+                assert.equal(ControlsOptionsUtil.canSetMuteOnEntry(locusInfo.parsedLocus.info.userDisplayHints), false);
+              });
+
+              it('rejects when correct display hint is not present for unsetting mute on entry', () => {
+                assert.equal(ControlsOptionsUtil.canUnsetMuteOnEntry(locusInfo.parsedLocus.info.userDisplayHints), false);
+              });
+            });
+
+            describe('canSetDisallowUnmute', () => {
+              it('can set disallow unmute enable', () => {
+                locusInfo.parsedLocus.info.userDisplayHints.push('ENABLE_HARD_MUTE');
+
+                assert.equal(ControlsOptionsUtil.canSetDisallowUnmute(locusInfo.parsedLocus.info.userDisplayHints), true);
+              });
+
+              it('can set disallow unmute disable', () => {
+                locusInfo.parsedLocus.info.userDisplayHints.push('DISABLE_HARD_MUTE');
+
+                assert.equal(ControlsOptionsUtil.canUnsetDisallowUnmute(locusInfo.parsedLocus.info.userDisplayHints), true);
+              });
+        
+              it('rejects when correct display hint is not present', () => {
+                assert.equal(ControlsOptionsUtil.canSetDisallowUnmute(locusInfo.parsedLocus.info.userDisplayHints), false);
+              });
+
+              it('rejects when correct display hint is not present', () => {
+                assert.equal(ControlsOptionsUtil.canUnsetDisallowUnmute(locusInfo.parsedLocus.info.userDisplayHints), false);
+              });
+            });
+
+        });
+    });
+});

package/test/unit/spec/meeting/in-meeting-actions.ts

@@ -13,6 +13,10 @@ describe('plugin-meetings', () => {
         canStartRecording: null,
         canPauseRecording: null,
         canResumeRecording: null,
+        canSetMuteOnEntry: null,
+        canUnsetMuteOnEntry: null,
+        canSetDisallowUnmute: null,
+        canUnsetDisallowUnmute: null,
         canStopRecording: null,
         canRaiseHand: null,
         canLowerAllHands: null,
@@ -49,6 +53,10 @@ describe('plugin-meetings', () => {
       'canPauseRecording',
       'canResumeRecording',
       'canStopRecording',
+      'canSetMuteOnEntry',
+      'canUnsetMuteOnEntry',
+      'canSetDisallowUnmute',
+      'canUnsetDisallowUnmute',
       'canRaiseHand',
       'canLowerAllHands',
       'canLowerSomeoneElsesHand',