@webex/plugin-meetings 2.60.0 → 2.60.1-next.10

package/src/meeting/request.ts

@@ -4,11 +4,13 @@ import {debounce} from 'lodash';
 import {StatelessWebexPlugin} from '@webex/webex-core';
 // @ts-ignore
 import {deviceType} from '@webex/common';
+import {CallDiagnosticUtils} from '@webex/internal-plugin-metrics';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import {
   ALERT,
   ALTERNATE_REDIRECT_TRUE,
+  BREAKOUTS,
   CALL,
   CONTROLS,
   DECLINE,
@@ -17,30 +19,73 @@ import {
   HTTP_VERBS,
   LEAVE,
   LOCI,
-  LOCUS,
-  MEDIA,
   PARTICIPANT,
   PROVISIONAL_TYPE_DIAL_IN,
   PROVISIONAL_TYPE_DIAL_OUT,
+  REACHABILITY,
   SEND_DTMF_ENDPOINT,
   _SLIDES_,
+  ANNOTATION,
+  IP_VERSION,
 } from '../constants';
-import {Reaction} from '../reactions/reactions.type';
+import {SendReactionOptions, ToggleReactionsOptions} from './request.type';
+import MeetingUtil from './util';
+import {AnnotationInfo} from '../annotation/annotation.types';
 
 /**
  * @class MeetingRequest
  */
 export default class MeetingRequest extends StatelessWebexPlugin {
   changeVideoLayoutDebounced: any;
+  meetingRef: WeakRef<any>;
+  locusDeltaRequest: (options: object) => Promise<any>;
+  buildLocusDeltaRequestOptions: (options: object) => Promise<any>;
 
+  /**
+   * Constructor
+   * @param {Object} attrs
+   * @param {Object} options
+   */
   constructor(attrs: any, options: any) {
-    super(attrs, options);
+    const {meeting, ...otherAttrs} = attrs;
+
+    super(otherAttrs, options);
+
+    this.locusDeltaRequest = MeetingUtil.generateLocusDeltaRequest(meeting);
+    this.buildLocusDeltaRequestOptions = MeetingUtil.generateBuildLocusDeltaRequestOptions(meeting);
+
     this.changeVideoLayoutDebounced = debounce(this.changeVideoLayout, 2000, {
       leading: true,
       trailing: true,
     });
   }
 
+  /**
+   * Returns joinCookie from boundedStorage if present.
+   * @returns {Object} joinCookie
+   */
+  private getJoinCookie = async () => {
+    // @ts-ignore
+    const joinCookieRaw = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageJoinCookie)
+      .catch(() => {});
+
+    if (joinCookieRaw) {
+      try {
+        const joinCookie = JSON.parse(joinCookieRaw);
+        if (joinCookie) {
+          return joinCookie;
+        }
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `MeetingRequest#constructor --> Error in parsing join cookie data: ${e}`
+        );
+      }
+    }
+
+    return null;
+  };
+
   /**
    * Make a network request to join a meeting
    * @param {Object} options
@@ -54,12 +99,17 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {boolean} options.pin
    * @param {boolean} options.moveToResource
    * @param {Object} options.roapMessage
+   * @param {boolean} options.breakoutsSupported
+   * @param {String} options.locale,
+   * @param {Array} options.deviceCapabilities
+   * @param {boolean} options.liveAnnotationSupported
    * @returns {Promise}
    */
   async joinMeeting(options: {
     sipUri: string;
     deviceUrl: string;
     locusUrl: string;
+    locusClusterUrl: string;
     resourceId: string;
     correlationId: string;
     ensureConversation: boolean;
@@ -72,6 +122,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     meetingNumber: any;
     permissionToken: any;
     preferTranscoding: any;
+    breakoutsSupported: boolean;
+    locale?: string;
+    deviceCapabilities?: Array<string>;
+    liveAnnotationSupported: boolean;
+    ipVersion?: IP_VERSION;
   }) {
     const {
       asResourceOccupant,
@@ -80,6 +135,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       permissionToken,
       deviceUrl,
       locusUrl,
+      locusClusterUrl,
       resourceId,
       correlationId,
       ensureConversation,
@@ -88,12 +144,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       moveToResource,
       roapMessage,
       preferTranscoding,
+      breakoutsSupported,
+      locale,
+      deviceCapabilities = [],
+      liveAnnotationSupported,
+      ipVersion,
     } = options;
 
     LoggerProxy.logger.info('Meeting:request#joinMeeting --> Joining a meeting', correlationId);
 
     let url = '';
 
+    const joinCookie = await this.getJoinCookie();
+
     const body: any = {
       asResourceOccupant,
       device: {
@@ -110,15 +173,43 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       supportsNativeLobby: 1,
       clientMediaPreferences: {
         preferTranscoding: preferTranscoding ?? true,
+        joinCookie,
+        ipver: ipVersion,
       },
     };
 
+    if (breakoutsSupported) {
+      deviceCapabilities.push(BREAKOUTS.BREAKOUTS_SUPPORTED);
+    }
+    if (liveAnnotationSupported) {
+      deviceCapabilities.push(ANNOTATION.ANNOTATION_ON_SHARE_SUPPORTED);
+    }
+
+    // append installationId to device config if it exists
     // @ts-ignore
-    if (this.webex.meetings.clientRegion) {
+    if (this.webex.internal.device.config.installationId) {
       // @ts-ignore
-      body.device.countryCode = this.webex.meetings.clientRegion.countryCode;
+      body.device.installationId = this.webex.internal.device.config.installationId;
+    }
+
+    if (locale) {
+      body.locale = locale;
+    }
+
+    // add deviceCapabilities prop
+    if (deviceCapabilities.length) {
+      body.deviceCapabilities = deviceCapabilities;
+    }
+    // @ts-ignore
+    if (this.webex.meetings.geoHintInfo) {
+      // @ts-ignore
+      body.device.countryCode = this.webex.meetings.geoHintInfo.countryCode;
       // @ts-ignore
-      body.device.regionCode = this.webex.meetings.clientRegion.regionCode;
+      body.device.regionCode = this.webex.meetings.geoHintInfo.regionCode;
+      body.device.localIp =
+        // @ts-ignore
+        CallDiagnosticUtils.anonymizeIPAddress(this.webex.meetings.geoHintInfo.clientAddress) ||
+        undefined;
     }
 
     if (moderator !== undefined) {
@@ -137,10 +228,18 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       url = `${locusUrl}/${PARTICIPANT}`;
     } else if (inviteeAddress || meetingNumber) {
       try {
-        // @ts-ignore
-        await this.webex.internal.services.waitForCatalog('postauth');
-        // @ts-ignore
-        url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
+        let clusterUrl;
+
+        if (locusClusterUrl) {
+          clusterUrl = `https://${locusClusterUrl}/locus/api/v1`;
+        } else {
+          // @ts-ignore
+          await this.webex.internal.services.waitForCatalog('postauth');
+          // @ts-ignore
+          clusterUrl = this.webex.internal.services.get('locus');
+        }
+
+        url = `${clusterUrl}/${LOCI}/${CALL}`;
         body.invitee = {
           address: inviteeAddress || `wbxmn:${meetingNumber}`,
         };
@@ -242,7 +341,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     };
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri,
       body,
@@ -297,7 +396,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     };
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri,
       body,
@@ -311,65 +410,25 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   }
 
   /**
-   * Syns the missed delta event
+   * Sends a requests to get the latest locus DTO, it might be a full Locus or a delta, depending on the url provided
    * @param {Object} options
-   * @param {boolean} options.desync flag to get partial or whole locus object
-   * @param {String} options.syncUrl sync url to get ht elatest locus delta
-   * @returns {Promise}
-   */
-  syncMeeting(options: {desync: boolean; syncUrl: string}) {
-    /* eslint-disable no-else-return */
-    const {desync} = options;
-    let {syncUrl} = options;
-
-    /* istanbul ignore else */
-    if (desync) {
-      // check for existing URL parameters
-      syncUrl = syncUrl
-        .concat(syncUrl.split('?')[1] ? '&' : '?')
-        .concat(`${LOCUS.SYNCDEBUG}=${desync}`);
-    }
-
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.GET,
-      uri: syncUrl,
-    }) // TODO: Handle if delta sync failed . Get the full locus object
-      .catch((err) => {
-        LoggerProxy.logger.error(
-          `Meeting:request#syncMeeting --> Error syncing meeting, error ${err}`
-        );
-
-        return err;
-      });
-  }
-
-  /**
-   * Request to get the complete locus object
-   * @param {Object} options
-   * @param {boolean} options.desync flag to get partial or whole locus object
    * @param {String} options.locusUrl sync url to get ht elatest locus delta
    * @returns {Promise}
    */
