Feat/practice session - start/stop control API and displayhint

packages/@webex/plugin-meetings/src/constants.ts

@@ -988,6 +988,12 @@ export const DISPLAY_HINTS = {
   STAGE_VIEW_INACTIVE: 'STAGE_VIEW_INACTIVE',
   ENABLE_STAGE_VIEW: 'ENABLE_STAGE_VIEW',
   DISABLE_STAGE_VIEW: 'DISABLE_STAGE_VIEW',
+
+  // Practice Session
+  PRACTICE_SESSION_ON: 'PRACTICE_SESSION_ON',
+  PRACTICE_SESSION_OFF: 'PRACTICE_SESSION_OFF',
+  SHOW_PRACTICE_SESSION_START: 'SHOW_PRACTICE_SESSION_START',
+  SHOW_PRACTICE_SESSION_STOP: 'SHOW_PRACTICE_SESSION_STOP',
 };
 
 export const INTERSTITIAL_DISPLAY_HINTS = [DISPLAY_HINTS.VOIP_IS_ENABLED];

packages/@webex/plugin-meetings/src/meeting/in-meeting-actions.ts

@@ -93,6 +93,10 @@ interface IInMeetingActions {
   canShowStageView?: boolean;
   canEnableStageView?: boolean;
   canDisableStageView?: boolean;
+  IsPracticeSessionOn?: boolean;
+  IsPracticeSessionOff?: boolean;
+  canStartPracticeSession?: boolean;
+  canStopPracticeSession?: boolean;
 }
 
 /**
@@ -266,6 +270,15 @@ export default class InMeetingActions implements IInMeetingActions {
   canEnableStageView = null;
 
   canDisableStageView = null;
+
+  IsPracticeSessionOn = null;
+
+  IsPracticeSessionOff = null;
+
+  canStartPracticeSession = null;
+
+  canStopPracticeSession = null;
+
   /**
    * Returns all meeting action options
    * @returns {Object}
@@ -354,6 +367,10 @@ export default class InMeetingActions implements IInMeetingActions {
     canShowStageView: this.canShowStageView,
     canEnableStageView: this.canEnableStageView,
     canDisableStageView: this.canDisableStageView,
+    IsPracticeSessionOn: this.IsPracticeSessionOn,
+    IsPracticeSessionOff: this.IsPracticeSessionOff,
+    canStartPracticeSession: this.canStartPracticeSession,
+    canStopPracticeSession: this.canStopPracticeSession,
   });
 
   /**

packages/@webex/plugin-meetings/src/meeting/index.ts

@@ -3904,6 +3904,22 @@ export default class Meeting extends StatelessWebexPlugin {
             requiredHints: [DISPLAY_HINTS.DISABLE_STAGE_VIEW],
             displayHints: this.userDisplayHints,
           }),
+          IsPracticeSessionOn: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.PRACTICE_SESSION_ON],
+            displayHints: this.userDisplayHints,
+          }),
+          IsPracticeSessionOff: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.PRACTICE_SESSION_OFF],
+            displayHints: this.userDisplayHints,
+          }),
+          canStartPracticeSession: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.SHOW_PRACTICE_SESSION_START],
+            displayHints: this.userDisplayHints,
+          }),
+          canStopPracticeSession: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.SHOW_PRACTICE_SESSION_STOP],
+            displayHints: this.userDisplayHints,
+          }),
           canShareFile:
             (ControlsOptionsUtil.hasHints({
               requiredHints: [DISPLAY_HINTS.SHARE_FILE],

packages/@webex/plugin-meetings/src/webinar/index.ts

@@ -3,9 +3,10 @@
  */
 import {WebexPlugin} from '@webex/webex-core';
 import {get} from 'lodash';
-import {MEETINGS, SELF_ROLES} from '../constants';
+import {HTTP_VERBS, MEETINGS, SELF_ROLES} from '../constants';
 
 import WebinarCollection from './collection';
