@webex/plugin-meetings 3.6.0-next.9 → 3.7.0

package/src/meeting/index.ts

@@ -2014,6 +2014,7 @@ export default class Meeting extends StatelessWebexPlugin {
     this.setUpLocusInfoSelfListener();
     this.setUpLocusInfoMeetingListener();
     this.setUpLocusServicesListener();
+    this.setUpLocusResourcesListener();
     // members update listeners
     this.setUpLocusFullStateListener();
     this.setUpLocusUrlListener();
@@ -2635,6 +2636,42 @@ export default class Meeting extends StatelessWebexPlugin {
       );
     });
 
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_WEBCAST_CHANGED, ({state}) => {
+      Trigger.trigger(
+        this,
+        {file: 'meeting/index', function: 'setupLocusControlsListener'},
+        EVENT_TRIGGERS.MEETING_CONTROLS_WEBCAST_UPDATED,
+        {state}
+      );
+    });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_MEETING_FULL_CHANGED, ({state}) => {
+      Trigger.trigger(
+        this,
+        {file: 'meeting/index', function: 'setupLocusControlsListener'},
+        EVENT_TRIGGERS.MEETING_CONTROLS_MEETING_FULL_UPDATED,
+        {state}
+      );
+    });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_PRACTICE_SESSION_STATUS_UPDATED, ({state}) => {
+      Trigger.trigger(
+        this,
+        {file: 'meeting/index', function: 'setupLocusControlsListener'},
+        EVENT_TRIGGERS.MEETING_CONTROLS_PRACTICE_SESSION_STATUS_UPDATED,
+        {state}
+      );
+    });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_STAGE_VIEW_UPDATED, ({state}) => {
+      Trigger.trigger(
+        this,
+        {file: 'meeting/index', function: 'setupLocusControlsListener'},
+        EVENT_TRIGGERS.MEETING_CONTROLS_STAGE_VIEW_UPDATED,
+        {state}
+      );
+    });
+
     this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_VIDEO_CHANGED, ({state}) => {
       Trigger.trigger(
         this,
@@ -2996,10 +3033,20 @@ export default class Meeting extends StatelessWebexPlugin {
       this.breakouts.breakoutServiceUrlUpdate(payload?.services?.breakout?.url);
       this.annotation.approvalUrlUpdate(payload?.services?.approval?.url);
       this.simultaneousInterpretation.approvalUrlUpdate(payload?.services?.approval?.url);
-      this.webinar.webcastUrlUpdate(payload?.services?.webcast?.url);
-      this.webinar.webinarAttendeesSearchingUrlUpdate(
-        payload?.services?.webinarAttendeesSearching?.url
-      );
+    });
+  }
+
+  /**
+   * Set up the locus info resources link listener
+   * update the locusInfo for webcast instance url
+   * @param {Object} payload - The event payload
+   * @returns {undefined}
+   * @private
+   * @memberof Meeting
+   */
+  private setUpLocusResourcesListener() {
+    this.locusInfo.on(LOCUSINFO.EVENTS.LINKS_RESOURCES, (payload) => {
+      this.webinar.updateWebcastUrl(payload);
     });
   }
 
@@ -3311,7 +3358,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.simultaneousInterpretation.updateCanManageInterpreters(
         payload.newRoles?.includes(SELF_ROLES.MODERATOR)
       );
