mediasoup 3.20.9 → 3.20.10

package/README.md

@@ -13,8 +13,10 @@
 [![][github-actions-shield-mediasoup-rust]][github-actions-mediasoup-rust]
 [![][github-actions-shield-mediasoup-worker-fuzzer]][github-actions-mediasoup-worker-fuzzer]
 [![][github-actions-shield-mediasoup-npm-publish]][github-actions-mediasoup-npm-publish]
+[![][github-actions-shield-mediasoup-crate-publish]][github-actions-mediasoup-crate-publish]
 [![][github-actions-shield-mediasoup-worker-prebuild]][github-actions-mediasoup-worker-prebuild]
-[![][github-actions-shield-mediasoup-website-publish]][github-actions-mediasoup-website-publish]
+[![][github-actions-shield-mediasoup-website-update]][github-actions-mediasoup-website-update]
+[![][github-actions-shield-mediasoup-demo-update]][github-actions-mediasoup-demo-update]
 [![][github-actions-mediasoup-codeql-shield-mediasoup]][github-actions-mediasoup-codeql-mediasoup]
 
 ## Website and Documentation
@@ -108,8 +110,12 @@ You can support mediasoup by [sponsoring][sponsor] it. Thanks!
 [github-actions-mediasoup-worker-prebuild]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-worker-prebuild.yaml?query=event%3Aworkflow_run
 [github-actions-shield-mediasoup-npm-publish]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-npm-publish.yaml/badge.svg?event=push
 [github-actions-mediasoup-npm-publish]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-npm-publish.yaml?query=event%3Apush
-[github-actions-shield-mediasoup-website-publish]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-website-publish.yaml/badge.svg?event=workflow_run
-[github-actions-mediasoup-website-publish]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-website-publish.yaml?query=event%3Aworkflow_run
+[github-actions-shield-mediasoup-crate-publish]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-crate-publish.yaml/badge.svg?event=push
+[github-actions-mediasoup-crate-publish]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-crate-publish.yaml?query=event%3Apush
+[github-actions-shield-mediasoup-website-update]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-website-update.yaml/badge.svg?event=workflow_run
+[github-actions-mediasoup-website-update]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-website-update.yaml?query=event%3Aworkflow_run
+[github-actions-shield-mediasoup-demo-update]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-demo-update.yaml/badge.svg?event=workflow_run
+[github-actions-mediasoup-demo-update]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-demo-update.yaml?query=event%3Aworkflow_run
 [github-actions-mediasoup-codeql-shield-mediasoup]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-codeql.yaml/badge.svg?branch=v3
 [github-actions-mediasoup-codeql-mediasoup]: https://github.com/versatica/mediasoup/actions/workflows/mediasoup-codeql.yaml?query=branch%3Av3
 [sponsor]: https://mediasoup.org/sponsor

package/npm-scripts.mjs

@@ -138,6 +138,12 @@ async function run() {
 			break;
 		}
 
