@webex/plugin-meetings 3.0.0-beta.307 → 3.0.0-beta.308

package/dist/types/constants.d.ts

@@ -1,3 +1,4 @@
+type Enum<T extends Record<string, unknown>> = T[keyof T];
 export declare const AUDIO = "audio";
 export declare const AUDIO_STATUS = "audioStatus";
 export declare const ALERT = "alert";
@@ -866,10 +867,11 @@ export declare const MediaContent: {
     slides: string;
 };
 export declare const NETWORK_STATUS: {
-    DISCONNECTED: string;
-    RECONNECTING: string;
-    CONNECTED: string;
+    readonly DISCONNECTED: "DISCONNECTED";
+    readonly RECONNECTING: "RECONNECTING";
+    readonly CONNECTED: "CONNECTED";
 };
+export type NETWORK_STATUS = Enum<typeof NETWORK_STATUS>;
 export declare const NETWORK_TYPE: {
     VPN: string;
     UNKNOWN: string;
@@ -1061,6 +1063,7 @@ export declare const IP_VERSION: {
     readonly only_ipv6: 6;
     readonly ipv4_and_ipv6: 1;
 };
-export type IP_VERSION = (typeof IP_VERSION)[keyof typeof IP_VERSION];
+export type IP_VERSION = Enum<typeof IP_VERSION>;
 export declare const MEETING_PERMISSION_TOKEN_REFRESH_THRESHOLD_IN_SEC = 30;
 export declare const MEETING_PERMISSION_TOKEN_REFRESH_REASON = "ttl-join";
+export {};

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

@@ -11,6 +11,7 @@ import ReconnectionManager from '../reconnection-manager';
 import MeetingRequest from './request';
 import Members from '../members/index';
 import Transcription from '../transcription';
+import { NETWORK_STATUS } from '../constants';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
 import { Configuration as RemoteMediaManagerConfiguration, RemoteMediaManager } from '../multistream/remoteMediaManager';
@@ -358,7 +359,7 @@ export default class Meeting extends StatelessWebexPlugin {
     meetingInfoFailureCode?: number;
     meetingInfoExtraParams?: Record<string, any>;
     networkQualityMonitor: NetworkQualityMonitor;
-    networkStatus: string;
+    networkStatus?: NETWORK_STATUS;
     passwordStatus: string;
     queuedMediaUpdates: any[];
     recording: any;
@@ -533,7 +534,7 @@ export default class Meeting extends StatelessWebexPlugin {
     private setUpLocusFullStateListener;
     /**
      * sets the network status on meeting object
-     * @param {String} networkStatus
+     * @param {NETWORK_STATUS} networkStatus
      * @private
      * @returns {undefined}
      * @memberof 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.0.0-beta.307"
+  version: "3.0.0-beta.308"
 });
 var _default = Webinar;
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.307",
+  "version": "3.0.0-beta.308",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.307",
-    "@webex/test-helper-chai": "3.0.0-beta.307",
-    "@webex/test-helper-mocha": "3.0.0-beta.307",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.307",
-    "@webex/test-helper-retry": "3.0.0-beta.307",
-    "@webex/test-helper-test-users": "3.0.0-beta.307",
+    "@webex/plugin-meetings": "3.0.0-beta.308",
+    "@webex/test-helper-chai": "3.0.0-beta.308",
+    "@webex/test-helper-mocha": "3.0.0-beta.308",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.308",
+    "@webex/test-helper-retry": "3.0.0-beta.308",
+    "@webex/test-helper-test-users": "3.0.0-beta.308",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.307",
+    "@webex/common": "3.0.0-beta.308",
     "@webex/internal-media-core": "2.2.1",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.307",
-    "@webex/internal-plugin-device": "3.0.0-beta.307",
-    "@webex/internal-plugin-llm": "3.0.0-beta.307",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.307",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.307",
-    "@webex/internal-plugin-support": "3.0.0-beta.307",
-    "@webex/internal-plugin-user": "3.0.0-beta.307",
-    "@webex/media-helpers": "3.0.0-beta.307",
-    "@webex/plugin-people": "3.0.0-beta.307",
-    "@webex/plugin-rooms": "3.0.0-beta.307",
-    "@webex/webex-core": "3.0.0-beta.307",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.308",
+    "@webex/internal-plugin-device": "3.0.0-beta.308",
+    "@webex/internal-plugin-llm": "3.0.0-beta.308",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.308",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.308",
+    "@webex/internal-plugin-support": "3.0.0-beta.308",
+    "@webex/internal-plugin-user": "3.0.0-beta.308",
+    "@webex/media-helpers": "3.0.0-beta.308",
+    "@webex/plugin-people": "3.0.0-beta.308",
+    "@webex/plugin-rooms": "3.0.0-beta.308",
+    "@webex/webex-core": "3.0.0-beta.308",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -1,6 +1,8 @@
 // @ts-ignore
 import {hydraTypes} from '@webex/common';
 
+type Enum<T extends Record<string, unknown>> = T[keyof T];
+
 // *********** LOWERCASE / CAMELCASE STRINGS ************
 
 export const AUDIO = 'audio';
@@ -1070,7 +1072,9 @@ export const NETWORK_STATUS = {
   DISCONNECTED: 'DISCONNECTED',
   RECONNECTING: 'RECONNECTING',
   CONNECTED: 'CONNECTED',
-};
+} as const;
+
+export type NETWORK_STATUS = Enum<typeof NETWORK_STATUS>;
 
 export const NETWORK_TYPE = {
   VPN: 'vpn',
@@ -1286,7 +1290,7 @@ export const IP_VERSION = {
   ipv4_and_ipv6: 1,
 } as const;
 
-export type IP_VERSION = (typeof IP_VERSION)[keyof typeof IP_VERSION];
+export type IP_VERSION = Enum<typeof IP_VERSION>;
 
 // constant for if the permissionToken is about to expire in the next 30 seconds, refresh it
 export const MEETING_PERMISSION_TOKEN_REFRESH_THRESHOLD_IN_SEC = 30;

package/src/meeting/index.ts

@@ -528,7 +528,7 @@ export default class Meeting extends StatelessWebexPlugin {
   meetingInfoFailureCode?: number;
   meetingInfoExtraParams?: Record<string, any>;
   networkQualityMonitor: NetworkQualityMonitor;
-  networkStatus: string;
+  networkStatus?: NETWORK_STATUS;
   passwordStatus: string;
   queuedMediaUpdates: any[];
   recording: any;
@@ -1095,13 +1095,14 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.networkQualityMonitor = null;
     /**
+     * Indicates network status of the webrtc media connection
      * @instance
      * @type {String}
      * @readonly
      * @public
      * @memberof Meeting
      */
-    this.networkStatus = null;
+    this.networkStatus = undefined;
     /**
      * Passing only info as we send basic info for meeting added event
      * @instance
@@ -1927,12 +1928,12 @@ export default class Meeting extends StatelessWebexPlugin {
 
   /**
    * sets the network status on meeting object
-   * @param {String} networkStatus
+   * @param {NETWORK_STATUS} networkStatus
    * @private
    * @returns {undefined}
    * @memberof Meeting
    */
-  private setNetworkStatus(networkStatus: string) {
+  private setNetworkStatus(networkStatus?: NETWORK_STATUS) {
     if (networkStatus === NETWORK_STATUS.DISCONNECTED) {
       Trigger.trigger(
         this,
@@ -3907,6 +3908,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.receiveSlotManager.reset();
       this.mediaProperties.webrtcMediaConnection.close();
       this.sendSlotManager.reset();
+      this.setNetworkStatus(undefined);
     }
 
     this.audio = null;
@@ -5445,6 +5447,10 @@ export default class Meeting extends StatelessWebexPlugin {
           // @ts-ignore
           this.webex.internal.newMetrics.submitClientEvent({
             name: 'client.ice.end',
+            payload: {
+              canProceed: true,
+              icePhase: !this.networkStatus ? 'JOIN_MEETING_FINAL' : 'IN_MEETING',
+            },
             options: {
               meetingId: this.id,
             },

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

@@ -5633,10 +5633,13 @@ describe('plugin-meetings', () => {
         });
 
         describe('submitClientEvent on connectionSuccess', () => {
-          it('sends client.ice.end when connectionSuccess on CONNECTION_STATE_CHANGED event', () => {
+          let setNetworkStatusSpy;
+
+          const setupSpies = () => {
+            setNetworkStatusSpy = sinon.spy(meeting, 'setNetworkStatus');
+
             meeting.reconnectionManager = new ReconnectionManager(meeting);
             meeting.reconnectionManager.iceReconnected = sinon.stub().returns(undefined);
-            meeting.setNetworkStatus = sinon.stub().returns(undefined);
             meeting.statsAnalyzer = {startAnalyzer: sinon.stub()};
             meeting.mediaProperties.webrtcMediaConnection = {
               // mock the on() method and store all the listeners
@@ -5644,17 +5647,19 @@ describe('plugin-meetings', () => {
                 eventListeners[event] = listener;
               }),
             };
+          };
 
-            meeting.setupMediaConnectionListeners();
-            eventListeners[Event.CONNECTION_STATE_CHANGED]({
-              state: 'Connected',
-            });
+          const checkExpectedSpies = (expected) => {
             assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
             assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
               name: 'client.ice.end',
               options: {
                 meetingId: meeting.id,
               },
+              payload: {
+                canProceed: true,
+                icePhase: expected.icePhase,
+              },
             });
             assert.calledOnce(Metrics.sendBehavioralMetric);
             assert.calledWith(Metrics.sendBehavioralMetric, BEHAVIORAL_METRICS.CONNECTION_SUCCESS, {
@@ -5662,14 +5667,54 @@ describe('plugin-meetings', () => {
               locus_id: meeting.locusId,
               latency: undefined,
             });
-            assert.calledOnce(meeting.setNetworkStatus);
-            assert.calledWith(meeting.setNetworkStatus, NETWORK_STATUS.CONNECTED);
+            assert.deepEqual(
+              setNetworkStatusSpy.getCalls().map((call) => call.args[0]),
+              expected.setNetworkStatusCallParams
+            );
             assert.calledOnce(meeting.reconnectionManager.iceReconnected);
             assert.calledOnce(meeting.statsAnalyzer.startAnalyzer);
             assert.calledWith(
               meeting.statsAnalyzer.startAnalyzer,
               meeting.mediaProperties.webrtcMediaConnection
             );
+          };
+
+          const resetSpies = () => {
+            setNetworkStatusSpy.resetHistory();
+            webex.internal.newMetrics.submitClientEvent.resetHistory();
+            Metrics.sendBehavioralMetric.resetHistory();
+            meeting.reconnectionManager.iceReconnected.resetHistory();
+            meeting.statsAnalyzer.startAnalyzer.resetHistory();
+          };
+
+          it('sends client.ice.end with the correct icePhase when we get ConnectionState.Connected on CONNECTION_STATE_CHANGED event', () => {
+            setupSpies();
+
+            meeting.setupMediaConnectionListeners();
+
+            // simulate first connection success
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Connected',
+            });
+            checkExpectedSpies({
+              icePhase: 'JOIN_MEETING_FINAL',
+              setNetworkStatusCallParams: [NETWORK_STATUS.CONNECTED],
+            });
+
+            // now simulate short connection loss, the 2nd client.ice.end should have a different icePhase
+            resetSpies();
+
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Disconnected',
+            });
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Connected',
+            });
+
+            checkExpectedSpies({
+              icePhase: 'IN_MEETING',
+              setNetworkStatusCallParams: [NETWORK_STATUS.DISCONNECTED, NETWORK_STATUS.CONNECTED],
+            });
           });
         });
 
@@ -6931,12 +6976,14 @@ describe('plugin-meetings', () => {
       });
       describe('#closePeerConnections', () => {
         it('should close the webrtc media connection, and return a promise', async () => {
+          const setNetworkStatusSpy = sinon.spy(meeting, 'setNetworkStatus');
           meeting.mediaProperties.webrtcMediaConnection = {close: sinon.stub()};
           const pcs = meeting.closePeerConnections();
 
           assert.exists(pcs.then);
           await pcs;
           assert.calledOnce(meeting.mediaProperties.webrtcMediaConnection.close);
+          assert.calledOnceWithExactly(setNetworkStatusSpy, undefined);
         });
       });
       describe('#unsetPeerConnections', () => {