-      this.webinar.updateCanManageWebcast(payload.newRoles?.includes(SELF_ROLES.MODERATOR));
+      this.webinar.updateRoleChanged(payload);
       Trigger.trigger(
         this,
         {
@@ -3805,6 +3852,22 @@ export default class Meeting extends StatelessWebexPlugin {
             requiredHints: [DISPLAY_HINTS.DISABLE_VIEW_THE_PARTICIPANT_LIST],
             displayHints: this.userDisplayHints,
           }),
+          canEnableViewTheParticipantsListPanelist: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_VIEW_THE_PARTICIPANT_LIST_PANELIST],
+            displayHints: this.userDisplayHints,
+          }),
+          canDisableViewTheParticipantsListPanelist: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_VIEW_THE_PARTICIPANT_LIST_PANELIST],
+            displayHints: this.userDisplayHints,
+          }),
+          canEnableShowAttendeeCount: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_SHOW_ATTENDEE_COUNT],
+            displayHints: this.userDisplayHints,
+          }),
+          canDisableShowAttendeeCount: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_SHOW_ATTENDEE_COUNT],
+            displayHints: this.userDisplayHints,
+          }),
           canEnableRaiseHand: ControlsOptionsUtil.hasHints({
             requiredHints: [DISPLAY_HINTS.ENABLE_RAISE_HAND],
             displayHints: this.userDisplayHints,
@@ -3821,6 +3884,26 @@ export default class Meeting extends StatelessWebexPlugin {
             requiredHints: [DISPLAY_HINTS.DISABLE_VIDEO],
             displayHints: this.userDisplayHints,
           }),
+          canStartWebcast: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.WEBCAST_CONTROL_START],
+            displayHints: this.userDisplayHints,
+          }),
+          canStopWebcast: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.WEBCAST_CONTROL_STOP],
+            displayHints: this.userDisplayHints,
+          }),
+          canShowStageView: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.STAGE_VIEW_ACTIVE],
+            displayHints: this.userDisplayHints,
+          }),
+          canEnableStageView: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_STAGE_VIEW],
+            displayHints: this.userDisplayHints,
+          }),
+          canDisableStageView: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_STAGE_VIEW],
+            displayHints: this.userDisplayHints,
+          }),
           canShareFile:
             (ControlsOptionsUtil.hasHints({
               requiredHints: [DISPLAY_HINTS.SHARE_FILE],
@@ -4821,6 +4904,8 @@ export default class Meeting extends StatelessWebexPlugin {
       );
     }
 
+    this.cleanUpBeforeReconnection();
+
     return this.reconnectionManager
       .reconnect(options, async () => {
         await this.waitForRemoteSDPAnswer();
@@ -6238,7 +6323,7 @@ export default class Meeting extends StatelessWebexPlugin {
     this.mediaProperties.webrtcMediaConnection.on(
       MediaConnectionEventNames.ICE_CANDIDATE,
       (event) => {
-        if (event.candidate) {
+        if (event.candidate && event.candidate.candidate && event.candidate.candidate.length > 0) {
           this.iceCandidatesCount += 1;
         }
       }
@@ -6949,6 +7034,23 @@ export default class Meeting extends StatelessWebexPlugin {
     }
   }
 
+  private async cleanUpBeforeReconnection(): Promise<void> {
+    try {
+      // when media fails, we want to upload a webrtc dump to see whats going on
+      // this function is async, but returns once the stats have been gathered
+      await this.forceSendStatsReport({callFrom: 'cleanUpBeforeReconnection'});
+
+      if (this.statsAnalyzer) {
+        await this.statsAnalyzer.stopAnalyzer();
+      }
+    } catch (error) {
+      LoggerProxy.logger.error(
+        'Meeting:index#cleanUpBeforeReconnection --> Error during cleanup: ',
+        error
+      );
+    }
+  }
+
   /**
    * Creates an instance of LocusMediaRequest for this meeting - it is needed for doing any calls
    * to Locus /media API (these are used for sending Roap messages and updating audio/video mute status).
@@ -7040,7 +7142,7 @@ export default class Meeting extends StatelessWebexPlugin {
       shareAudioEnabled = true,
       shareVideoEnabled = true,
       remoteMediaManagerConfig,
-      bundlePolicy,
+      bundlePolicy = 'max-bundle',
     } = options;
 
     this.allowMediaInLobby = options?.allowMediaInLobby;
@@ -7927,18 +8029,21 @@ export default class Meeting extends StatelessWebexPlugin {
    * @param {boolean} mutedEnabled
    * @param {boolean} disallowUnmuteEnabled
    * @param {boolean} muteOnEntryEnabled
+   * @param {array} roles
    * @public
    * @memberof Meeting
    */
   public setMuteAll(
     mutedEnabled: boolean,
     disallowUnmuteEnabled: boolean,
-    muteOnEntryEnabled: boolean
+    muteOnEntryEnabled: boolean,
+    roles: Array<string>
   ) {
     return this.controlsOptionsManager.setMuteAll(
       mutedEnabled,
       disallowUnmuteEnabled,
-      muteOnEntryEnabled
+      muteOnEntryEnabled,
+      roles
     );
   }
 

package/src/meetings/index.ts

@@ -1044,48 +1044,55 @@ export default class Meetings extends WebexPlugin {
    */
   fetchUserPreferredWebexSite() {
     // @ts-ignore
-    return this.webex.people._getMe().then((me) => {
-      const isGuestUser = me.type === 'appuser';
-      if (!isGuestUser) {
-        return this.request.getMeetingPreferences().then((res) => {
-          if (res) {
-            const preferredWebexSite = MeetingsUtil.parseDefaultSiteFromMeetingPreferences(res);
-            this.preferredWebexSite = preferredWebexSite;
-            // @ts-ignore
-            this.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
-          }
+    return this.webex.people
+      ._getMe()
+      .then((me) => {
+        const isGuestUser = me.type === 'appuser';
+        if (!isGuestUser) {
+          return this.request.getMeetingPreferences().then((res) => {
+            if (res) {
+              const preferredWebexSite = MeetingsUtil.parseDefaultSiteFromMeetingPreferences(res);
+              this.preferredWebexSite = preferredWebexSite;
+              // @ts-ignore
+              this.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
+            }
 
-          // fall back to getting the preferred site from the user information
-          if (!this.preferredWebexSite) {
-            // @ts-ignore
-            return this.webex.internal.user
-              .get()
-              .then((user) => {
-                const preferredWebexSite =
-                  user?.userPreferences?.userPreferencesItems?.preferredWebExSite;
-                if (preferredWebexSite) {
-                  this.preferredWebexSite = preferredWebexSite;
-                  // @ts-ignore
-                  this.webex.internal.services
-                    ._getCatalog()
-                    .addAllowedDomains([preferredWebexSite]);
-                } else {
-                  throw new Error('site not found');
-                }
-              })
-              .catch(() => {
-                LoggerProxy.logger.error(
-                  'Failed to fetch preferred site from user - no site will be set'
-                );
-              });
-          }
+            // fall back to getting the preferred site from the user information
+            if (!this.preferredWebexSite) {
+              // @ts-ignore
+              return this.webex.internal.user
+                .get()
+                .then((user) => {
+                  const preferredWebexSite =
+                    user?.userPreferences?.userPreferencesItems?.preferredWebExSite;
+                  if (preferredWebexSite) {
+                    this.preferredWebexSite = preferredWebexSite;
+                    // @ts-ignore
+                    this.webex.internal.services
+                      ._getCatalog()
+                      .addAllowedDomains([preferredWebexSite]);
+                  } else {
+                    throw new Error('site not found');
+                  }
+                })
+                .catch(() => {
+                  LoggerProxy.logger.error(
+                    'Failed to fetch preferred site from user - no site will be set'
+                  );
+                });
+            }
 
-          return Promise.resolve();
-        });
-      }
+            return Promise.resolve();
+          });
+        }
 
-      return Promise.resolve();
-    });
+        return Promise.resolve();
+      })
+      .catch(() => {
+        LoggerProxy.logger.error(
+          'Failed to retrieve user information. No preferredWebexSite will be set'
+        );
+      });
   }
 
   /**

package/src/members/index.ts

@@ -915,11 +915,12 @@ export default class Members extends StatelessWebexPlugin {
   /**
    * Lower all hands of members in a meeting
    * @param {String} requestingMemberId - id of the participant which requested the lower all hands
+   * @param {array} roles which should be lowered
    * @returns {Promise}
    * @public
    * @memberof Members
    */
-  public lowerAllHands(requestingMemberId: string) {
+  public lowerAllHands(requestingMemberId: string, roles: Array<string>) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError(
@@ -936,7 +937,8 @@ export default class Members extends StatelessWebexPlugin {
     }
     const options = MembersUtil.generateLowerAllHandsMemberOptions(
       requestingMemberId,
-      this.locusUrl
+      this.locusUrl,
+      roles
     );
 
     return this.membersRequest.lowerAllHandsMember(options);

package/src/members/util.ts

@@ -166,9 +166,10 @@ const MembersUtil = {
     locusUrl,
   }),
 
-  generateLowerAllHandsMemberOptions: (requestingParticipantId, locusUrl) => ({
+  generateLowerAllHandsMemberOptions: (requestingParticipantId, locusUrl, roles) => ({
     requestingParticipantId,
     locusUrl,
+    ...(roles !== undefined && {roles}),
   }),
 
   /**
@@ -253,6 +254,7 @@ const MembersUtil = {
     const body = {
       hand: {
         raised: false,
+        ...(options.roles !== undefined && {roles: options.roles}),
       },
       requestingParticipantId: options.requestingParticipantId,
     };

package/src/reachability/index.ts

@@ -154,10 +154,10 @@ export default class Reachability extends EventsScope {
     try {
       this.lastTrigger = trigger;
 
-      // kick off ip version detection. For now we don't await it, as we're doing it
-      // to gather the timings and send them with our reachability metrics
+      // kick off ip version detection. We don't await it, as we don't want to waste time
+      // and if it fails, that's ok we can still carry on
       // @ts-ignore
-      this.webex.internal.device.ipNetworkDetector.detect();
+      this.webex.internal.device.ipNetworkDetector.detect(true);
 
       const {clusters, joinCookie} = await this.getClusters();
 

package/src/reachability/request.ts

@@ -46,6 +46,7 @@ class ReachabilityRequest {
               JCSupport: 1,
               ipver: ipVersion,
             },
+            timeout: this.webex.config.meetings.reachabilityGetClusterTimeout,
           }),
         'internal.get.cluster.time'
       )

package/src/webinar/index.ts

@@ -2,7 +2,8 @@
  * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
  */
 import {WebexPlugin} from '@webex/webex-core';
-import {MEETINGS} from '../constants';
+import {get} from 'lodash';
+import {MEETINGS, SELF_ROLES} from '../constants';
 
 import WebinarCollection from './collection';
 
@@ -17,14 +18,15 @@ const Webinar = WebexPlugin.extend({
 
   props: {
     locusUrl: 'string', // appears current webinar's locus url
-    webcastUrl: 'string', // current webinar's webcast url
-    webinarAttendeesSearchingUrl: 'string', // current webinarAttendeesSearching url
+    webcastInstanceUrl: 'string', // current webinar's webcast instance url
     canManageWebcast: 'boolean', // appears the ability to manage webcast
+    selfIsPanelist: 'boolean', // self is panelist
+    selfIsAttendee: 'boolean', // self is attendee
   },
 
   /**
    * Update the current locus url of the webinar
-   * @param {string} locusUrl // locus url
+   * @param {string} locusUrl
    * @returns {void}
    */
   locusUrlUpdate(locusUrl) {
@@ -32,21 +34,12 @@ const Webinar = WebexPlugin.extend({
   },
 
   /**
-   * Update the current webcast url of the meeting
-   * @param {string} webcastUrl // webcast url
+   * Update the current webcast instance url of the meeting
+   * @param {object} payload
    * @returns {void}
    */
-  webcastUrlUpdate(webcastUrl) {
-    this.set('webcastUrl', webcastUrl);
-  },
-
-  /**
-   * Update the current webinarAttendeesSearching url of the meeting
-   * @param {string} webinarAttendeesSearchingUrl // webinarAttendeesSearching url
-   * @returns {void}
-   */
-  webinarAttendeesSearchingUrlUpdate(webinarAttendeesSearchingUrl) {
-    this.set('webinarAttendeesSearchingUrl', webinarAttendeesSearchingUrl);
+  updateWebcastUrl(payload) {
+    this.set('webcastInstanceUrl', get(payload, 'resources.webcastInstance.url'));
   },
 
   /**
@@ -57,6 +50,27 @@ const Webinar = WebexPlugin.extend({
   updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
+
+  /**
+   * Updates user roles and manages associated state transitions
+   * @param {object} payload
+   * @param {string[]} payload.oldRoles - Previous roles of the user
+   * @param {string[]} payload.newRoles - New roles of the user
+   * @returns {{isPromoted: boolean, isDemoted: boolean}} Role transition states
+   */
+  updateRoleChanged(payload) {
+    const isPromoted =
+      get(payload, 'oldRoles', []).includes(SELF_ROLES.ATTENDEE) &&
+      get(payload, 'newRoles', []).includes(SELF_ROLES.PANELIST);
+    const isDemoted =
+      get(payload, 'oldRoles', []).includes(SELF_ROLES.PANELIST) &&
+      get(payload, 'newRoles', []).includes(SELF_ROLES.ATTENDEE);
+    this.set('selfIsPanelist', get(payload, 'newRoles', []).includes(SELF_ROLES.PANELIST));
+    this.set('selfIsAttendee', get(payload, 'newRoles', []).includes(SELF_ROLES.ATTENDEE));
+    this.updateCanManageWebcast(get(payload, 'newRoles', []).includes(SELF_ROLES.MODERATOR));
+
+    return {isPromoted, isDemoted};
+  },
 });
 
 export default Webinar;

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

@@ -22,7 +22,7 @@ describe('plugin-meetings', () => {
 
             describe('Mute On Entry', () => {
                 let manager;
-            
+
                 beforeEach(() => {
                   request = {
                     request: sinon.stub().returns(Promise.resolve()),
@@ -37,85 +37,85 @@ describe('plugin-meetings', () => {
                 });
 
                 describe('setMuteOnEntry', () => {
-                    it('rejects when correct display hint is not present enabled=false', () => {  
+                    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', () => {  
+                    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', () => {  
+                    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', () => {  
+                    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', () => {
+
+                    it('can set disallow unmute when ENABLE_HARD_MUTE display hint is available', () => {
                       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', () => {
+                    it('can set allow unmute when DISABLE_HARD_MUTE display hint is available', () => {
                       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);
                     });
                   });
@@ -218,7 +218,7 @@ describe('plugin-meetings', () => {
                 })
               });
 
-              it('rejects when correct display hint is not present mutedEnabled=false', () => {  
+              it('rejects when correct display hint is not present mutedEnabled=false', () => {
                 const result = manager.setMuteAll(false, false, false);
 
                 assert.notCalled(request.request);
@@ -226,7 +226,7 @@ describe('plugin-meetings', () => {
                 assert.isRejected(result);
               });
 
-              it('rejects when correct display hint is not present mutedEnabled=true', () => {  
+              it('rejects when correct display hint is not present mutedEnabled=true', () => {
                 const result = manager.setMuteAll(true, false, false);
 
                 assert.notCalled(request.request);
@@ -281,7 +281,31 @@ describe('plugin-meetings', () => {
 
                 assert.deepEqual(result, request.request.firstCall.returnValue);
               });
+
+              it('can set mute all panelists when the display hint is available mutedEnabled=true', () => {
+                manager.setDisplayHints(['MUTE_ALL', 'DISABLE_HARD_MUTE', 'DISABLE_MUTE_ON_ENTRY']);
+
+                const result = manager.setMuteAll(true, true, true, ['panelist']);
+
+                assert.calledWith(request.request, {  uri: 'test/id/controls',
+                  body: { audio: { muted: true, disallowUnmute: true, muteOnEntry: true, roles: ['panelist'] } },
+                  method: HTTP_VERBS.PATCH});
+
+                assert.deepEqual(result, request.request.firstCall.returnValue);
+              });
+
+              it('can set mute all attendees when the display hint is available mutedEnabled=true', () => {
+                manager.setDisplayHints(['MUTE_ALL', 'DISABLE_HARD_MUTE', 'DISABLE_MUTE_ON_ENTRY']);
+
+                const result = manager.setMuteAll(true, true, true, ['attendee']);
+
+                assert.calledWith(request.request, {  uri: 'test/id/controls',
+                  body: { audio: { muted: true, disallowUnmute: true, muteOnEntry: true, roles: ['attendee'] } },
+                  method: HTTP_VERBS.PATCH});
+
+                assert.deepEqual(result, request.request.firstCall.returnValue);
+              });
             });
           });
     });
-});
+});