@webex/plugin-meetings 2.37.2 → 2.38.0

package/src/recording-controller/index.ts

@@ -0,0 +1,315 @@
+import PermissionError from '../common/errors/permission';
+import {CONTROLS, HTTP_VERBS} from '../constants';
+import MeetingRequest from '../meeting/request';
+import RecordingAction from './enums';
+import Util from './util';
+import LoggerProxy from '../common/logs/logger-proxy';
+
+/**
+ * @description Recording manages the recording functionality of the meeting object, there should only be one instantation of recording per meeting
+ * @export
+ * @private
+ * @class Recording
+ */
+export default class RecordingController {
+  /**
+   * @instance
+   * @type {MeetingRequest}
+   * @private
+   * @memberof RecordingController
+   */
+  private request: MeetingRequest;
+
+  /**
+   * @instance
+   * @type {Array}
+   * @private
+   * @memberof RecordingInfo
+   */
+  private displayHints: Array<string> = [];
+
+  /**
+   * @instance
+   * @type {string}
+   * @private
+   * @memberof RecordingInfo
+   */
+  private serviceUrl: string;
+
+  /**
+   * @instance
+   * @type {string}
+   * @private
+   * @memberof RecordingInfo
+   */
+  private sessionId: string;
+
+  /**
+   * @instance
+   * @type {string}
+   * @private
+   * @memberof RecordingInfo
+   */
+  private locusUrl: string;
+
+  /**
+   * @instance
+   * @type {string}
+   * @private
+   * @memberof RecordingInfo
+   */
+  private locusId: string;
+
+  /**
+   * @param {MeetingRequest} request
+   * @param {Object} options
+   * @constructor
+   * @memberof RecordingController
+   */
+  constructor(
+    request: MeetingRequest,
+    options?: {
+      serviceUrl?: string;
+      sessionId: string;
+      locusUrl: string;
+      displayHints?: Array<string>;
+    }
+  ) {
+    this.initialize(request);
+    this.set(options);
+  }
+
+  /**
+   * @param {MeetingRequest} request
+   * @param {LocusInfo} info
+   * @returns {void}
+   * @private
+   * @memberof RecordingController
+   */
+  private initialize(request: MeetingRequest) {
+    this.request = request;
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {void}
+   * @public
+   * @memberof RecordingController
+   */
+  public set(options?: {
+    serviceUrl?: string;
+    sessionId: string;
+    locusUrl: string;
+    displayHints?: Array<string>;
+  }) {
+    this.extract(options);
+  }
+
+  /**
+   * @param {string} url
+   * @returns {void}
+   * @public
+   * @memberof RecordingController
+   */
+  public setLocusUrl(url: string) {
+    this.locusUrl = url;
+    this.locusId = Util.extractLocusId(this.locusUrl);
+  }
+
+  /**
+   * @param {Array} hints
+   * @returns {void}
+   * @public
+   * @memberof RecordingController
+   */
+  public setDisplayHints(hints: Array<string>) {
+    this.displayHints = hints;
+  }
+
+  /**
+   * @param {string} id
+   * @returns {void}
+   * @public
+   * @memberof RecordingController
+   */
+  public setSessionId(id: string) {
+    this.sessionId = id;
+  }
+
+  /**
+   * @param {string} url
+   * @returns {void}
+   * @public
+   * @memberof RecordingController
+   */
+  public setServiceUrl(url: string) {
+    this.serviceUrl = url;
+  }
+
+  /**
+   * @returns {string}
+   * @public
+   * @memberof RecordingController
+   */
+  public getLocusUrl() {
+    return this.locusUrl;
+  }
+
+  /**
+   * @returns {string}
+   * @public
+   * @memberof RecordingController
+   */
+  public getLocusId() {
+    return this.locusId;
+  }
+
+  /**
+   * @returns {string}
+   * @public
+   * @memberof RecordingController
+   */
+  public getSessionId() {
+    return this.sessionId;
+  }
+
+  /**
+   * @returns {string}
+   * @public
+   * @memberof RecordingController
+   */
+  public getServiceUrl() {
+    return this.serviceUrl;
+  }
+
+  /**
+   * @returns {Array}
+   * @public
+   * @memberof RecordingController
+   */
+  public getDisplayHints() {
+    return this.displayHints;
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {void}
+   * @private
+   * @memberof RecordingController
+   */
+  private extract(options?: {
+    serviceUrl?: string;
+    sessionId: string;
+    locusUrl: string;
+    displayHints?: Array<string>;
+  }) {
+    this.setServiceUrl(options?.serviceUrl);
+    this.setSessionId(options?.sessionId);
+    this.setDisplayHints(options?.displayHints);
+    this.setLocusUrl(options?.locusUrl);
+  }
+
+  /**
+   * @param {RecordingAction} action
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  private recordingService(action: RecordingAction): Promise<any> {
+    // @ts-ignore
+    return this.request.request({
+      body: {
+        meetingInfo: {
+          locusSessionId: this.sessionId,
+        },
+        recording: {
+          action: action.toLowerCase(),
+        },
+      },
+      uri: `${this.serviceUrl}/loci/${this.locusId}/recording`,
+      method: HTTP_VERBS.PUT,
+    });
+  }
+
+  /**
+   * @param {RecordingAction} action
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  private recordingControls(action: RecordingAction): Promise<any> {
+    const record = Util.deriveRecordingStates(action);
+
+    LoggerProxy.logger.log(`RecordingController:index#recordingControls --> ${record}`);
+
+    // @ts-ignore
+    return this.request.request({
+      uri: `${this.locusUrl}/${CONTROLS}`,
+      body: {
+        record,
+      },
+      method: HTTP_VERBS.PATCH,
+    });
+  }
+
+  /**
+   * @param {RecordingAction} action
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  private recordingFacade(action: RecordingAction): Promise<any> {
+    LoggerProxy.logger.log(
+      `RecordingController:index#recordingFacade --> recording action [${action}]`
+    );
+
+    // assumes action is proper cased (i.e., Example)
+    if (Util?.[`canUser${action}`](this.displayHints)) {
+      if (this.serviceUrl) {
+        return this.recordingService(action);
+      }
+
+      return this.recordingControls(action);
+    }
+
+    return Promise.reject(
+      new PermissionError(`${action} recording not allowed, due to moderator property.`)
+    );
+  }
+
+  /**
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  public startRecording(): Promise<any> {
+    return this.recordingFacade(RecordingAction.Start);
+  }
+
+  /**
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  public stopRecording(): Promise<any> {
+    return this.recordingFacade(RecordingAction.Stop);
+  }
+
+  /**
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  public pauseRecording(): Promise<any> {
+    return this.recordingFacade(RecordingAction.Pause);
+  }
+
+  /**
+   * @private
+   * @memberof RecordingController
+   * @returns {Promise}
+   */
+  public resumeRecording(): Promise<any> {
+    return this.recordingFacade(RecordingAction.Resume);
+  }
+}

package/src/recording-controller/util.ts

@@ -0,0 +1,58 @@
+import {DISPLAY_HINTS} from '../constants';
+import RecordingAction from './enums';
+
+const canUserStart = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_START);
+
+const canUserPause = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_PAUSE);
+
+const canUserResume = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_RESUME);
+
+const canUserStop = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_STOP);
+
+const extractLocusId = (url: string) => {
+  return url?.split('/').pop();
+};
+
+const deriveRecordingStates = (action: RecordingAction): {recording: boolean; paused: boolean} => {
+  let recording;
+  let paused;
+
+  switch (action) {
+    case RecordingAction.Start:
+      recording = true;
+      paused = false;
+      break;
+    case RecordingAction.Stop:
+      recording = false;
+      paused = false;
+      break;
+    case RecordingAction.Resume:
+      recording = true;
+      paused = false;
+      break;
+    case RecordingAction.Pause:
+      recording = true;
+      paused = true;
+      break;
+    default:
+      throw new Error(`Recording state cannot be derived from invalid action: ${action}`);
+  }
+
+  return {
+    recording,
+    paused,
+  };
+};
+
+export default {
+  canUserStart,
+  canUserPause,
+  canUserResume,
+  canUserStop,
+  deriveRecordingStates,
+  extractLocusId,
+};

