Include local iceParameters in Transport 'connect' event

.github/workflows/mediasoup-client.yaml

@@ -20,6 +20,8 @@ jobs:
           - os: ubuntu-22.04
             node: 20
           - os: macos-12
+            node: 18
+          - os: macos-14
             node: 20
           - os: windows-2022
             node: 20

src/Transport.ts

@@ -144,7 +144,7 @@ export type PlainRtpParameters = {
 
 export type TransportEvents = {
 	connect: [
-		{ dtlsParameters: DtlsParameters },
+		{ iceParameters: IceParameters; dtlsParameters: DtlsParameters },
 		() => void,
 		(error: Error) => void,
 	];
@@ -1106,7 +1106,10 @@ export class Transport<
 		handler.on(
 			'@connect',
 			(
-				{ dtlsParameters }: { dtlsParameters: DtlsParameters },
+				{
+					iceParameters,
+					dtlsParameters,
+				}: { iceParameters: IceParameters; dtlsParameters: DtlsParameters },
 				callback: () => void,
 				errback: (error: Error) => void
 			) => {
@@ -1116,7 +1119,12 @@ export class Transport<
 					return;
 				}
 
-				this.safeEmit('connect', { dtlsParameters }, callback, errback);
+				this.safeEmit(
+					'connect',
+					{ iceParameters, dtlsParameters },
+					callback,
+					errback
+				);
 			}
 		);
 

src/handlers/Chrome111.ts

@@ -1094,6 +1094,11 @@ export class Chrome111 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -1109,7 +1114,12 @@ export class Chrome111 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Chrome55.ts

@@ -822,6 +822,11 @@ export class Chrome55 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -837,7 +842,12 @@ export class Chrome55 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Chrome67.ts

@@ -924,6 +924,11 @@ export class Chrome67 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -939,7 +944,12 @@ export class Chrome67 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Chrome70.ts

@@ -977,6 +977,11 @@ export class Chrome70 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -992,7 +997,12 @@ export class Chrome70 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Chrome74.ts

@@ -1117,6 +1117,11 @@ export class Chrome74 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -1132,7 +1137,12 @@ export class Chrome74 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Edge11.ts

@@ -625,14 +625,22 @@ export class Edge11 extends HandlerInterface {
 	}): Promise<void> {
 		logger.debug('setupTransport()');
 
+		// Get our local ICE parameters.
+		const iceParameters = this._iceGatherer.getLocalParameters();
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = this._dtlsTransport.getLocalParameters();
 
 		dtlsParameters.role = localDtlsRole;
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		// Start the RTCIceTransport.

src/handlers/FakeHandler.ts

@@ -453,6 +453,10 @@ export class FakeHandler extends HandlerInterface {
 		localDtlsRole: DtlsRole;
 		localSdpObject?: any;
 	}): Promise<void> {
+		const iceParameters = utils.clone<IceParameters>(
+			this.fakeParameters.generateLocalIceParameters()
+		);
+
 		const dtlsParameters = utils.clone<DtlsParameters>(
 			this.fakeParameters.generateLocalDtlsParameters()
 		);
@@ -467,7 +471,7 @@ export class FakeHandler extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) =>
-			this.emit('@connect', { dtlsParameters }, resolve, reject)
+			this.emit('@connect', { iceParameters, dtlsParameters }, resolve, reject)
 		);
 
 		this._transportReady = true;

src/handlers/Firefox60.ts

@@ -1129,6 +1129,11 @@ export class Firefox60 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -1144,7 +1149,12 @@ export class Firefox60 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/HandlerInterface.ts

@@ -86,7 +86,7 @@ export type HandlerReceiveDataChannelResult = {
 export type HandlerEvents = {
 	'@close': [];
 	'@connect': [
-		{ dtlsParameters: DtlsParameters },
+		{ iceParameters: IceParameters; dtlsParameters: DtlsParameters },
 		() => void,
 		(error: Error) => void,
 	];

src/handlers/ReactNative.ts

@@ -843,6 +843,11 @@ export class ReactNative extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -858,7 +863,12 @@ export class ReactNative extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/ReactNativeUnifiedPlan.ts

@@ -1146,6 +1146,11 @@ export class ReactNativeUnifiedPlan extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -1161,7 +1166,12 @@ export class ReactNativeUnifiedPlan extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Safari11.ts

@@ -918,6 +918,11 @@ export class Safari11 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -933,7 +938,12 @@ export class Safari11 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;

src/handlers/Safari12.ts

@@ -1084,6 +1084,11 @@ export class Safari12 extends HandlerInterface {
 			localSdpObject = sdpTransform.parse(this._pc.localDescription.sdp);
 		}
 
+		// Get our local ICE parameters.
+		const iceParameters = sdpCommonUtils.extractIceParameters({
+			sdpObject: localSdpObject,
+		});
+
 		// Get our local DTLS parameters.
 		const dtlsParameters = sdpCommonUtils.extractDtlsParameters({
 			sdpObject: localSdpObject,
@@ -1099,7 +1104,12 @@ export class Safari12 extends HandlerInterface {
 
 		// Need to tell the remote transport about our parameters.
 		await new Promise<void>((resolve, reject) => {
-			this.safeEmit('@connect', { dtlsParameters }, resolve, reject);
+			this.safeEmit(
+				'@connect',
+				{ iceParameters, dtlsParameters },
+				resolve,
+				reject
+			);
 		});
 
 		this._transportReady = true;