@webex/plugin-meetings 3.5.0 → 3.6.0-next.2

package/dist/types/constants.d.ts

@@ -714,7 +714,8 @@ export declare enum SELF_POLICY {
     SUPPORT_HQV = "supportHQV",
     SUPPORT_HDV = "supportHDV",
     SUPPORT_PARTICIPANT_LIST = "supportParticipantList",
-    SUPPORT_VOIP = "supportVoIP"
+    SUPPORT_VOIP = "supportVoIP",
+    SUPPORT_POLLING_AND_QA = "supportPollingAndQA"
 }
 export declare const DISPLAY_HINTS: {
     ADD_GUEST: string;

package/dist/types/meeting/in-meeting-actions.d.ts

@@ -79,6 +79,7 @@ interface IInMeetingActions {
     supportHDV?: boolean;
     canShareWhiteBoard?: boolean;
     enforceVirtualBackground?: boolean;
+    canPollingAndQA?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -158,6 +159,7 @@ export default class InMeetingActions implements IInMeetingActions {
     enforceVirtualBackground: any;
     supportHDV: any;
     canShareWhiteBoard: any;
+    canPollingAndQA: any;
     /**
      * Returns all meeting action options
      * @returns {Object}

package/dist/types/meeting/index.d.ts

@@ -67,6 +67,7 @@ export type AddMediaOptions = {
 };
 export type CallStateForMetrics = {
     correlationId?: string;
+    sessionCorrelationId?: string;
     joinTrigger?: string;
     loginType?: string;
 };
@@ -488,6 +489,16 @@ export default class Meeting extends StatelessWebexPlugin {
      * @param {string} correlationId
      */
     set correlationId(correlationId: string);
+    /**
+     * Getter - Returns callStateForMetrics.sessionCorrelationId
+     * @returns {string}
+     */
+    get sessionCorrelationId(): string;
+    /**
+     * Setter - sets callStateForMetrics.sessionCorrelationId
+     * @param {string} sessionCorrelationId
+     */
+    set sessionCorrelationId(sessionCorrelationId: string);
     /**
      * Getter - Returns isoLocalClientMeetingJoinTime
      * This will be set once on meeting join, and not updated again

package/dist/types/meetings/index.d.ts

@@ -2,6 +2,7 @@ import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
 import '@webex/internal-plugin-metrics';
 import { WebexPlugin } from '@webex/webex-core';
+import { DeviceRegistrationOptions } from '@webex/internal-plugin-device';
 import * as mediaHelpersModule from '@webex/media-helpers';
 import 'webrtc-adapter';
 import { DESTINATION_TYPE } from '../constants';
@@ -51,6 +52,26 @@ import { INoiseReductionEffect, IVirtualBackgroundEffect } from './meetings.type
  * @property {String} type what type of meeting it was
  * @memberof Meetings
  */
+/**
+ * Object containing only the most basic information about a meeting.
+ * This is the information that is kept even after the meeting is deleted from the MeetingCollection
+ */
+export type BasicMeetingInformation = {
+    allowMediaInLobby: boolean;
+    correlationId: string;
+    environment: string;
+    id: string;
+    locusUrl: string;
+    locusInfo: {
+        url: string;
+        fullState: {
+            lastActive: string;
+            sessionId: string;
+        };
+    };
+    meetingInfo: any;
+    sessionCorrelationId: string;
+};
 /**
  * Maintain a cache of meetings and sync with services.
  * @class
@@ -59,6 +80,7 @@ export default class Meetings extends WebexPlugin {
     loggerRequest: any;
     media: any;
     meetingCollection: any;
+    deletedMeetings: Map<string, BasicMeetingInformation>;
     personalMeetingRoom: any;
     preferredWebexSite: any;
     reachability: Reachability;
@@ -185,15 +207,25 @@ export default class Meetings extends WebexPlugin {
      * @returns {undefined}
      */
     private _toggleTlsReachability;
+    /**
+     * API to toggle backend ipv6 native support config, needs to be called before webex.meetings.register()
+     *
+     * @param {Boolean} newValue
+     * @private
+     * @memberof Meetings
+     * @returns {undefined}
+     */
+    private _toggleIpv6BackendNativeSupport;
     /**
      * Explicitly sets up the meetings plugin by registering
      * the device, connecting to mercury, and listening for locus events.
      *
+     * @param {DeviceRegistrationOptions} [deviceRegistrationOptions] - The options for registering the device (optional)
      * @returns {Promise}
      * @public
      * @memberof Meetings
      */
-    register(): Promise<void>;
+    register(deviceRegistrationOptions?: DeviceRegistrationOptions): Promise<any>;
     /**
      * Explicitly tears down the meetings plugin by deregistering
      * the device, disconnecting from mercury, and stops listening to locus events
@@ -281,6 +313,14 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     getPersonalMeetingRoom(): any;
+    /**
+     * Returns basic information about a meeting that exists or
+     * used to exist in the MeetingCollection
+     *
+     * @param {string} meetingId
+     * @returns {BasicMeetingInformation|undefined}
+     */
+    getBasicMeetingInformation(meetingId: string): BasicMeetingInformation;
     /**
      * @param {Meeting} meeting
      * @param {Object} reason
@@ -304,11 +344,12 @@ export default class Meetings extends WebexPlugin {
      * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
      * @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
      * @returns {Promise<Meeting>} A new Meeting.
      * @public
      * @memberof Meetings
      */
-    create(destination: string, type?: DESTINATION_TYPE, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any): any;
+    create(destination: string, type?: DESTINATION_TYPE, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any, sessionCorrelationId?: string): any;
     /**
      * Create meeting
      *

package/dist/webinar/index.js

@@ -62,7 +62,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
   updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
-  version: "3.5.0"
+  version: "3.6.0-next.2"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,13 +43,13 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.5.0",
-    "@webex/plugin-rooms": "3.5.0",
-    "@webex/test-helper-chai": "3.5.0",
-    "@webex/test-helper-mocha": "3.5.0",
-    "@webex/test-helper-mock-webex": "3.5.0",
-    "@webex/test-helper-retry": "3.5.0",
-    "@webex/test-helper-test-users": "3.5.0",
+    "@webex/plugin-meetings": "3.6.0-next.2",
+    "@webex/plugin-rooms": "3.5.0-next.23",
+    "@webex/test-helper-chai": "3.5.0-next.21",
+    "@webex/test-helper-mocha": "3.5.0-next.21",
+    "@webex/test-helper-mock-webex": "3.5.0-next.21",
+    "@webex/test-helper-retry": "3.5.0-next.21",
+    "@webex/test-helper-test-users": "3.5.0-next.21",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -61,21 +61,21 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.5.0",
-    "@webex/internal-media-core": "2.11.1",
-    "@webex/internal-plugin-conversation": "3.5.0",
-    "@webex/internal-plugin-device": "3.5.0",
-    "@webex/internal-plugin-llm": "3.5.0",
-    "@webex/internal-plugin-mercury": "3.5.0",
-    "@webex/internal-plugin-metrics": "3.5.0",
-    "@webex/internal-plugin-support": "3.5.0",
-    "@webex/internal-plugin-user": "3.5.0",
-    "@webex/internal-plugin-voicea": "3.5.0",
-    "@webex/media-helpers": "3.5.0",
-    "@webex/plugin-people": "3.5.0",
-    "@webex/plugin-rooms": "3.5.0",
+    "@webex/common": "3.5.0-next.21",
+    "@webex/internal-media-core": "2.11.3",
+    "@webex/internal-plugin-conversation": "3.5.0-next.23",
+    "@webex/internal-plugin-device": "3.5.0-next.21",
+    "@webex/internal-plugin-llm": "3.5.0-next.21",
+    "@webex/internal-plugin-mercury": "3.5.0-next.21",
+    "@webex/internal-plugin-metrics": "3.5.0-next.21",
+    "@webex/internal-plugin-support": "3.5.0-next.23",
+    "@webex/internal-plugin-user": "3.5.0-next.21",
+    "@webex/internal-plugin-voicea": "3.6.0-next.2",
+    "@webex/media-helpers": "3.5.0-next.22",
+    "@webex/plugin-people": "3.5.0-next.21",
+    "@webex/plugin-rooms": "3.5.0-next.23",
     "@webex/web-capabilities": "^1.4.0",
-    "@webex/webex-core": "3.5.0",
+    "@webex/webex-core": "3.5.0-next.21",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -91,5 +91,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.5.0"
+  "version": "3.6.0-next.2"
 }

package/src/config.ts

@@ -92,5 +92,8 @@ export default {
     degradationPreferences: {
       maxMacroblocksLimit: 8192,
     },
+    // This only applies to non-multistream meetings
+    iceCandidatesGatheringTimeout: undefined,
+    backendIpv6NativeSupport: false,
   },
 };

package/src/constants.ts

@@ -879,6 +879,7 @@ export enum SELF_POLICY {
   SUPPORT_HDV = 'supportHDV',
   SUPPORT_PARTICIPANT_LIST = 'supportParticipantList',
   SUPPORT_VOIP = 'supportVoIP',
+  SUPPORT_POLLING_AND_QA = 'supportPollingAndQA',
 }
 
 export const DISPLAY_HINTS = {

package/src/media/index.ts

@@ -15,12 +15,12 @@ import {
   LocalSystemAudioStream,
   LocalMicrophoneStream,
 } from '@webex/media-helpers';
+import {RtcMetrics} from '@webex/internal-plugin-metrics';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {MEDIA_TRACK_CONSTRAINT} from '../constants';
 import Config from '../config';
 import StaticConfig from '../common/config';
 import BrowserDetection from '../common/browser-detection';
-import RtcMetrics from '../rtcMetrics';
 
 const {isBrowser} = BrowserDetection();
 
@@ -144,6 +144,7 @@ Media.createMediaConnection = (
       password: string;
     };
     bundlePolicy?: BundlePolicy;
+    iceCandidatesTimeout?: number;
   }
 ) => {
   const {
@@ -154,6 +155,7 @@ Media.createMediaConnection = (
     enableExtmap,
     turnServerInfo,
     bundlePolicy,
+    iceCandidatesTimeout,
   } = options;
 
   const iceServers = [];
@@ -210,6 +212,7 @@ Media.createMediaConnection = (
   return new RoapMediaConnection(
     {
       iceServers,
+      iceCandidatesTimeout,
       skipInactiveTransceivers: false,
       requireH264: true,
       sdpMunging: {

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

@@ -82,6 +82,7 @@ interface IInMeetingActions {
   supportHDV?: boolean;
   canShareWhiteBoard?: boolean;
   enforceVirtualBackground?: boolean;
+  canPollingAndQA?: boolean;
 }
 
 /**
@@ -236,6 +237,7 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canShareWhiteBoard = null;
 
+  canPollingAndQA = null;
   /**
    * Returns all meeting action options
    * @returns {Object}
@@ -314,6 +316,7 @@ export default class InMeetingActions implements IInMeetingActions {
     supportHQV: this.supportHQV,
     supportHDV: this.supportHDV,
     canShareWhiteBoard: this.canShareWhiteBoard,
+    canPollingAndQA: this.canPollingAndQA,
   });
 
   /**

package/src/meeting/index.ts

@@ -10,6 +10,7 @@ import {
   ClientEventLeaveReason,
   CallDiagnosticUtils,
   CALL_DIAGNOSTIC_CONFIG,
+  RtcMetrics,
 } from '@webex/internal-plugin-metrics';
 import {ClientEvent as RawClientEvent} from '@webex/event-dictionary-ts';
 
@@ -155,7 +156,6 @@ import ControlsOptionsManager from '../controls-options-manager';
 import PermissionError from '../common/errors/permission';
 import {LocusMediaRequest} from './locusMediaRequest';
 import {ConnectionStateHandler, ConnectionStateEvent} from './connectionStateHandler';
-import RtcMetrics from '../rtcMetrics';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -227,6 +227,7 @@ export type AddMediaOptions = {
 
 export type CallStateForMetrics = {
   correlationId?: string;
+  sessionCorrelationId?: string;
   joinTrigger?: string;
   loginType?: string;
 };
@@ -742,12 +743,29 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.callStateForMetrics = attrs.callStateForMetrics || {};
     const correlationId = attrs.correlationId || attrs.callStateForMetrics?.correlationId;
+    const sessionCorrelationId =
+      attrs.sessionCorrelationId || attrs.callStateForMetrics?.sessionCorrelationId;
+    if (sessionCorrelationId) {
+      LoggerProxy.logger.log(
+        `Meetings:index#constructor --> Initializing the meeting object with session correlation id from app ${correlationId}`
+      );
+      this.callStateForMetrics.sessionCorrelationId = sessionCorrelationId;
+    } else {
+      LoggerProxy.logger.log(
+        `Meetings:index#constructor --> No session correlation id supplied. None will be generated and this field will remain blank`
+      );
+      // TODO: supply a session from the meetings instance
+      this.callStateForMetrics.sessionCorrelationId = '';
+    }
     if (correlationId) {
       LoggerProxy.logger.log(
         `Meetings:index#constructor --> Initializing the meeting object with correlation id from app ${correlationId}`
       );
       this.callStateForMetrics.correlationId = correlationId;
     } else {
+      LoggerProxy.logger.log(
+        `Meetings:index#constructor --> Initializing the meeting object with generated correlation id from sdk ${this.id}`
+      );
       this.callStateForMetrics.correlationId = this.id;
     }
     /**
@@ -1581,6 +1599,22 @@ export default class Meeting extends StatelessWebexPlugin {
     this.callStateForMetrics.correlationId = correlationId;
   }
 
+  /**
+   * Getter - Returns callStateForMetrics.sessionCorrelationId
+   * @returns {string}
+   */
+  get sessionCorrelationId() {
+    return this.callStateForMetrics.sessionCorrelationId;
+  }
+
+  /**
+   * Setter - sets callStateForMetrics.sessionCorrelationId
+   * @param {string} sessionCorrelationId
+   */
+  set sessionCorrelationId(sessionCorrelationId: string) {
+    this.callStateForMetrics.sessionCorrelationId = sessionCorrelationId;
+  }
+
   /**
    * Getter - Returns isoLocalClientMeetingJoinTime
    * This will be set once on meeting join, and not updated again
@@ -2705,6 +2739,9 @@ export default class Meeting extends StatelessWebexPlugin {
         newShareStatus = SHARE_STATUS.NO_SHARE;
       }
 
+      LoggerProxy.logger.info(
+        `Meeting:index#setUpLocusInfoMediaInactiveListener --> this.shareStatus=${this.shareStatus} newShareStatus=${newShareStatus}`
+      );
       if (newShareStatus !== this.shareStatus) {
         const oldShareStatus = this.shareStatus;
 
@@ -3792,6 +3829,10 @@ export default class Meeting extends StatelessWebexPlugin {
             requiredPolicies: [SELF_POLICY.SUPPORT_CHAT],
             policies: this.selfUserPolicies,
           }),
+          canPollingAndQA: ControlsOptionsUtil.hasPolicies({
+            requiredPolicies: [SELF_POLICY.SUPPORT_POLLING_AND_QA],
+            policies: this.selfUserPolicies,
+          }),
           canShareApplication:
             (ControlsOptionsUtil.hasHints({
               requiredHints: [DISPLAY_HINTS.SHARE_APPLICATION],
@@ -6338,7 +6379,7 @@ export default class Meeting extends StatelessWebexPlugin {
   private async createMediaConnection(turnServerInfo, bundlePolicy?: BundlePolicy) {
     this.rtcMetrics = this.isMultistream
       ? // @ts-ignore
-        new RtcMetrics(this.webex, this.id, this.correlationId)
+        new RtcMetrics(this.webex, {meetingId: this.id}, this.correlationId)
       : undefined;
 
     const mc = Media.createMediaConnection(
@@ -6355,6 +6396,8 @@ export default class Meeting extends StatelessWebexPlugin {
         enableExtmap: this.config.enableExtmap,
         turnServerInfo,
         bundlePolicy,
+        // @ts-ignore - config coming from registerPlugin
+        iceCandidatesTimeout: this.config.iceCandidatesGatheringTimeout,
       }
     );
 
@@ -8142,6 +8185,9 @@ export default class Meeting extends StatelessWebexPlugin {
    * @returns {undefined}
    */
   private handleShareAudioStreamEnded = async () => {
+    LoggerProxy.logger.info(
+      `Meeting:index#handleShareAudioStreamEnded --> audio share stream ended`
+    );
     // current share audio stream has ended, but there might be an active
     // share video stream. we only leave from wireless share if share has
     // completely ended, which means no share audio or video streams active
@@ -8184,6 +8230,9 @@ export default class Meeting extends StatelessWebexPlugin {
    * @returns {undefined}
    */
   private handleShareVideoStreamEnded = async () => {
+    LoggerProxy.logger.info(
+      `Meeting:index#handleShareVideoStreamEnded --> video share stream ended`
+    );
     // current share video stream has ended, but there might be an active
     // share audio stream. we only leave from wireless share if share has
     // completely ended, which means no share audio or video streams active
@@ -8672,6 +8721,9 @@ export default class Meeting extends StatelessWebexPlugin {
    * @returns {Promise}
    */
   async publishStreams(streams: LocalStreams): Promise<void> {
+    LoggerProxy.logger.info(
+      `Meeting:index#publishStreams --> called with: ${JSON.stringify(streams)}`
+    );
     this.checkMediaConnection();
     if (
       !streams.microphone &&
@@ -8753,6 +8805,9 @@ export default class Meeting extends StatelessWebexPlugin {
    * @returns {Promise}
    */
   async unpublishStreams(streams: LocalStream[]): Promise<void> {
+    LoggerProxy.logger.info(
+      `Meeting:index#unpublishStreams --> called with: ${JSON.stringify(streams)}`
+    );
     this.checkMediaConnection();
 
     const promises = [];

package/src/meeting/util.ts

@@ -89,8 +89,12 @@ const MeetingUtil = {
   getIpVersion(webex: any): IP_VERSION | undefined {
     const {supportsIpV4, supportsIpV6} = webex.internal.device.ipNetworkDetector;
 
-    if (BrowserDetection().isBrowser('firefox')) {
-      // our ipv6 solution relies on FQDN ICE candidates, but Firefox doesn't support them,
+    if (
+      !webex.config.meetings.backendIpv6NativeSupport &&
+      BrowserDetection().isBrowser('firefox')
+    ) {
+      // when backend doesn't support native ipv6,
+      // then our NAT64/DNS64 based solution relies on FQDN ICE candidates, but Firefox doesn't support them,
       // see https://bugzilla.mozilla.org/show_bug.cgi?id=1713128
       // so for Firefox we don't want the backend to activate the "ipv6 feature"
       return undefined;
@@ -150,7 +154,9 @@ const MeetingUtil = {
         ipVersion: MeetingUtil.getIpVersion(meeting.getWebexObject()),
       })
       .then((res) => {
-        // @ts-ignore
+        const parsed = MeetingUtil.parseLocusJoin(res);
+        meeting.setLocus(parsed);
+
         webex.internal.newMetrics.submitClientEvent({
           name: 'client.locus.join.response',
           payload: {
@@ -161,11 +167,11 @@ const MeetingUtil = {
           },
           options: {
             meetingId: meeting.id,
-            mediaConnections: res.body.mediaConnections,
+            mediaConnections: parsed.mediaConnections,
           },
         });
 
-        return MeetingUtil.parseLocusJoin(res);
+        return parsed;
       });
   },
 
@@ -313,34 +319,24 @@ const MeetingUtil = {
     }
 
     // normal join meeting, scenario A, D
-    return MeetingUtil.joinMeeting(meeting, options)
-      .then((response) => {
-        meeting.setLocus(response);
-
-        return Promise.resolve(response);
-      })
-      .catch((err) => {
-        // joining a claimed PMR that is not my own, scenario B
-        if (MeetingUtil.isPinOrGuest(err)) {
-          // @ts-ignore
-          webex.internal.newMetrics.submitClientEvent({
-            name: 'client.pin.prompt',
-            options: {
-              meetingId: meeting.id,
-            },
-          });
+    return MeetingUtil.joinMeeting(meeting, options).catch((err) => {
+      // joining a claimed PMR that is not my own, scenario B
+      if (MeetingUtil.isPinOrGuest(err)) {
+        webex.internal.newMetrics.submitClientEvent({
+          name: 'client.pin.prompt',
+          options: {
+            meetingId: meeting.id,
+          },
+        });
 
-          // request host pin or non host for unclaimed PMR, start of Scenario C
-          // see https://sqbu-github.cisco.com/WebExSquared/locus/wiki/Locus-Lobby-and--IVR-Feature
-          return Promise.reject(new IntentToJoinError('Error Joining Meeting', err));
-        }
-        LoggerProxy.logger.error(
-          'Meeting:util#joinMeetingOptions --> Error joining the call, ',
-          err
-        );
+        // request host pin or non host for unclaimed PMR, start of Scenario C
+        // see https://sqbu-github.cisco.com/WebExSquared/locus/wiki/Locus-Lobby-and--IVR-Feature
+        return Promise.reject(new IntentToJoinError('Error Joining Meeting', err));
+      }
+      LoggerProxy.logger.error('Meeting:util#joinMeetingOptions --> Error joining the call, ', err);
 
-        return Promise.reject(new JoinMeetingError(options, 'Error Joining Meeting', err));
-      });
+      return Promise.reject(new JoinMeetingError(options, 'Error Joining Meeting', err));
+    });
   },
 
   /**