package/src/roap/turnDiscovery.ts

@@ -230,7 +230,7 @@ export default class TurnDiscovery {
    *                                 media connection just after a reconnection
    * @returns {Promise}
    */
-  doTurnDiscovery(meeting: Meeting, isReconnecting: boolean) {
+  doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean) {
     // @ts-ignore - fix type
     const isAnyClusterReachable = meeting.webex.meetings.reachability.isAnyClusterReachable();
 

package/src/statsAnalyzer/mqaUtil.ts

@@ -26,6 +26,7 @@ export const getAudioReceiverMqa = ({audioReceiver, statsResults, lastMqaDataSen
 
   // @ts-ignore
   audioReceiver.streams[0].common.maxRtpJitter =
+    // @ts-ignore
     max(statsResults[mediaType][sendrecvType].meanRtpJitter) * 1000 || 0;
   audioReceiver.streams[0].common.meanRtpJitter =
     mean(statsResults[mediaType][sendrecvType].meanRtpJitter) * 1000 || 0;
@@ -72,6 +73,7 @@ export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent})
 
   // @ts-ignore
   audioSender.common.maxRemoteJitter =
+    // @ts-ignore
     max(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
   audioSender.common.meanRemoteJitter =
     mean(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
@@ -96,6 +98,7 @@ export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent})
 
   // @ts-ignore
   audioSender.common.maxRoundTripTime =
+    // @ts-ignore
     max(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
   audioSender.common.meanRoundTripTime =
     mean(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
@@ -152,6 +155,7 @@ export const getVideoReceiverMqa = ({
 
   // @ts-ignore
   videoReceiver.common.maxRemoteJitter =
+    // @ts-ignore
     max(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
   videoReceiver.common.meanRemoteJitter =
     mean(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
@@ -217,6 +221,7 @@ export const getVideoSenderMqa = ({
 
   // @ts-ignore
   videoSender.common.maxRemoteJitter =
+    // @ts-ignore
     max(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
   videoSender.common.meanRemoteJitter =
     mean(statsResults[mediaType][sendrecvType].meanRemoteJitter) * 1000 || 0;
@@ -239,6 +244,7 @@ export const getVideoSenderMqa = ({
 
   // @ts-ignore
   videoSender.common.maxRoundTripTime =
+    // @ts-ignore
     max(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;
   videoSender.common.meanRoundTripTime =
     mean(statsResults[mediaType][sendrecvType].meanRoundTripTime) * 1000 || 0;

package/test/integration/spec/journey.js

@@ -5,7 +5,7 @@ import {assert} from '@webex/test-helper-chai';
 import {skipInNode} from '@webex/test-helper-mocha';
 import sinon from 'sinon';
 
-import BrowserDetection from '@webex/plugin-meetings/src/common/browser-detection';
+import BrowserDetection from '@webex/plugin-meetings/dist/common/browser-detection';
 
 import DEFAULT_RESOLUTIONS from '../../../src/config';
 import testUtils from '../../utils/testUtils';

package/test/integration/spec/space-meeting.js

@@ -2,7 +2,7 @@
 import {assert} from '@webex/test-helper-chai';
 import {skipInNode, jenkinsOnly} from '@webex/test-helper-mocha';
 import {patterns} from '@webex/common';
-import MeetingInfoUtil from '@webex/plugin-meetings/src/meeting-info/utilv2';
+import MeetingInfoUtil from '@webex/plugin-meetings/dist/meeting-info/utilv2';
 
 import CMR from '../../utils/cmr';
 import testUtils from '../../utils/testUtils';

package/test/integration/spec/transcription.js

@@ -1,4 +1,4 @@
-import Transcription from '@webex/plugin-meetings/src/transcription';
+import Transcription from '@webex/plugin-meetings/dist/transcription';
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 

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

@@ -35,6 +35,7 @@ import Media from '@webex/plugin-meetings/src/media/index';
 import PeerConnectionManager from '@webex/plugin-meetings/src/peer-connection-manager';
 import ReconnectionManager from '@webex/plugin-meetings/src/reconnection-manager';
 import MediaUtil from '@webex/plugin-meetings/src/media/util';
+import RecordingUtil from '@webex/plugin-meetings/src/recording-controller/util';
 import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
 import LoggerConfig from '@webex/plugin-meetings/src/common/logs/logger-config';
 import TriggerProxy from '@webex/plugin-meetings/src/common/events/trigger-proxy';
@@ -3583,6 +3584,7 @@ describe('plugin-meetings', () => {
           const newLocusUrl = 'newLocusUrl/12345';
 
           meeting.members = {locusUrlUpdate: sinon.stub().returns(Promise.resolve(test1))};
+          meeting.recordingController = {setLocusUrl: sinon.stub().returns(undefined)};
 
           meeting.locusInfo.emit(
             {function: 'test', file: 'test'},
@@ -3590,11 +3592,36 @@ describe('plugin-meetings', () => {
             newLocusUrl
           );
           assert.calledWith(meeting.members.locusUrlUpdate, newLocusUrl);
+          assert.calledWith(meeting.recordingController.setLocusUrl, newLocusUrl);
           assert.equal(meeting.locusUrl, newLocusUrl);
           assert(meeting.locusId, '12345');
           done();
         });
       });
+
+      describe('#setUpLocusServicesListener', () => {
+        it('listens to the locus services update event', (done) => {
+          const newLocusServices = {
+              services: {
+                record: {
+                  url: 'url',
+                }
+              },
+          };
+
+          meeting.recordingController = {setServiceUrl: sinon.stub().returns(undefined), setSessionId: sinon.stub().returns(undefined)};
+
+          meeting.locusInfo.emit(
+            {function: 'test', file: 'test'},
+            'LINKS_SERVICES',
+            newLocusServices
+          );
+
+          assert.calledWith(meeting.recordingController.setServiceUrl, newLocusServices.services.record.url);
+          assert.calledOnce(meeting.recordingController.setSessionId);
+          done();
+        });
+      });
       describe('#setUpLocusInfoMediaInactiveListener', () => {
         it('listens to disconnect due to un activity ', (done) => {
           TriggerProxy.trigger.reset();
@@ -4009,7 +4036,7 @@ describe('plugin-meetings', () => {
         let inMeetingActionsSetSpy;
         let canUserLockSpy;
         let canUserUnlockSpy;
-        let canUserRecordSpy;
+        let canUserStartSpy;
         let canUserStopSpy;
         let canUserPauseSpy;
         let canUserResumeSpy;
@@ -4023,10 +4050,10 @@ describe('plugin-meetings', () => {
           locusInfoOnSpy = sinon.spy(meeting.locusInfo, 'on');
           canUserLockSpy = sinon.spy(MeetingUtil, 'canUserLock');
           canUserUnlockSpy = sinon.spy(MeetingUtil, 'canUserUnlock');
-          canUserRecordSpy = sinon.spy(MeetingUtil, 'canUserRecord');
-          canUserStopSpy = sinon.spy(MeetingUtil, 'canUserStop');
-          canUserPauseSpy = sinon.spy(MeetingUtil, 'canUserPause');
-          canUserResumeSpy = sinon.spy(MeetingUtil, 'canUserResume');
+          canUserStartSpy = sinon.spy(RecordingUtil, 'canUserStart');
+          canUserStopSpy = sinon.spy(RecordingUtil, 'canUserStop');
+          canUserPauseSpy = sinon.spy(RecordingUtil, 'canUserPause');
+          canUserResumeSpy = sinon.spy(RecordingUtil, 'canUserResume');
           inMeetingActionsSetSpy = sinon.spy(meeting.inMeetingActions, 'set');
           canUserRaiseHandSpy = sinon.spy(MeetingUtil, 'canUserRaiseHand');
           canUserLowerAllHandsSpy = sinon.spy(MeetingUtil, 'canUserLowerAllHands');
@@ -4064,7 +4091,7 @@ describe('plugin-meetings', () => {
 
           assert.calledWith(canUserLockSpy, payload.info.userDisplayHints);
           assert.calledWith(canUserUnlockSpy, payload.info.userDisplayHints);
-          assert.calledWith(canUserRecordSpy, payload.info.userDisplayHints);
+          assert.calledWith(canUserStartSpy, payload.info.userDisplayHints);
           assert.calledWith(canUserStopSpy, payload.info.userDisplayHints);
           assert.calledWith(canUserPauseSpy, payload.info.userDisplayHints);
           assert.calledWith(canUserResumeSpy, payload.info.userDisplayHints);

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

@@ -297,34 +297,6 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('canUserRecord', () => {
-      it('works as expected', () => {
-        assert.deepEqual(MeetingUtil.canUserRecord(['RECORDING_CONTROL_START']), true);
-        assert.deepEqual(MeetingUtil.canUserRecord([]), false);
-      });
-    });
-
-    describe('canUserPause', () => {
-      it('works as expected', () => {
-        assert.deepEqual(MeetingUtil.canUserPause(['RECORDING_CONTROL_PAUSE']), true);
-        assert.deepEqual(MeetingUtil.canUserPause([]), false);
-      });
-    });
-
-    describe('canUserResume', () => {
-      it('works as expected', () => {
-        assert.deepEqual(MeetingUtil.canUserResume(['RECORDING_CONTROL_RESUME']), true);
-        assert.deepEqual(MeetingUtil.canUserResume([]), false);
-      });
-    });
-
-    describe('canUserStop', () => {
-      it('works as expected', () => {
-        assert.deepEqual(MeetingUtil.canUserStop(['RECORDING_CONTROL_STOP']), true);
-        assert.deepEqual(MeetingUtil.canUserStop([]), false);
-      });
-    });
-
     [
       {functionName: 'canEnableClosedCaption', displayHint: 'CAPTION_START'},
       {functionName: 'canStartTranscribing', displayHint: 'TRANSCRIPTION_CONTROL_START'},
@@ -343,104 +315,5 @@ describe('plugin-meetings', () => {
         });
       });
     });
-
-    describe('recording tests', () => {
-      let request;
-      let locusInfo;
-      const locusUrl = 'locusUrl';
-
-      beforeEach(() => {
-        locusInfo = {
-          parsedLocus: {
-            info: {
-              userDisplayHints: ['RECORDING_CONTROL_START'],
-            },
-          },
-        };
-        request = {
-          recordMeeting: sinon.stub().returns(Promise.resolve()),
-        };
-      });
-
-      describe('startRecording', () => {
-        it('can start recording when the correct display hint is present', () => {
-          locusInfo.parsedLocus.info.userDisplayHints.push('RECORDING_CONTROL_START');
-
-          const result = MeetingUtil.startRecording(request, locusUrl, locusInfo);
-
-          assert.calledWith(request.recordMeeting, {locusUrl, recording: true, paused: false});
-
-          assert.deepEqual(result, request.recordMeeting.firstCall.returnValue);
-        });
-
-        it('rejects when correct display hint is not present', () => {
-          const result = MeetingUtil.startRecording(request, locusUrl, {});
-
-          assert.notCalled(request.recordMeeting);
-
-          assert.isRejected(result);
-        });
-      });
-
-      describe('pauseRecording', () => {
-        it('can pause recording when the correct display hint is present', () => {
-          locusInfo.parsedLocus.info.userDisplayHints.push('RECORDING_CONTROL_PAUSE');
-
-          const result = MeetingUtil.pauseRecording(request, locusUrl, locusInfo);
-
-          assert.calledWith(request.recordMeeting, {locusUrl, recording: true, paused: true});
-
-          assert.deepEqual(result, request.recordMeeting.firstCall.returnValue);
-        });
-
-        it('rejects when correct display hint is not present', () => {
-          const result = MeetingUtil.pauseRecording(request, locusUrl, {});
-
-          assert.notCalled(request.recordMeeting);
-
-          assert.isRejected(result);
-        });
-      });
-
-      describe('resumeRecording', () => {
-        it('can resume recording when the correct display hint is present', () => {
-          locusInfo.parsedLocus.info.userDisplayHints.push('RECORDING_CONTROL_RESUME');
-
-          const result = MeetingUtil.resumeRecording(request, locusUrl, locusInfo);
-
-          assert.calledWith(request.recordMeeting, {locusUrl, recording: true, paused: false});
-
-          assert.deepEqual(result, request.recordMeeting.firstCall.returnValue);
-        });
-
-        it('rejects when correct display hint is not present', () => {
-          const result = MeetingUtil.resumeRecording(request, locusUrl, {});
-
-          assert.notCalled(request.recordMeeting);
-
-          assert.isRejected(result);
-        });
-      });
-
-      describe('stopRecording', () => {
-        it('can stop recording when the correct display hint is present', () => {
-          locusInfo.parsedLocus.info.userDisplayHints.push('RECORDING_CONTROL_STOP');
-
-          const result = MeetingUtil.stopRecording(request, locusUrl, locusInfo);
-
-          assert.calledWith(request.recordMeeting, {locusUrl, recording: false, paused: false});
-
-          assert.deepEqual(result, request.recordMeeting.firstCall.returnValue);
-        });
-
-        it('rejects when correct display hint is not present', () => {
-          const result = MeetingUtil.stopRecording(request, locusUrl, {});
-
-          assert.notCalled(request.recordMeeting);
-
-          assert.isRejected(result);
-        });
-      });
-    });
   });
 });