-  getFullLocus(options: {desync: boolean; locusUrl: string}) {
-    let {locusUrl} = options;
-    const {desync} = options;
-
-    if (locusUrl) {
-      if (desync) {
-        locusUrl += `?${LOCUS.SYNCDEBUG}=${desync}`;
-      }
+  getLocusDTO(options: {url: string}) {
+    const {url} = options;
 
+    if (url) {
       // @ts-ignore
       return this.request({
         method: HTTP_VERBS.GET,
-        uri: locusUrl,
+        uri: url,
       }).catch((err) => {
         LoggerProxy.logger.error(
-          `Meeting:request#getFullLocus --> Error getting full locus, error ${err}`
+          `Meeting:request#getLocusDTO --> Error getting latest locus, error ${err}`
         );
 
-        return err;
+        throw err;
       });
     }
 
@@ -412,7 +471,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     };
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
       body,
@@ -426,13 +485,49 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   }
 
   /**
-   * Make a network request to leave a meeting
+   * Prepares request options to to leave a meeting
    * @param {Object} options
    * @param {Url} options.locusUrl
    * @param {String} options.selfId
    * @param {Url} options.deviceUrl
    * @param {String} options.resourceId,
    * @param {String} options.correlationId
+   * @returns {Object} request options
+   */
+  prepareLeaveMeetingRequestOptions({
+    locusUrl,
+    selfId,
+    deviceUrl: url,
+    resourceId,
+    correlationId,
+  }: {
+    locusUrl: string;
+    selfId: string;
+    deviceUrl: string;
+    resourceId: string;
+    correlationId: string;
+  }) {
+    const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${LEAVE}`;
+    const body = {
+      device: {
+        // @ts-ignore
+        deviceType: this.config.meetings.deviceType,
+        url,
+      },
+      usingResource: resourceId || null,
+      correlationId,
+    };
+
+    return {
+      method: HTTP_VERBS.PUT,
+      uri,
+      body,
+    };
+  }
+
+  /**
+   * Make a network request to leave a meeting
+   * @param {Object} options
    * @returns {Promise}
    */
   leaveMeeting({
@@ -461,14 +556,22 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       correlationId,
     };
 
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
       body,
     });
   }
 
+  /**
+   * Builds request options to leave a meeting
+   * @param {Object} options
+   * @returns {Object} request options
+   */
+  buildLeaveMeetingRequestOptions(options: any) {
+    return this.buildLocusDeltaRequestOptions(this.prepareLeaveMeetingRequestOptions(options));
+  }
+
   /**
    * Make a network request to acknowledge a meeting
    * @param {Object} options
@@ -488,14 +591,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       correlationId: options.correlationId,
     };
 
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
       body,
     });
   }
 
+  /**
+   * Makes a network request to lock the meeting
+   * @param {Object} options
+   * @param {Boolean} options.lock Whether it is locked or not
+   * @returns {Promise}
+   */
   lockMeeting(options) {
     const uri = `${options.locusUrl}/${CONTROLS}`;
     const body = {
@@ -504,8 +612,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       },
     };
 
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PATCH,
       uri,
       body,
@@ -531,53 +638,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       ...(options.reason && {reason: options.reason}),
     };
 
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body,
-    });
-  }
-
-  /**
-   * Toggle remote audio and/or video
-   * @param {Object} options options for toggling
-   * @param {String} options.selfId Locus self id??
-   * @param {String} options.locusUrl Locus url
-   * @param {String} options.deviceUrl Url of a device
-   * @param {String} options.resourceId Populated if you are paired to a device
-   * @param {String} options.localMedias local sdps
-   * @returns {Promise}
-   */
-  remoteAudioVideoToggle(
-    options:
-      | {
-          selfId: string;
-          locusUrl: string;
-          deviceUrl: string;
-          resourceId: string;
-          localMedias: string;
-        }
-      | any
-  ) {
-    const uri = `${options.locusUrl}/${PARTICIPANT}/${options.selfId}/${MEDIA}`;
-    const body = {
-      device: {
-        // @ts-ignore
-        deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl,
-      },
-      usingResource: options.resourceId || null,
-      correlationId: options.correlationId,
-      respOnlySdp: true,
-      localMedias: options.localMedias,
-      clientMediaPreferences: {
-        preferTranscoding: options.preferTranscoding ?? true,
-      },
-    };
-
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
       body,
@@ -602,6 +663,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
           deviceUrl: string;
           resourceId: string;
           uri: string;
+          annotationInfo: AnnotationInfo;
         }
       | any
   ) {
@@ -635,6 +697,9 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     if (options?.resourceToken) {
       body.resourceToken = options?.resourceToken;
     }
+    if (options?.annotationInfo) {
+      body.annotation = options?.annotationInfo;
+    }
 
     // @ts-ignore
     return this.request({
@@ -654,7 +719,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    */
   sendDTMF({locusUrl, deviceUrl, tones}: {locusUrl: string; deviceUrl: string; tones: string}) {
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri: `${locusUrl}/${SEND_DTMF_ENDPOINT}`,
       body: {
@@ -735,7 +800,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         : undefined;
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri: `${locusUrl}/${CONTROLS}`,
       body: {
@@ -758,7 +823,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     const uri = `${locusUrl}/${END}`;
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri,
     });
@@ -786,15 +851,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {string} options.senderID
    * @returns {Promise}
    */
-  sendReaction({
-    reactionChannelUrl,
-    reaction,
-    participantId,
-  }: {
-    reactionChannelUrl: string;
-    reaction: Reaction;
-    participantId: string;
-  }) {
+  sendReaction({reactionChannelUrl, reaction, participantId}: SendReactionOptions) {
     const uri = reactionChannelUrl;
 
     // @ts-ignore
@@ -807,4 +864,34 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       },
     });
   }
+
+  /**
+   * Make a network request to enable or disable reactions.
+   * @param {boolean} options.enable - determines if we need to enable or disable.
+   * @param {locusUrl} options.locusUrl
+   * @returns {Promise}
+   */
+  toggleReactions({enable, locusUrl, requestingParticipantId}: ToggleReactionsOptions) {
+    const uri = `${locusUrl}/${CONTROLS}`;
+
+    // @ts-ignore
+    return this.locusDeltaRequest({
+      method: HTTP_VERBS.PUT,
+      uri,
+      body: {
+        reactions: {
+          enabled: enable,
+        },
+        requestingParticipantId,
+      },
+    });
+  }
+
+  getLocusStatusByUrl(locusUrl: string) {
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.GET,
+      uri: locusUrl,
+    });
+  }
 }

package/src/meeting/request.type.ts

@@ -0,0 +1,13 @@
+import {Reaction} from '../reactions/reactions.type';
+
+export type SendReactionOptions = {
+  reactionChannelUrl: string;
+  reaction: Reaction;
+  participantId: string;
+};
+
+export type ToggleReactionsOptions = {
+  enable: boolean;
+  locusUrl: string;
+  requestingParticipantId: string;
+};