@webex/plugin-meetings 3.9.0 → 3.10.0

package/src/index.ts

@@ -3,7 +3,7 @@ import {registerPlugin} from '@webex/webex-core';
 
 import Meetings from './meetings';
 import config from './config';
-import {LocusRetryStatusInterceptor} from './interceptors';
+import {LocusRetryStatusInterceptor, LocusRouteTokenInterceptor} from './interceptors';
 import CaptchaError from './common/errors/captcha-error';
 import IntentToJoinError from './common/errors/intent-to-join';
 import PasswordError from './common/errors/password-error';
@@ -23,6 +23,7 @@ registerPlugin('meetings', Meetings, {
   config,
   interceptors: {
     LocusRetryStatusInterceptor: LocusRetryStatusInterceptor.create,
+    LocusRouteTokenInterceptor: LocusRouteTokenInterceptor.create,
   },
 });
 

package/src/interceptors/index.ts

@@ -1,3 +1,4 @@
 import LocusRetryStatusInterceptor from './locusRetry';
+import LocusRouteTokenInterceptor from './locusRouteToken';
 
-export {LocusRetryStatusInterceptor};
+export {LocusRetryStatusInterceptor, LocusRouteTokenInterceptor};

package/src/interceptors/locusRouteToken.ts

@@ -0,0 +1,80 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {Interceptor} from '@webex/http-core';
+import {has} from 'lodash';
+
+const LOCUS_ID_REGEX = /\/locus\/api\/v1\/loci\/([a-f0-9-]{36})/i;
+const X_CISCO_PART_ROUTE_TOKEN = 'X-Cisco-Part-Route-Token';
+const ROUTE_TOKEN = {};
+
+/**
+ * @class LocusRouteTokenInterceptor
+ */
+export default class LocusRouteTokenInterceptor extends Interceptor {
+  /**
+   * @returns {LocusRouteTokenInterceptor}
+   */
+  static create() {
+    // @ts-ignore
+    return new LocusRouteTokenInterceptor({webex: this});
+  }
+
+  getLocusIdByRequestUrl(url: string) {
+    return url?.match(LOCUS_ID_REGEX)?.[1];
+  }
+
+  /**
+   * @param {Object} options
+   * @param {HttpResponse} response
+   * @returns {Promise<HttpResponse>}
+   */
+  onResponse(options, response) {
+    const locusId = this.getLocusIdByRequestUrl(options.uri);
+    if (locusId) {
+      const hasRouteToken = has(response.headers, X_CISCO_PART_ROUTE_TOKEN);
+      const token = response.headers[X_CISCO_PART_ROUTE_TOKEN];
+      if (hasRouteToken) {
+        this.updateToken(locusId, token);
+      }
+    }
+
+    return Promise.resolve(response);
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {Promise<Object>} options
+   */
+  onRequest(options) {
+    const locusId = this.getLocusIdByRequestUrl(options.uri);
+    if (locusId) {
+      const token = this.getToken(locusId);
+      if (token) {
+        options.headers[X_CISCO_PART_ROUTE_TOKEN] = token;
+      }
+    }
+
+    return Promise.resolve(options);
+  }
+
+  /**
+   * Update the meeting route token
+   * @param {string} locusId
+   * @param {string} token
+   * @returns {void}
+   */
+  updateToken(locusId, token) {
+    ROUTE_TOKEN[locusId] = token;
+  }
+
+  /**
+   * Get the meeting route token
+   * @param {string} locusId
+   * @returns {string|undefined}
+   */
+  getToken(locusId) {
+    return ROUTE_TOKEN[locusId];
+  }
+}

package/src/locus-info/controlsUtils.ts

@@ -130,6 +130,15 @@ ControlsUtils.parse = (controls: any) => {
     };
   }
 
+  if (controls?.autoEndMeetingWarning) {
+    parsedControls.autoEndMeetingWarning = {
+      enabled: controls.autoEndMeetingWarning.enabled,
+      extensionDurationMinutes: controls.autoEndMeetingWarning.extensionDurationMinutes,
+      countdownDurationMinutes: controls.autoEndMeetingWarning.countdownDurationMinutes,
+      countdownStartedAt: controls.autoEndMeetingWarning.countdownStartedAt,
+    };
+  }
+
   return parsedControls;
 };
 
