refactor+feat: allow subsystems to send only declared messages, generate graphviz (#5314)

Closes #3774
Closes #3826

polkadot/node/overseer/overseer-gen/examples/dummy.rs

@@ -1,143 +0,0 @@
-//! A dummy to be used with cargo expand
-
-use polkadot_node_network_protocol::WrongVariant;
-use polkadot_overseer_gen::*;
-use std::collections::HashMap;
-
-/// Concrete subsystem implementation for `MsgStrukt` msg type.
-#[derive(Default)]
-pub struct AwesomeSubSys;
-
-impl ::polkadot_overseer_gen::Subsystem<XxxSubsystemContext<MsgStrukt>, Yikes> for AwesomeSubSys {
-	fn start(self, _ctx: XxxSubsystemContext<MsgStrukt>) -> SpawnedSubsystem<Yikes> {
-		unimplemented!("starting yay!")
-	}
-}
-
-#[derive(Default)]
-pub struct GoblinTower;
-
-impl ::polkadot_overseer_gen::Subsystem<XxxSubsystemContext<Plinko>, Yikes> for GoblinTower {
-	fn start(self, _ctx: XxxSubsystemContext<Plinko>) -> SpawnedSubsystem<Yikes> {
-		unimplemented!("welcum")
-	}
-}
-
-/// A signal sent by the overseer.
-#[derive(Debug, Clone)]
-pub struct SigSigSig;
-
-/// The external event.
-#[derive(Debug, Clone)]
-pub struct EvX;
-
-impl EvX {
-	pub fn focus<'a, T>(&'a self) -> Result<EvX, ()> {
-		unimplemented!("dispatch")
-	}
-}
-
-#[derive(Debug, Clone, Copy)]
-pub struct Yikes;
-
-impl std::fmt::Display for Yikes {
-	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-		writeln!(f, "yikes!")
-	}
-}
-
-impl std::error::Error for Yikes {}
-
-impl From<polkadot_overseer_gen::OverseerError> for Yikes {
-	fn from(_: polkadot_overseer_gen::OverseerError) -> Yikes {
-		Yikes
-	}
-}
-
-impl From<polkadot_overseer_gen::mpsc::SendError> for Yikes {
-	fn from(_: polkadot_overseer_gen::mpsc::SendError) -> Yikes {
-		Yikes
-	}
-}
-
-#[derive(Debug, Clone)]
-pub struct MsgStrukt(u8);
-
-#[derive(Debug, Clone, Copy)]
-pub struct Plinko;
-
-impl From<NetworkMsg> for MsgStrukt {
-	fn from(_event: NetworkMsg) -> Self {
-		MsgStrukt(1u8)
-	}
-}
-
-#[derive(Debug, Clone, Copy)]
-pub enum NetworkMsg {
-	A,
-	B,
-	C,
-}
-
-impl NetworkMsg {
-	fn focus(&self) -> Result<Self, WrongVariant> {
-		Ok(match self {
-			Self::B => return Err(WrongVariant),
-			Self::A | Self::C => self.clone(),
-		})
-	}
-}
-
-#[overlord(signal=SigSigSig, event=EvX, error=Yikes, network=NetworkMsg, gen=AllMessages)]
-struct Xxx<T> {
-	#[subsystem(MsgStrukt)]
-	sub0: AwesomeSubSys,
-
-	#[subsystem(no_dispatch, blocking, Plinko)]
-	plinkos: GoblinTower,
-
-	i_like_pi: f64,
-	i_like_generic: T,
-	i_like_hash: HashMap<f64, f64>,
-}
-
-#[derive(Debug, Clone)]
-struct DummySpawner;
-
-impl SpawnNamed for DummySpawner {
-	fn spawn_blocking(
-		&self,
-		task_name: &'static str,
-		subsystem_name: Option<&'static str>,
-		_future: futures::future::BoxFuture<'static, ()>,
-	) {
-		unimplemented!("spawn blocking {} {}", task_name, subsystem_name.unwrap_or("default"))
-	}
-
-	fn spawn(
-		&self,
-		task_name: &'static str,
-		subsystem_name: Option<&'static str>,
-		_future: futures::future::BoxFuture<'static, ()>,
-	) {
-		unimplemented!("spawn {} {}", task_name, subsystem_name.unwrap_or("default"))
-	}
-}
-
-#[derive(Debug, Clone)]
-struct DummyCtx;
-
-fn main() {
-	let (overseer, _handle): (Xxx<_, f64>, _) = Xxx::builder()
-		.sub0(AwesomeSubSys::default())
-		.plinkos(GoblinTower::default())
-		.i_like_pi(::std::f64::consts::PI)
-		.i_like_generic(42.0)
-		.i_like_hash(HashMap::new())
-		.spawner(DummySpawner)
-		.build()
-		.unwrap();
-	assert_eq!(overseer.i_like_pi.floor() as i8, 3);
-	assert_eq!(overseer.i_like_generic.floor() as i8, 42);
-	assert_eq!(overseer.i_like_hash.len() as i8, 0);
-}

