@webex/plugin-meetings 3.0.0-beta.320 → 3.0.0-beta.321

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.320"
+  version: "3.0.0-beta.321"
 });
 var _default = Webinar;
 exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.320",
+  "version": "3.0.0-beta.321",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -33,12 +33,12 @@
   },
   "devDependencies": {
     "@peculiar/webcrypto": "^1.4.3",
-    "@webex/plugin-meetings": "3.0.0-beta.320",
-    "@webex/test-helper-chai": "3.0.0-beta.320",
-    "@webex/test-helper-mocha": "3.0.0-beta.320",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.320",
-    "@webex/test-helper-retry": "3.0.0-beta.320",
-    "@webex/test-helper-test-users": "3.0.0-beta.320",
+    "@webex/plugin-meetings": "3.0.0-beta.321",
+    "@webex/test-helper-chai": "3.0.0-beta.321",
+    "@webex/test-helper-mocha": "3.0.0-beta.321",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.321",
+    "@webex/test-helper-retry": "3.0.0-beta.321",
+    "@webex/test-helper-test-users": "3.0.0-beta.321",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -47,19 +47,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.320",
+    "@webex/common": "3.0.0-beta.321",
     "@webex/internal-media-core": "2.2.2",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.320",
-    "@webex/internal-plugin-device": "3.0.0-beta.320",
-    "@webex/internal-plugin-llm": "3.0.0-beta.320",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.320",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.320",
-    "@webex/internal-plugin-support": "3.0.0-beta.320",
-    "@webex/internal-plugin-user": "3.0.0-beta.320",
-    "@webex/media-helpers": "3.0.0-beta.320",
-    "@webex/plugin-people": "3.0.0-beta.320",
-    "@webex/plugin-rooms": "3.0.0-beta.320",
-    "@webex/webex-core": "3.0.0-beta.320",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.321",
+    "@webex/internal-plugin-device": "3.0.0-beta.321",
+    "@webex/internal-plugin-llm": "3.0.0-beta.321",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.321",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.321",
+    "@webex/internal-plugin-support": "3.0.0-beta.321",
+    "@webex/internal-plugin-user": "3.0.0-beta.321",
+    "@webex/media-helpers": "3.0.0-beta.321",
+    "@webex/plugin-people": "3.0.0-beta.321",
+    "@webex/plugin-rooms": "3.0.0-beta.321",
+    "@webex/webex-core": "3.0.0-beta.321",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/meeting/index.ts

@@ -9,7 +9,6 @@ import {
   ClientEvent,
   ClientEventLeaveReason,
   CallDiagnosticUtils,
-  CALL_DIAGNOSTIC_CONFIG,
 } from '@webex/internal-plugin-metrics';
 import {
   ConnectionState,
@@ -5421,25 +5420,6 @@ export default class Meeting extends StatelessWebexPlugin {
           this.reconnectionManager.resetReconnectionTimer();
 
           this.reconnect({networkDisconnect: true});
-          // @ts-ignore
-          this.webex.internal.newMetrics.submitClientEvent({
-            name: 'client.ice.end',
-            payload: {
-              canProceed: false,
-              icePhase: 'IN_MEETING',
-              errors: [
-                // @ts-ignore
-                this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode(
-                  {
-                    clientErrorCode: CALL_DIAGNOSTIC_CONFIG.ICE_FAILURE_CLIENT_CODE,
-                  }
-                ),
-              ],
-            },
-            options: {
-              meetingId: this.id,
-            },
-          });
 
           this.uploadLogs({
             file: 'peer-connection-manager/index',
@@ -5457,26 +5437,32 @@ export default class Meeting extends StatelessWebexPlugin {
 
       switch (event.state) {
         case ConnectionState.Connecting:
-          // @ts-ignore
-          this.webex.internal.newMetrics.submitClientEvent({
-            name: 'client.ice.start',
-            options: {
-              meetingId: this.id,
-            },
-          });
+          if (!this.hasMediaConnectionConnectedAtLeastOnce) {
+            // Only send CA event for join flow if we haven't successfully connected media yet
+            // @ts-ignore
+            this.webex.internal.newMetrics.submitClientEvent({
+              name: 'client.ice.start',
+              options: {
+                meetingId: this.id,
+              },
+            });
+          }
           break;
         case ConnectionState.Connected:
-          // @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,
-            },
-          });
+          if (!this.hasMediaConnectionConnectedAtLeastOnce) {
+            // Only send CA event for join flow if we haven't successfully connected media yet
+            // @ts-ignore
+            this.webex.internal.newMetrics.submitClientEvent({
+              name: 'client.ice.end',
+              payload: {
+                canProceed: true,
+                icePhase: 'JOIN_MEETING_FINAL',
+              },
+              options: {
+                meetingId: this.id,
+              },
+            });
+          }
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.CONNECTION_SUCCESS, {
             correlation_id: this.correlationId,
             locus_id: this.locusId,
@@ -5790,36 +5776,42 @@ export default class Meeting extends StatelessWebexPlugin {
     try {
       await this.mediaProperties.waitForMediaConnectionConnected();
     } catch (error) {
-      // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent({
-        name: 'client.ice.end',
-        payload: {
-          canProceed: !this.turnServerUsed, // If we haven't done turn tls retry yet we will proceed with join attempt
-          icePhase: this.turnServerUsed ? 'JOIN_MEETING_FINAL' : 'JOIN_MEETING_RETRY',
-          errors: [
-            // @ts-ignore
-            this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode({
-              clientErrorCode: CallDiagnosticUtils.generateClientErrorCodeForIceFailure({
-                signalingState:
-                  this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
-                    ?.signalingState ||
-                  this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc?.signalingState ||
-                  'unknown',
-                iceConnectionState:
-                  this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
-                    ?.iceConnectionState ||
-                  this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc
-                    ?.iceConnectionState ||
-                  'unknown',
-                turnServerUsed: this.turnServerUsed,
-              }),
-            }),
-          ],
-        },
-        options: {
-          meetingId: this.id,
-        },
-      });
+      if (!this.hasMediaConnectionConnectedAtLeastOnce) {
+        // Only send CA event for join flow if we haven't successfully connected media yet
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.ice.end',
+          payload: {
+            canProceed: !this.turnServerUsed, // If we haven't done turn tls retry yet we will proceed with join attempt
+            icePhase: this.turnServerUsed ? 'JOIN_MEETING_FINAL' : 'JOIN_MEETING_RETRY',
+            errors: [
+              // @ts-ignore
+              this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode(
+                {
+                  clientErrorCode: CallDiagnosticUtils.generateClientErrorCodeForIceFailure({
+                    signalingState:
+                      this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
+                        ?.signalingState ||
+                      this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc
+                        ?.signalingState ||
+                      'unknown',
+                    iceConnectionState:
+                      this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
+                        ?.iceConnectionState ||
+                      this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc
+                        ?.iceConnectionState ||
+                      'unknown',
+                    turnServerUsed: this.turnServerUsed,
+                  }),
+                }
+              ),
+            ],
+          },
+          options: {
+            meetingId: this.id,
+          },
+        });
+      }
       throw new Error(
         `Timed out waiting for media connection to be connected, correlationId=${this.correlationId}`
       );

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

@@ -5691,11 +5691,23 @@ describe('plugin-meetings', () => {
         });
 
         describe('CONNECTION_STATE_CHANGED event when state = "Connecting"', () => {
-          it('sends client.ice.start correctly', () => {
+          it('sends client.ice.start correctly when hasMediaConnectionConnectedAtLeastOnce = true', () => {
+            meeting.hasMediaConnectionConnectedAtLeastOnce = true;
+            meeting.setupMediaConnectionListeners();
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Connecting',
+            });
+
+            assert.notCalled(webex.internal.newMetrics.submitClientEvent);
+          })
+
+          it('sends client.ice.start correctly when hasMediaConnectionConnectedAtLeastOnce = false', () => {
+            meeting.hasMediaConnectionConnectedAtLeastOnce = false;
             meeting.setupMediaConnectionListeners();
             eventListeners[Event.CONNECTION_STATE_CHANGED]({
               state: 'Connecting',
             });
+
             assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
             assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
               name: 'client.ice.start',
@@ -5724,17 +5736,21 @@ describe('plugin-meetings', () => {
           };
 
           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,
-              },
-            });
+            if (expected.icePhase) {
+              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,
+                },
+              });
+            } else {
+              assert.notCalled(webex.internal.newMetrics.submitClientEvent);
+            }
             assert.calledOnce(Metrics.sendBehavioralMetric);
             assert.calledWith(Metrics.sendBehavioralMetric, BEHAVIORAL_METRICS.CONNECTION_SUCCESS, {
               correlation_id: meeting.correlationId,
@@ -5776,8 +5792,9 @@ describe('plugin-meetings', () => {
               icePhase: 'JOIN_MEETING_FINAL',
               setNetworkStatusCallParams: [NETWORK_STATUS.CONNECTED],
             });
+            assert.equal(meeting.hasMediaConnectionConnectedAtLeastOnce, true);
 
-            // now simulate short connection loss, the 2nd client.ice.end should have a different icePhase
+            // now simulate short connection loss, client.ice.end is not sent a second time as hasMediaConnectionConnectedAtLeastOnce = true
             resetSpies();
 
             eventListeners[Event.CONNECTION_STATE_CHANGED]({
@@ -5788,11 +5805,17 @@ describe('plugin-meetings', () => {
             });
 
             checkExpectedSpies({
-              icePhase: 'IN_MEETING',
               setNetworkStatusCallParams: [NETWORK_STATUS.DISCONNECTED, NETWORK_STATUS.CONNECTED],
             });
 
-            assert.equal(meeting.hasMediaConnectionConnectedAtLeastOnce, true);
+            resetSpies();
+
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Disconnected',
+            });
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Connected',
+            });
           });
         });
 
