@webex/plugin-meetings 3.8.1 → 3.9.0-webinar5k.1

package/src/meetings/index.ts

@@ -66,6 +66,7 @@ import JoinWebinarError from '../common/errors/join-webinar-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
 import JoinForbiddenError from '../common/errors/join-forbidden-error';
+import {DataSet} from '../hashTree/hashTreeParser';
 
 let mediaLogger;
 
@@ -407,6 +408,13 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   getCorrespondingMeetingByLocus(data) {
+    if (data.eventType === 'locus.state_message' && data.stateElementsMessage?.locusUrl) {
+      return this.meetingCollection.getByKey(
+        MEETING_KEY.LOCUS_URL,
+        data.stateElementsMessage.locusUrl
+      );
+    }
+
     // getting meeting by correlationId. This will happen for the new event
     // Either the locus
     // TODO : Add check for the callBack Address
@@ -445,7 +453,10 @@ export default class Meetings extends WebexPlugin {
    * @private
    * @memberof Meetings
    */
-  private handleLocusEvent(data: {locusUrl: string; locus: any}, useRandomDelayForInfo = false) {
+  private handleLocusEvent(
+    data: {locusUrl: string; locus: any; dataSets?: DataSet[]},
+    useRandomDelayForInfo = false
+  ) {
     let meeting = this.getCorrespondingMeetingByLocus(data);
 
     // Special case when locus has got replaced, This only happend once if a replace locus exists
@@ -524,7 +535,7 @@ export default class Meetings extends WebexPlugin {
           meeting = newMeeting;
 
           // It's a new meeting so initialize the locus data
-          meeting.locusInfo.initialSetup(data.locus);
+          meeting.locusInfo.initialSetup(data.locus, data.dataSets);
           this.checkHandleBreakoutLocus(data.locus);
         })
         .catch((e) => {
@@ -1824,7 +1835,10 @@ export default class Meetings extends WebexPlugin {
     }
 
     const associateBreakoutLocus = this.breakoutLocusForHandleLater[existIndex];
-    this.handleLocusEvent({locus: associateBreakoutLocus, locusUrl: associateBreakoutLocus.url});
+    this.handleLocusEvent({
+      locus: associateBreakoutLocus,
+      locusUrl: associateBreakoutLocus.url,
+    });
     this.breakoutLocusForHandleLater.splice(existIndex, 1);
   }
 

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/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

@@ -73,7 +73,11 @@ import {ServerRoleShape} from './types';
  * @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
  */
@@ -388,7 +392,11 @@ export default class Members extends StatelessWebexPlugin {
    * @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();
@@ -546,10 +554,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
@@ -599,6 +619,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;
   }
 
@@ -846,12 +870,14 @@ export default class Members extends StatelessWebexPlugin {
   }
 
   /**
-   * Cancels an SIP call to the associated meeting
-   * @param {String} invitee
+   * Cancels an SIP/phone call to the associated meeting
+   * @param {Object} invitee
+   * @param {String} invitee.memberId - The memberId of the invitee
+   * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
    * @returns {Promise}
    * @memberof Members
    */
-  cancelSIPInvite(invitee: any) {
+  cancelInviteByMemberId(invitee: {memberId: string; isInternalNumber?: boolean}) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError('The associated locus url for this meeting object must be defined.')
@@ -862,9 +888,9 @@ export default class Members extends StatelessWebexPlugin {
         new ParameterError('The invitee must be defined with a memberId property.')
       );
     }
-    const options = MembersUtil.cancelSIPInviteOptions(invitee, this.locusUrl);
+    const options = MembersUtil.cancelInviteByMemberIdOptions(invitee, this.locusUrl);
 
-    return this.membersRequest.cancelSIPInvite(options);
+    return this.membersRequest.cancelInviteByMemberId(options);
   }
 
   /**

package/src/members/request.ts

@@ -285,14 +285,14 @@ export default class MembersRequest extends StatelessWebexPlugin {
    * @throws {Error} if the options are not valid and complete, must have invitee with memberId AND locusUrl
    * @memberof MembersRequest
    */
-  cancelSIPInvite(options: any) {
+  cancelInviteByMemberId(options: any) {
     if (!options?.invitee?.memberId || !options?.locusUrl) {
       throw new ParameterError(
         'invitee must be passed and the associated locus url for this meeting object must be defined.'
       );
     }
 
-    const requestParams = MembersUtil.generateCancelSIPInviteRequestParams(options);
+    const requestParams = MembersUtil.generateCancelInviteByMemberIdRequestParams(options);
 
     return this.locusDeltaRequest(requestParams);
   }

package/src/members/util.ts

@@ -1,4 +1,5 @@
 import uuid from 'uuid';
+import {has} from 'lodash';
 import {
   HTTP_VERBS,
   CONTROLS,
@@ -47,6 +48,9 @@ const MembersUtil = {
         address:
           options.invitee.emailAddress || options.invitee.email || options.invitee.phoneNumber,
         ...(options.invitee.roles ? {roles: options.invitee.roles} : {}),
+        ...(has(options.invitee, 'isInternalNumber')
+          ? {isInternalNumber: options.invitee.isInternalNumber}
+          : {}),
       },
     ],
     alertIfActive: options.alertIfActive,
@@ -107,6 +111,10 @@ const MembersUtil = {
     }
 
     if (invitee.phoneNumber) {
+      if (invitee.isInternalNumber) {
+        return !DIALER_REGEX.INTERNAL_NUMBER.test(invitee.phoneNumber);
+      }
+
       return !DIALER_REGEX.E164_FORMAT.test(invitee.phoneNumber);
     }
 
@@ -371,17 +379,20 @@ const MembersUtil = {
     return requestParams;
   },
 
-  cancelSIPInviteOptions: (invitee, locusUrl) => ({
+  cancelInviteByMemberIdOptions: (invitee, locusUrl) => ({
     invitee,
     locusUrl,
   }),
 
-  generateCancelSIPInviteRequestParams: (options) => {
+  generateCancelInviteByMemberIdRequestParams: (options) => {
+    const {memberId, isInternalNumber} = options.invitee;
+    const hasIsInternalNumberProp = has(options.invitee, 'isInternalNumber');
     const body = {
       actionType: _REMOVE_,
       invitees: [
         {
-          address: options.invitee.memberId,
+          address: memberId,
+          ...(hasIsInternalNumberProp ? {isInternalNumber} : {}),
         },
       ],
     };

package/src/metrics/constants.ts

@@ -72,6 +72,7 @@ const BEHAVIORAL_METRICS = {
   MEETING_INFO_POLICY_ERROR: 'js_sdk_meeting_info_policy_error',
   LOCUS_DELTA_SYNC_FAILED: 'js_sdk_locus_delta_sync_failed',
   LOCUS_DELTA_OUT_OF_ORDER: 'js_sdk_locus_delta_ooo',
+  LOCUS_SYNC_HANDLING_FAILED: 'js_sdk_locus_sync_handling_failed',
   PERMISSION_TOKEN_REFRESH: 'js_sdk_permission_token_refresh',
   PERMISSION_TOKEN_REFRESH_ERROR: 'js_sdk_permission_token_refresh_error',
   TURN_DISCOVERY_LATENCY: 'js_sdk_turn_discovery_latency',

package/src/multistream/sendSlotManager.ts

@@ -7,10 +7,20 @@ import {
   StreamState,
 } from '@webex/internal-media-core';
 
+/**
+ * This class is used to manage the sendSlots for the given media types.
+ */
 export default class SendSlotManager {
   private readonly slots: Map<MediaType, SendSlot> = new Map();
   private readonly LoggerProxy: any;
+  private readonly sourceStateOverrides: Map<MediaType, StreamState> = new Map();
 
+  /**
+   * Constructor for SendSlotManager
+   *
+   * @param {any} LoggerProxy is used to log the messages
+   * @constructor
+   */
   constructor(LoggerProxy: any) {
     this.LoggerProxy = LoggerProxy;
   }
@@ -93,7 +103,7 @@ export default class SendSlotManager {
   public setSourceStateOverride(mediaType: MediaType, state: StreamState | null) {
     if (mediaType !== MediaType.VideoMain) {
       throw new Error(
-        `sendSlotManager cannot set source state override which media type is ${mediaType}`
+        `Invalid media type '${mediaType}'. Source state overrides are only applicable to ${MediaType.VideoMain}.`
       );
     }
 
@@ -103,17 +113,39 @@ export default class SendSlotManager {
       throw new Error(`Slot for ${mediaType} does not exist`);
     }
 
+    const currentStateOverride = this.getSourceStateOverride(mediaType);
+    if (currentStateOverride === state) {
+      return;
+    }
+
     if (state) {
       slot.setSourceStateOverride(state);
+      this.sourceStateOverrides.set(mediaType, state);
     } else {
       slot.clearSourceStateOverride();
+      this.sourceStateOverrides.delete(mediaType);
     }
 
     this.LoggerProxy.logger.info(
-      `SendSlotsManager->setSourceStateOverride#set source state override for ${mediaType} to ${state}`
+      `SendSlotManager->setSourceStateOverride#set source state override for ${mediaType} to ${state}`
     );
   }
 
+  /**
+   * Gets the source state override for the given media type.
+   * @param {MediaType} mediaType - The type of media to get the source state override for.
+   * @returns {StreamState | null} - The current source state override or null if not set.
+   */
+  private getSourceStateOverride(mediaType: MediaType): StreamState | null {
+    if (mediaType !== MediaType.VideoMain) {
+      throw new Error(
+        `Invalid media type '${mediaType}'. Source state overrides are only applicable to ${MediaType.VideoMain}.`
+      );
+    }
+
+    return this.sourceStateOverrides.get(mediaType) || null;
+  }
+
   /**
    * This method publishes the given stream to the sendSlot for the given mediaType
    * @param {MediaType} mediaType MediaType of the sendSlot to which a stream needs to be published (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)

package/src/reachability/index.ts

@@ -140,22 +140,14 @@ export default class Reachability extends EventsScope {
 
   /**
    * Checks if the given subnet is reachable
-   * @param {string} mediaServerIp - media server ip
+   * @param {string} selectedSubnetFirstOctet - selected subnet first octet, e.g. "10" for "10.X.X.X"
    * @returns {boolean | null} true if reachable, false if not reachable, null if mediaServerIp is not provided
    * @public
    * @memberof Reachability
    */
-  public isSubnetReachable(mediaServerIp?: string): boolean | null {
-    if (!mediaServerIp) {
-      LoggerProxy.logger.error(`Reachability:index#isSubnetReachable --> mediaServerIp is null`);
-
-      return null;
-    }
-
-    const subnetFirstOctet = mediaServerIp.split('.')[0];
-
+  public isSubnetReachable(selectedSubnetFirstOctet: string): boolean | null {
     LoggerProxy.logger.info(
-      `Reachability:index#isSubnetReachable --> Looking for subnet: ${subnetFirstOctet}.X.X.X`
+      `Reachability:index#isSubnetReachable --> Looking for subnet: ${selectedSubnetFirstOctet}.X.X.X`
     );
 
     const matchingReachedClusters = Object.values(this.clusterReachability).reduce(
@@ -167,7 +159,7 @@ export default class Reachability extends EventsScope {
           const subnet = reachedSubnetsArray[i];
           const reachedSubnetFirstOctet = subnet.split('.')[0];
 
-          if (subnetFirstOctet === reachedSubnetFirstOctet) {
+          if (selectedSubnetFirstOctet === reachedSubnetFirstOctet) {
             acc.add(cluster.name);
           }
 
@@ -186,7 +178,7 @@ export default class Reachability extends EventsScope {
     );
 
     LoggerProxy.logger.info(
-      `Reachability:index#isSubnetReachable --> Found ${matchingReachedClusters.size} clusters that use the subnet ${subnetFirstOctet}.X.X.X`
+      `Reachability:index#isSubnetReachable --> Found ${matchingReachedClusters.size} clusters that use the subnet ${selectedSubnetFirstOctet}.X.X.X`
     );
 
     return matchingReachedClusters.size > 0;

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

@@ -473,6 +473,40 @@ describe('plugin-meetings', () => {
           assert.equal(results, expected);
         });
       });
+      
+      describe('canUpdatePollingQA()', () => {
+        beforeEach(() => {
+          sinon.stub(ControlsOptionsUtil, 'hasHints').returns(true);
+        });
+
+        it('should call hasHints() with proper hints when `enabled` is true', () => {
+          ControlsOptionsUtil.canUpdatePollingQA({properties: {enabled: true}}, []);
+
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.ENABLE_ATTENDEE_START_POLLING_QA],
+            displayHints: [],
+          });
+        });
+
+        it('should call hasHints() with proper hints when `enabled` is false', () => {
+          ControlsOptionsUtil.canUpdatePollingQA({properties: {enabled: false}}, []);
+
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.DISABLE_ATTENDEE_START_POLLING_QA],
+            displayHints: [],
+          });
+        });
+
+        it('should return the resolution of hasHints()', () => {
+          const expected = 'example-return-value';
+          ControlsOptionsUtil.hasHints.returns(expected);
+
+          const results = ControlsOptionsUtil.canUpdatePollingQA({properties: {}}, []);
+
+          assert.calledOnce(ControlsOptionsUtil.hasHints);
+          assert.equal(results, expected);
+        });
+      });
 
       describe('canUpdate()', () => {
         const displayHints = [];
@@ -486,6 +520,7 @@ describe('plugin-meetings', () => {
           ControlsOptionsUtil.canUpdateViewTheParticipantsList = sinon.stub().returns(true);
           ControlsOptionsUtil.canUpdateAnnotation = sinon.stub().returns(true);
           ControlsOptionsUtil.canUpdateRemoteDesktopControl = sinon.stub().returns(true);
+          ControlsOptionsUtil.canUpdatePollingQA = sinon.stub().returns(true);
         });
 
         it('should only call canUpdateAudio() if the scope is audio', () => {
@@ -621,6 +656,28 @@ describe('plugin-meetings', () => {
             control,
             displayHints
           );
+          assert.callCount(ControlsOptionsUtil.canUpdatePollingQA, 0);
+          assert.isTrue(results);
+        });
+
+        it('should only call canUpdatePollingQA() if the scope is pollingQA', () => {
+          const control = {scope: 'pollingQA'};
+
+          const results = ControlsOptionsUtil.canUpdate(control, displayHints);
+
+          assert.callCount(ControlsOptionsUtil.canUpdateAudio, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRaiseHand, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateReactions, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
+          assert.calledWith(
+            ControlsOptionsUtil.canUpdatePollingQA,
+            control,
+            displayHints
+          );
           assert.isTrue(results);
         });
 
@@ -637,6 +694,7 @@ describe('plugin-meetings', () => {
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdatePollingQA, 0);
           assert.isFalse(results);
         });
       });