@webex/plugin-meetings 3.0.0-beta.112 → 3.0.0-beta.114

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

@@ -156,14 +156,38 @@ export default class MeetingInfoV2 {
     });
   }
 
+  /**
+   * Raises a MeetingInfoV2PolicyError for policy error codes
+   * @param {any} err the error from the request
+   * @returns {void}
+   */
+  handlePolicyError = (err) => {
+    if (!err.body) {
+      return;
+    }
+
+    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
+      );
+    }
+  };
+
   /**
    * Creates adhoc space meetings for a space by fetching the conversation infomation
    * @param {String} conversationUrl conversationUrl to start adhoc meeting on
+   * @param {String} installedOrgID org ID of user's machine
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
    */
-  async createAdhocSpaceMeeting(conversationUrl: string) {
+  async createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: string) {
     if (!this.webex.meetings.preferredWebexSite) {
       throw Error('No preferred webex site found');
     }
@@ -185,7 +209,14 @@ export default class MeetingInfoV2 {
     return this.webex.internal.conversation
       .get({url: conversationUrl}, {includeParticipants: true, disableTransform: true})
       .then((conversation) => {
-        const body = {
+        const body: {
+          title: string;
+          spaceUrl: string;
+          keyUrl: string;
+          kroUrl: string;
+          invitees: any[];
+          installedOrgID?: string;
+        } = {
           title: conversation.displayName,
           spaceUrl: conversation.url,
           keyUrl: conversation.encryptionKeyUrl,
@@ -193,19 +224,28 @@ export default class MeetingInfoV2 {
           invitees: getInvitees(conversation.participants?.items),
         };
 
+        if (installedOrgID) {
+          body.installedOrgID = installedOrgID;
+        }
+
         const uri = this.webex.meetings.preferredWebexSite
           ? `https://${this.webex.meetings.preferredWebexSite}/wbxappapi/v2/meetings/spaceInstant`
           : '';
 
-        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
-
         return this.webex.request({
           method: HTTP_VERBS.POST,
           uri,
           body,
         });
       })
+      .then((requestResult) => {
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
+
+        return requestResult;
+      })
       .catch((err) => {
+        this.handlePolicyError(err);
+
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE, {
           reason: err.message,
           stack: err.stack,
@@ -222,7 +262,7 @@ export default class MeetingInfoV2 {
    * @param {Object} captchaInfo
    * @param {String} captchaInfo.code
    * @param {String} captchaInfo.id
-   * @param {String} installedOrgID
+   * @param {String} installedOrgID org ID of user's machine
    * @param {String} locusId
    * @param {Object} extraParams
    * @param {Object} options
@@ -256,7 +296,7 @@ export default class MeetingInfoV2 {
       this.webex.config.meetings.experimental.enableAdhocMeetings &&
       this.webex.meetings.preferredWebexSite
     ) {
-      return this.createAdhocSpaceMeeting(destinationType.destination);
+      return this.createAdhocSpaceMeeting(destinationType.destination, installedOrgID);
     }
 
     const body = await MeetingInfoUtil.getRequestBody({
@@ -318,17 +358,7 @@ export default class MeetingInfoV2 {
         }
 
         if (err?.statusCode === 403) {
-          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
-            );
-          }
+          this.handlePolicyError(err);
 
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR, {
             reason: err.message,

package/src/meeting-info/utilv2.ts

@@ -221,6 +221,7 @@ MeetingInfoUtil.getDestinationType = async (from) => {
  * 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 {String} options.installedOrgID org ID of user's machine
  * @param {Object} options.destination ?? value.value
  * @returns {Object} returns an object with {resource, method}
  */

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

@@ -226,6 +226,25 @@ describe('plugin-meetings', () => {
 
       });
 
+      it('adds deviceCapabilities and locale to request when they are provided', async () => {
+        await meetingsRequest.joinMeeting({
+          locale: 'en_UK',
+          deviceCapabilities: ['SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED']
+        });
+        const requestParams = meetingsRequest.request.getCall(0).args[0];
+
+        assert.deepEqual(requestParams.body.deviceCapabilities, ['SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED']);
+        assert.deepEqual(requestParams.body.locale, 'en_UK');
+      });
+
+      it('does not add deviceCapabilities and locale to request when they are not provided', async () => {
+        await meetingsRequest.joinMeeting({});
+        const requestParams = meetingsRequest.request.getCall(0).args[0];
+
+        assert.deepEqual(requestParams.body.deviceCapabilities, undefined);
+        assert.deepEqual(requestParams.body.locale, undefined);
+      });
+
       it('includes joinCookie correctly', async () => {
         const locusUrl = 'locusURL';
         const deviceUrl = 'deviceUrl';

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

@@ -193,6 +193,26 @@ describe('plugin-meetings', () => {
         assert.equal(parameter.breakoutsSupported, true);
       });
 
+      it('#Should call meetingRequest.joinMeeting with locale=en_UK, deviceCapabilities=["TEST"] when they are passed in as those values', async () => {
+        const meeting = {
+          meetingRequest: {
+            joinMeeting: sinon.stub().returns(Promise.resolve({body: {}, headers: {}})),
+          },
+        };
+
+        MeetingUtil.parseLocusJoin = sinon.stub();
+        await MeetingUtil.joinMeeting(meeting, {
+          locale: 'en_UK',
+          deviceCapabilities: ['TEST'],
+        });
+
+        assert.calledOnce(meeting.meetingRequest.joinMeeting);
+        const parameter = meeting.meetingRequest.joinMeeting.getCall(0).args[0];
+
+        assert.equal(parameter.locale, 'en_UK');
+        assert.deepEqual(parameter.deviceCapabilities, ['TEST']);
+      });
+
       it('#Should call meetingRequest.joinMeeting with preferTranscoding=false when multistream is enabled', async () => {
         const meeting = {
           isMultistream: true,

package/test/unit/spec/meeting-info/meetinginfov2.js

@@ -304,6 +304,29 @@ describe('plugin-meetings', () => {
         meetingInfo.createAdhocSpaceMeeting.restore();
       });
 
+      it('create adhoc meeting when conversationUrl and installedOrgID passed with enableAdhocMeetings toggle', async () => {
+        sinon.stub(meetingInfo, 'createAdhocSpaceMeeting').returns(Promise.resolve());
+
+        const installedOrgID = '12345'
+
+        await meetingInfo.fetchMeetingInfo(
+          'conversationUrl',
+          _CONVERSATION_URL_,
+          null,
+          null,
+          installedOrgID
+        );
+
+        assert.calledOnceWithExactly(
+          meetingInfo.createAdhocSpaceMeeting,
+          'conversationUrl',
+          installedOrgID
+        );
+        assert.notCalled(webex.request);
+        meetingInfo.createAdhocSpaceMeeting.restore();
+      });
+
+
       it('should not call createAdhocSpaceMeeting if enableAdhocMeetings toggle is off', async () => {
         webex.config.meetings.experimental.enableAdhocMeetings = false;
         sinon.stub(meetingInfo, 'createAdhocSpaceMeeting').returns(Promise.resolve());
@@ -329,7 +352,7 @@ describe('plugin-meetings', () => {
       it('should throw an error MeetingInfoV2AdhocMeetingError if not able to start adhoc meeting for a conversation', async () => {
         webex.config.meetings.experimental.enableAdhocMeetings = true;
 
-        webex.request = sinon.stub().rejects({statusCode: 403, body: {code: 400000}});
+        webex.request = sinon.stub().rejects({stack: 'a stack', message: 'a message', statusCode: 403, body: {code: 400000}});
         try {
           await meetingInfo.createAdhocSpaceMeeting('conversationUrl');
         } catch (err) {
@@ -339,6 +362,12 @@ describe('plugin-meetings', () => {
             'Failed starting the adhoc meeting, Please contact support team , code=400000'
           );
           assert.equal(err.wbxAppApiCode, 400000);
+          assert(Metrics.sendBehavioralMetric.calledOnce);
+          assert.calledWith(
+            Metrics.sendBehavioralMetric,
+            BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE,
+            {reason: 'a message', stack: 'a stack'}
+          );
         }
       });
 
@@ -563,8 +592,10 @@ describe('plugin-meetings', () => {
     });
 
     describe('createAdhocSpaceMeeting', () => {
-      it('Make a request to /instantSpace when conversationUrl', async () => {
-        const conversationUrl = 'https://conversationUrl/xxx';
+      const conversationUrl = 'https://conversationUrl/xxx';
+      const installedOrgID = '12345';
+
+      const setup = () => {
         const invitee = [];
 
         invitee.push({
@@ -577,7 +608,13 @@ describe('plugin-meetings', () => {
           ciUserUuid: conversation.participants.items[1].entryUUID,
         });
 
-        await meetingInfo.createAdhocSpaceMeeting(conversationUrl);
+        return {invitee}
+      }
+
+      it('Make a request to /spaceInstant when conversationUrl', async () => {
+        const {invitee} = setup();
+
+        const result = await meetingInfo.createAdhocSpaceMeeting(conversationUrl);
 
         assert.calledWith(
           webex.internal.conversation.get,
@@ -598,7 +635,78 @@ describe('plugin-meetings', () => {
         });
         assert(Metrics.sendBehavioralMetric.calledOnce);
         assert.calledWith(Metrics.sendBehavioralMetric, BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
+        assert.deepEqual(result, {
+          body: {},
+          statusCode: 200
+        });
       });
+
+      it('Make a request to /spaceInstant when conversationUrl with installed org ID', async () => {
+        const {invitee} = setup();
+
+        await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID);
+
+        assert.calledWith(
+          webex.internal.conversation.get,
+          {url: conversationUrl},
+          {includeParticipants: true, disableTransform: true}
+        );
+
+        assert.calledWith(webex.request, {
+          method: 'POST',
+          uri: 'https://go.webex.com/wbxappapi/v2/meetings/spaceInstant',
+          body: {
+            title: conversation.displayName,
+            spaceUrl: conversation.url,
+            keyUrl: conversation.encryptionKeyUrl,
+            kroUrl: conversation.kmsResourceObjectUrl,
+            invitees: invitee,
+            installedOrgID,
+          },
+        });
+        assert(Metrics.sendBehavioralMetric.calledOnce);
+        assert.calledWith(Metrics.sendBehavioralMetric, BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
+      });
+
+
+      forEach(
+        [
+          {errorCode: 403049},
+          {errorCode: 403104},
+          {errorCode: 403103},
+          {errorCode: 403048},
+          {errorCode: 403102},
+          {errorCode: 403101},
+        ],
+        ({errorCode}) => {
+          it(`should throw a MeetingInfoV2PolicyError for error code ${errorCode}`, async () => {
+            const message = 'a message';
+            const meetingInfoData = 'meeting info';
+
+            webex.request = sinon.stub().rejects({
+              statusCode: 403,
+              body: {message, code: errorCode, data: {meetingInfo: meetingInfoData}},
+            });
+            try {
+              await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID);
+              assert.fail('createAdhocSpaceMeeting should have thrown, but has not done that');
+            } catch (err) {
+              assert.instanceOf(err, MeetingInfoV2PolicyError);
+              assert.deepEqual(err.message, `${message}, code=${errorCode}`);
+              assert.equal(err.wbxAppApiCode, errorCode);
+              assert.deepEqual(err.meetingInfo, meetingInfoData);
+
+              assert(Metrics.sendBehavioralMetric.calledOnce);
+              assert.calledWith(
+                Metrics.sendBehavioralMetric,
+                BEHAVIORAL_METRICS.MEETING_INFO_POLICY_ERROR,
+                {code: errorCode}
+              );
+
+            }
+          });
+        }
+      );
     });
   });
 });