@@ -244,6 +253,15 @@ ControlsUtils.getControls = (oldControls: any, newControls: any) => {
 
       hasPollingQAControlChanged:
         current?.pollingQAControl?.enabled !== previous?.pollingQAControl?.enabled,
+
+      hasAutoEndMeetingChanged:
+        current?.autoEndMeetingWarning?.enabled !== previous?.autoEndMeetingWarning?.enabled ||
+        current?.autoEndMeetingWarning?.extensionDurationMinutes !==
+          previous?.autoEndMeetingWarning?.extensionDurationMinutes ||
+        current?.autoEndMeetingWarning?.countdownDurationMinutes !==
+          previous?.autoEndMeetingWarning?.countdownDurationMinutes ||
+        current?.autoEndMeetingWarning?.countdownStartedAt !==
+          previous?.autoEndMeetingWarning?.countdownStartedAt,
     },
   };
 };

package/src/locus-info/index.ts

@@ -31,6 +31,51 @@ import LocusDeltaParser from './parser';
 import Metrics from '../metrics';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 
+export type LocusDTO = {
+  controls?: any;
+  fullState?: {
+    active: boolean;
+    count: number;
+    lastActive: string;
+    locked: boolean;
+    sessionId: string;
+    seessionIds: string[];
+    startTime: number;
+    state: string;
+    type: string;
+  };
+  host?: {
+    id: string;
+    incomingCallProtocols: any[];
+    isExternal: boolean;
+    name: string;
+    orgId: string;
+  };
+  info?: any;
+  links?: any;
+  mediaShares?: any[];
+  meetings?: any[];
+  participants: any[];
+  replaces?: any[];
+  self?: any;
+  sequence?: {
+    dirtyParticipants: number;
+    entries: number[];
+    rangeEnd: number;
+    rangeStart: number;
+    sequenceHash: number;
+    sessionToken: string;
+    since: string;
+    totalParticipants: number;
+  };
+  syncUrl?: string;
+  url?: string;
+};
+
+export type LocusApiResponseBody = {
+  locus: LocusDTO; // this LocusDTO here might not be the full one (for example it won't have all the participants, but it should have self)
+};
+
 /**
  * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
  * @export
@@ -93,19 +138,26 @@ export default class LocusInfo extends EventsScope {
    * Does a Locus sync. It tries to get the latest delta DTO or if it can't, it falls back to getting the full Locus DTO.
    *
    * @param {Meeting} meeting
+   * @param {boolean} isLocusUrlChanged
+   * @param {Locus} locus
    * @returns {undefined}
    */