+import LoggerProxy from '../common/logs/logger-proxy';
 
 /**
  * @class Webinar
@@ -59,18 +60,39 @@ const Webinar = WebexPlugin.extend({
    * @returns {{isPromoted: boolean, isDemoted: boolean}} Role transition states
    */
   updateRoleChanged(payload) {
+    const oldRoles = get(payload, 'oldRoles', []);
+    const newRoles = get(payload, 'newRoles', []);
+
     const isPromoted =
-      get(payload, 'oldRoles', []).includes(SELF_ROLES.ATTENDEE) &&
-      get(payload, 'newRoles', []).includes(SELF_ROLES.PANELIST);
+      oldRoles.includes(SELF_ROLES.ATTENDEE) && 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));
+      oldRoles.includes(SELF_ROLES.PANELIST) && newRoles.includes(SELF_ROLES.ATTENDEE);
+    this.set('selfIsPanelist', newRoles.includes(SELF_ROLES.PANELIST));
+    this.set('selfIsAttendee', newRoles.includes(SELF_ROLES.ATTENDEE));
+    this.updateCanManageWebcast(newRoles.includes(SELF_ROLES.MODERATOR));
 
     return {isPromoted, isDemoted};
   },
+
+  /**
+   * start practice session for webinar
+   * @param {boolean} enabled
+   * @returns {Promise}
+   */
+  startPracticeSession(enabled) {
+    return this.request({
+      method: HTTP_VERBS.PATCH,
+      uri: `${this.locusUrl}/controls`,
+      body: {
+        practiceSession: {
+          enabled,
+        },
+      },
+    }).catch((error) => {
+      LoggerProxy.logger.error('Meeting:webinar#startPracticeSession failed', error);
+      throw error;
+    });
+  },
 });
 
 export default Webinar;

packages/@webex/plugin-meetings/test/unit/spec/meeting/in-meeting-actions.ts

@@ -88,6 +88,11 @@ describe('plugin-meetings', () => {
         canShowStageView: null,
         canEnableStageView: null,
         canDisableStageView: null,
+        IsPracticeSessionOn : null,
+        IsPracticeSessionOff : null,
+        canStartPracticeSession: null,
+        canStopPracticeSession: null,
+
         ...expected,
       };
 
@@ -181,7 +186,12 @@ describe('plugin-meetings', () => {
       'canShowStageView',
       'canEnableStageView',
       'canDisableStageView',
-    ].forEach((key) => {
+      'IsPracticeSessionOn',
+      'IsPracticeSessionOff',
+      'canStartPracticeSession',
+      'canStopPracticeSession',
+
+  ].forEach((key) => {
       it(`get and set for ${key} work as expected`, () => {
         const inMeetingActions = new InMeetingActions();
 

packages/@webex/plugin-meetings/test/unit/spec/webinar/index.ts

@@ -122,5 +122,56 @@ describe('plugin-meetings', () => {
         });
       });
 
+      describe('#startPracticeSession', () => {
+        it('sends a PATCH request to enable the practice session', async () => {
+          const enabled = true;
+
+          const result = await webinar.startPracticeSession(enabled);
+
+          assert.calledOnce(webex.request);
+          assert.calledWith(webex.request, {
+            method: 'PATCH',
+            uri: `${webinar.locusUrl}/controls`,
+            body: {
+              practiceSession: { enabled },
+            },
+          });
+          assert.equal(result, 'REQUEST_RETURN_VALUE', 'should return the resolved value from the request');
+        });
+
+        it('sends a PATCH request to disable the practice session', async () => {
+          const enabled = false;
+
+          const result = await webinar.startPracticeSession(enabled);
+
+          assert.calledOnce(webex.request);
+          assert.calledWith(webex.request, {
+            method: 'PATCH',
+            uri: `${webinar.locusUrl}/controls`,
+            body: {
+              practiceSession: { enabled },
+            },
+          });
+          assert.equal(result, 'REQUEST_RETURN_VALUE', 'should return the resolved value from the request');
+        });
+
+        it('handles API call failures gracefully', async () => {
+          webex.request.rejects(new Error('API_ERROR'));
+          const errorLogger = sinon.stub(LoggerProxy.logger, 'error');
+
+          try {
+            await webinar.startPracticeSession(true);
+            assert.fail('startPracticeSession should throw an error');
+          } catch (error) {
+            assert.equal(error.message, 'API_ERROR', 'should throw the correct error');
+            assert.calledOnce(errorLogger);
+            assert.calledWith(errorLogger, 'Meeting:webinar#startPracticeSession failed', sinon.match.instanceOf(Error));
+          }
+
+          errorLogger.restore();
+        });
+      });
+
+
     })
 })