@webex/plugin-meetings 3.0.0-beta.16 → 3.0.0-beta.160

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/index.ts

@@ -98,11 +98,8 @@ export default class Roap extends StatelessWebexPlugin {
           roapMessage,
           locusSelfUrl: meeting.selfUrl,
           mediaId: options.mediaId,
-          correlationId: options.correlationId,
-          audioMuted: meeting.isAudioMuted(),
-          videoMuted: meeting.isVideoMuted(),
           meetingId: meeting.id,
-          preferTranscoding: !meeting.isMultistream,
+          locusMediaRequest: meeting.locusMediaRequest,
         })
         .then(() => {
           LoggerProxy.logger.log(`Roap:index#sendRoapOK --> ROAP OK sent with seq ${options.seq}`);
@@ -135,11 +132,8 @@ export default class Roap extends StatelessWebexPlugin {
       roapMessage,
       locusSelfUrl: meeting.selfUrl,
       mediaId: options.mediaId,
-      correlationId: options.correlationId,
-      audioMuted: meeting.isAudioMuted(),
-      videoMuted: meeting.isVideoMuted(),
       meetingId: meeting.id,
-      preferTranscoding: !meeting.isMultistream,
+      locusMediaRequest: meeting.locusMediaRequest,
     });
   }
 
@@ -167,11 +161,8 @@ export default class Roap extends StatelessWebexPlugin {
         roapMessage,
         locusSelfUrl: meeting.selfUrl,
         mediaId: options.mediaId,
-        correlationId: options.correlationId,
-        audioMuted: meeting.isAudioMuted(),
-        videoMuted: meeting.isVideoMuted(),
         meetingId: meeting.id,
-        preferTranscoding: !meeting.isMultistream,
+        locusMediaRequest: meeting.locusMediaRequest,
       })
       .then(() => {
         LoggerProxy.logger.log(
@@ -199,26 +190,26 @@ export default class Roap extends StatelessWebexPlugin {
     // When reconnecting, it's important that the first roap message being sent out has empty media id.
     // Normally this is the roap offer, but when TURN discovery is enabled,
     // then this is the TURN discovery request message
-    const sendEmptyMediaId = reconnect && !meeting.config.experimental.enableTurnDiscovery;
+    return this.turnDiscovery.isSkipped(meeting).then((isTurnDiscoverySkipped) => {
+      const sendEmptyMediaId = reconnect && isTurnDiscoverySkipped;
 
-    return this.roapRequest
-      .sendRoap({
-        roapMessage,
-        correlationId: meeting.correlationId,
-        locusSelfUrl: meeting.selfUrl,
-        mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
-        audioMuted: meeting.isAudioMuted(),
-        videoMuted: meeting.isVideoMuted(),
-        meetingId: meeting.id,
-        preferTranscoding: !meeting.isMultistream,
-      })
-      .then(({locus, mediaConnections}) => {
-        if (mediaConnections) {
-          meeting.updateMediaConnections(mediaConnections);
-        }
+      return this.roapRequest
+        .sendRoap({
+          roapMessage,
+          locusSelfUrl: meeting.selfUrl,
+          mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
+          meetingId: meeting.id,
+          preferTranscoding: !meeting.isMultistream,
+          locusMediaRequest: meeting.locusMediaRequest,
+        })
+        .then(({locus, mediaConnections}) => {
+          if (mediaConnections) {
+            meeting.updateMediaConnections(mediaConnections);
+          }
 
-        return locus;
-      });
+          return locus;
+        });
+    });
   }
 
   /**

package/src/roap/request.ts

@@ -1,24 +1,28 @@
-/* global window */
 // @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import LoggerProxy from '../common/logs/logger-proxy';
-import {MEDIA, HTTP_VERBS, REACHABILITY} from '../constants';
+import {REACHABILITY} from '../constants';
 import Metrics from '../metrics';
 import {eventType} from '../metrics/config';
+import {LocusMediaRequest} from '../meeting/locusMediaRequest';
 
 /**
  * @class RoapRequest
  */
 export default class RoapRequest extends StatelessWebexPlugin {
   /**
-   * Joins a meeting via ROAP
-   * @param {Object} options
-   * @returns {Promise} returns a promise that resolves/rejects whatever the request does
+   * Returns reachability data.
+   * @param {Object} localSdp
+   * @returns {Object}
    */
+  async attachReachabilityData(localSdp) {
+    let joinCookie;
 
-  attachRechabilityData(localSdp) {
-    const reachabilityData = window.localStorage.getItem(REACHABILITY.localStorage);
+    // @ts-ignore
+    const reachabilityData = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageResult)
+      .catch(() => {});
 
     if (reachabilityData) {
       try {
@@ -35,7 +39,22 @@ export default class RoapRequest extends StatelessWebexPlugin {
       }
     }
 
-    return localSdp;
+    // @ts-ignore
+    const joinCookieRaw = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageJoinCookie)
+      .catch(() => {});
+
+    if (joinCookieRaw) {
+      try {
+        joinCookie = JSON.parse(joinCookieRaw);
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `MeetingRequest#constructor --> Error in parsing join cookie data: ${e}`
+        );
+      }
+    }
+
+    return {localSdp, joinCookie};
   }
 
   /**
@@ -45,67 +64,47 @@ export default class RoapRequest extends StatelessWebexPlugin {
    * @param {String} options.locusSelfUrl
    * @param {String} options.mediaId
    * @param {String} options.correlationId
-   * @param {Boolean} options.audioMuted
-   * @param {Boolean} options.videoMuted
    * @param {String} options.meetingId
    * @returns {Promise} returns the response/failure of the request
    */
-  sendRoap(options: {
+  async sendRoap(options: {
     roapMessage: any;
     locusSelfUrl: string;
     mediaId: string;
-    correlationId: string;
-    audioMuted: boolean;
-    videoMuted: boolean;
     meetingId: string;
-    preferTranscoding?: boolean;
+    locusMediaRequest?: LocusMediaRequest;
   }) {
-    const {roapMessage, locusSelfUrl, mediaId, correlationId, meetingId} = options;
+    const {roapMessage, locusSelfUrl, mediaId, meetingId, locusMediaRequest} = options;
 
     if (!mediaId) {
-      LoggerProxy.logger.info('Roap:request#sendRoap --> Race Condition /call mediaID not present');
+      LoggerProxy.logger.info('Roap:request#sendRoap --> sending empty mediaID');
     }
 
-    const mediaUrl = `${locusSelfUrl}/${MEDIA}`;
-    // @ts-ignore
-    const deviceUrl = this.webex.internal.device.url;
+    if (!locusMediaRequest) {
+      LoggerProxy.logger.warn(
+        'Roap:request#sendRoap --> locusMediaRequest unavailable, not sending roap'
+      );
+
+      return Promise.reject(new Error('sendRoap called when locusMediaRequest is undefined'));
+    }
+    const {localSdp: localSdpWithReachabilityData, joinCookie} = await this.attachReachabilityData({
+      roapMessage,
+    });
 
     LoggerProxy.logger.info(
-      `Roap:request#sendRoap --> ${mediaUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`
+      `Roap:request#sendRoap --> ${locusSelfUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`
     );
 
     Metrics.postEvent({event: eventType.MEDIA_REQUEST, meetingId});
 
-    // @ts-ignore
-    return this.webex
-      .request({
-        uri: mediaUrl,
-        method: HTTP_VERBS.PUT,
-        body: {
-          device: {
-            url: deviceUrl,
-            // @ts-ignore
-            deviceType: this.config.meetings.deviceType,
-          },
-          correlationId,
-          localMedias: [
-            {
-              localSdp: JSON.stringify(
-                this.attachRechabilityData({
-                  roapMessage,
-                  // eslint-disable-next-line no-warning-comments
-                  // TODO: check whats the need for video and audiomute
-                  audioMuted: !!options.audioMuted,
-                  videoMuted: !!options.videoMuted,
-                })
-              ),
-              mediaId: options.mediaId,
-            },
-          ],
-          clientMediaPreferences: {
-            preferTranscoding: options.preferTranscoding ?? true,
-          },
-        },
+    return locusMediaRequest
+      .send({
+        type: 'RoapMessage',
+        selfUrl: locusSelfUrl,
+        joinCookie,
+        mediaId,
+        roapMessage,
+        reachability: localSdpWithReachabilityData.reachability,
       })
       .then((res) => {
         Metrics.postEvent({event: eventType.MEDIA_RESPONSE, meetingId});
@@ -116,7 +115,7 @@ export default class RoapRequest extends StatelessWebexPlugin {
           res.body.mediaConnections.length > 0 &&
           res.body.mediaConnections[0];
 
-        LoggerProxy.logger.info(
+        LoggerProxy.logger.debug(
           `Roap:request#sendRoap --> response:${JSON.stringify(
             mediaConnections,
             null,