+		case 'prepublishOnly': {
+			prepublishOnly();
+
+			break;
+		}
+
 		case 'typescript:build': {
 			buildTypescript({ force: true, args: taskArgs });
 
@@ -524,6 +530,26 @@ function installNodeDeps() {
 	executeCmd('npm audit --prefix worker/scripts');
 }
 
+/**
+ * `prepublishOnly` is run by NPM only on `npm publish` (not on `npm pack`,
+ * `npm install` or `npm ci`). We use it to forbid publishing mediasoup from a
+ * local machine. The package must only be published by the
+ * `mediasoup-npm-publish.yaml` workflow, which runs inside GitHub Actions (where
+ * GITHUB_ACTIONS environment variable is set to 'true') and uses OIDC trusted
+ * publishing.
+ */
+function prepublishOnly() {
+	logInfo('prepublishOnly()');
+
+	if (process.env.GITHUB_ACTIONS !== 'true') {
+		logError(
+			"prepublishOnly() | refusing to 'npm publish' outside of GitHub Actions: mediasoup is published only by the mediasoup-npm-publish.yaml workflow (triggered by pushing a release tag via 'npm run release')"
+		);
+
+		exitWithError();
+	}
+}
+
 function publishDryRun() {
 	logInfo('publishDryRun()');
 
@@ -551,7 +577,7 @@ async function checkRelease() {
 	try {
 		versionChanges = await getVersionChanges();
 	} catch (error) {
-		logError(error.message);
+		logError(`checkRelease() | ${error.message}`);
 
 		exitWithError();
 	}
@@ -609,10 +635,19 @@ async function release({ args = '' } = {}) {
 	await updateChangelog(version);
 
 	// Commit the bump, tag it, and push both. The pushed tag triggers
-	// mediasoup-npm-publish.yaml, which checks, creates the GitHub release and
-	// publishes to NPM; on its success mediasoup-worker-prebuild.yaml builds and
-	// uploads the prebuilt binaries.
-	executeCmd(`git commit -am 'version ${version}'`);
+	// `mediasoup-npm-publish.yaml`, which checks, creates the GitHub release and
+	// publishes to NPM; on its success `mediasoup-worker-prebuild.yaml` builds
+	// and uploads the prebuilt binaries.
+	//
+	// The commit message carries a "[no-ci]" marker so the regular branch CI
+	// workflows (node, worker, rust, fuzzer, codeql) skip this commit: it only
+	// bumps version/CHANGELOG (no code change) and its parent already passed CI,
+	// and the release is driven by the tag-triggered workflows instead.
+	//
+	// NOTE: "[no-ci]" (with a hyphen) is a custom marker, NOT GitHub's native
+	// "[skip ci]"/"[no ci]" (which would also skip mediasoup-npm-publish, since
+	// the tag push shares this same commit).
+	executeCmd(`git commit -am 'release ${version} [no-ci]'`);
 	executeCmd(`git tag -a ${version} -m '${version}'`);
 	executeCmd(`git push origin ${MAIN_BRANCH}`);
 	executeCmd(`git push origin '${version}'`);
@@ -664,8 +699,10 @@ async function prebuildWorker() {
 	}
 }
 
-// Returns a Promise resolving to true if a mediasoup-worker prebuilt binary
-// was downloaded and uncompressed, false otherwise.
+/**
+ * Returns a Promise resolving to true if a mediasoup-worker prebuilt binary was
+ * downloaded and uncompressed, false otherwise.
+ */
 async function downloadPrebuiltWorker() {
 	const releaseBase =
 		process.env.MEDIASOUP_WORKER_PREBUILT_DOWNLOAD_BASE_URL ||
@@ -873,11 +910,14 @@ async function updateChangelog(version) {
 	fs.writeFileSync('./CHANGELOG.md', updatedChangelog);
 }
 
-function executeCmd(command) {
-	logInfo(`executeCmd(): ${command}`);
+function executeCmd(command, { cwd } = {}) {
+	logInfo(`executeCmd(): ${command}${cwd ? ` [cwd:${cwd}]` : ''}`);
 
 	try {
-		execSync(command, { stdio: ['ignore', process.stdout, process.stderr] });
+		execSync(command, {
+			cwd,
+			stdio: ['ignore', process.stdout, process.stderr],
+		});
 	} catch (error) {
 		logError(`executeCmd() failed, exiting: ${error}`);
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mediasoup",
-	"version": "3.20.9",
+	"version": "3.20.10",
 	"description": "Cutting Edge WebRTC Video Conferencing",
 	"contributors": [
 		"Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -75,6 +75,7 @@
 	"scripts": {
 		"prepare": "node npm-scripts.mjs prepare",
 		"postinstall": "node npm-scripts.mjs postinstall",
+		"prepublishOnly": "node npm-scripts.mjs prepublishOnly",
 		"typescript:build": "node npm-scripts.mjs typescript:build",
 		"typescript:watch": "node npm-scripts.mjs typescript:watch",
 		"worker:build": "node npm-scripts.mjs worker:build",
@@ -112,7 +113,6 @@
 	},
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
-		"@octokit/rest": "^22.0.1",
 		"@types/debug": "^4.1.13",
 		"@types/ini": "^4.1.1",
 		"@types/jest": "^30.0.0",
@@ -121,17 +121,17 @@
 		"eslint-config-prettier": "^10.1.8",
 		"eslint-plugin-jest": "^29.15.2",
 		"eslint-plugin-prettier": "^5.5.6",
-		"globals": "^17.6.0",
+		"globals": "^17.7.0",
 		"ini": "^7.0.0",
 		"jest": "^30.4.2",
-		"knip": "^6.17.1",
+		"knip": "^6.18.0",
 		"marked": "^18.0.5",
 		"open-cli": "^9.0.0",
 		"pick-port": "^2.2.1",
 		"prettier": "^3.8.4",
 		"ts-jest": "^29.4.11",
 		"typescript": "^6.0.3",
-		"typescript-eslint": "^8.61.1",
+		"typescript-eslint": "^8.62.0",
 		"werift-sctp": "^0.0.11"
 	}
 }

package/worker/include/RTC/ICE/StunPacket.hpp

@@ -113,7 +113,21 @@ namespace RTC
 				FINGERPRINT        = 0x8028,
 				ICE_CONTROLLED     = 0x8029,
 				ICE_CONTROLLING    = 0x802A,
-				NOMINATION         = 0xC001
+				/**
+				 * In libwebrtc native code, STUN_ATTR_NOMINATION is defined as 0xC001.
+				 * However that value is not defined in any RFC/draft, not even in the
+				 * draft that defines the NOMINATION attribute.
+				 *
+				 * @see https://datatracker.ietf.org/doc/html/draft-thatcher-ice-renomination
+				 * @see https://issues.webrtc.org/issues/496629058
+				 */
+				NOMINATION_OLD = 0xC001,
+				/**
+				 * Value of the NOMINATION attribute in the new specification.
+				 *
+				 * @see https://juberti.github.io/draft-renomination/draft-thatcher-tsvwg-renomination.html
+				 */
+				NOMINATION = 0x0030
 			};
 
 			// Authentication result.
@@ -290,7 +304,12 @@ namespace RTC
 
 			uint32_t GetNomination() const
 			{
-				const auto* attribute = GetAttribute(StunPacket::AttributeType::NOMINATION);
+				auto* attribute = GetAttribute(StunPacket::AttributeType::NOMINATION);
+
+				if (!attribute)
+				{
+					attribute = GetAttribute(StunPacket::AttributeType::NOMINATION_OLD);
+				}
 
 				if (!attribute)
 				{

package/worker/include/RTC/NackGenerator.hpp

@@ -48,7 +48,7 @@ namespace RTC
 		};
 
 	public:
-		explicit NackGenerator(Listener* listener, SharedInterface* shared, unsigned int sendNackDelayMs);
+		explicit NackGenerator(Listener* listener, SharedInterface* shared, uint32_t sendNackDelayMs);
 		~NackGenerator() override;
 
 		bool ReceivePacket(const RTC::RTP::Packet* packet, bool isRecovered);
@@ -76,7 +76,7 @@ namespace RTC
 		// Passed by argument.
 		Listener* listener{ nullptr };
 		SharedInterface* shared{ nullptr };
-		unsigned int sendNackDelayMs{ 0u };
+		uint32_t sendNackDelayMs{ 0u };
 		// Allocated by this.
 		TimerHandleInterface* timer{ nullptr };
 		// Others.

package/worker/include/RTC/RTP/RtpStreamRecv.hpp

@@ -49,7 +49,7 @@ namespace RTC
 			  RTP::RtpStreamRecv::Listener* listener,
 			  SharedInterface* shared,
 			  RTP::RtpStream::Params& params,
-			  unsigned int sendNackDelayMs,
+			  uint32_t sendNackDelayMs,
 			  bool useRtpInactivityCheck);
 			~RtpStreamRecv() override;
 
@@ -105,7 +105,7 @@ namespace RTC
 
 		private:
 			// Passed by argument.
-			unsigned int sendNackDelayMs{ 0u };
+			uint32_t sendNackDelayMs{ 0u };
 			bool useRtpInactivityCheck{ false };
 			// Others.
 			// Packets expected at last interval.

package/worker/src/RTC/ICE/IceServer.cpp

@@ -523,7 +523,8 @@ namespace RTC
 			HandleTuple(
 			  tuple,
 			  request->HasAttribute(StunPacket::AttributeType::USE_CANDIDATE),
-			  request->HasAttribute(StunPacket::AttributeType::NOMINATION),
+			  request->HasAttribute(StunPacket::AttributeType::NOMINATION) ||
+			    request->HasAttribute(StunPacket::AttributeType::NOMINATION_OLD),
 			  request->GetNomination());
 
 			// If state is 'connected' or 'completed' after handling the tuple, then

package/worker/src/RTC/ICE/StunPacket.cpp

@@ -250,6 +250,11 @@ namespace RTC
 				MS_DUMP_CLEAN(indentation + 1, "  nomination: %" PRIu32, GetNomination());
 			}
 
+			if (HasAttribute(StunPacket::AttributeType::NOMINATION_OLD))
+			{
+				MS_DUMP_CLEAN(indentation + 1, "  nomination (old): %" PRIu32, GetNomination());
+			}
+
 			if (HasAttribute(StunPacket::AttributeType::SOFTWARE))
 			{
 				const auto software = GetSoftware();
@@ -404,6 +409,8 @@ namespace RTC
 
 			StoreNewAttribute(
 			  StunPacket::AttributeType::NOMINATION, AttributeFactoryBuffer, sizeof(nomination));
+			StoreNewAttribute(
+			  StunPacket::AttributeType::NOMINATION_OLD, AttributeFactoryBuffer, sizeof(nomination));
 		}
 
 		void StunPacket::AddSoftware(const std::string_view software)
@@ -1058,6 +1065,7 @@ namespace RTC
 					}
 
 					case StunPacket::AttributeType::NOMINATION:
+					case StunPacket::AttributeType::NOMINATION_OLD:
 					{
 						if (attrLen != 4)
 						{

package/worker/src/RTC/NackGenerator.cpp

@@ -16,7 +16,7 @@ namespace RTC
 
 	/* Instance methods. */
 
-	NackGenerator::NackGenerator(Listener* listener, SharedInterface* shared, unsigned int sendNackDelayMs)
+	NackGenerator::NackGenerator(Listener* listener, SharedInterface* shared, uint32_t sendNackDelayMs)
 	  : listener(listener),
 	    shared(shared),
 	    sendNackDelayMs(sendNackDelayMs),

package/worker/src/RTC/Producer.cpp

@@ -20,7 +20,7 @@ namespace RTC
 
 	static constexpr size_t ProducerSendBufferSize{ 65536 };
 	static thread_local uint8_t ProducerSendBuffer[ProducerSendBufferSize];
-	static constexpr unsigned int SendNackDelay{ 10u }; // In ms.
+	static constexpr uint32_t SendNackDelay{ 10u }; // In ms.
 
 	/* Instance methods. */
 

package/worker/src/RTC/SeqManager.cpp

@@ -140,9 +140,7 @@ namespace RTC
 			}
 
 			// There are dropped inputs, calculate 'base' for this input.
-			auto droppedCount = std::distance(
-			  this->dropped.begin(),
-			  std::lower_bound(this->dropped.begin(), this->dropped.end(), input, SeqLowerThan()));
+			auto droppedCount = std::distance(this->dropped.begin(), it);
 
 			base = (this->base - droppedCount) & SeqManager::MaxValue;
 		}

package/worker/test/src/RTC/ICE/TestStunPacket.cpp

@@ -508,7 +508,9 @@ SCENARIO("ICE StunPacket", "[serializable][ice][stunpacket]")
 		// Byte length: 8.
 		uint64_t iceControlling = 15697499370457501716u;
 		// Byte length of USE_CANDIDATE: 0.
-		// // Byte length: 4.
+		// NOTE: `AddNomination()` adds the "NOMINATION" attribute with both the old
+		// and the new value, so it will insert 2 attributes instead of one.
+		// Byte length: 4 x 2.
 		uint32_t nomination = 12345678u;
 		// Byte length: 18 (2 byte of padding needed).
 		std::string software = "mediasoup x.y.z :)";
@@ -518,7 +520,7 @@ SCENARIO("ICE StunPacket", "[serializable][ice][stunpacket]")
 
 		// Total length of the attributes.
 		size_t attributesLen =
-		  (4 + 27 + 1) + (4 + 4) + (4 + 8) + (4) + (4 + 4) + (4 + 18 + 2) + (4 + 4 + 23 + 1);
+		  (4 + 27 + 1) + (4 + 4) + (4 + 8) + (4) + ((4 + 4) * 2) + (4 + 18 + 2) + (4 + 4 + 23 + 1);
 
 		request->AddUsername(username);
 		request->AddPriority(priority);
@@ -533,6 +535,8 @@ SCENARIO("ICE StunPacket", "[serializable][ice][stunpacket]")
 		REQUIRE_THROWS_AS(request->AddPriority(priority), MediaSoupError);
 		REQUIRE_THROWS_AS(request->AddIceControlling(iceControlling), MediaSoupError);
 		REQUIRE_THROWS_AS(request->AddUseCandidate(), MediaSoupError);
+		// NOTE: `AddNomination()` adds the "NOMINATION" attribute with both the old
+		// and the new value, so it will insert 2 attributes instead of one.
 		REQUIRE_THROWS_AS(request->AddNomination(nomination), MediaSoupError);
 		REQUIRE_THROWS_AS(request->AddSoftware(software), MediaSoupError);
 		REQUIRE_THROWS_AS(request->AddErrorCode(errorCode, errorReasonPhrase), MediaSoupError);

package/worker/test/src/RTC/RTP/TestRtpStreamRecv.cpp

@@ -8,7 +8,7 @@
 
 // 17: 16 bit mask + the initial sequence number.
 static constexpr size_t MaxRequestedPackets{ 17 };
-static constexpr unsigned int SendNackDelay{ 0u }; // In ms.
+static constexpr uint32_t SendNackDelay{ 0u }; // In ms.
 static const bool UseRtpInactivityCheck{ false };
 
 SCENARIO("RtpStreamRecv", "[rtp][rtpstream][rtpstreamrecv]")

package/worker/test/src/RTC/TestNackGenerator.cpp

@@ -9,7 +9,7 @@
 
 SCENARIO("NackGenerator generator", "[rtp][rtcp][nack]")
 {
-	constexpr unsigned int SendNackDelay{ 0u }; // In ms.
+	constexpr uint32_t SendNackDelay{ 0u }; // In ms.
 
 	struct TestNackGeneratorInput
 	{