feat(swarm): Show task spawn paths in tokio-console

oblique · web-flow · commit 693d7b7df75c · 2024-07-04T15:02:49.000Z
This PR adds `#[track_caller]` on all `spawn` wrappers. Pull-Request: #5465.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -86,7 +86,7 @@ libp2p-gossipsub = { version = "0.46.2", path = "protocols/gossipsub" }
 libp2p-identify = { version = "0.45.0", path = "protocols/identify" }
 libp2p-identity = { version = "0.2.9" }
 libp2p-kad = { version = "0.46.0", path = "protocols/kad" }
-libp2p-mdns = { version = "0.45.1", path = "protocols/mdns" }
+libp2p-mdns = { version = "0.45.2", path = "protocols/mdns" }
 libp2p-memory-connection-limits = { version = "0.2.0", path = "misc/memory-connection-limits" }
 libp2p-metrics = { version = "0.14.2", path = "misc/metrics" }
 libp2p-mplex = { version = "0.41.0", path = "muxers/mplex" }
diff --git a/protocols/mdns/CHANGELOG.md b/protocols/mdns/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.45.2
+
+- Add `#[track_caller]` on all `spawn` wrappers.
+  See [PR 5465](https://github.com/libp2p/rust-libp2p/pull/5465).
+
 ## 0.45.1
 
 - Ensure `Multiaddr` handled and returned by `Behaviour` are `/p2p` terminated.
diff --git a/protocols/mdns/Cargo.toml b/protocols/mdns/Cargo.toml
@@ -2,7 +2,7 @@
 name = "libp2p-mdns"
 edition = "2021"
 rust-version = { workspace = true }
-version = "0.45.1"
+version = "0.45.2"
 description = "Implementation of the libp2p mDNS discovery method"
 authors = ["Parity Technologies <admin@parity.io>"]
 license = "MIT"
diff --git a/protocols/mdns/src/behaviour.rs b/protocols/mdns/src/behaviour.rs
@@ -55,6 +55,7 @@ pub trait Provider: 'static {
     /// Create a new instance of the `IfWatcher` type.
     fn new_watcher() -> Result<Self::Watcher, std::io::Error>;
 
+    #[track_caller]
     fn spawn(task: impl Future<Output = ()> + Send + 'static) -> Self::TaskHandle;
 }
 
diff --git a/swarm/CHANGELOG.md b/swarm/CHANGELOG.md
@@ -5,6 +5,8 @@
 
 - Use `web-time` instead of `instant`.
   See [PR 5347](https://github.com/libp2p/rust-libp2p/pull/5347).
+- Add `#[track_caller]` on all `spawn` wrappers.
+  See [PR 5465](https://github.com/libp2p/rust-libp2p/pull/5465).
 
 ## 0.44.2
 
diff --git a/swarm/src/connection/pool.rs b/swarm/src/connection/pool.rs
@@ -70,6 +70,7 @@ impl ExecSwitch {
         }
     }
 
+    #[track_caller]
     fn spawn(&mut self, task: impl Future<Output = ()> + Send + 'static) {
         let task = task.boxed();
 
diff --git a/swarm/src/executor.rs b/swarm/src/executor.rs
@@ -11,6 +11,7 @@ use std::{future::Future, pin::Pin};
 /// >           about running `Future`s on a separate task.
 pub trait Executor {
     /// Run the given future in the background until it ends.
+    #[track_caller]
     fn exec(&self, future: Pin<Box<dyn Future<Output = ()> + Send>>);
 }
 

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ pub trait Provider: 'static {`
`55`	`55`	/// Create a new instance of the `IfWatcher` type.
`56`	`56`	`fn new_watcher() -> Result<Self::Watcher, std::io::Error>;`
`57`	`57`
	`58`	`+ #[track_caller]`
`58`	`59`	`fn spawn(task: impl Future<Output = ()> + Send + 'static) -> Self::TaskHandle;`
`59`	`60`	`}`
`60`	`61`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ impl ExecSwitch {`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`
	`73`	`+ #[track_caller]`
`73`	`74`	`fn spawn(&mut self, task: impl Future<Output = ()> + Send + 'static) {`
`74`	`75`	`let task = task.boxed();`
`75`	`76`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ use std::{future::Future, pin::Pin};`
`11`	`11`	/// > about running `Future`s on a separate task.
`12`	`12`	`pub trait Executor {`
`13`	`13`	`/// Run the given future in the background until it ends.`
	`14`	`+ #[track_caller]`
`14`	`15`	`fn exec(&self, future: Pin<Box<dyn Future<Output = ()> + Send>>);`
`15`	`16`	`}`
`16`	`17`