@@ -5864,19 +5887,7 @@ describe('plugin-meetings', () => {
             assert.calledOnce(meeting.setNetworkStatus);
             assert.calledWith(meeting.setNetworkStatus, NETWORK_STATUS.DISCONNECTED);
             assert.calledOnce(meeting.reconnectionManager.waitForIceReconnect);
-            assert.calledOnce(getErrorPayloadForClientErrorCodeStub);
-            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
-            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
-              name: 'client.ice.end',
-              payload: {
-                canProceed: false,
-                icePhase: 'IN_MEETING',
-                errors: [FAKE_ERROR],
-              },
-              options: {
-                meetingId: meeting.id,
-              },
-            });
+            assert.notCalled(webex.internal.newMetrics.submitClientEvent);
             checkBehavioralMetricSent(true);
           });
 
@@ -5891,6 +5902,7 @@ describe('plugin-meetings', () => {
             assert.calledOnce(meeting.setNetworkStatus);
             assert.calledWith(meeting.setNetworkStatus, NETWORK_STATUS.DISCONNECTED);
             assert.calledOnce(meeting.reconnectionManager.waitForIceReconnect);
+            assert.notCalled(webex.internal.newMetrics.submitClientEvent);
             checkBehavioralMetricSent();
           });
         });
@@ -5923,32 +5935,16 @@ describe('plugin-meetings', () => {
 
             mockFailedEvent();
 
-            checkBehavioralMetricSent();
             assert.notCalled(webex.internal.newMetrics.submitClientEvent);
+            checkBehavioralMetricSent();
           });
 
           it('handles "Failed" state correctly when hasMediaConnectionConnectedAtLeastOnce = true', async () => {
-            const FAKE_ERROR = {fatal: true};
-            const getErrorPayloadForClientErrorCodeStub = webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode = sinon
-              .stub()
-              .returns(FAKE_ERROR);
             meeting.hasMediaConnectionConnectedAtLeastOnce = true;
 
             mockFailedEvent();
 
-            assert.calledOnceWithExactly(getErrorPayloadForClientErrorCodeStub, {clientErrorCode: 2004});
-            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
-            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
-              name: 'client.ice.end',
-              payload: {
-                canProceed: false,
-                icePhase: 'IN_MEETING',
-                errors: [FAKE_ERROR],
-              },
-              options: {
-                meetingId: meeting.id,
-              },
-            });
+            assert.notCalled(webex.internal.newMetrics.submitClientEvent);
             checkBehavioralMetricSent(true);
           });
         });
@@ -5960,6 +5956,8 @@ describe('plugin-meetings', () => {
 
           beforeEach(() => {
             meeting.setupMediaConnectionListeners();
+            webex.internal.newMetrics.submitClientEvent.resetHistory();
+            Metrics.sendBehavioralMetric.resetHistory();
           });
 
           const checkMetricSent = (event, error) => {