From ffeecf39c24966e01428f01647da03d2194cabcb Mon Sep 17 00:00:00 2001
From: Mike <mike.hsu@gmail.com>
Date: Wed, 4 Oct 2023 23:05:43 -0700
Subject: [PATCH] add test for nested scopes (#10026)

# Objective

- When I've tested alternative async executors with bevy a common
problem is that they deadlock when we try to run nested scopes. i.e.
running a multithreaded schedule from inside another multithreaded
schedule. This adds a test to bevy_tasks for that so the issue can be
spotted earlier while developing.

## Changelog

- add a test for nested scopes.
---
 crates/bevy_tasks/src/task_pool.rs | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/crates/bevy_tasks/src/task_pool.rs b/crates/bevy_tasks/src/task_pool.rs
index 5562a5abc0a47..b538705b6742b 100644
--- a/crates/bevy_tasks/src/task_pool.rs
+++ b/crates/bevy_tasks/src/task_pool.rs
@@ -918,4 +918,23 @@ mod tests {
         assert!(!thread_check_failed.load(Ordering::Acquire));
         assert_eq!(count.load(Ordering::Acquire), 200);
     }
+
+    // This test will often freeze on other executors.
+    #[test]
+    fn test_nested_scopes() {
+        let pool = TaskPool::new();
+        let count = Arc::new(AtomicI32::new(0));
+
+        pool.scope(|scope| {
+            scope.spawn(async {
+                pool.scope(|scope| {
+                    scope.spawn(async {
+                        count.fetch_add(1, Ordering::Relaxed);
+                    });
+                });
+            });
+        });
+
+        assert_eq!(count.load(Ordering::Acquire), 1);
+    }
 }