mediasoup 3.24.1 → 3.24.2

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ### NEXT
 
+### 3.24.2
+
+- Worker: Verify `DataConsumer` subchannels before cloning the message ([PR #1880](https://github.com/versatica/mediasoup/pull/1880)).
+
 ### 3.24.1
 
 - Worker: Don't check `ignoredSubchannel` in piped `DataConsumers` ([PR #1879](https://github.com/versatica/mediasoup/pull/1879)).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mediasoup",
-	"version": "3.24.1",
+	"version": "3.24.2",
 	"description": "Cutting Edge WebRTC Video Conferencing",
 	"contributors": [
 		"Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -121,8 +121,8 @@
 		"@types/debug": "^4.1.13",
 		"@types/ini": "^4.1.1",
 		"@types/jest": "^30.0.0",
-		"@types/node": "^26.1.2",
-		"eslint": "^10.8.0",
+		"@types/node": "^26.2.0",
+		"eslint": "^10.8.1",
 		"eslint-config-prettier": "^10.1.8",
 		"eslint-plugin-jest": "^29.16.0",
 		"eslint-plugin-prettier": "^5.5.6",

package/worker/include/RTC/DataConsumer.hpp

@@ -93,6 +93,18 @@ namespace RTC
 		void SctpBufferedAmountLow(uint32_t bufferedAmount) const;
 		void SctpSendBufferFull() const;
 		void DataProducerClosed();
+		/**
+		 * Verifies if given subchannels would allow a message to be delivered to
+		 * the DataConsumer endpoint or not.
+		 *
+		 * @remarks
+		 * - This method must be called before invoking `SendMessage()` if subchannels
+		 *   are given to `SendMessage()`.
+		 */
+		bool VerifySubchannels(
+		  const std::vector<uint16_t>& subchannels,
+		  std::optional<uint16_t> requiredSubchannel,
+		  std::optional<uint16_t> ignoredSubchannel) const;
 		bool SendMessage(
 		  RTC::SCTP::Message message,
 		  std::vector<uint16_t>& subchannels,

package/worker/src/RTC/DataConsumer.cpp

@@ -482,101 +482,93 @@ namespace RTC
 		this->listener->OnDataConsumerDataProducerClosed(this);
 	}
 
-	bool DataConsumer::SendMessage(
-	  RTC::SCTP::Message message,
-	  std::vector<uint16_t>& subchannels,
+	bool DataConsumer::VerifySubchannels(
+	  const std::vector<uint16_t>& subchannels,
 	  std::optional<uint16_t> requiredSubchannel,
-	  std::optional<uint16_t> ignoredSubchannel,
-	  const onQueuedCallback* cb)
+	  std::optional<uint16_t> ignoredSubchannel) const
 	{
 		MS_TRACE();
 
-		if (!IsActive())
+		// Only verify subchannels if this is not a piped DataConsumer or if this
+		// is a piped DataConsumer and it's subscribed to at least one subchannel.
+		const bool verifySubchannels = !this->pipe || !this->subchannels.empty();
+
+		if (!verifySubchannels)
 		{
-			if (cb)
-			{
-				(*cb)(false, false);
-				delete cb;
-			}
+			return true;
+		}
 
+		// If a required subchannel is given, verify that this data consumer is
+		// subscribed to it.
+		if (requiredSubchannel.has_value() && !this->subchannels.contains(requiredSubchannel.value()))
+		{
 			return false;
 		}
 
-		// Only verify subchannels if this is not a piped DataConsumer or if this
-		// is a piped DataConsumer and it's subscribed to at least one subchannel.
-		const bool verifySubchannels = !this->pipe || !this->subchannels.empty();
+		// If an ignored subchannel is given, verify that this data consumer is
+		// not subscribed to it, otherwise don't send this message to it.
+		// NOTE: We don't check this in piped DataConsumers on purpose. Otherwise
+		// a message generated by peer X and forwarded to all peers in another
+		// host wouldn't pass this filter in the local PipeTransport.
+		if (!this->pipe && ignoredSubchannel.has_value() && this->subchannels.contains(ignoredSubchannel.value()))
+		{
+			return false;
+		}
 
-		if (verifySubchannels)
+		// If subchannels are given, verify that this data consumer is subscribed
+		// to at least one of them.
+		if (!subchannels.empty())
 		{
-			// If a required subchannel is given, verify that this data consumer is
-			// subscribed to it.
-			if (requiredSubchannel.has_value() && !this->subchannels.contains(requiredSubchannel.value()))
+			bool subchannelMatched{ false };
+
+			for (const auto subchannel : subchannels)
 			{
-				if (cb)
+				if (this->subchannels.contains(subchannel))
 				{
-					(*cb)(false, false);
-					delete cb;
-				}
+					subchannelMatched = true;
 
-				return false;
+					break;
+				}
 			}
 
-			// If an ignored subchannel is given, verify that this data consumer is
-			// not subscribed to it, otherwise don't send this message to it.
-			// NOTE: We don't check this in piped DataConsumers on purpose. Otherwise
-			// a message generated by peer X and forwarded to all peers in another
-			// host wouldn't pass this filter in the local PipeTransport.
-			if (
-			  !this->pipe && ignoredSubchannel.has_value() &&
-			  this->subchannels.contains(ignoredSubchannel.value()))
+			if (!subchannelMatched)
 			{
-				if (cb)
-				{
-					(*cb)(false, false);
-					delete cb;
-				}
-
 				return false;
 			}
+		}
 
-			// If subchannels are given, verify that this data consumer is subscribed
-			// to at least one of them.
-			if (!subchannels.empty())
-			{
-				bool subchannelMatched{ false };
-
-				for (const auto subchannel : subchannels)
-				{
-					if (this->subchannels.contains(subchannel))
-					{
-						subchannelMatched = true;
-
-						break;
-					}
-				}
+		return true;
+	}
 
-				if (!subchannelMatched)
-				{
-					if (cb)
-					{
-						(*cb)(false, false);
-						delete cb;
-					}
+	bool DataConsumer::SendMessage(
+	  RTC::SCTP::Message message,
+	  std::vector<uint16_t>& subchannels,
+	  std::optional<uint16_t> requiredSubchannel,
+	  std::optional<uint16_t> ignoredSubchannel,
+	  const onQueuedCallback* cb)
+	{
+		MS_TRACE();
 
-					return false;
-				}
+		if (!IsActive())
+		{
+			if (cb)
+			{
+				(*cb)(false, false);
+				delete cb;
 			}
+
+			return false;
 		}
 
-		// If this is a piped DataConsumer, encode given subchannels and required
-		// subchannel at the beginning of the message payload so the receiving
-		// PipeTransport can decode them and apply them to its own DataConsumers.
+		// If this is a piped DataConsumer, encode given subchannels at the beginning
+		// of the message payload so the receiving PipeTransport can decode them and
+		// apply them to its own DataConsumers.
 		if (this->pipe)
 		{
-			// If subchannels were verified, encode just those this DataConsumer is
-			// subscribed to. Otherwise the receiving Router would deliver the message to
+			// Encode just those subchannels this DataConsumer is subscribed to.
+			// Otherwise the receiving Router would deliver the message to
 			// DataConsumers subscribed to subchannels that this pipe does not carry.
-			const bool reduceSubchannels = verifySubchannels && !subchannels.empty();
+			const bool reduceSubchannels = !this->subchannels.empty();
 
 			std::vector<uint16_t> reducedSubchannels;
 

package/worker/src/RTC/Router.cpp

@@ -917,44 +917,57 @@ namespace RTC
 
 		auto& dataConsumers = this->mapDataProducerDataConsumers.at(dataProducer);
 
-		if (!dataConsumers.empty())
+		const auto getStreamId = [](const RTC::DataConsumer* dataConsumer) -> uint16_t
 		{
-			const auto numDataConsumers = dataConsumers.size();
+			return dataConsumer->GetType() == DataConsumer::Type::SCTP
+			         ? dataConsumer->GetSctpStreamParameters().streamId
+			         : 0;
+		};
 
-			for (auto* dataConsumer : dataConsumers)
+		// NOTE: We don't send the message to a matching DataConsumer right away.
+		// Instead we hold it as pending until we know whether there is another
+		// matching DataConsumer after it. This way just the last matching one needs
+		// no message clone since it can take ownership of the original message.
+		RTC::DataConsumer* pendingDataConsumer{ nullptr };
+
+		for (auto* dataConsumer : dataConsumers)
+		{
+			// Verify subchannels first to avoid cloning the message needlessly.
+			if (!dataConsumer->IsActive() || !dataConsumer->VerifySubchannels(subchannels, requiredSubchannel, ignoredSubchannel))
 			{
-				const uint16_t streamId =
-				  (dataConsumer->GetType() == DataConsumer::Type::SCTP
-				     ? dataConsumer->GetSctpStreamParameters().streamId
-				     : 0);
+				continue;
+			}
 
-				if (numDataConsumers == 1)
-				{
-					// We must update the message`s `streamId` for each destination
-					// DataConsumer.
-					// NOTE: clang-tidy doesn't understand that we are only doing this
-					// once in the original `message`.
-					// NOLINTNEXTLINE(clang-analyzer-cplusplus.Move, bugprone-use-after-move, hicpp-invalid-access-moved)
-					message.SetStreamId(streamId);
-
-					dataConsumer->SendMessage(
-					  std::move(message), subchannels, requiredSubchannel, ignoredSubchannel);
-				}
-				// NOTE: Here we are cloning the message before passing it to each
-				// DataConsumer because each DataConsumer will pass std::move(message)
-				// internally to its SCTP association.
-				else
-				{
-					auto clonedMessage = message.Clone();
+			// There is a matching DataConsumer after the pending one, so the pending
+			// one must be given a clone of the message.
+			// NOTE: Here we are cloning the message before passing it to the
+			// DataConsumer because each DataConsumer will pass std::move(message)
+			// internally to its SCTP association.
+			if (pendingDataConsumer)
+			{
+				auto clonedMessage = message.Clone();
 
-					// We must update the message`s `streamId` for each destination
-					// DataConsumer.
-					clonedMessage.SetStreamId(streamId);
+				// We must update the message`s `streamId` for each destination
+				// DataConsumer.
+				clonedMessage.SetStreamId(getStreamId(pendingDataConsumer));
 
-					dataConsumer->SendMessage(
-					  std::move(clonedMessage), subchannels, requiredSubchannel, ignoredSubchannel);
-				}
+				pendingDataConsumer->SendMessage(
+				  std::move(clonedMessage), subchannels, requiredSubchannel, ignoredSubchannel);
 			}
+
+			pendingDataConsumer = dataConsumer;
+		}
+
+		// The last matching DataConsumer (if any) takes ownership of the original
+		// message.
+		if (pendingDataConsumer)
+		{
+			// We must update the message`s `streamId` for each destination
+			// DataConsumer.
+			message.SetStreamId(getStreamId(pendingDataConsumer));
+
+			pendingDataConsumer->SendMessage(
+			  std::move(message), subchannels, requiredSubchannel, ignoredSubchannel);
 		}
 	}