@webex/plugin-meetings 3.8.0-next.61 → 3.8.0-next.63

package/dist/types/media/properties.d.ts

@@ -1,4 +1,5 @@
 import { LocalCameraStream, LocalMicrophoneStream, LocalDisplayStream, LocalSystemAudioStream, RemoteStream } from '@webex/media-helpers';
+import { ClientEvent } from '@webex/internal-plugin-metrics';
 export type MediaDirection = {
     sendAudio: boolean;
     sendVideo: boolean;
@@ -7,6 +8,7 @@ export type MediaDirection = {
     receiveVideo: boolean;
     receiveShare: boolean;
 };
+export type IPVersion = ClientEvent['payload']['ipVersion'];
 /**
  * @class MediaProperties
  */
@@ -94,6 +96,18 @@ export default class MediaProperties {
      * @returns {Object}
      */
     private getTransportInfo;
+    /**
+     * Checks if the given IP address is IPv6
+     * @param {string} ip address to check
+     * @returns {boolean} true if the address is IPv6, false otherwise
+     */
+    private isIPv6;
+    /** Finds out if we connected using IPv4 or IPv6
+     * @param {RTCPeerConnection} webrtcMediaConnection
+     * @param {Array<any>} allStatsReports array of RTC stats reports
+     * @returns {string} IPVersion
+     */
+    private getConnectionIpVersion;
     /**
      * Returns the type of a connection that has been established
      * It should be 'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'
@@ -111,6 +125,7 @@ export default class MediaProperties {
      */
     getCurrentConnectionInfo(): Promise<{
         connectionType: string;
+        ipVersion?: IPVersion;
         selectedCandidatePairChanges: number;
         numTransports: number;
     }>;

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.0-next.61"
+  version: "3.8.0-next.63"
 });
 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.8.0-next.61",
-    "@webex/plugin-rooms": "3.8.0-next.21",
-    "@webex/test-helper-chai": "3.8.0-next.17",
-    "@webex/test-helper-mocha": "3.8.0-next.17",
-    "@webex/test-helper-mock-webex": "3.8.0-next.17",
-    "@webex/test-helper-retry": "3.8.0-next.17",
-    "@webex/test-helper-test-users": "3.8.0-next.17",
+    "@webex/plugin-meetings": "3.8.0-next.63",
+    "@webex/plugin-rooms": "3.8.0-next.22",
+    "@webex/test-helper-chai": "3.8.0-next.18",
+    "@webex/test-helper-mocha": "3.8.0-next.18",
+    "@webex/test-helper-mock-webex": "3.8.0-next.18",
+    "@webex/test-helper-retry": "3.8.0-next.18",
+    "@webex/test-helper-test-users": "3.8.0-next.18",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -61,22 +61,23 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.0-next.17",
+    "@webex/common": "3.8.0-next.18",
     "@webex/event-dictionary-ts": "^1.0.1753",
     "@webex/internal-media-core": "2.16.0",
-    "@webex/internal-plugin-conversation": "3.8.0-next.21",
-    "@webex/internal-plugin-device": "3.8.0-next.17",
-    "@webex/internal-plugin-llm": "3.8.0-next.20",
-    "@webex/internal-plugin-mercury": "3.8.0-next.19",
-    "@webex/internal-plugin-metrics": "3.8.0-next.17",
-    "@webex/internal-plugin-support": "3.8.0-next.21",
-    "@webex/internal-plugin-user": "3.8.0-next.17",
-    "@webex/internal-plugin-voicea": "3.8.0-next.61",
-    "@webex/media-helpers": "3.8.0-next.21",
-    "@webex/plugin-people": "3.8.0-next.19",
-    "@webex/plugin-rooms": "3.8.0-next.21",
+    "@webex/internal-plugin-conversation": "3.8.0-next.22",
+    "@webex/internal-plugin-device": "3.8.0-next.18",
+    "@webex/internal-plugin-llm": "3.8.0-next.21",
+    "@webex/internal-plugin-mercury": "3.8.0-next.20",
+    "@webex/internal-plugin-metrics": "3.8.0-next.18",
+    "@webex/internal-plugin-support": "3.8.0-next.22",
+    "@webex/internal-plugin-user": "3.8.0-next.18",
+    "@webex/internal-plugin-voicea": "3.8.0-next.63",
+    "@webex/media-helpers": "3.8.0-next.22",
+    "@webex/plugin-people": "3.8.0-next.20",
+    "@webex/plugin-rooms": "3.8.0-next.22",
+    "@webex/ts-sdp": "^1.8.1",
     "@webex/web-capabilities": "^1.4.0",