polkadot/node/overseer/overseer-gen/examples/duo.rs

@@ -0,0 +1,89 @@
+#![allow(dead_code)] // overseer events are not used
+
+//! A dummy to be used with cargo expand
+
+use polkadot_overseer_gen::{self as overseer, SpawnNamed, *};
+use std::collections::HashMap;
+mod misc;
+
+pub use self::misc::*;
+
+/// Concrete subsystem implementation for `MsgStrukt` msg type.
+#[derive(Default)]
+pub struct AwesomeSubSys;
+
+#[overseer::subsystem(Awesome, error=Yikes)]
+impl<Context> AwesomeSubSys {
+	fn start(self, mut ctx: Context) -> SpawnedSubsystem<Yikes> {
+		let mut sender = ctx.sender().clone();
+		ctx.spawn(
+			"AwesomeSubsys",
+			Box::pin(async move {
+				sender.send_message(Plinko).await;
+			}),
+		)
+		.unwrap();
+		unimplemented!("starting yay!")
+	}
+}
+
+#[derive(Default)]
+pub struct Fortified;
+
+#[overseer::subsystem(GoblinTower, error=Yikes)]
+impl<Context> Fortified {
+	fn start(self, mut ctx: Context) -> SpawnedSubsystem<Yikes> {
+		let mut sender = ctx.sender().clone();
+		ctx.spawn(
+			"GoblinTower",
+			Box::pin(async move {
+				sender.send_message(MsgStrukt(8u8)).await;
+			}),
+		)
+		.unwrap();
+		unimplemented!("welcum")
+	}
+}
+
+#[overlord(signal=SigSigSig, event=EvX, error=Yikes, gen=AllMessages)]
+struct Duo<T> {
+	#[subsystem(consumes: MsgStrukt, sends: [Plinko])]
+	sub0: Awesome,
+
+	#[subsystem(blocking, consumes: Plinko, sends: [MsgStrukt])]
+	plinkos: GoblinTower,
+
+	i_like_pi: f64,
+	i_like_generic: T,
+	i_like_hash: HashMap<f64, f64>,
+}
+
+fn main() {
+	use futures::{executor, pin_mut};
+
+	executor::block_on(async move {
+		let (overseer, _handle): (Duo<_, f64>, _) = Duo::builder()
+			.sub0(AwesomeSubSys::default())
+			.plinkos(Fortified::default())
+			.i_like_pi(::std::f64::consts::PI)
+			.i_like_generic(42.0)
+			.i_like_hash(HashMap::new())
+			.spawner(DummySpawner)
+			.build()
+			.unwrap();
+
+		assert_eq!(overseer.i_like_pi.floor() as i8, 3);
+		assert_eq!(overseer.i_like_generic.floor() as i8, 42);
+		assert_eq!(overseer.i_like_hash.len() as i8, 0);
+
+		let overseer_fut = overseer
+			.running_subsystems
+			.into_future()
+			.timeout(std::time::Duration::from_millis(300))
+			.fuse();
+
+		pin_mut!(overseer_fut);
+
+		overseer_fut.await
+	});
+}