-  private doLocusSync(meeting: any) {
-    let isDelta;
+  private doLocusSync(meeting: any, isLocusUrlChanged: boolean, locus: any) {
     let url;
+    let isDelta = false;
     let meetingDestroyed = false;
 
-    if (this.locusParser.workingCopy.syncUrl) {
+    if (isLocusUrlChanged) {
+      // for the locus url changed case from breakout to main session, we should always do a full sync, in this case, the url from locus is always on main session,
+      // so use the main session locus url to get the full locus(full participants list in the response).
+      // for the locus url changed case from main session to breakout, we don't need to care about it here,
+      // because it is a USE_INCOMING case, it will not be executed here.
+      url = locus.url;
+    } else if (this.locusParser.workingCopy?.syncUrl) {
       url = this.locusParser.workingCopy.syncUrl;
       isDelta = true;
     } else {
       url = meeting.locusUrl;
-      isDelta = false;
     }
 
     LoggerProxy.logger.info(
@@ -217,6 +269,7 @@ export default class LocusInfo extends EventsScope {
    */
   applyLocusDeltaData(action: string, locus: any, meeting: any) {
     const {DESYNC, USE_CURRENT, USE_INCOMING, WAIT, LOCUS_URL_CHANGED} = LocusDeltaParser.loci;
+    const isLocusUrlChanged = action === LOCUS_URL_CHANGED;
 
     switch (action) {
       case USE_INCOMING:
@@ -228,7 +281,7 @@ export default class LocusInfo extends EventsScope {
         break;
       case DESYNC:
       case LOCUS_URL_CHANGED:
-        this.doLocusSync(meeting);
+        this.doLocusSync(meeting, isLocusUrlChanged, locus);
         break;
       default:
         LoggerProxy.logger.info(
@@ -286,11 +339,11 @@ export default class LocusInfo extends EventsScope {
     this.updateLocusCache(locus);
     // above section only updates the locusInfo object
     // The below section makes sure it updates the locusInfo as well as updates the meeting object
-    this.updateParticipants(locus.participants);
+    this.updateParticipants(locus.participants, []);
     // For 1:1 space meeting the conversation Url does not exist in locus.conversation
     this.updateConversationUrl(locus.conversationUrl, locus.info);
     this.updateControls(locus.controls, locus.self);
-    this.updateLocusUrl(locus.url);
+    this.updateLocusUrl(locus.url, ControlsUtils.isMainSessionDTO(locus));
     this.updateFullState(locus.fullState);
     this.updateMeetingInfo(locus.info);
     this.updateEmbeddedApps(locus.embeddedApps);
@@ -315,6 +368,16 @@ export default class LocusInfo extends EventsScope {
     this.emitChange = true;
   }
 
+  /**
+   * Handles HTTP response from Locus API call.
+   * @param {Meeting} meeting meeting object
+   * @param {LocusApiResponseBody} responseBody body of the http response from Locus API call
+   * @returns {void}
+   */
+  handleLocusAPIResponse(meeting, responseBody: LocusApiResponseBody): void {
+    this.handleLocusDelta(responseBody.locus, meeting);
+  }
+
   /**
    * @param {Meeting} meeting
    * @param {Object} data
@@ -327,6 +390,8 @@ export default class LocusInfo extends EventsScope {
     const locus = this.getTheLocusToUpdate(data.locus);
     LoggerProxy.logger.info(`Locus-info:index#parse --> received locus data: ${eventType}`);
 
+    locus.jsSdkMeta = {removedParticipantIds: []};
+
     switch (eventType) {
       case LOCUSEVENT.PARTICIPANT_JOIN:
       case LOCUSEVENT.PARTICIPANT_LEFT:
@@ -392,7 +457,11 @@ export default class LocusInfo extends EventsScope {
     this.participants = locus.participants;
     const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
     this.updateLocusInfo(locus);
-    this.updateParticipants(locus.participants, isReplaceMembers);
+    this.updateParticipants(
+      locus.participants,
+      locus.jsSdkMeta?.removedParticipantIds,
+      isReplaceMembers
+    );
     this.isMeetingActive();
     this.handleOneOnOneEvent(eventType);
     this.updateEmbeddedApps(locus.embeddedApps);
@@ -454,7 +523,11 @@ export default class LocusInfo extends EventsScope {
     const isReplaceMembers = ControlsUtils.isNeedReplaceMembers(this.controls, locus.controls);
     this.mergeParticipants(this.participants, locus.participants);
     this.updateLocusInfo(locus);
-    this.updateParticipants(locus.participants, isReplaceMembers);
+    this.updateParticipants(
+      locus.participants,
+      locus.jsSdkMeta?.removedParticipantIds,
+      isReplaceMembers
+    );
     this.isMeetingActive();
   }
 
@@ -476,7 +549,7 @@ export default class LocusInfo extends EventsScope {
     this.updateCreated(locus.created);
     this.updateFullState(locus.fullState);
     this.updateHostInfo(locus.host);
-    this.updateLocusUrl(locus.url);
+    this.updateLocusUrl(locus.url, ControlsUtils.isMainSessionDTO(locus));
     this.updateMeetingInfo(locus.info, locus.self);
     this.updateMediaShares(locus.mediaShares);
     this.updateParticipantsUrl(locus.participantsUrl);
@@ -745,11 +818,12 @@ export default class LocusInfo extends EventsScope {
   /**
    * update meeting's members
    * @param {Object} participants new participants object
+   * @param {Array} removedParticipantIds list of removed participants
    * @param {Boolean} isReplace is replace the whole members
    * @returns {Array} updatedParticipants
    * @memberof LocusInfo
    */
-  updateParticipants(participants: object, isReplace?: boolean) {
+  updateParticipants(participants: object, removedParticipantIds?: string[], isReplace?: boolean) {
     this.emitScoped(
       {
         file: 'locus-info',
@@ -758,6 +832,7 @@ export default class LocusInfo extends EventsScope {
       EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS,
       {
         participants,
+        removedParticipantIds,
         recordingId: this.parsedLocus.controls && this.parsedLocus.controls.record?.modifiedBy,
         selfIdentity: this.parsedLocus.self && this.parsedLocus.self.selfIdentity,
         selfId: this.parsedLocus.self && this.parsedLocus.self.selfId,
@@ -820,6 +895,7 @@ export default class LocusInfo extends EventsScope {
           hasAnnotationControlChanged,
           hasRemoteDesktopControlChanged,
           hasPollingQAControlChanged,
+          hasAutoEndMeetingChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -1094,6 +1170,14 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasAutoEndMeetingChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_AUTO_END_MEETING_WARNING_CHANGED,
+          {state: current.autoEndMeetingWarning}
+        );
+      }
+
       this.controls = controls;
     }
   }
@@ -1254,10 +1338,7 @@ export default class LocusInfo extends EventsScope {
    */
   updateMeetingInfo(info: object, self?: object) {
     const roles = self ? SelfUtils.getRoles(self) : this.parsedLocus.self?.roles || [];
-    if (
-      (info && !isEqual(this.info, info)) ||
-      (roles.length && !isEqual(this.roles, roles) && info)
-    ) {
+    if ((info && !isEqual(this.info, info)) || (!isEqual(this.roles, roles) && info)) {
       const isJoined = SelfUtils.isJoined(self || this.parsedLocus.self);
       const parsedInfo = InfoUtils.getInfos(this.parsedLocus.info, info, roles, isJoined);
 
@@ -1660,10 +1741,11 @@ export default class LocusInfo extends EventsScope {
   /**
    * handles when the locus.url is updated
    * @param {String} url
+   * @param {Boolean} isMainLocus
    * @returns {undefined}
    * emits internal event locus_info_update_url
    */
-  updateLocusUrl(url: string) {
+  updateLocusUrl(url: string, isMainLocus = true) {
     if (url && this.url !== url) {
       this.url = url;
       this.updateMeeting({locusUrl: url});
@@ -1673,7 +1755,7 @@ export default class LocusInfo extends EventsScope {
           function: 'updateLocusUrl',
         },
         EVENTS.LOCUS_INFO_UPDATE_URL,
-        url
+        {url, isMainLocus}
       );
     }
   }

package/src/locus-info/parser.ts

@@ -728,13 +728,17 @@ export default class Parser {
         break;
 
       case USE_INCOMING:
-      case LOCUS_URL_CHANGED:
         // update working copy for future comparisons.
         // Note: The working copy of parser gets updated in .onFullLocus()
         // and here when USE_INCOMING or LOCUS_URL_CHANGED locus.
         this.workingCopy = newLoci;
         break;
 
+      case LOCUS_URL_CHANGED:
+        // clear the working copy completely, do a full locus sync
+        this.workingCopy = null;
+        break;
+
       case WAIT:
         // we've taken newLoci from the front of the queue, so put it back there as we have to wait
         // for the one that should be in front of it, before we can process it

package/src/media/properties.ts

@@ -9,9 +9,12 @@ import {
 
 import {parse} from '@webex/ts-sdp';
 import {ClientEvent} from '@webex/internal-plugin-metrics';
+import {throttle} from 'lodash';
+import Metrics from '../metrics';
 import {MEETINGS, QUALITY_LEVELS} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 import MediaConnectionAwaiter from './MediaConnectionAwaiter';
+import BEHAVIORAL_METRICS from '../metrics/constants';
 
 export type MediaDirection = {
   sendAudio: boolean;
@@ -41,6 +44,8 @@ export default class MediaProperties {
   videoDeviceId: any;
   videoStream?: LocalCameraStream;
   namespace = MEETINGS;
+  mediaIssueCounters: {[key: string]: number} = {};
+  throttledSendMediaIssueMetric: ReturnType<typeof throttle>;
 
   /**
    * @param {Object} [options] -- to auto construct
@@ -66,6 +71,15 @@ export default class MediaProperties {
     this.remoteQualityLevel = QUALITY_LEVELS.HIGH;
     this.mediaSettings = {};
     this.videoDeviceId = null;
+
+    this.throttledSendMediaIssueMetric = throttle((eventPayload) => {
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.MEDIA_ISSUE_DETECTED, {
+        ...eventPayload,
+      });
+      Object.keys(this.mediaIssueCounters).forEach((key) => {
+        this.mediaIssueCounters[key] = 0;
+      });
+    }, 1000 * 60 * 5); // at most once every 5 minutes
   }
 
   /**
@@ -139,8 +153,14 @@ export default class MediaProperties {
     this.videoDeviceId = deviceId;
   }
 
+  /**
+   * Clears the webrtcMediaConnection. This method should be called after
+   * peer connection is closed and no longer needed.
+   * @returns {void}
+   */
   unsetPeerConnection() {
     this.webrtcMediaConnection = null;
+    this.throttledSendMediaIssueMetric.flush();
   }
 
   /**
@@ -424,4 +444,27 @@ export default class MediaProperties {
       };
     }
   }
+
+  /**
+   * Sends a metric about a media issue. Metrics are throttled so that we don't
+   * send too many of them, but include a count so that we know how many issues
+   * were detected.
+   *
+   * @param {string} issueType
+   * @param {string} issueSubType
+   * @param {string} correlationId
+   * @returns {void}
+   */
+  public sendMediaIssueMetric(issueType: string, issueSubType: string, correlationId) {
+    const key = `${issueType}_${issueSubType}`;
+
+    const count = (this.mediaIssueCounters[key] || 0) + 1;
+
+    this.mediaIssueCounters[key] = count;
+
+    this.throttledSendMediaIssueMetric({
+      correlationId,
+      ...this.mediaIssueCounters,
+    });
+  }
 }

package/src/meeting/in-meeting-actions.ts

@@ -41,9 +41,12 @@ interface IInMeetingActions {
   isLocalRecordingStarted?: boolean;
   isLocalRecordingStopped?: boolean;
   isLocalRecordingPaused?: boolean;
+  isLocalStreamingStarted?: boolean;
+  isLocalStreamingStopped?: boolean;
 
   isManualCaptionActive?: boolean;
   isSaveTranscriptsEnabled?: boolean;
+  isSpokenLanguageAutoDetectionEnabled?: boolean;
   isWebexAssistantActive?: boolean;
   canViewCaptionPanel?: boolean;
   isRealTimeTranslationEnabled?: boolean;
@@ -91,6 +94,7 @@ interface IInMeetingActions {
   canDoVideo?: boolean;
   canAnnotate?: boolean;
   canUseVoip?: boolean;
+  showAutoEndMeetingWarning?: boolean;
   supportHQV?: boolean;
   supportHDV?: boolean;
   canShareWhiteBoard?: boolean;
@@ -185,8 +189,14 @@ export default class InMeetingActions implements IInMeetingActions {
 
   isManualCaptionActive = null;
 
+  isLocalStreamingStarted = null;
+
+  isLocalStreamingStopped = null;
+
   isSaveTranscriptsEnabled = null;
 
+  isSpokenLanguageAutoDetectionEnabled = null;
+
   isWebexAssistantActive = null;
 
   canViewCaptionPanel = null;
@@ -281,6 +291,8 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canUseVoip = null;
 
+  showAutoEndMeetingWarning = null;
+
   supportHQV = null;
 
   enforceVirtualBackground = null;
@@ -360,9 +372,12 @@ export default class InMeetingActions implements IInMeetingActions {
     isLocalRecordingStarted: this.isLocalRecordingStarted,
     isLocalRecordingStopped: this.isLocalRecordingStopped,
     isLocalRecordingPaused: this.isLocalRecordingPaused,
+    isLocalStreamingStarted: this.isLocalStreamingStarted,
+    isLocalStreamingStopped: this.isLocalStreamingStopped,
     canStopManualCaption: this.canStopManualCaption,
     isManualCaptionActive: this.isManualCaptionActive,
     isSaveTranscriptsEnabled: this.isSaveTranscriptsEnabled,
+    isSpokenLanguageAutoDetectionEnabled: this.isSpokenLanguageAutoDetectionEnabled,
     isWebexAssistantActive: this.isWebexAssistantActive,
     canViewCaptionPanel: this.canViewCaptionPanel,
     isRealTimeTranslationEnabled: this.isRealTimeTranslationEnabled,
@@ -401,6 +416,7 @@ export default class InMeetingActions implements IInMeetingActions {
     canShareFile: this.canShareFile,
     canShareApplication: this.canShareApplication,
     canShareCamera: this.canShareCamera,
+    showAutoEndMeetingWarning: this.showAutoEndMeetingWarning,
     canShareDesktop: this.canShareDesktop,
     canShareContent: this.canShareContent,
     canTransferFile: this.canTransferFile,