@webex/plugin-meetings 3.9.0 → 3.10.0

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

@@ -371,6 +371,7 @@ export default class MeetingInfoV2 {
    * @param {String} conversationUrl conversationUrl to start adhoc meeting on
    * @param {String} installedOrgID org ID of user's machine
    * @param {Boolean} enableStaticMeetingLink whether or not to enable static meeting link
+   * @param {String} classificationId need it to start adhoc meeting if space support classification
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -379,7 +380,8 @@ export default class MeetingInfoV2 {
     conversationUrl: string,
     installedOrgID?: string,
     // setting this to true enables static meeting link
-    enableStaticMeetingLink = false
+    enableStaticMeetingLink = false,
+    classificationId = undefined
   ) {
     const getInvitees = (particpants = []) => {
       const invitees = [];
@@ -407,6 +409,7 @@ export default class MeetingInfoV2 {
           invitees: getInvitees(conversation.participants?.items),
           installedOrgID,
           schedule: enableStaticMeetingLink,
+          classificationId,
         };
 
         if (installedOrgID) {
@@ -429,16 +432,26 @@ export default class MeetingInfoV2 {
    * 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
+   * @param {String} classificationId if space is support classification, it needs provide it during start instant meeting
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
    */
-  async createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: string) {
+  async createAdhocSpaceMeeting(
+    conversationUrl: string,
+    installedOrgID?: string,
+    classificationId?: string
+  ) {
     if (!this.webex.meetings.preferredWebexSite) {
       throw Error('No preferred webex site found');
     }
 
-    return this.createAdhocSpaceMeetingOrEnableStaticMeetingLink(conversationUrl, installedOrgID)
+    return this.createAdhocSpaceMeetingOrEnableStaticMeetingLink(
+      conversationUrl,
+      installedOrgID,
+      false,
+      classificationId
+    )
       .then((requestResult) => {
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
 
@@ -618,6 +631,7 @@ export default class MeetingInfoV2 {
    * @param {Object} options
    * @param {String} registrationId
    * @param {String} fullSiteUrl
+   * @param {String} classificationId
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -635,7 +649,8 @@ export default class MeetingInfoV2 {
     extraParams: object = {},
     options: {meetingId?: string; sendCAevents?: boolean} = {},
     registrationId: string = null,
-    fullSiteUrl: string = null
+    fullSiteUrl: string = null,
+    classificationId: string = null
   ) {
     const {meetingId, sendCAevents} = options;
 
@@ -650,7 +665,11 @@ export default class MeetingInfoV2 {
       this.webex.config.meetings.experimental.enableAdhocMeetings &&
       this.webex.meetings.preferredWebexSite
     ) {
-      return this.createAdhocSpaceMeeting(destinationType.destination, installedOrgID);
+      return this.createAdhocSpaceMeeting(
+        destinationType.destination,
+        installedOrgID,
+        classificationId
+      );
     }
 
     const body = await MeetingInfoUtil.getRequestBody({

package/src/meetings/index.ts

@@ -1331,6 +1331,7 @@ export default class Meetings extends WebexPlugin {
    * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
    * @param {String} [meetingLookupUrl] - meeting info prefetch url
    * @param {string} sessionCorrelationId - the optional specified sessionCorrelationId (callStateForMetrics.sessionCorrelationId) can be provided instead
+   * @param {String} classificationId - If space support classification, it will provide it while start instant meeting
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1345,7 +1346,8 @@ export default class Meetings extends WebexPlugin {
     callStateForMetrics: CallStateForMetrics = undefined,
     meetingInfo = undefined,
     meetingLookupUrl = undefined,
-    sessionCorrelationId: string = undefined
+    sessionCorrelationId: string = undefined,
+    classificationId: string = undefined
   ) {
     // Validate meeting information based on the provided destination and
     // type. This must be performed prior to determining if the meeting is
@@ -1415,7 +1417,8 @@ export default class Meetings extends WebexPlugin {
               callStateForMetrics,
               failOnMissingMeetingInfo,
               meetingInfo,
-              meetingLookupUrl
+              meetingLookupUrl,
+              classificationId
             ).then((createdMeeting: any) => {
               // If the meeting was successfully created.
               if (createdMeeting && createdMeeting.on) {
@@ -1529,6 +1532,7 @@ export default class Meetings extends WebexPlugin {
    * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
    * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
    * @param {String} [meetingLookupUrl] - meeting info prefetch url
+   * @param {String} classificationId see create()
    * @returns {Promise} a new meeting instance complete with meeting info and destination
    * @private
    * @memberof Meetings
@@ -1541,7 +1545,8 @@ export default class Meetings extends WebexPlugin {
     callStateForMetrics: CallStateForMetrics = undefined,
     failOnMissingMeetingInfo = false,
     meetingInfo = undefined,
-    meetingLookupUrl = undefined
+    meetingLookupUrl = undefined,
+    classificationId = undefined
   ) {
     const meeting = new Meeting(
       {
@@ -1589,6 +1594,7 @@ export default class Meetings extends WebexPlugin {
       // @ts-ignore
       const {enableUnifiedMeetings} = this.config.experimental;
       const meetingInfoOptions = {
+        classificationId,
         extraParams: infoExtraParams,
         sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
       };

package/src/member/index.ts

@@ -42,6 +42,7 @@ export default class Member {
   status: any;
   supportsBreakouts: boolean;
   supportsInterpretation: boolean;
+  supportsSingleUserAutoEndMeeting: boolean;
   supportLiveAnnotation: boolean;
   type: any;
   namespace = MEETINGS;
@@ -130,6 +131,13 @@ export default class Member {
      * @memberof Member
      */
     this.supportsBreakouts = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.supportsSingleUserAutoEndMeeting = null;
     /**
      * @instance
      * @type {Boolean}
@@ -339,6 +347,8 @@ export default class Member {
       this.isVideoMuted = MemberUtil.isVideoMuted(participant);
       this.isHandRaised = MemberUtil.isHandRaised(participant);
       this.supportsBreakouts = MemberUtil.isBreakoutsSupported(participant);
+      this.supportsSingleUserAutoEndMeeting =
+        MemberUtil.isSupportsSingleUserAutoEndMeeting(participant);
       this.supportsInterpretation = MemberUtil.isInterpretationSupported(participant);
       this.supportLiveAnnotation = MemberUtil.isLiveAnnotationSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);

package/src/member/types.ts

@@ -109,4 +109,5 @@ export interface Participant {
   status: ParticipantMediaStatus;
   type: string;
   url: ParticipantUrl;
+  isRemoved: boolean; // JS-SDK internal field to indicate in updates when the participant is removed
 }

package/src/member/util.ts

@@ -207,6 +207,20 @@ const MemberUtil = {
     return !participant.doesNotSupportBreakouts;
   },
 
+  /**
+   * @param {Object} participant - The locus participant object.
+   * @returns {Boolean}
+   */
+  isSupportsSingleUserAutoEndMeeting: (participant) => {
+    if (!participant) {
+      throw new ParameterError(
+        'Single user auto end meeting support could not be processed, participant is undefined.'
+      );
+    }
+
+    return !participant.doesNotSupportSingleUserAutoEndMeeting;
+  },
+
   /**
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}

package/src/members/collection.ts

@@ -39,6 +39,17 @@ export default class MembersCollection {
     return this.members;
   }
 
+  /**
+   * Removes a member from the collection
+   * @param {String} id
+   * @returns {void}
+   */
+  remove(id: string) {
+    if (this.members[id]) {
+      delete this.members[id];
+    }
+  }
+
   /**
    * @returns {void}
    * reset members

package/src/members/index.ts

@@ -74,7 +74,11 @@ import {Invitee} from '../meeting/type';
  * @memberof Members
  */
 
-type UpdatedMembers = {added: Array<Member>; updated: Array<Member>};
+type UpdatedMembers = {
+  added: Array<Member>;
+  updated: Array<Member>;
+  removedIds?: Array<string>; // removed member ids
+};
 /**
  * @class Members
  */
@@ -384,12 +388,18 @@ export default class Members extends StatelessWebexPlugin {
    * when new participant updates come in, both delta and full participants, update them in members collection
    * delta object in the event will have {updated, added} and full will be the full membersCollection
    * @param {Object} payload
-   * @param {Object} payload.participants
+   * @param {Object} payload.participants new/updated participants
+   * @param {Boolean} payload.isReplace whether to replace the whole members collection
+   * @param {Object} payload.removedParticipantIds ids of the removed participants
    * @returns {undefined}
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload: {participants: object; isReplace?: boolean}) {
+  locusParticipantsUpdate(payload: {
+    participants: object;
+    isReplace?: boolean;
+    removedParticipantIds?: Array<string>;
+  }) {
     if (payload) {
       if (payload.isReplace) {
         this.clearMembers();
@@ -547,10 +557,22 @@ export default class Members extends StatelessWebexPlugin {
   private handleMembersUpdate(membersUpdate: UpdatedMembers) {
     this.constructMembers(membersUpdate.updated, true);
     this.constructMembers(membersUpdate.added, false);
+    this.removeMembers(membersUpdate.removedIds);
 
     return this.membersCollection.getAll();
   }
 
+  /**
+   * removes members from the collection
+   * @param {Array<string>} removedMembers removed members ids
+   * @returns {void}
+   */
+  private removeMembers(removedMembers: Array<string>) {
+    removedMembers.forEach((memberId) => {
+      this.membersCollection.remove(memberId);
+    });
+  }
+
   /**
    * set members to the member collection from each updated/added lists as passed in
    * @param {Array} list
@@ -600,6 +622,10 @@ export default class Members extends StatelessWebexPlugin {
     }
     const memberUpdate = this.update(payload.participants);
 
+    // this code depends on memberIds being the same as participantIds
+    // if MemberUtil.extractId() ever changes, this will need to be updated
+    memberUpdate.removedIds = payload.removedParticipantIds || [];
+
     return memberUpdate;
   }
 
@@ -1181,11 +1207,17 @@ export default class Members extends StatelessWebexPlugin {
    * @param {string} memberId - id of the participant who is receiving request
    * @param {string} requestingParticipantId - id of the participant who is sending request (optional)
    * @param {string} [alias] - alias name
+   * @param {string} [suffix] - name suffix (optional)
    * @returns {Promise}
    * @public
    * @memberof Members
    */
-  public editDisplayName(memberId: string, requestingParticipantId: string, alias: string) {
+  public editDisplayName(
+    memberId: string,
+    requestingParticipantId: string,
+    alias: string,
+    suffix?: string
+  ) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError(
@@ -1205,7 +1237,8 @@ export default class Members extends StatelessWebexPlugin {
       memberId,
       requestingParticipantId,
       alias,
-      locusUrl
+      locusUrl,
+      suffix
     );
 
     return this.membersRequest.editDisplayNameMember(options);

package/src/members/util.ts

@@ -190,13 +190,21 @@ const MembersUtil = {
    * @param {String} requestingParticipantId id of the participant who is sending request (optional)
    * @param {String} alias alias name
    * @param {String} locusUrl url
+   * @param {String} suffix optional suffix
    * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
    */
-  generateEditDisplayNameMemberOptions: (memberId, requestingParticipantId, alias, locusUrl) => ({
+  generateEditDisplayNameMemberOptions: (
     memberId,
     requestingParticipantId,
     alias,
     locusUrl,
+    suffix
+  ) => ({
+    memberId,
+    requestingParticipantId,
+    alias,
+    locusUrl,
+    suffix,
   }),
 
   getMuteMemberRequestParams: (options) => {
@@ -301,10 +309,18 @@ const MembersUtil = {
    * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
    */
   editDisplayNameMemberRequestParams: (options) => {
-    const body = {
+    const body: {
+      aliasValue: string;
+      requestingParticipantId: string;
+      suffixValue?: string;
+    } = {
       aliasValue: options.alias,
       requestingParticipantId: options.requestingParticipantId,
     };
+
+    if (options.suffix !== undefined) {
+      body.suffixValue = options.suffix;
+    }
     const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${ALIAS}`;
 
     return {

package/src/metrics/constants.ts

@@ -86,6 +86,7 @@ const BEHAVIORAL_METRICS = {
   VERIFY_REGISTRATION_ID_SUCCESS: 'js_sdk_verify_registrationId_success',
   VERIFY_REGISTRATION_ID_ERROR: 'js_sdk_verify_registrationId_error',
   JOIN_FORBIDDEN_ERROR: 'js_sdk_join_forbidden_error',
+  MEDIA_ISSUE_DETECTED: 'js_sdk_media_issue_detected',
 };
 
 export {BEHAVIORAL_METRICS as default};

package/src/reachability/index.ts

@@ -923,10 +923,10 @@ export default class Reachability extends EventsScope {
 
       // update expected results counters to include this cluster
       this.expectedResultsCount[cluster.isVideoMesh ? 'videoMesh' : 'public'].udp +=
-        cluster.udp.length;
+        cluster.udp.length > 0 ? 1 : 0;
       if (!cluster.isVideoMesh) {
-        this.expectedResultsCount.public.tcp += cluster.tcp.length;
-        this.expectedResultsCount.public.xtls += cluster.xtls.length;
+        this.expectedResultsCount.public.tcp += cluster.tcp.length > 0 ? 1 : 0;
+        this.expectedResultsCount.public.xtls += cluster.xtls.length > 0 ? 1 : 0;
       }
     });
 

package/test/unit/spec/common/browser-detection.js

@@ -18,16 +18,6 @@ const USER_AGENT_SAFARI_MAC =
 const USER_AGENT_FIREFOX_MAC =
   'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:87.0) ' + 'Gecko/20100101 Firefox/87.0';
 
-const mockDetectionObject = {
-  /* eslint-disable global-require */
-  getOSName: () => require('os').platform(),
-  getOSVersion: () => require('os').release(),
-  /* eslint-enable global-require */
-  getBrowserName: () => '',
-  getBrowserVersion: () => '',
-  isBrowser: () => false,
-};
-
 describe('common/browser-detection', () => {
   it('returns the correct browser name.', () => {
     assert.equal(
@@ -102,18 +92,4 @@ describe('common/browser-detection', () => {
       'This browser is NOT Firefox'
     );
   });
-
-  it('returns the mock object when there is no userAgent', () => {
-    Object.defineProperty(global.window.navigator, 'userAgent', {
-      get: () => undefined,
-      configurable: true,
-    });
-
-    const {getBrowserName, getBrowserVersion, getOSName, getOSVersion} = BrowserDetection(null);
-
-    assert.equal(getBrowserName(), mockDetectionObject.getBrowserName());
-    assert.equal(getBrowserVersion(), mockDetectionObject.getBrowserVersion());
-    assert.equal(getOSName(), mockDetectionObject.getOSName());
-    assert.equal(getOSVersion(), mockDetectionObject.getOSVersion());
-  });
 });

package/test/unit/spec/controls-options-manager/index.js

@@ -133,6 +133,7 @@ describe('plugin-meetings', () => {
 
                 manager.set({
                   locusUrl: 'test/id',
+                  mainLocusUrl: '',
                   displayHints: [],
                 });
               });
@@ -201,6 +202,38 @@ describe('plugin-meetings', () => {
                     Util.canUpdate = restorable;
                   });
               });
+
+              it('should call request with mainLocusUrl and locusUrl as authorizingLocusUrl if mainLocusUrl is exist and not same with locusUrl', () => {
+                const restorable = Util.canUpdate;
+                Util.canUpdate = sinon.stub().returns(true);
+                manager.mainLocusUrl = 'test/main';
+
+                const audio = {scope: 'audio', properties: {a: 1, b: 2}};
+                const reactions = {scope: 'reactions', properties: {c: 3, d: 4}};
+
+                return manager.update(audio, reactions)
+                  .then(() => {
+                    assert.calledWith(request.request, {
+                      uri: 'test/main/controls',
+                      body: {
+                        audio: audio.properties,
+                        authorizingLocusUrl: 'test/id'
+                      },
+                      method: HTTP_VERBS.PATCH,
+                    });
+
+                    assert.calledWith(request.request, {
+                      uri: 'test/main/controls',
+                      body: {
+                        reactions: reactions.properties,
+                        authorizingLocusUrl: 'test/id'
+                      },
+                      method: HTTP_VERBS.PATCH,
+                    });
+
+                    Util.canUpdate = restorable;
+                  });
+              });
             });
 
             describe('Mute/Unmute All', () => {
@@ -214,6 +247,7 @@ describe('plugin-meetings', () => {
 
                 manager.set({
                   locusUrl: 'test/id',
+                  mainLocusUrl: '',
                   displayHints: [],
                 })
               });
@@ -305,6 +339,19 @@ describe('plugin-meetings', () => {
 
                 assert.deepEqual(result, request.request.firstCall.returnValue);
               });
+
+              it('request with mainLocusUrl and make locusUrl as authorizingLocusUrl if mainLocusUrl is exist and not same with locusUrl', () => {
+                manager.setDisplayHints(['MUTE_ALL', 'DISABLE_HARD_MUTE', 'DISABLE_MUTE_ON_ENTRY']);
+                manager.mainLocusUrl = `test/main`;
+
+                const result = manager.setMuteAll(true, true, true, ['attendee']);
+
+                assert.calledWith(request.request, {  uri: 'test/main/controls',
+                  body: { audio: { muted: true, disallowUnmute: true, muteOnEntry: true, roles: ['attendee'] }, authorizingLocusUrl: 'test/id' },
+                  method: HTTP_VERBS.PATCH});
+
+                assert.deepEqual(result, request.request.firstCall.returnValue);
+              });
             });
           });
     });

package/test/unit/spec/fixture/locus.js

@@ -36,6 +36,7 @@ export default {
         'LOCK_STATUS_UNLOCKED',
         'ROSTER_IN_MEETING',
         'SHARE_WHITEBOARD',
+        'SHOW_AUTO_END_MEETING_WARNING',
         'SHARE_WHITEBOARD_POLICY',
         'WEBEX_ASSISTANT_STATUS_INACTIVE',
         'CAPTION_START',

package/test/unit/spec/interceptors/locusRouteToken.ts

@@ -0,0 +1,87 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+/* eslint-disable camelcase */
+import 'jsdom-global/register';
+import {assert} from '@webex/test-helper-chai';
+import MockWebex from '@webex/test-helper-mock-webex';
+import {LocusRouteTokenInterceptor} from '@webex/plugin-meetings/src/interceptors';
+import Meetings from '@webex/plugin-meetings';
+
+const X_CISCO_PART_ROUTE_TOKEN = 'X-Cisco-Part-Route-Token';
+
+describe('LocusRouteTokenInterceptor', () => {
+  let interceptor, webex;
+  const TEST_LOCUS_ID = '0f1eba56-91e2-2a11-9b2b-1e2da077f066';
+  beforeEach(() => {
+    webex = new MockWebex({
+      children: {
+        meetings: Meetings,
+      },
+    });
+    interceptor = Reflect.apply(LocusRouteTokenInterceptor.create, webex, []);
+  });
+
+  it('getLocusIdByRequestUrl should return locusId from url', () => {
+    const url = `https://locus-test.webex.com/locus/api/v1/loci/${TEST_LOCUS_ID}/foo`;
+    assert.equal(interceptor.getLocusIdByRequestUrl(url), TEST_LOCUS_ID);
+  });
+
+  it('getLocusIdByRequestUrl should return undefined when no locusId in url', () => {
+    const url = 'https://locus-test.webex.com/locus/api/v1/foo';
+    assert.isUndefined(interceptor.getLocusIdByRequestUrl(url));
+  });
+
+  it('getLocusIdByRequestUrl should return undefined when url is undefined', () => {
+    assert.isUndefined(interceptor.getLocusIdByRequestUrl(undefined));
+  });
+
+  it('onResponse should store route token when header exists', async () => {
+    const response = {
+      headers: {
+        [X_CISCO_PART_ROUTE_TOKEN]: 'test-token',
+      },
+    };
+
+    const result = await interceptor.onResponse(
+      {
+        uri: `https://locus-test.webex.com/locus/api/v1/loci/${TEST_LOCUS_ID}/foo`,
+      },
+      response
+    );
+    assert.equal(result, response);
+    assert.equal(interceptor.getToken(TEST_LOCUS_ID), 'test-token');
+  });
+
+  it('onResponse should not store token when header missing', async () => {
+    interceptor.updateToken(TEST_LOCUS_ID);
+    const response = {headers: {}};
+
+    await interceptor.onResponse({}, response);
+    assert.isUndefined(interceptor.getToken(TEST_LOCUS_ID));
+  });
+
+  it('onRequest should attach token to headers when token exists', async () => {
+    interceptor.updateToken(TEST_LOCUS_ID, 'abc123');
+
+    const options = {
+      headers: {},
+      uri: `https://locus-test.webex.com/locus/api/v1/loci/${TEST_LOCUS_ID}/foo`,
+    };
+    const result = await interceptor.onRequest(options);
+    assert.equal(result.headers[X_CISCO_PART_ROUTE_TOKEN], 'abc123');
+  });
+
+  it('onRequest should not attach token if none is stored', async () => {
+    interceptor.updateToken(TEST_LOCUS_ID);
+    const options = {headers: {}};
+    const result = await interceptor.onRequest(options);
+    assert.isUndefined(result.headers[X_CISCO_PART_ROUTE_TOKEN]);
+  });
+
+  it('updateToken & getToken should work as pair', () => {
+    interceptor.updateToken(TEST_LOCUS_ID, 'abc456');
+    assert.equal(interceptor.getToken(TEST_LOCUS_ID), 'abc456');
+  });
+});