Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Fix `TestScheduler::spawn_dedicated` leaking due to cycle (#58802)
Lukas Wirthb14229f1a062
diff --git a/crates/scheduler/src/test_scheduler.rs b/crates/scheduler/src/test_scheduler.rsindex 722dfb13587..6c272395a49 100644--- a/crates/scheduler/src/test_scheduler.rs+++ b/crates/scheduler/src/test_scheduler.rs@@ -22,7 +22,7 @@ use std::{panic::{self, AssertUnwindSafe},pin::Pin,sync::{- Arc,+ Arc, Weak,atomic::{AtomicBool, Ordering::SeqCst},},task::{Context, Poll, RawWaker, RawWakerVTable, Waker},@@ -162,12 +162,11 @@ impl TestScheduler {/// Create a local executor for this scheduler.pub fn foreground(self: &Arc<Self>) -> LocalExecutor {let session_id = self.allocate_session_id();- let scheduler = Arc::downgrade(self);- LocalExecutor::new(session_id, self.clone(), move |runnable| {- if let Some(scheduler) = scheduler.upgrade() {- scheduler.schedule_local(session_id, runnable);- }- })+ LocalExecutor::new(+ session_id,+ self.clone(),+ schedule_local_dispatch(Arc::downgrade(self), session_id),+ )}/// Create a background executor for this scheduler@@ -680,13 +679,30 @@ impl Scheduler for TestScheduler {>,) -> Task<Box<dyn Any + Send + Sync>> {let session_id = self.allocate_session_id();- let scheduler = Arc::downgrade(&self);- let executor = LocalExecutor::new(session_id, self, move |runnable| {- if let Some(scheduler) = scheduler.upgrade() {- scheduler.schedule_local(session_id, runnable);- }- });- executor.spawn(f(executor.clone()))+ let weak_scheduler = Arc::downgrade(&self);+ let spawner = LocalExecutor::new(+ session_id,+ self,+ schedule_local_dispatch(weak_scheduler.clone(), session_id),+ );+ // The dedicated future sits in this scheduler's own queue until its+ // first poll. A `LocalExecutor` holds the scheduler strongly, so+ // capturing one here would create a reference cycle+ // (scheduler -> queued runnable -> future -> executor -> scheduler)+ // that leaks both if the scheduler is dropped before ever being run.+ // Construct the executor lazily at first poll, when the runnable is+ // already out of the queue.+ spawner.spawn(async move {+ let scheduler = weak_scheduler+ .upgrade()+ .expect("dedicated tasks are only polled by their scheduler, which is still alive when polled");+ let executor = LocalExecutor::new(+ session_id,+ scheduler,+ schedule_local_dispatch(weak_scheduler, session_id),+ );+ f(executor).await+ })}fn as_test(&self) -> Option<&TestScheduler> {@@ -694,6 +710,19 @@ impl Scheduler for TestScheduler {}}+/// Dispatch closure for `LocalExecutor`s backed by a `TestScheduler`. Holds+/// the scheduler weakly so queued runnables don't keep it alive.+fn schedule_local_dispatch(+ scheduler: Weak<TestScheduler>,+ session_id: SessionId,+) -> impl Fn(Runnable<RunnableMeta>) + Send + Sync + 'static {+ move |runnable| {+ if let Some(scheduler) = scheduler.upgrade() {+ scheduler.schedule_local(session_id, runnable);+ }+ }+}+#[derive(Clone, Debug)]pub struct TestSchedulerConfig {pub seed: u64,diff --git a/crates/scheduler/src/tests.rs b/crates/scheduler/src/tests.rsindex 1e29211ca87..1daea8cf965 100644--- a/crates/scheduler/src/tests.rs+++ b/crates/scheduler/src/tests.rs@@ -72,6 +72,23 @@ fn test_scheduler_drops_with_stalled_detached_background_task() {drop(sender);}+/// A dedicated task that is never polled must not keep the scheduler alive:+/// its runnable sits in the scheduler's own queue, so any strong scheduler+/// handle captured by the future would form a reference cycle and leak both.+#[test]+fn test_scheduler_drops_with_never_polled_dedicated_task() {+ let scheduler = Arc::new(TestScheduler::new(TestSchedulerConfig::default()));+ let weak_scheduler = Arc::downgrade(&scheduler);++ scheduler+ .background()+ .spawn_dedicated(|_executor| async move {})+ .detach();++ drop(scheduler);+ assert!(weak_scheduler.upgrade().is_none());+}+#[test]fn test_foreground_ordering() {let mut traces = HashSet::new();