@webex/plugin-meetings 3.0.0-beta.11 → 3.0.0-beta.111

package/src/meeting-info/index.ts

@@ -2,11 +2,7 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
-import {
-  _MEETING_LINK_,
-  _SIP_URI_,
-  _PERSONAL_ROOM_
-} from '../constants';
+import {_MEETING_LINK_, _SIP_URI_, _PERSONAL_ROOM_} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 
 import MeetingInfoCollection from './collection';
@@ -34,7 +30,7 @@ export default class MeetingInfo {
      * @type {Object}
      * @private
      * @memberof MeetingInfo
-    */
+     */
     this.meetingInfoRequest = new MeetingInfoRequest(this.webex);
     /**
      * The meeting information collection interface
@@ -42,7 +38,7 @@ export default class MeetingInfo {
      * @type {Object}
      * @private
      * @memberof MeetingInfo
-    */
+     */
     this.meetingInfoCollection = new MeetingInfoCollection();
   }
 
@@ -75,17 +71,22 @@ export default class MeetingInfo {
    * @memberof MeetingInfo
    */
   private requestFetchInfo(options: object) {
-    return this.meetingInfoRequest.fetchMeetingInfo(options).then((info) => {
-      if (info && info.body) {
-        this.setMeetingInfo(info.body.sipMeetingUri || info.body.meetingLink, info.body);
-      }
+    return this.meetingInfoRequest
+      .fetchMeetingInfo(options)
+      .then((info) => {
+        if (info && info.body) {
+          this.setMeetingInfo(info.body.sipMeetingUri || info.body.meetingLink, info.body);
+        }
 
-      return info;
-    }).catch((error) => {
-      LoggerProxy.logger.error(`Meeting-info:index#requestFetchInfo -->  ${error} fetch meetingInfo`);
+        return info;
+      })
+      .catch((error) => {
+        LoggerProxy.logger.error(
+          `Meeting-info:index#requestFetchInfo -->  ${error} fetch meetingInfo`
+        );
 
-      return Promise.reject(error);
-    });
+        return Promise.reject(error);
+      });
   }
 
   /**
@@ -100,7 +101,7 @@ export default class MeetingInfo {
     return MeetingInfoUtil.generateOptions({
       destination,
       type,
-      webex: this.webex
+      webex: this.webex,
     });
   }
 
@@ -117,19 +118,20 @@ export default class MeetingInfo {
       destination = this.webex.internal.device.userId;
     }
 
-    return this.fetchInfoOptions(
-      MeetingInfoUtil.extractDestination(destination, type),
-      type
-    ).then((options) =>
-    // fetch meeting info
-      this.requestFetchInfo(options).catch((error) => {
-      // if it failed the first time as meeting link
-        if (options.type === _MEETING_LINK_) {
-        // convert the meeting link to sip URI and retry
-          return this.requestFetchInfo(this.fetchInfoOptions(MeetingInfoUtil.convertLinkToSip(destination), _SIP_URI_));
-        }
+    return this.fetchInfoOptions(MeetingInfoUtil.extractDestination(destination, type), type).then(
+      (options) =>
+        // fetch meeting info
+        this.requestFetchInfo(options).catch((error) => {
+          // if it failed the first time as meeting link
+          if (options.type === _MEETING_LINK_) {
+            // convert the meeting link to sip URI and retry
+            return this.requestFetchInfo(
+              this.fetchInfoOptions(MeetingInfoUtil.convertLinkToSip(destination), _SIP_URI_)
+            );
+          }
 
-        return Promise.reject(error);
-      }));
+          return Promise.reject(error);
+        })
+    );
   }
 }

package/src/meeting-info/meeting-info-v2.ts

@@ -1,13 +1,24 @@
-import { HTTP_VERBS, _CONVERSATION_URL_, WBXAPPAPI_SERVICE } from '../constants';
+import lodash from 'lodash';
+import {
+  HTTP_VERBS,
+  _CONVERSATION_URL_,
+  WBXAPPAPI_SERVICE,
+  DEFAULT_MEETING_INFO_REQUEST_BODY,
+} from '../constants';
 import Metrics from '../metrics';
+import {eventType} from '../metrics/config';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 
 import MeetingInfoUtil from './utilv2';
 
-const PASSWORD_ERROR_DEFAULT_MESSAGE = 'Password required. Call fetchMeetingInfo() with password argument';
-const CAPTCHA_ERROR_DEFAULT_MESSAGE = 'Captcha required. Call fetchMeetingInfo() with captchaInfo argument';
-const ADHOC_MEETING_DEFAULT_ERROR = 'Failed starting the adhoc meeting, Please contact support team ';
+const PASSWORD_ERROR_DEFAULT_MESSAGE =
+  'Password required. Call fetchMeetingInfo() with password argument';
+const CAPTCHA_ERROR_DEFAULT_MESSAGE =
+  'Captcha required. Call fetchMeetingInfo() with captchaInfo argument';
+const ADHOC_MEETING_DEFAULT_ERROR =
+  'Failed starting the adhoc meeting, Please contact support team ';
 const CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES = [423005, 423006];
+const POLICY_ERROR_CODES = [403049, 403104, 403103, 403048, 403102, 403101];
 
 /**
  * Error to indicate that wbxappapi requires a password
@@ -16,19 +27,24 @@ export class MeetingInfoV2PasswordError extends Error {
   meetingInfo: any;
   sdkMessage: any;
   wbxAppApiCode: any;
+  body: any;
 
   /**
-    *
-    * @constructor
-    * @param {Number} [wbxAppApiErrorCode]
-    * @param {Object} [meetingInfo]
-    * @param {String} [message]
-    */
-  constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message: string = PASSWORD_ERROR_DEFAULT_MESSAGE) {
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [meetingInfo]
+   * @param {String} [message]
+   */
+  constructor(
+    wbxAppApiErrorCode?: number,
+    meetingInfo?: object,
+    message: string = PASSWORD_ERROR_DEFAULT_MESSAGE
+  ) {
     super(`${message}, code=${wbxAppApiErrorCode}`);
     this.name = 'MeetingInfoV2PasswordError';
     this.sdkMessage = message;
-    this.stack = (new Error()).stack;
+    this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
     this.meetingInfo = meetingInfo;
   }
@@ -41,40 +57,69 @@ export class MeetingInfoV2AdhocMeetingError extends Error {
   sdkMessage: any;
   wbxAppApiCode: any;
   /**
-    *
-    * @constructor
-    * @param {Number} [wbxAppApiErrorCode]
-    * @param {String} [message]
-    */
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {String} [message]
+   */
   constructor(wbxAppApiErrorCode?: number, message: string = ADHOC_MEETING_DEFAULT_ERROR) {
     super(`${message}, code=${wbxAppApiErrorCode}`);
     this.name = 'MeetingInfoV2AdhocMeetingError';
     this.sdkMessage = message;
-    this.stack = (new Error()).stack;
+    this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
   }
 }
 
 /**
-   * Error to indicate that preferred webex site not present to start adhoc meeting
+ * Error preventing join because of a meeting policy
+ */
+export class MeetingInfoV2PolicyError extends Error {
+  meetingInfo: object;
+  sdkMessage: string;
+  wbxAppApiCode: number;
+  /**
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [meetingInfo]
+   * @param {String} [message]
    */
+  constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string) {
+    super(`${message}, code=${wbxAppApiErrorCode}`);
+    this.name = 'MeetingInfoV2AdhocMeetingError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+    this.meetingInfo = meetingInfo;
+  }
+}
+
+/**
+ * Error to indicate that preferred webex site not present to start adhoc meeting
+ */
 export class MeetingInfoV2CaptchaError extends Error {
   captchaInfo: any;
   isPasswordRequired: any;
   sdkMessage: any;
   wbxAppApiCode: any;
+  body: any;
   /**
-    *
-    * @constructor
-    * @param {Number} [wbxAppApiErrorCode]
-    * @param {Object} [captchaInfo]
-    * @param {String} [message]
-    */
-  constructor(wbxAppApiErrorCode?: number, captchaInfo?: object, message: string = CAPTCHA_ERROR_DEFAULT_MESSAGE) {
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [captchaInfo]
+   * @param {String} [message]
+   */
+  constructor(
+    wbxAppApiErrorCode?: number,
+    captchaInfo?: object,
+    message: string = CAPTCHA_ERROR_DEFAULT_MESSAGE
+  ) {
     super(`${message}, code=${wbxAppApiErrorCode}`);
     this.name = 'MeetingInfoV2PasswordError';
     this.sdkMessage = message;
-    this.stack = (new Error()).stack;
+    this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
     this.isPasswordRequired = CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES.includes(wbxAppApiErrorCode);
     this.captchaInfo = captchaInfo;
@@ -82,42 +127,42 @@ export class MeetingInfoV2CaptchaError extends Error {
 }
 
 /**
-   * @class MeetingInfo
-   */
+ * @class MeetingInfo
+ */
 export default class MeetingInfoV2 {
   webex: any;
 
   /**
-     *
-     * @param {WebexSDK} webex
-     */
+   *
+   * @param {WebexSDK} webex
+   */
   constructor(webex) {
     this.webex = webex;
   }
 
   /**
-     * converts hydra id into conversation url and persons Id
-     * @param {String} destination one of many different types of destinations to look up info for
-     * @param {String} [type] to match up with the destination value
-     * @returns {Promise} destination and type
-     * @public
-     * @memberof MeetingInfo
-     */
+   * converts hydra id into conversation url and persons Id
+   * @param {String} destination one of many different types of destinations to look up info for
+   * @param {String} [type] to match up with the destination value
+   * @returns {Promise} destination and type
+   * @public
+   * @memberof MeetingInfo
+   */
   fetchInfoOptions(destination: string, type: string = null) {
     return MeetingInfoUtil.getDestinationType({
       destination,
       type,
-      webex: this.webex
+      webex: this.webex,
     });
   }
 
   /**
-     * Creates adhoc space meetings for a space by fetching the conversation infomation
-     * @param {String} conversationUrl conversationUrl to start adhoc meeting on
-     * @returns {Promise} returns a meeting info object
-     * @public
-     * @memberof MeetingInfo
-     */
+   * Creates adhoc space meetings for a space by fetching the conversation infomation
+   * @param {String} conversationUrl conversationUrl to start adhoc meeting on
+   * @returns {Promise} returns a meeting info object
+   * @public
+   * @memberof MeetingInfo
+   */
   async createAdhocSpaceMeeting(conversationUrl: string) {
     if (!this.webex.meetings.preferredWebexSite) {
       throw Error('No preferred webex site found');
@@ -129,7 +174,7 @@ export default class MeetingInfoV2 {
         particpants.forEach((participant) => {
           invitees.push({
             email: participant.emailAddress,
-            ciUserUuid: participant.entryUUID
+            ciUserUuid: participant.entryUUID,
           });
         });
       }
@@ -137,56 +182,54 @@ export default class MeetingInfoV2 {
       return invitees;
     };
 
-    return this.webex.internal.conversation.get(
-      {url: conversationUrl},
-      {includeParticipants: true, disableTransform: true}
-    )
+    return this.webex.internal.conversation
+      .get({url: conversationUrl}, {includeParticipants: true, disableTransform: true})
       .then((conversation) => {
         const body = {
           title: conversation.displayName,
           spaceUrl: conversation.url,
           keyUrl: conversation.encryptionKeyUrl,
           kroUrl: conversation.kmsResourceObjectUrl,
-          invitees: getInvitees(conversation.participants?.items)
+          invitees: getInvitees(conversation.participants?.items),
         };
 
-        const uri = this.webex.meetings.preferredWebexSite ?
-          `https://${this.webex.meetings.preferredWebexSite}/wbxappapi/v2/meetings/spaceInstant` : '';
+        const uri = this.webex.meetings.preferredWebexSite
+          ? `https://${this.webex.meetings.preferredWebexSite}/wbxappapi/v2/meetings/spaceInstant`
+          : '';
 
-        Metrics.sendBehavioralMetric(
-          BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS
-        );
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
 
         return this.webex.request({
           method: HTTP_VERBS.POST,
           uri,
-          body
+          body,
         });
       })
       .catch((err) => {
-        Metrics.sendBehavioralMetric(
-          BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE,
-          {
-            reason: err.message,
-            stack: err.stack
-          }
-        );
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE, {
+          reason: err.message,
+          stack: err.stack,
+        });
         throw new MeetingInfoV2AdhocMeetingError(err.body?.code, err.body?.message);
       });
   }
 
   /**
-     * Fetches meeting info from the server
-     * @param {String} destination one of many different types of destinations to look up info for
-     * @param {String} [type] to match up with the destination value
-     * @param {String} password
-     * @param {Object} captchaInfo
-     * @param {String} captchaInfo.code
-     * @param {String} captchaInfo.id
-     * @returns {Promise} returns a meeting info object
-     * @public
-     * @memberof MeetingInfo
-     */
+   * Fetches meeting info from the server
+   * @param {String} destination one of many different types of destinations to look up info for
+   * @param {String} [type] to match up with the destination value
+   * @param {String} password
+   * @param {Object} captchaInfo
+   * @param {String} captchaInfo.code
+   * @param {String} captchaInfo.id
+   * @param {String} installedOrgID
+   * @param {String} locusId
+   * @param {Object} extraParams
+   * @param {Object} options
+   * @returns {Promise} returns a meeting info object
+   * @public
+   * @memberof MeetingInfo
+   */
   async fetchMeetingInfo(
     destination: string,
     type: string = null,
@@ -194,79 +237,124 @@ export default class MeetingInfoV2 {
     captchaInfo: {
       code: string;
       id: string;
-    } = null
+    } = null,
+    installedOrgID = null,
+    locusId = null,
+    extraParams: object = {},
+    options: {meetingId?: string} = {}
   ) {
+    const {meetingId} = options;
+
     const destinationType = await MeetingInfoUtil.getDestinationType({
       destination,
       type,
-      webex: this.webex
+      webex: this.webex,
     });
 
-    if (destinationType.type === _CONVERSATION_URL_ && this.webex.config.meetings.experimental.enableAdhocMeetings && this.webex.meetings.preferredWebexSite) {
+    if (
+      destinationType.type === _CONVERSATION_URL_ &&
+      this.webex.config.meetings.experimental.enableAdhocMeetings &&
+      this.webex.meetings.preferredWebexSite
+    ) {
       return this.createAdhocSpaceMeeting(destinationType.destination);
     }
 
-    const body = await MeetingInfoUtil.getRequestBody({...destinationType, password, captchaInfo});
+    const body = await MeetingInfoUtil.getRequestBody({
+      ...destinationType,
+      password,
+      captchaInfo,
+      installedOrgID,
+      locusId,
+      extraParams,
+    });
+
+    // If the body only contains the default properties, we don't have enough to
+    // fetch the meeting info so don't bother trying.
+    if (
+      !lodash.difference(Object.keys(body), Object.keys(DEFAULT_MEETING_INFO_REQUEST_BODY)).length
+    ) {
+      const err = new Error('Not enough information to fetch meeting info');
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_FAILURE, {
+        reason: err.message,
+        destinationType: destinationType?.type,
+        webExMeetingId: destinationType?.info?.webExMeetingId,
+        sipUri: destinationType?.info?.sipUri,
+      });
+
+      throw err;
+    }
 
-    const options: any = {
+    const requestOptions: any = {
       method: HTTP_VERBS.POST,
-      body
+      body,
     };
 
     const directURI = await MeetingInfoUtil.getDirectMeetingInfoURI(destinationType);
 
     if (directURI) {
-      options.uri = directURI;
-    }
-    else {
-      options.service = WBXAPPAPI_SERVICE;
-      options.resource = 'meetingInfo';
+      requestOptions.uri = directURI;
+    } else {
+      requestOptions.service = WBXAPPAPI_SERVICE;
+      requestOptions.resource = 'meetingInfo';
     }
 
-    return this.webex.request(options)
+    return this.webex
+      .request(requestOptions)
       .then((response) => {
-        Metrics.sendBehavioralMetric(
-          BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_SUCCESS
-        );
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_SUCCESS);
 
         return response;
       })
       .catch((err) => {
+        if (meetingId) {
+          Metrics.postEvent({
+            event: eventType.MEETING_INFO_RESPONSE,
+            meetingId,
+            data: {
+              errors: [Metrics.parseWebexApiError(err, true)],
+              meetingLookupUrl: err?.url,
+            },
+          });
+        }
+
         if (err?.statusCode === 403) {
-          Metrics.sendBehavioralMetric(
-            BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR,
-            {
-              reason: err.message,
-              stack: err.stack
-            }
-          );
+          if (POLICY_ERROR_CODES.includes(err.body?.code)) {
+            Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.MEETING_INFO_POLICY_ERROR, {
+              code: err.body?.code,
+            });
+
+            throw new MeetingInfoV2PolicyError(
+              err.body?.code,
+              err.body?.data?.meetingInfo,
+              err.body?.message
+            );
+          }
+
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR, {
+            reason: err.message,
+            stack: err.stack,
+          });
 
           throw new MeetingInfoV2PasswordError(err.body?.code, err.body?.data?.meetingInfo);
         }
         if (err?.statusCode === 423) {
-          Metrics.sendBehavioralMetric(
-            BEHAVIORAL_METRICS.VERIFY_CAPTCHA_ERROR,
-            {
-              reason: err.message,
-              stack: err.stack
-            }
-          );
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_CAPTCHA_ERROR, {
+            reason: err.message,
+            stack: err.stack,
+          });
 
           throw new MeetingInfoV2CaptchaError(err.body?.code, {
             captchaId: err.body.captchaID,
             verificationImageURL: err.body.verificationImageURL,
             verificationAudioURL: err.body.verificationAudioURL,
-            refreshURL: err.body.refreshURL
+            refreshURL: err.body.refreshURL,
           });
         }
 
-        Metrics.sendBehavioralMetric(
-          BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_FAILURE,
-          {
-            reason: err.message,
-            stack: err.stack
-          }
-        );
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_FAILURE, {
+          reason: err.message,
+          stack: err.stack,
+        });
         throw err;
       });
   }

package/src/meeting-info/request.ts

@@ -3,7 +3,6 @@ import ParameterError from '../common/errors/parameter';
 
 import MeetingInfoUtil from './util';
 
-
 /**
  * @class MeetingInfoRequest
  */
@@ -30,10 +29,17 @@ export default class MeetingInfoRequest {
    */
   fetchMeetingInfo(options: any) {
     if (!options || !options.type || !options.destination) {
-      throw new ParameterError('MeetingInfo should be fetched with a type and destination specified, see list of valid types and their corresponding values in constants');
+      throw new ParameterError(
+        'MeetingInfo should be fetched with a type and destination specified, see list of valid types and their corresponding values in constants'
+      );
     }
     const resourceUrl = MeetingInfoUtil.getResourceUrl(options.type, options.destination);
-    const requestParams = MeetingInfoUtil.getRequestParams(resourceUrl, options.type, options.destination, API.LOCUS);
+    const requestParams = MeetingInfoUtil.getRequestParams(
+      resourceUrl,
+      options.type,
+      options.destination,
+      API.LOCUS
+    );
 
     return this.webex.request(requestParams);
   }