-    "@webex/webex-core": "3.8.0-next.17",
+    "@webex/webex-core": "3.8.0-next.18",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -92,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.61"
+  "version": "3.8.0-next.63"
 }

package/src/media/properties.ts

@@ -7,6 +7,8 @@ import {
   RemoteStream,
 } from '@webex/media-helpers';
 
+import {parse} from '@webex/ts-sdp';
+import {ClientEvent} from '@webex/internal-plugin-metrics';
 import {MEETINGS, QUALITY_LEVELS} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 import MediaConnectionAwaiter from './MediaConnectionAwaiter';
@@ -20,6 +22,8 @@ export type MediaDirection = {
   receiveShare: boolean;
 };
 
+export type IPVersion = ClientEvent['payload']['ipVersion'];
+
 /**
  * @class MediaProperties
  */
@@ -212,6 +216,91 @@ export default class MediaProperties {
     };
   }
 
+  /**
+   * Checks if the given IP address is IPv6
+   * @param {string} ip address to check
+   * @returns {boolean} true if the address is IPv6, false otherwise
+   */
+  private isIPv6(ip: string): boolean {
+    return ip.includes(':');
+  }
+
+  /** Finds out if we connected using IPv4 or IPv6
+   * @param {RTCPeerConnection} webrtcMediaConnection
+   * @param {Array<any>} allStatsReports array of RTC stats reports
+   * @returns {string} IPVersion
+   */
+  private getConnectionIpVersion(
+    webrtcMediaConnection: RTCPeerConnection,
+    allStatsReports: any[]
+  ): IPVersion | undefined {
+    const transports = allStatsReports.filter((report) => report.type === 'transport');
+
+    let selectedCandidatePair;
+
+    if (transports.length > 0 && transports[0].selectedCandidatePairId) {
+      selectedCandidatePair = allStatsReports.find(
+        (report) =>
+          report.type === 'candidate-pair' && report.id === transports[0].selectedCandidatePairId
+      );
+    } else {
+      // Firefox doesn't have selectedCandidatePairId, but has selected property on the candidate pair
+      selectedCandidatePair = allStatsReports.find(
+        (report) => report.type === 'candidate-pair' && report.selected
+      );
+    }
+
+    if (selectedCandidatePair) {
+      const localCandidate = allStatsReports.find(
+        (report) =>
+          report.type === 'local-candidate' && report.id === selectedCandidatePair.localCandidateId
+      );
+
+      if (localCandidate) {
+        if (localCandidate.address) {
+          return this.isIPv6(localCandidate.address) ? 'IPv6' : 'IPv4';
+        }
+
+        try {
+          // safari doesn't have address field on the candidate, so we have to use the port to look up the candidate in the SDP
+          const localSdp = webrtcMediaConnection.localDescription.sdp;
+
+          const parsedSdp = parse(localSdp);
+
+          for (const mediaLine of parsedSdp.avMedia) {
+            const matchingCandidate = mediaLine.iceInfo.candidates.find(
+              (candidate) => candidate.port === localCandidate.port
+            );
+            if (matchingCandidate) {
+              return this.isIPv6(matchingCandidate.connectionAddress) ? 'IPv6' : 'IPv4';
+            }
+          }
+
+          LoggerProxy.logger.warn(
+            `Media:properties#getConnectionIpVersion --> failed to find local candidate in the SDP for port ${localCandidate.port}`
+          );
+        } catch (error) {
+          LoggerProxy.logger.warn(
+            `Media:properties#getConnectionIpVersion --> error while trying to find candidate in local SDP:`,
+            error
+          );
+
+          return undefined;
+        }
+      } else {
+        LoggerProxy.logger.warn(
+          `Media:properties#getConnectionIpVersion --> failed to find local candidate "${selectedCandidatePair.localCandidateId}" in getStats() results`
+        );
+      }
+    } else {
+      LoggerProxy.logger.warn(
+        `Media:properties#getConnectionIpVersion --> failed to find selected candidate pair in getStats() results (transports.length=${transports.length}, selectedCandidatePairId=${transports[0]?.selectedCandidatePairId})`
+      );
+    }
+
+    return undefined;
+  }
+
   /**
    * Returns the type of a connection that has been established
    * It should be 'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'
@@ -284,6 +373,7 @@ export default class MediaProperties {
    */
   async getCurrentConnectionInfo(): Promise<{
     connectionType: string;
+    ipVersion?: IPVersion;
     selectedCandidatePairChanges: number;
     numTransports: number;
   }> {
@@ -309,10 +399,15 @@ export default class MediaProperties {
       });
 
       const connectionType = this.getConnectionType(allStatsReports);
