Prepare for network protocol version upgrades (#5084)

* explicitly tag network requests with version * fmt * make PeerSet more aware of versioning * some generalization of the network bridge to support upgrades * walk back some renaming * walk back some version stuff * extract version from fallback * remove V1 from NetworkBridgeUpdate * add accidentally-removed timer * implement focusing for versioned messages * fmt * fix up network bridge & tests * remove inaccurate version check in bridge * remove some TODO [now]s * fix fallout in statement distribution * fmt * fallout in gossip-support * fix fallout in collator-protocol * fix fallout in bitfield-distribution * fix fallout in approval-distribution * fmt * use never! * fmt
2026-04-26 23:57:56 +00:00 · 2022-04-21 11:34:59 -05:00
parent 203441981f
commit fc4b04db20
45 changed files with 942 additions and 594 deletions
@@ -89,36 +89,6 @@ impl Into<sc_network::ObservedRole> for ObservedRole {
 	}
 }

-/// Implement `TryFrom` for one enum variant into the inner type.
-/// `$m_ty::$variant(inner) -> Ok(inner)`
-macro_rules! impl_try_from {
-	($m_ty:ident, $variant:ident, $out:ty) => {
-		impl TryFrom<$m_ty> for $out {
-			type Error = crate::WrongVariant;
-
-			fn try_from(x: $m_ty) -> Result<$out, Self::Error> {
-				#[allow(unreachable_patterns)] // when there is only one variant
-				match x {
-					$m_ty::$variant(y) => Ok(y),
-					_ => Err(crate::WrongVariant),
-				}
-			}
-		}
-
-		impl<'a> TryFrom<&'a $m_ty> for &'a $out {
-			type Error = crate::WrongVariant;
-
-			fn try_from(x: &'a $m_ty) -> Result<&'a $out, Self::Error> {
-				#[allow(unreachable_patterns)] // when there is only one variant
-				match *x {
-					$m_ty::$variant(ref y) => Ok(y),
-					_ => Err(crate::WrongVariant),
-				}
-			}
-		}
-	};
-}
-
 /// Specialized wrapper around [`View`].
 ///
 /// Besides the access to the view itself, it also gives access to the [`jaeger::Span`] per leave/head.
@@ -279,7 +249,152 @@ impl View {
 	}
 }

