@webex/plugin-meetings 3.3.1-next.3 → 3.3.1-next.31

package/src/meeting-info/utilv2.ts

@@ -4,15 +4,9 @@ import url from 'url';
 import {deconstructHydraId} from '@webex/common';
 
 import {
-  _SIP_URI_,
-  _PERSONAL_ROOM_,
-  _MEETING_ID_,
-  _CONVERSATION_URL_,
-  _LOCUS_ID_,
-  _MEETING_LINK_,
+  DESTINATION_TYPE,
   _PEOPLE_,
   _ROOM_,
-  _MEETING_UUID_,
   DIALER_REGEX,
   WEBEX_DOT_COM,
   CONVERSATION_SERVICE,
@@ -144,7 +138,7 @@ export default class MeetingInfoUtil {
     const {type, webex} = from;
     let {destination} = from;
 
-    if (type === _PERSONAL_ROOM_) {
+    if (type === DESTINATION_TYPE.PERSONAL_ROOM) {
       // this case checks if your type is personal room
       if (!destination) {
         // if we are not getting anything in desination we fetch org and user ids from webex instance
@@ -185,19 +179,19 @@ export default class MeetingInfoUtil {
         'Meeting-info:util#generateOptions --> WARN, use of Meeting Link is deprecated, please use a SIP URI instead'
       );
 
-      options.type = _MEETING_LINK_;
+      options.type = DESTINATION_TYPE.MEETING_LINK;
       options.destination = destination;
     } else if (this.isSipUri(destination)) {
-      options.type = _SIP_URI_;
+      options.type = DESTINATION_TYPE.SIP_URI;
       options.destination = destination;
     } else if (this.isPhoneNumber(destination)) {
-      options.type = _SIP_URI_;
+      options.type = DESTINATION_TYPE.SIP_URI;
       options.destination = destination;
     } else if (this.isConversationUrl(destination, webex)) {
-      options.type = _CONVERSATION_URL_;
+      options.type = DESTINATION_TYPE.CONVERSATION_URL;
       options.destination = destination;
     } else if (hydraId && hydraId.people) {
-      options.type = _SIP_URI_;
+      options.type = DESTINATION_TYPE.SIP_URI;
 
       return this.getSipUriFromHydraPersonId(hydraId && hydraId.destination, webex).then((res) => {
         options.destination = res;
@@ -226,12 +220,12 @@ export default class MeetingInfoUtil {
   /**
    * Helper function to build up a correct locus url depending on the value passed
    * @param {Object} options type and value to fetch meeting info
-   * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
+   * @param {DESTINATION_TYPE} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
    * @param {String} options.installedOrgID org ID of user's machine
    * @param {Object} options.destination ?? value.value
    * @returns {Object} returns an object with {resource, method}
    */
-  static getRequestBody(options: {type: string; destination: object} | any) {
+  static getRequestBody(options: {type: DESTINATION_TYPE; destination: object} | any) {
     const {type, destination, password, captchaInfo, installedOrgID, locusId, extraParams} =
       options;
     const body: any = {
@@ -240,20 +234,20 @@ export default class MeetingInfoUtil {
     };
 
     switch (type) {
-      case _SIP_URI_:
+      case DESTINATION_TYPE.SIP_URI:
         body.sipUrl = destination;
         break;
-      case _PERSONAL_ROOM_:
+      case DESTINATION_TYPE.PERSONAL_ROOM:
         body.userId = destination.userId;
         body.orgId = destination.orgId;
         break;
-      case _MEETING_ID_:
+      case DESTINATION_TYPE.MEETING_ID:
         body.meetingKey = destination;
         break;
-      case _CONVERSATION_URL_:
+      case DESTINATION_TYPE.CONVERSATION_URL:
         body.conversationUrl = destination;
         break;
-      case _LOCUS_ID_:
+      case DESTINATION_TYPE.LOCUS_ID:
         // use meetingID for the completer meeting info for the already started meeting
         if (destination.info?.webExMeetingId) {
           body.meetingKey = destination.info.webExMeetingId;
@@ -261,10 +255,10 @@ export default class MeetingInfoUtil {
           body.sipUrl = destination.info.sipUri;
         }
         break;
-      case _MEETING_LINK_:
+      case DESTINATION_TYPE.MEETING_LINK:
         body.meetingUrl = destination;
         break;
-      case _MEETING_UUID_: {
+      case DESTINATION_TYPE.MEETING_UUID: {
         body.meetingUUID = destination;
         break;
       }
@@ -317,10 +311,10 @@ export default class MeetingInfoUtil {
     let preferredWebexSite = null;
 
     switch (type) {
-      case _SIP_URI_:
+      case DESTINATION_TYPE.SIP_URI:
         preferredWebexSite = this.getWebexSite(destination);
         break;
-      case _LOCUS_ID_:
+      case DESTINATION_TYPE.LOCUS_ID:
         preferredWebexSite = destination.info?.webExSite;
         break;
       default:

package/src/meetings/collection.ts

@@ -1,7 +1,7 @@
 import {find} from 'lodash';
 
 import Collection from '../common/collection';
-
+import {MEETING_KEY} from './meetings.types';
 /**
  * @export
  * @class MeetingCollection
@@ -26,13 +26,13 @@ export default class MeetingCollection extends Collection {
 
   /**
    * get a specific meeting searching for key
-   * @param {String} key
+   * @param {MEETING_KEY} key
    * @param {Any} value
    * @returns {Meeting} if found, else returns null
    * @public
    * @memberof MeetingCollection
    */
-  public getByKey(key: string, value: any) {
+  public getByKey(key: MEETING_KEY, value: any) {
     if (key && value) {
       // @ts-ignore
       return find(this.meetings, (meeting) => meeting[key] === value);

package/src/meetings/index.ts

@@ -25,28 +25,22 @@ import {
   EVENT_TRIGGERS,
   READY,
   LOCUSEVENT,
-  LOCUS_URL,
   MAX_RANDOM_DELAY_FOR_MEETING_INFO,
   ROAP,
   ONLINE,
   OFFLINE,
   _MEETING_,
   _JOIN_,
-  _LOCUS_ID_,
   _INCOMING_,
   LOCUS,
-  CORRELATION_ID,
-  SIP_URI,
   _LEFT_,
   _ID_,
   MEETING_REMOVED_REASON,
-  _CONVERSATION_URL_,
-  CONVERSATION_URL,
-  MEETINGNUMBER,
   _JOINED_,
   _MOVED_,
   _ON_HOLD_LOBBY_,
   _WAIT_,
+  DESTINATION_TYPE,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import MeetingInfo from '../meeting-info';
@@ -57,11 +51,10 @@ import Reachability from '../reachability';
 import Request from './request';
 import PasswordError from '../common/errors/password-error';
 import CaptchaError from '../common/errors/captcha-error';
-
 import MeetingCollection from './collection';
+import {MEETING_KEY, INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
-import {INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
 
@@ -380,23 +373,26 @@ export default class Meetings extends WebexPlugin {
     // Either the locus
     // TODO : Add check for the callBack Address
     return (
-      this.meetingCollection.getByKey(LOCUS_URL, data.locusUrl) ||
+      this.meetingCollection.getByKey(MEETING_KEY.LOCUS_URL, data.locusUrl) ||
       // @ts-ignore
       this.meetingCollection.getByKey(
-        CORRELATION_ID,
+        MEETING_KEY.CORRELATION_ID,
         // @ts-ignore
         MeetingsUtil.checkForCorrelationId(this.webex.internal.device.url, data.locus)
       ) ||
       this.meetingCollection.getByKey(
-        SIP_URI,
+        MEETING_KEY.SIP_URI,
         data.locus.self &&
           data.locus.self.callbackInfo &&
           data.locus.self.callbackInfo.callbackAddress
       ) ||
       (data.locus.info?.isUnifiedSpaceMeeting
         ? undefined
-        : this.meetingCollection.getByKey(CONVERSATION_URL, data.locus.conversationUrl)) ||
-      this.meetingCollection.getByKey(MEETINGNUMBER, data.locus?.info?.webExMeetingId)
+        : this.meetingCollection.getByKey(
+            MEETING_KEY.CONVERSATION_URL,
+            data.locus.conversationUrl
+          )) ||
+      this.meetingCollection.getByKey(MEETING_KEY.MEETINGNUMBER, data.locus?.info?.webExMeetingId)
     );
   }
 
@@ -420,7 +416,7 @@ export default class Meetings extends WebexPlugin {
     if (!meeting && data.locus?.replaces?.length > 0) {
       // Always the last element in the replace is the active one
       meeting = this.meetingCollection.getByKey(
-        LOCUS_URL,
+        MEETING_KEY.LOCUS_URL,
         data.locus.replaces[data.locus.replaces.length - 1].locusUrl
       );
     }
@@ -485,7 +481,7 @@ export default class Meetings extends WebexPlugin {
         return;
       }
 
-      this.create(data.locus, _LOCUS_ID_, useRandomDelayForInfo)
+      this.create(data.locus, DESTINATION_TYPE.LOCUS_ID, useRandomDelayForInfo)
         .then((newMeeting) => {
           meeting = newMeeting;
 
@@ -1076,7 +1072,7 @@ export default class Meetings extends WebexPlugin {
    * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
    *
    * @param {string} destination - sipURL, phonenumber, or locus object}
-   * @param {string} [type] - the optional specified type, such as locusId
+   * @param {DESTINATION_TYPE} [type] - the optional specified type, such as locusId
    * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
    * @param {string} correlationId - the optional specified correlationId (callStateForMetrics.correlationId can be provided instead)
@@ -1090,7 +1086,7 @@ export default class Meetings extends WebexPlugin {
    */
   public create(
     destination: string,
-    type: string = null,
+    type: DESTINATION_TYPE = null,
     useRandomDelayForInfo = false,
     infoExtraParams = {},
     correlationId: string = undefined,
@@ -1099,12 +1095,11 @@ export default class Meetings extends WebexPlugin {
     meetingInfo = undefined,
     meetingLookupUrl = undefined
   ) {
-    // TODO: type should be from a dictionary
-
     // Validate meeting information based on the provided destination and
     // type. This must be performed prior to determining if the meeting is
     // found in the collection, as we mutate the destination for hydra person
     // id values.
+
     if (correlationId) {
       callStateForMetrics = {...(callStateForMetrics || {}), correlationId};
     }
@@ -1128,8 +1123,14 @@ export default class Meetings extends WebexPlugin {
           // check for the conversation URL then sip Url
           let meeting = null;
 
-          if (type === _CONVERSATION_URL_ || options.type === _CONVERSATION_URL_) {
-            const foundMeeting = this.meetingCollection.getByKey(CONVERSATION_URL, targetDest);
+          if (
+            type === DESTINATION_TYPE.CONVERSATION_URL ||
+            options.type === DESTINATION_TYPE.CONVERSATION_URL
+          ) {
+            const foundMeeting = this.meetingCollection.getByKey(
+              MEETING_KEY.CONVERSATION_URL,
+              targetDest
+            );
 
             if (foundMeeting) {
               const foundMeetingIsNotCalendarMeeting = !foundMeeting.locusInfo.scheduledMeeting;
@@ -1144,7 +1145,7 @@ export default class Meetings extends WebexPlugin {
 
           // Attempt to collect the meeting if it exists.
           if (!meeting) {
-            meeting = this.meetingCollection.getByKey(SIP_URI, targetDest);
+            meeting = this.meetingCollection.getByKey(MEETING_KEY.SIP_URI, targetDest);
           }
 
           // Validate if a meeting was found.
@@ -1218,7 +1219,7 @@ export default class Meetings extends WebexPlugin {
    * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
    *
    * @param {String} destination see create()
-   * @param {String} type see create()
+   * @param {DESTINATION_TYPE} type see create()
    * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
    * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
@@ -1231,7 +1232,7 @@ export default class Meetings extends WebexPlugin {
    */
   private async createMeeting(
     destination: any,
-    type: string = null,
+    type: DESTINATION_TYPE = null,
     useRandomDelayForInfo = false,
     infoExtraParams = {},
     callStateForMetrics: CallStateForMetrics = undefined,
@@ -1247,7 +1248,7 @@ export default class Meetings extends WebexPlugin {
         deviceUrl: this.webex.internal.device.url,
         // @ts-ignore
         orgId: this.webex.internal.device.orgId,
-        locus: type === _LOCUS_ID_ ? destination : null, // pass the locus object if present
+        locus: type === DESTINATION_TYPE.LOCUS_ID ? destination : null, // pass the locus object if present
         meetingInfoProvider: this.meetingInfo,
         destination,
         destinationType: type,
@@ -1290,19 +1291,17 @@ export default class Meetings extends WebexPlugin {
 
       if (meetingInfo) {
         meeting.injectMeetingInfo(meetingInfo, meetingInfoOptions, meetingLookupUrl);
-      } else if (
-        enableUnifiedMeetings &&
-        !isMeetingActive &&
-        useRandomDelayForInfo &&
-        waitingTime > 0
-      ) {
-        meeting.fetchMeetingInfoTimeoutId = setTimeout(
-          () => meeting.fetchMeetingInfo(meetingInfoOptions),
-          waitingTime
-        );
-        meeting.parseMeetingInfo(undefined, destination);
-      } else {
-        await meeting.fetchMeetingInfo(meetingInfoOptions);
+      } else if (type !== DESTINATION_TYPE.ONE_ON_ONE_CALL) {
+        // ignore fetchMeetingInfo for 1:1 meetings
+        if (enableUnifiedMeetings && !isMeetingActive && useRandomDelayForInfo && waitingTime > 0) {
+          meeting.fetchMeetingInfoTimeoutId = setTimeout(
+            () => meeting.fetchMeetingInfo(meetingInfoOptions),
+            waitingTime
+          );
+          meeting.parseMeetingInfo(undefined, destination);
+        } else {
+          await meeting.fetchMeetingInfo(meetingInfoOptions);
+        }
       }
     } catch (err) {
       if (
@@ -1333,7 +1332,7 @@ export default class Meetings extends WebexPlugin {
       // For type LOCUS_ID we need to parse the locus object to get the information
       // about the caller and callee
       // Meeting Added event will be created in `handleLocusEvent`
-      if (type !== _LOCUS_ID_) {
+      if (type !== DESTINATION_TYPE.LOCUS_ID) {
         if (!meeting.sipUri) {
           meeting.setSipUri(destination);
         }

package/src/meetings/meetings.types.ts

@@ -2,6 +2,7 @@ import type {
   NoiseReductionEffectOptions,
   VirtualBackgroundEffectOptions,
 } from '@webex/media-helpers';
+import {Enum} from '../constants';
 
 type INoiseReductionEffect = Omit<
   NoiseReductionEffectOptions,
@@ -10,3 +11,13 @@ type INoiseReductionEffect = Omit<
 type IVirtualBackgroundEffect = Omit<VirtualBackgroundEffectOptions, 'authToken'>;
 
 export type {INoiseReductionEffect, IVirtualBackgroundEffect};
+
+export const MEETING_KEY = {
+  CONVERSATION_URL: 'conversationUrl',
+  SIP_URI: 'sipUri',
+  LOCUS_URL: 'locusUrl',
+  MEETINGNUMBER: 'meetingNumber',
+  CORRELATION_ID: 'correlationId',
+} as const;
+
+export type MEETING_KEY = Enum<typeof MEETING_KEY>;

package/src/meetings/util.ts

@@ -5,10 +5,9 @@ import {
   _INCOMING_,
   _JOINED_,
   _LEFT_,
-  _LOCUS_ID_,
+  DESTINATION_TYPE,
   _MOVED_,
   BREAKOUTS,
-  CORRELATION_ID,
   EVENT_TRIGGERS,
   LOCUS,
   LOCUSEVENT,
@@ -18,6 +17,7 @@ import LoggerProxy from '../common/logs/logger-proxy';
 import Trigger from '../common/events/trigger-proxy';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import Metrics from '../metrics';
+import {MEETING_KEY} from './meetings.types';
 
 /**
  * Meetings Media Codec Missing Event
@@ -39,14 +39,15 @@ import Metrics from '../metrics';
 
 const MeetingsUtil: any = {};
 
-MeetingsUtil.getMeetingAddedType = (type) => (type === _LOCUS_ID_ ? _INCOMING_ : _CREATED_);
+MeetingsUtil.getMeetingAddedType = (type: DESTINATION_TYPE) =>
+  type === DESTINATION_TYPE.LOCUS_ID ? _INCOMING_ : _CREATED_;
 
 MeetingsUtil.handleRoapMercury = (envelope, meetingCollection) => {
   const {data} = envelope;
   const {eventType} = data;
 
   if (eventType === LOCUSEVENT.MESSAGE_ROAP) {
-    const meeting = meetingCollection.getByKey(CORRELATION_ID, data.correlationId);
+    const meeting = meetingCollection.getByKey(MEETING_KEY.CORRELATION_ID, data.correlationId);
 
     if (meeting) {
       const {seq, messageType, tieBreaker, errorType, errorCause} = data.message;

package/src/metrics/constants.ts

@@ -69,6 +69,7 @@ const BEHAVIORAL_METRICS = {
   ROAP_OFFER_TO_ANSWER_LATENCY: 'js_sdk_roap_offer_to_answer_latency',
   ROAP_HTTP_RESPONSE_MISSING: 'js_sdk_roap_http_response_missing',
   TURN_DISCOVERY_REQUIRES_OK: 'js_sdk_turn_discovery_requires_ok',
+  REACHABILITY_COMPLETED: 'js_sdk_reachability_completed',
 };
 
 export {BEHAVIORAL_METRICS as default};

package/src/metrics/index.ts

@@ -65,6 +65,50 @@ class Metrics {
       tags: metricTags,
     });
   }
+
+  /**
+   * Flattens an object into one that has no nested properties. Each level of nesting is represented
+   * by "_" in the flattened object property names.
+   * This function is needed, because Amplitude doesn't allow passing nested objects as metricFields.
+   * Use this function for metricFields before calling sendBehavioralMetric() if you want to send
+   * nested objects in your metrics.
+   *
+   * If the function is called with a literal, it returns an object with a single property "value"
+   * and the literal value in it.
+   *
+   * @param {any} payload object you want to flatten
+   * @param {string} prefix string prefix prepended to any property names in flatten object
+   * @returns {Object}
+   */
+  prepareMetricFields(payload: any = {}, prefix = '') {
+    let output = {};
+
+    if (Array.isArray(payload)) {
+      payload.forEach((item, index) => {
+        const propName = prefix.length > 0 ? `${prefix}_${index}` : `${index}`;
+
+        output = {...output, ...this.prepareMetricFields(item, propName)};
+      });
+
+      return output;
+    }
+
+    if (typeof payload !== 'object' || payload === null) {
+      if (prefix.length > 0) {
+        return {[prefix]: payload};
+      }
+
+      return {value: payload};
+    }
+
+    Object.entries(payload).forEach(([key, value]) => {
+      const propName = prefix.length > 0 ? `${prefix}_${key}` : key;
+
+      output = {...output, ...this.prepareMetricFields(value, propName)};
+    });
+
+    return output;
+  }
 }
 
 // Export Metrics singleton ---------------------------------------------------

package/src/personal-meeting-room/index.ts

@@ -1,7 +1,7 @@
 // @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
-import {MEETINGS, _PERSONAL_ROOM_} from '../constants';
+import {MEETINGS, DESTINATION_TYPE} from '../constants';
 import ParameterError from '../common/errors/parameter';
 
 import PersonalMeetingRoomRequest from './request';
@@ -141,7 +141,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    */
   public get() {
     const options = {
-      type: _PERSONAL_ROOM_,
+      type: DESTINATION_TYPE.PERSONAL_ROOM,
     };
 
     return this.meetingInfo.fetchMeetingInfo(options).then((pmr) => {