+      const rtcPeerconnection =
+        this.webrtcMediaConnection.multistreamConnection?.pc.pc ||
+        this.webrtcMediaConnection.mediaConnection?.pc;
+      const ipVersion = this.getConnectionIpVersion(rtcPeerconnection, allStatsReports);
       const {selectedCandidatePairChanges, numTransports} = this.getTransportInfo(allStatsReports);
 
       return {
         connectionType,
+        ipVersion,
         selectedCandidatePairChanges,
         numTransports,
       };
@@ -323,6 +418,7 @@ export default class MediaProperties {
 
       return {
         connectionType: 'unknown',
+        ipVersion: undefined,
         selectedCandidatePairChanges: -1,
         numTransports: 0,
       };

package/src/meeting/index.ts

@@ -7780,7 +7780,7 @@ export default class Meeting extends StatelessWebexPlugin {
         await this.enqueueScreenShareFloorRequest();
       }
 
-      const {connectionType, selectedCandidatePairChanges, numTransports} =
+      const {connectionType, ipVersion, selectedCandidatePairChanges, numTransports} =
         await this.mediaProperties.getCurrentConnectionInfo();
 
       const iceCandidateErrors = Object.fromEntries(this.iceCandidateErrors);
@@ -7791,6 +7791,7 @@ export default class Meeting extends StatelessWebexPlugin {
         correlation_id: this.correlationId,
         locus_id: this.locusUrl.split('/').pop(),
         connectionType,
+        ipVersion,
         selectedCandidatePairChanges,
         numTransports,
         isMultistream: this.isMultistream,
@@ -7803,6 +7804,9 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media-engine.ready',
+        payload: {
+          ipVersion,
+        },
         options: {
           meetingId: this.id,
         },

package/test/unit/spec/media/properties.ts

@@ -2,6 +2,7 @@ import 'jsdom-global/register';
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 import {ConnectionState} from '@webex/internal-media-core';
+import * as tsSdpModule from '@webex/ts-sdp';
 import MediaProperties from '@webex/plugin-meetings/src/media/properties';
 import {Defer} from '@webex/common';
 import MediaConnectionAwaiter from '../../../../src/media/MediaConnectionAwaiter';
@@ -10,15 +11,21 @@ describe('MediaProperties', () => {
   let mediaProperties;
   let mockMC;
   let clock;
+  let rtcPeerConnection;
 
   beforeEach(() => {
     clock = sinon.useFakeTimers();
 
+    rtcPeerConnection = {
+      localDescription: {sdp: ''},
+    };
+
     mockMC = {
       getStats: sinon.stub().resolves([]),
       on: sinon.stub(),
       off: sinon.stub(),
       getConnectionState: sinon.stub().returns(ConnectionState.Connected),
+      multistreamConnection: {pc: {pc: rtcPeerConnection}},
     };
 
     mediaProperties = new MediaProperties();
@@ -81,6 +88,129 @@ describe('MediaProperties', () => {
       assert.equal(numTransports, 0);
     });
 
+    describe('ipVersion', () => {
+      it('returns ipVersion=undefined if getStats() returns no candidate pairs', async () => {
+        mockMC.getStats.resolves([{type: 'something', id: '1234'}]);
+        const info = await mediaProperties.getCurrentConnectionInfo();
+        assert.equal(info.ipVersion, undefined);
+      });
+
+      it('returns ipVersion=undefined if getStats() returns no selected candidate pair', async () => {
+        mockMC.getStats.resolves([{type: 'candidate-pair', id: '1234', selected: false}]);
+        const info = await mediaProperties.getCurrentConnectionInfo();
+        assert.equal(info.ipVersion, undefined);
+      });
+
+      it('returns ipVersion="IPv4" if transport has selectedCandidatePairId and local candidate has IPv4 address', async () => {
+        mockMC.getStats.resolves([
+          {type: 'transport', id: 't1', selectedCandidatePairId: 'cp1'},
+          {type: 'candidate-pair', id: 'cp1', localCandidateId: 'lc1'},
+          {type: 'local-candidate', id: 'lc1', address: '192.168.1.1'},
+        ]);
+        const info = await mediaProperties.getCurrentConnectionInfo();
+        assert.equal(info.ipVersion, 'IPv4');
+      });
+
+      it('returns ipVersion="IPv6" if transport has selectedCandidatePairId and local candidate has IPv6 address', async () => {
+        mockMC.getStats.resolves([
+          {type: 'transport', id: 't1', selectedCandidatePairId: 'cp1'},
+          {type: 'candidate-pair', id: 'cp1', localCandidateId: 'lc1'},
+          {type: 'local-candidate', id: 'lc1', address: 'fd8f:12e6:5e53:784f:a0ba:f8d5:b906:1acc'},
+        ]);
+        const info = await mediaProperties.getCurrentConnectionInfo();
+        assert.equal(info.ipVersion, 'IPv6');
+      });
+
+      it('returns ipVersion="IPv4" if transport has no selectedCandidatePairId but finds selected candidate pair and local candidate has IPv4 address', async () => {
+        mockMC.getStats.resolves([
+          {type: 'transport', id: 't1'},
+          {type: 'candidate-pair', id: 'cp2', localCandidateId: 'lc2', selected: true},
+          {type: 'local-candidate', id: 'lc2', address: '10.0.0.1'},
+        ]);
+        const info = await mediaProperties.getCurrentConnectionInfo();
+        assert.equal(info.ipVersion, 'IPv4');
+      });
+
+      it('returns ipVersion="IPv6" if transport has no selectedCandidatePairId but finds selected candidate pair and local candidate has IPv6 address', async () => {
+        mockMC.getStats.resolves([
+          {type: 'transport', id: 't1'},
+          {type: 'candidate-pair', id: 'cp2', localCandidateId: 'lc2', selected: true},
+          {type: 'local-candidate', id: 'lc2', address: 'fe80::1ff:fe23:4567:890a'},
+        ]);
+        const info = await mediaProperties.getCurrentConnectionInfo();
+        assert.equal(info.ipVersion, 'IPv6');
+      });
+
+      describe('local candidate without address', () => {
+        it('return="IPv4" if candidate from SDP with matching port number has IPv4 address', async () => {
+          sinon.stub(tsSdpModule, 'parse').returns({
+            avMedia: [
+              {
+                iceInfo: {
+                  candidates: [
+                    {
+                      port: 1234,
+                      connectionAddress: '192.168.0.1',
+                    },
+                  ],
+                },
+              },
+            ],
+          });
+
+          mockMC.getStats.resolves([
+            {type: 'transport', id: 't1'},
+            {type: 'candidate-pair', id: 'cp2', localCandidateId: 'lc2', selected: true},
+            {type: 'local-candidate', id: 'lc2', port: 1234},
+          ]);
+          const info = await mediaProperties.getCurrentConnectionInfo();
+          assert.equal(info.ipVersion, 'IPv4');
+
+          assert.calledWith(tsSdpModule.parse, rtcPeerConnection.localDescription.sdp);
+        });
+
+        it('returns ipVersion="IPv6" if candidate from SDP with matching port number has IPv6 address', async () => {
+          sinon.stub(tsSdpModule, 'parse').returns({
+            avMedia: [
+              {
+                iceInfo: {
+                  candidates: [
+                    {
+                      port: 5000,
+                      connectionAddress: 'fe80::1ff:fe23:4567:890a',
+                    },
+                  ],
+                },
+              },
+            ],
+          });
+
+          mockMC.getStats.resolves([
+            {type: 'transport', id: 't1'},
+            {type: 'candidate-pair', id: 'cp2', localCandidateId: 'lc2', selected: true},
+            {type: 'local-candidate', id: 'lc2', port: 5000},
+          ]);
+          const info = await mediaProperties.getCurrentConnectionInfo();
+          assert.equal(info.ipVersion, 'IPv6');
+
+          assert.calledWith(tsSdpModule.parse, rtcPeerConnection.localDescription.sdp);
+        });
+
+        it('returns ipVersion=undefined if parsing of the SDP fails', async () => {
+          sinon.stub(tsSdpModule, 'parse').throws(new Error('fake error'));
+
+          mockMC.getStats.resolves([
+            {type: 'candidate-pair', id: 'cp2', localCandidateId: 'lc2', selected: true},
+            {type: 'local-candidate', id: 'lc2', port: 5000},
+          ]);
+          const info = await mediaProperties.getCurrentConnectionInfo();
+          assert.equal(info.ipVersion, undefined);
+
+          assert.calledWith(tsSdpModule.parse, rtcPeerConnection.localDescription.sdp);
+        });
+      });
+    });
+
     describe('selectedCandidatePairChanges and numTransports', () => {
       it('returns correct values when getStats() returns no transport stats at all', async () => {
         mockMC.getStats.resolves([{type: 'something', id: '1234'}]);

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

@@ -2047,7 +2047,12 @@ describe('plugin-meetings', () => {
           meeting.mediaProperties.waitForMediaConnectionConnected = sinon.stub().resolves();
           meeting.mediaProperties.getCurrentConnectionInfo = sinon
             .stub()
-            .resolves({connectionType: 'udp', selectedCandidatePairChanges: 2, numTransports: 1});
+            .resolves({
+              connectionType: 'udp',
+              selectedCandidatePairChanges: 2,
+              numTransports: 1,
+              ipVersion: 'IPv6',
+            });
           meeting.audio = muteStateStub;
           meeting.video = muteStateStub;
           sinon.stub(Media, 'createMediaConnection').returns(fakeMediaConnection);
@@ -3059,6 +3064,9 @@ describe('plugin-meetings', () => {
           });
           assert.calledWith(webex.internal.newMetrics.submitClientEvent.thirdCall, {
             name: 'client.media-engine.ready',
+            payload: {
+              ipVersion: 'IPv6',
+            },
             options: {
               meetingId: meeting.id,
             },
@@ -3115,6 +3123,7 @@ describe('plugin-meetings', () => {
               locus_id: meeting.locusUrl.split('/').pop(),
               connectionType: 'udp',
               selectedCandidatePairChanges: 2,
+              ipVersion: 'IPv6',
               numTransports: 1,
               isMultistream: false,
               retriedWithTurnServer: true,
@@ -3268,6 +3277,7 @@ describe('plugin-meetings', () => {
               locus_id: meeting.locusUrl.split('/').pop(),
               connectionType: 'udp',
               selectedCandidatePairChanges: 2,
+              ipVersion: 'IPv6',
               numTransports: 1,
               isMultistream: false,
               retriedWithTurnServer: false,
@@ -3443,6 +3453,7 @@ describe('plugin-meetings', () => {
             correlation_id: meeting.correlationId,
             locus_id: meeting.locusUrl.split('/').pop(),
             connectionType: 'udp',
+            ipVersion: 'IPv6',
             selectedCandidatePairChanges: 2,
             numTransports: 1,
             isMultistream: false,