-/// v1 protocol types.
+/// A protocol-versioned type.
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub enum Versioned<V1> {
+	/// V1 type.
+	V1(V1),
+}
+
+impl<V1: Clone> Versioned<&'_ V1> {
+	/// Convert to a fully-owned version of the message.
+	pub fn clone_inner(&self) -> Versioned<V1> {
+		match *self {
+			Versioned::V1(inner) => Versioned::V1(inner.clone()),
+		}
+	}
+}
+
+/// All supported versions of the validation protocol message.
+pub type VersionedValidationProtocol = Versioned<v1::ValidationProtocol>;
+
+impl From<v1::ValidationProtocol> for VersionedValidationProtocol {
+	fn from(v1: v1::ValidationProtocol) -> Self {
+		VersionedValidationProtocol::V1(v1)
+	}
+}
+
+/// All supported versions of the collation protocol message.
+pub type VersionedCollationProtocol = Versioned<v1::CollationProtocol>;
+
+impl From<v1::CollationProtocol> for VersionedCollationProtocol {
+	fn from(v1: v1::CollationProtocol) -> Self {
+		VersionedCollationProtocol::V1(v1)
+	}
+}
+
+macro_rules! impl_versioned_full_protocol_from {
+	($from:ty, $out:ty, $variant:ident) => {
+		impl From<$from> for $out {
+			fn from(versioned_from: $from) -> $out {
+				match versioned_from {
+					Versioned::V1(x) => Versioned::V1(x.into()),
+				}
+			}
+		}
+	};
+}
+
+/// Implement `TryFrom` for one versioned enum variant into the inner type.
+/// `$m_ty::$variant(inner) -> Ok(inner)`
+macro_rules! impl_versioned_try_from {
+	($from:ty, $out:ty, $v1_pat:pat => $v1_out:expr) => {
+		impl TryFrom<$from> for $out {
+			type Error = crate::WrongVariant;
+
+			fn try_from(x: $from) -> Result<$out, Self::Error> {
+				#[allow(unreachable_patterns)] // when there is only one variant
+				match x {
+					Versioned::V1($v1_pat) => Ok(Versioned::V1($v1_out)),
+					_ => Err(crate::WrongVariant),
+				}
+			}
+		}
+
+		impl<'a> TryFrom<&'a $from> for $out {
+			type Error = crate::WrongVariant;
+
+			fn try_from(x: &'a $from) -> Result<$out, Self::Error> {
+				#[allow(unreachable_patterns)] // when there is only one variant
+				match x {
+					Versioned::V1($v1_pat) => Ok(Versioned::V1($v1_out.clone())),
+					_ => Err(crate::WrongVariant),
+				}
+			}
+		}
+	};
+}
+
+/// Version-annotated messages used by the bitfield distribution subsystem.
+pub type BitfieldDistributionMessage = Versioned<v1::BitfieldDistributionMessage>;
+impl_versioned_full_protocol_from!(
+	BitfieldDistributionMessage,
+	VersionedValidationProtocol,
+	BitfieldDistribution
+);
+impl_versioned_try_from!(
+	VersionedValidationProtocol,
+	BitfieldDistributionMessage,
+	v1::ValidationProtocol::BitfieldDistribution(x) => x
+);
+
+/// Version-annotated messages used by the statement distribution subsystem.
+pub type StatementDistributionMessage = Versioned<v1::StatementDistributionMessage>;
+impl_versioned_full_protocol_from!(
+	StatementDistributionMessage,
+	VersionedValidationProtocol,
+	StatementDistribution
+);
+impl_versioned_try_from!(
+	VersionedValidationProtocol,
+	StatementDistributionMessage,
+	v1::ValidationProtocol::StatementDistribution(x) => x
+);
+
+/// Version-annotated messages used by the approval distribution subsystem.
+pub type ApprovalDistributionMessage = Versioned<v1::ApprovalDistributionMessage>;
+impl_versioned_full_protocol_from!(
+	ApprovalDistributionMessage,
+	VersionedValidationProtocol,
+	ApprovalDistribution
+);
+impl_versioned_try_from!(
+	VersionedValidationProtocol,
+	ApprovalDistributionMessage,
+	v1::ValidationProtocol::ApprovalDistribution(x) => x
+);
+
+/// Version-annotated messages used by the gossip-support subsystem (this is void).
+pub type GossipSupportNetworkMessage = Versioned<v1::GossipSupportNetworkMessage>;
+// This is a void enum placeholder, so never gets sent over the wire.
+impl TryFrom<VersionedValidationProtocol> for GossipSupportNetworkMessage {
+	type Error = WrongVariant;
+	fn try_from(_: VersionedValidationProtocol) -> Result<Self, Self::Error> {
+		Err(WrongVariant)
+	}
+}
+
+impl<'a> TryFrom<&'a VersionedValidationProtocol> for GossipSupportNetworkMessage {
+	type Error = WrongVariant;
+	fn try_from(_: &'a VersionedValidationProtocol) -> Result<Self, Self::Error> {
+		Err(WrongVariant)
+	}
+}
+
+/// Version-annotated messages used by the bitfield distribution subsystem.
+pub type CollatorProtocolMessage = Versioned<v1::CollatorProtocolMessage>;
+impl_versioned_full_protocol_from!(
+	CollatorProtocolMessage,
+	VersionedCollationProtocol,
+	CollatorProtocol
+);
+impl_versioned_try_from!(
+	VersionedCollationProtocol,
+	CollatorProtocolMessage,
+	v1::CollationProtocol::CollatorProtocol(x) => x
+);
+
+/// v1 notification protocol types.
 pub mod v1 {
 	use parity_scale_codec::{Decode, Encode};

@@ -293,8 +408,6 @@ pub mod v1 {
 		UncheckedSignedFullStatement,
 	};

-	use crate::WrongVariant;
-
 	/// Network messages used by the bitfield distribution subsystem.
 	#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq)]
 	pub enum BitfieldDistributionMessage {
@@ -384,7 +497,7 @@ pub mod v1 {

 	/// Dummy network message type, so we will receive connect/disconnect events.
 	#[derive(Debug, Clone, PartialEq, Eq)]
-	pub enum GossipSuppportNetworkMessage {}
+	pub enum GossipSupportNetworkMessage {}

 	/// Network messages used by the collator protocol subsystem
 	#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq)]
@@ -403,47 +516,31 @@ pub mod v1 {
 	}

 	/// All network messages on the validation peer-set.
-	#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq)]
+	#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq, derive_more::From)]
 	pub enum ValidationProtocol {
 		/// Bitfield distribution messages
 		#[codec(index = 1)]
+		#[from]
 		BitfieldDistribution(BitfieldDistributionMessage),
 		/// Statement distribution messages
 		#[codec(index = 3)]
+		#[from]
 		StatementDistribution(StatementDistributionMessage),
 		/// Approval distribution messages
 		#[codec(index = 4)]
+		#[from]
 		ApprovalDistribution(ApprovalDistributionMessage),
 	}

-	impl_try_from!(ValidationProtocol, BitfieldDistribution, BitfieldDistributionMessage);
-	impl_try_from!(ValidationProtocol, StatementDistribution, StatementDistributionMessage);
-	impl_try_from!(ValidationProtocol, ApprovalDistribution, ApprovalDistributionMessage);
-
-	impl TryFrom<ValidationProtocol> for GossipSuppportNetworkMessage {
-		type Error = WrongVariant;
-		fn try_from(_: ValidationProtocol) -> Result<Self, Self::Error> {
-			Err(WrongVariant)
-		}
-	}
-
-	impl<'a> TryFrom<&'a ValidationProtocol> for &'a GossipSuppportNetworkMessage {
-		type Error = WrongVariant;
-		fn try_from(_: &'a ValidationProtocol) -> Result<Self, Self::Error> {
-			Err(WrongVariant)
-		}
-	}
-
 	/// All network messages on the collation peer-set.
-	#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq)]
+	#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq, derive_more::From)]
 	pub enum CollationProtocol {
 		/// Collator protocol messages
 		#[codec(index = 0)]
+		#[from]
 		CollatorProtocol(CollatorProtocolMessage),
 	}

-	impl_try_from!(CollationProtocol, CollatorProtocol, CollatorProtocolMessage);
-
 	/// Get the payload that should be signed and included in a `Declare` message.
 	///
 	/// The payload is the local peer id of the node, which serves to prove that it