@webex/plugin-meetings 1.158.0 → 1.159.2

package/src/meetings/index.js

@@ -3,6 +3,7 @@
 */
 
 import '@webex/internal-plugin-mercury';
+import '@webex/internal-plugin-conversation';
 import {WebexPlugin} from '@webex/webex-core';
 
 import 'webrtc-adapter';
@@ -163,6 +164,15 @@ export default class Meetings extends WebexPlugin {
        */
       this.registered = false;
 
+      /**
+       * This values indicates the preferred webex site the user will start there meeting, getsits value from {@link Meetings#register}
+       * @instance
+       * @type {String}
+       * @private
+       * @memberof Meetings
+       */
+      this.preferredWebexSite = '';
+
       /**
        * The public interface for the internal Media util files. These are helpful to expose outside the context
        * of a meeting so that a user can access media without creating a meeting instance.
@@ -407,6 +417,22 @@ export default class Meetings extends WebexPlugin {
       }
     }
 
+    /**
+     * API to toggle starting adhoc meeting
+     * @param {Boolean} changeState
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
+    */
+    _toggleAdhocMeetings(changeState) {
+      if (typeof changeState !== 'boolean') {
+        return;
+      }
+      if (this.config?.experimental?.enableAdhocMeetings !== changeState) {
+        this.config.experimental.enableAdhocMeetings = changeState;
+      }
+    }
+
     /**
      * Explicitly sets up the meetings plugin by registering
      * the device, connecting to mercury, and listening for locus events.
@@ -430,6 +456,7 @@ export default class Meetings extends WebexPlugin {
       }
 
       return Promise.all([
+        this.fetchUserPreferredWebexSite(),
         this.getGeoHint(),
         this.startReachability().catch((error) => {
           LoggerProxy.logger.error(`Meetings:index#register --> GDM error, ${error.message}`);
@@ -604,12 +631,29 @@ export default class Meetings extends WebexPlugin {
       });
     }
 
+    /**
+     * Fetch user preferred webex site information
+     * This also has other infomation about the user
+     * @returns {Promise}
+     * @private
+     * @memberof Meetings
+     */
+    fetchUserPreferredWebexSite() {
+      return this.request.fetchLoginUserInformation().then((res) => {
+        if (res && res.userPreferences) {
+          this.preferredWebexSite = MeetingsUtil.parseUserPreferences(res?.userPreferences);
+        }
+      });
+    }
+
+
     /**
      * gets the personal meeting room instance, for saved PMR values for this user
      * @returns {PersonalMeetingRoom}
      * @public
      * @memberof Meetings
      */
+
     getPersonalMeetingRoom() {
       return this.personalMeetingRoom;
     }
@@ -740,7 +784,9 @@ export default class Meetings extends WebexPlugin {
           orgId: this.webex.internal.device.orgId,
           roapSeq: 0,
           locus: type === _LOCUS_ID_ ? destination : null, // pass the locus object if present
-          meetingInfoProvider: this.meetingInfo
+          meetingInfoProvider: this.meetingInfo,
+          destination,
+          destinationType: type,
         },
         {
           parent: this.webex
@@ -750,7 +796,7 @@ export default class Meetings extends WebexPlugin {
       this.meetingCollection.set(meeting);
 
       try {
-        await meeting.fetchMeetingInfo({destination, type});
+        await meeting.fetchMeetingInfo({});
       }
       catch (err) {
         if (!(err instanceof CaptchaError) && !(err instanceof PasswordError)) {
@@ -759,8 +805,6 @@ export default class Meetings extends WebexPlugin {
           LoggerProxy.logger.info('Meetings:index#createMeeting --> Info assuming this destination is a 1:1 or wireless share');
         }
         LoggerProxy.logger.debug(`Meetings:index#createMeeting --> Debug ${err} fetching /meetingInfo for creation.`);
-        // We need to save this info for future reference
-        meeting.destination = destination;
       }
       finally {
         // For type LOCUS_ID we need to parse the locus object to get the information

package/src/meetings/request.js

@@ -12,9 +12,9 @@ import {
  */
 export default class MeetingRequest extends StatelessWebexPlugin {
   /**
-     *  get all the active meetings for the user
-     * @returns {Array} return locus array
-    */
+   *  get all the active meetings for the user
+   * @returns {Array} return locus array
+  */
   getActiveMeetings() {
     return this.request({
       api: API.LOCUS,
@@ -27,13 +27,22 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   }
 
   /**
-     *  fetch geoHit for the user
-     * @returns {Promise<object>} geoHintInfo
-    */
+   *  fetch geoHit for the user
+   * @returns {Promise<object>} geoHintInfo
+   */
   fetchGeoHint() {
     return this.webex.internal.services.fetchClientRegionInfo();
   }
 
+  /**
+   *  fetch login user information
+   * @returns {Promise<object>} loginUserInformation
+  */
+  fetchLoginUserInformation() {
+    return this.webex.internal.services.fetchLoginUserInformation();
+  }
+
+
   // locus federation, determines and populate locus if the responseBody has remote URLs to fetch locus details
 
   /**

package/src/meetings/util.js

@@ -64,6 +64,25 @@ MeetingsUtil.checkForCorrelationId = (deviceUrl, locus) => {
   return false;
 };
 
+MeetingsUtil.parseUserPreferences = (userPreferences) => {
+  let webexSite = null;
+
+  userPreferences.find((item) => {
+    // eslint-disable-next-line no-useless-escape
+    const regex = /"preferredWebExSite\":\"(\S+)\"/;
+    const preferredSite = item.match(regex);
+
+    if (preferredSite) {
+      webexSite = preferredSite[1];
+
+      return true;
+    }
+
+    return false;
+  });
+
+  return webexSite;
+};
 
 /**
  * Will check to see if the H.264 media codec is supported.

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

@@ -36,7 +36,8 @@ import {
   PASSWORD_STATUS,
   EVENTS,
   EVENT_TRIGGERS,
-  _SIP_URI_
+  _SIP_URI_,
+  _MEETING_ID_,
 } from '@webex/plugin-meetings/src/constants';
 import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
 
@@ -126,6 +127,7 @@ describe('plugin-meetings', () => {
   let test2;
   let test3;
   let test4;
+  let testDestination;
 
   beforeEach(() => {
     webex = new MockWebex({
@@ -175,13 +177,16 @@ describe('plugin-meetings', () => {
     test2 = `test2-${uuid.v4()}`;
     test3 = `test3-${uuid.v4()}`;
     test4 = `test4-${uuid.v4()}`;
+    testDestination = `testDestination-${uuid.v4()}`;
 
     meeting = new Meeting(
       {
         userId: uuid1,
         resource: uuid2,
         deviceUrl: uuid3,
-        locus: {url: url1}
+        locus: {url: url1},
+        destination: testDestination,
+        destinationType: _MEETING_ID_,
       },
       {
         parent: webex
@@ -227,6 +232,8 @@ describe('plugin-meetings', () => {
           assert.equal(meeting.passwordStatus, PASSWORD_STATUS.UNKNOWN);
           assert.equal(meeting.requiredCaptcha, null);
           assert.equal(meeting.meetingInfoFailureReason, undefined);
+          assert.equal(meeting.destination, testDestination);
+          assert.equal(meeting.destinationType, _MEETING_ID_);
         });
       });
       describe('#invite', () => {
@@ -2141,8 +2148,11 @@ describe('plugin-meetings', () => {
         it('calls meetingInfoProvider with all the right parameters and parses the result', async () => {
           meeting.attrs.meetingInfoProvider = {fetchMeetingInfo: sinon.stub().resolves({body: FAKE_MEETING_INFO})};
           meeting.requiredCaptcha = FAKE_SDK_CAPTCHA_INFO;
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
+
           await meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, password: FAKE_PASSWORD, captchaCode: FAKE_CAPTCHA_CODE
+            password: FAKE_PASSWORD, captchaCode: FAKE_CAPTCHA_CODE
           });
 
           assert.calledWith(meeting.attrs.meetingInfoProvider.fetchMeetingInfo, FAKE_DESTINATION, FAKE_TYPE, FAKE_PASSWORD, {code: FAKE_CAPTCHA_CODE, id: FAKE_CAPTCHA_ID});
@@ -2156,9 +2166,11 @@ describe('plugin-meetings', () => {
         it('fails if captchaCode is provided when captcha not needed', async () => {
           meeting.attrs.meetingInfoProvider = {fetchMeetingInfo: sinon.stub().resolves({body: FAKE_MEETING_INFO})};
           meeting.requiredCaptcha = null;
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
 
           await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, captchaCode: FAKE_CAPTCHA_CODE
+            captchaCode: FAKE_CAPTCHA_CODE
           }), Error, 'fetchMeetingInfo() called with captchaCode when captcha was not required');
 
           assert.notCalled(meeting.attrs.meetingInfoProvider.fetchMeetingInfo);
@@ -2167,22 +2179,24 @@ describe('plugin-meetings', () => {
         it('fails if password is provided when not required', async () => {
           meeting.attrs.meetingInfoProvider = {fetchMeetingInfo: sinon.stub().resolves({body: FAKE_MEETING_INFO})};
           meeting.passwordStatus = PASSWORD_STATUS.NOT_REQUIRED;
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
 
           await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, password: FAKE_PASSWORD
+            password: FAKE_PASSWORD
           }), Error, 'fetchMeetingInfo() called with password when password was not required');
 
           assert.notCalled(meeting.attrs.meetingInfoProvider.fetchMeetingInfo);
         });
 
         it('handles meetingInfoProvider requiring password', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
           meeting.attrs.meetingInfoProvider = {
             fetchMeetingInfo: sinon.stub().throws(new MeetingInfoV2PasswordError(403004, FAKE_MEETING_INFO))
           };
 
-          await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE
-          }), PasswordError);
+          await assert.isRejected(meeting.fetchMeetingInfo({}), PasswordError);
 
           assert.calledWith(meeting.attrs.meetingInfoProvider.fetchMeetingInfo, FAKE_DESTINATION, FAKE_TYPE, null, null);
 
@@ -2193,13 +2207,15 @@ describe('plugin-meetings', () => {
         });
 
         it('handles meetingInfoProvider requiring captcha because of wrong password', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
           meeting.attrs.meetingInfoProvider = {
             fetchMeetingInfo: sinon.stub().throws(new MeetingInfoV2CaptchaError(423005, FAKE_SDK_CAPTCHA_INFO))
           };
           meeting.requiredCaptcha = null;
 
           await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, password: 'aaa'
+            password: 'aaa'
           }), CaptchaError);
 
           assert.calledWith(meeting.attrs.meetingInfoProvider.fetchMeetingInfo, FAKE_DESTINATION, FAKE_TYPE, 'aaa', null);
@@ -2216,13 +2232,15 @@ describe('plugin-meetings', () => {
         });
 
         it('handles meetingInfoProvider requiring captcha because of wrong captcha', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
           meeting.attrs.meetingInfoProvider = {
             fetchMeetingInfo: sinon.stub().throws(new MeetingInfoV2CaptchaError(423005, FAKE_SDK_CAPTCHA_INFO))
           };
           meeting.requiredCaptcha = FAKE_SDK_CAPTCHA_INFO;
 
           await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, password: 'aaa', captchaCode: 'bbb'
+            password: 'aaa', captchaCode: 'bbb'
           }), CaptchaError);
 
           assert.calledWith(meeting.attrs.meetingInfoProvider.fetchMeetingInfo, FAKE_DESTINATION, FAKE_TYPE, 'aaa', {code: 'bbb', id: FAKE_CAPTCHA_ID});
@@ -2234,6 +2252,8 @@ describe('plugin-meetings', () => {
         });
 
         it('handles successful response when good password is passed', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
           meeting.attrs.meetingInfoProvider = {
             fetchMeetingInfo: sinon.stub().resolves(
               {
@@ -2245,7 +2265,7 @@ describe('plugin-meetings', () => {
           meeting.passwordStatus = PASSWORD_STATUS.REQUIRED;
 
           await meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, password: 'aaa'
+            password: 'aaa'
           });
 
           assert.calledWith(meeting.attrs.meetingInfoProvider.fetchMeetingInfo, FAKE_DESTINATION, FAKE_TYPE, 'aaa', null);
@@ -2257,6 +2277,8 @@ describe('plugin-meetings', () => {
         });
 
         it('refreshes captcha when captcha was required and we received 403 error code', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
           const refreshedCaptcha = {
             captchaID: FAKE_WBXAPPAPI_CAPTCHA_INFO.captchaID,
             verificationImageURL: FAKE_WBXAPPAPI_CAPTCHA_INFO.verificationImageURL,
@@ -2273,9 +2295,11 @@ describe('plugin-meetings', () => {
           ));
           meeting.passwordStatus = PASSWORD_STATUS.REQUIRED;
           meeting.requiredCaptcha = FAKE_SDK_CAPTCHA_INFO;
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
 
           await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: FAKE_DESTINATION, type: FAKE_TYPE, password: 'aaa', captchaCode: 'bbb'
+            password: 'aaa', captchaCode: 'bbb'
           }));
 
           assert.calledWith(meeting.attrs.meetingInfoProvider.fetchMeetingInfo, FAKE_DESTINATION, FAKE_TYPE, 'aaa', {code: 'bbb', id: FAKE_CAPTCHA_ID});
@@ -2319,7 +2343,7 @@ describe('plugin-meetings', () => {
           };
 
           await assert.isRejected(meeting.fetchMeetingInfo({
-            destination: 'something@somecompany.com', type: _SIP_URI_, password: ''
+            password: ''
           }), CaptchaError);
 
           assert.deepEqual(meeting.requiredCaptcha, FAKE_SDK_CAPTCHA_INFO);
@@ -2352,6 +2376,10 @@ describe('plugin-meetings', () => {
           assert.equal(result.isPasswordValid, true);
           assert.equal(result.requiredCaptcha, null);
           assert.equal(result.failureReason, MEETING_INFO_FAILURE_REASON.NONE);
+          assert.calledWith(meeting.fetchMeetingInfo, {
+            password: 'password',
+            captchaCode: 'captcha id',
+          });
         });
         it('handles PasswordError returned by fetchMeetingInfo', async () => {
           meeting.fetchMeetingInfo = sinon.stub().callsFake(() => {

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

@@ -10,12 +10,34 @@ import Mercury from '@webex/internal-plugin-mercury';
 import Meetings from '@webex/plugin-meetings/src/meetings';
 import {
   _MEETING_ID_,
-  _PERSONAL_ROOM_
+  _PERSONAL_ROOM_,
+  _CONVERSATION_URL_
 } from '@webex/plugin-meetings/src/constants';
-import MeetingInfo, {MeetingInfoV2PasswordError, MeetingInfoV2CaptchaError} from '@webex/plugin-meetings/src/meeting-info/meeting-info-v2';
+import MeetingInfo, {MeetingInfoV2PasswordError, MeetingInfoV2CaptchaError, MeetingInfoV2AdhocMeetingError} from '@webex/plugin-meetings/src/meeting-info/meeting-info-v2';
 import MeetingInfoUtil from '@webex/plugin-meetings/src/meeting-info/utilv2';
 
 describe('plugin-meetings', () => {
+  const conversation = {
+    displayName: 'displayName',
+    url: 'conversationUrl',
+    encryptionKeyUrl: 'encryptionKeyUrl',
+    kmsResourceObjectUrl: 'kmsResourceObjectUrl',
+    participants: {
+      items: [
+        {
+          id: '344ea183-9d5d-4e77-aed',
+          emailAddress: 'testUser1@cisco.com',
+          entryUUID: '344ea183-9d5d-4e77-'
+
+        },
+        {
+          id: '40b446fe-175c-4628-8a9d',
+          emailAddress: 'testUser2@cisco.com',
+          entryUUID: '40b446fe-175c-4628'
+        }
+      ]
+    }
+  };
   let webex;
   let meetingInfo = null;
 
@@ -29,6 +51,9 @@ describe('plugin-meetings', () => {
         }
       });
 
+      webex.meetings.preferredWebexSite = 'go.webex.com';
+      webex.config.meetings = {experimental: {enableUnifiedMeetings: true, enableAdhocMeetings: true}};
+
       Object.assign(webex.internal, {
         device: {
           deviceType: 'FAKE_DEVICE',
@@ -41,6 +66,9 @@ describe('plugin-meetings', () => {
           disconnect: sinon.stub().returns(Promise.resolve()),
           on: () => {},
           off: () => {}
+        },
+        conversation: {
+          get: sinon.stub().returns(Promise.resolve(conversation))
         }
       });
 
@@ -98,6 +126,40 @@ describe('plugin-meetings', () => {
         });
       });
 
+      it('create adhoc meeting when conversationUrl passed with enableAdhocMeetings toggle', async () => {
+        sinon.stub(meetingInfo, 'createAdhocSpaceMeeting').returns(Promise.resolve());
+        await meetingInfo.fetchMeetingInfo('conversationUrl', _CONVERSATION_URL_);
+
+        assert.calledWith(meetingInfo.createAdhocSpaceMeeting, 'conversationUrl');
+        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());
+
+        await meetingInfo.fetchMeetingInfo('conversationUrl', _CONVERSATION_URL_);
+
+        assert.notCalled(meetingInfo.createAdhocSpaceMeeting);
+        assert.called(webex.request);
+        meetingInfo.createAdhocSpaceMeeting.restore();
+      });
+
+      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, message: 'Input is invalid'}});
+        try {
+          await meetingInfo.createAdhocSpaceMeeting('conversationUrl');
+        }
+        catch (err) {
+          assert.instanceOf(err, MeetingInfoV2AdhocMeetingError);
+          assert.deepEqual(err.message, 'Input is invalid, code=400000');
+          assert.equal(err.wbxAppApiCode, 400000);
+        }
+      });
+
       it('should throw MeetingInfoV2PasswordError for 403 response', async () => {
         const FAKE_MEETING_INFO = {blablabla: 'some_fake_meeting_info'};
 
@@ -154,5 +216,40 @@ describe('plugin-meetings', () => {
         });
       });
     });
+
+
+    describe('createAdhocSpaceMeeting', () => {
+      it('Make a request to /instantSpace when conversationUrl', async () => {
+        const conversationUrl = 'https://conversationUrl/xxx';
+        const invitee = [];
+
+        invitee.push({
+          email: conversation.participants.items[0].emailAddress,
+          ciUserUuid: conversation.participants.items[0].entryUUID
+        });
+
+        invitee.push({
+          email: conversation.participants.items[1].emailAddress,
+          ciUserUuid: conversation.participants.items[1].entryUUID
+        });
+
+        await meetingInfo.createAdhocSpaceMeeting(conversationUrl);
+
+        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
+          }
+        });
+      });
+    });
   });
 });