polkadot/node/overseer/overseer-gen/examples/misc.rs

@@ -0,0 +1,69 @@
+use polkadot_overseer_gen::{SpawnNamed, *};
+
+#[derive(Debug, Clone, Copy)]
+pub enum SigSigSig {
+	Conclude,
+	Foo,
+}
+
+#[derive(Debug, Clone)]
+pub struct DummySpawner;
+
+impl SpawnNamed for DummySpawner {
+	fn spawn_blocking(
+		&self,
+		task_name: &'static str,
+		subsystem_name: Option<&'static str>,
+		_future: futures::future::BoxFuture<'static, ()>,
+	) {
+		unimplemented!("spawn blocking {} {}", task_name, subsystem_name.unwrap_or("default"))
+	}
+
+	fn spawn(
+		&self,
+		task_name: &'static str,
+		subsystem_name: Option<&'static str>,
+		_future: futures::future::BoxFuture<'static, ()>,
+	) {
+		unimplemented!("spawn {} {}", task_name, subsystem_name.unwrap_or("default"))
+	}
+}
+
+/// The external event.
+#[derive(Debug, Clone)]
+pub struct EvX;
+
+impl EvX {
+	pub fn focus<'a, T>(&'a self) -> Result<EvX, ()> {
+		unimplemented!("focus")
+	}
+}
+
+#[derive(Debug, Clone, Copy)]
+pub struct Yikes;
+
+impl std::fmt::Display for Yikes {
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		writeln!(f, "yikes!")
+	}
+}
+
+impl std::error::Error for Yikes {}
+
+impl From<polkadot_overseer_gen::OverseerError> for Yikes {
+	fn from(_: polkadot_overseer_gen::OverseerError) -> Yikes {
+		Yikes
+	}
+}
+
+impl From<polkadot_overseer_gen::mpsc::SendError> for Yikes {
+	fn from(_: polkadot_overseer_gen::mpsc::SendError) -> Yikes {
+		Yikes
+	}
+}
+
+#[derive(Debug, Clone)]
+pub struct MsgStrukt(pub u8);
+
+#[derive(Debug, Clone, Copy)]
+pub struct Plinko;

polkadot/node/overseer/overseer-gen/examples/solo.rs

@@ -0,0 +1,54 @@
+#![allow(dead_code)] // overseer events are not used
+
+//! A minimal demo to be used with cargo expand.
+
+use polkadot_overseer_gen::{self as overseer, SpawnNamed, *};
+mod misc;
+
+pub use self::misc::*;
+
+#[overlord(signal=SigSigSig, event=EvX, error=Yikes, gen=AllMessages)]
+struct Solo<T> {
+	#[subsystem(consumes: Plinko, sends: [MsgStrukt])]
+	goblin_tower: GoblinTower,
+}
+
+#[derive(Default)]
+pub struct Fortified;
+
+#[overseer::subsystem(GoblinTower, error=Yikes)]
+impl<Context> Fortified {
+	fn start(self, mut ctx: Context) -> SpawnedSubsystem<Yikes> {
+		let mut sender = ctx.sender().clone();
+		ctx.spawn(
+			"GoblinTower",
+			Box::pin(async move {
+				sender.send_message(MsgStrukt(8u8)).await;
+			}),
+		)
+		.unwrap();
+		unimplemented!("welcum")
+	}
+}
+
+fn main() {
+	use futures::{executor, pin_mut};
+
+	executor::block_on(async move {
+		let (overseer, _handle): (Solo<_>, _) = Solo::builder()
+			.goblin_tower(Fortified::default())
+			.spawner(DummySpawner)
+			.build()
+			.unwrap();
+
+		let overseer_fut = overseer
+			.running_subsystems
+			.into_future()
+			.timeout(std::time::Duration::from_millis(300))
+			.fuse();
+
+		pin_mut!(overseer_fut);
+
+		overseer_fut.await
+	});
+}