1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
#![forbid(unsafe_code)]
#![warn(missing_debug_implementations)]
#![warn(missing_docs)]
#![doc = include_str!("../README.md")]

mod command;
mod entity;
mod resource;
mod system;
mod world;

use async_channel::{Receiver, Sender, TryRecvError};
use bevy_app::prelude::*;
use bevy_ecs::prelude::*;
use bevy_ecs::system::Command;
use entity::wait_for_reflect_components;
use operations::AsyncOperation;
use resource::wait_for_reflect_resources;
use std::borrow::Cow;

pub use entity::{AsyncComponent, AsyncEntity};
pub use resource::AsyncResource;
pub use system::{AsyncIOSystem, AsyncSystem};
pub use world::AsyncWorld;

/// Types for interacting with the `AsyncWorld` directly, rather than through the convenience commands.
pub mod operations {
	use bevy_ecs::prelude::*;
	use bevy_ecs::system::Command;

	pub use super::command::BoxedCommand;
	pub use super::entity::reflect::ReflectOperation;
	pub use super::entity::EntityOperation;
	pub use super::resource::ResourceOperation;
	pub use super::system::SystemOperation;

	/// An operation that can be applied to an `AsyncWorld`.
	#[derive(Debug)]
	#[non_exhaustive]
	pub enum AsyncOperation {
		/// A vanilla Bevy `Command` (wrapped in a `CommandBox`).
		Command(BoxedCommand),
		/// `System` operations.
		System(SystemOperation),
		/// `Entity` operations.
		Entity(EntityOperation),
		/// `Resource` operations.
		Resource(ResourceOperation),
		/// A FIFO queue of `AsyncOperation`s.
		Queue(OperationQueue),
	}

	impl Command for AsyncOperation {
		fn apply(self, world: &mut World) {
			match self {
				AsyncOperation::Command(command) => command.apply(world),
				AsyncOperation::System(system_op) => system_op.apply(world),
				AsyncOperation::Entity(entity_op) => entity_op.apply(world),
				AsyncOperation::Resource(resource_op) => resource_op.apply(world),
				AsyncOperation::Queue(queue) => queue.apply(world),
			}
		}
	}

	/// A queue of `AsyncOperation`s that will be applied to the `AsyncWorld` atomically in FIFO order.
	#[derive(Debug)]
	pub struct OperationQueue(Vec<AsyncOperation>);

	impl Default for OperationQueue {
		fn default() -> Self {
			Self::new()
		}
	}

	impl OperationQueue {
		/// Constructs a new, empty `OperationQueue`.
		pub fn new() -> Self {
			Self(Vec::with_capacity(4))
		}

		/// Appends an operation to the queue.
		pub fn push(&mut self, operation: impl Into<AsyncOperation>) {
			let operation = operation.into();
			self.0.push(operation);
		}

		#[cfg(test)]
		pub(crate) fn len(&self) -> usize {
			self.0.len()
		}
	}

	impl Command for OperationQueue {
		fn apply(self, world: &mut World) {
			for operation in self.0 {
				operation.apply(world);
			}
		}
	}

	impl FromIterator<AsyncOperation> for OperationQueue {
		fn from_iter<I: IntoIterator<Item = AsyncOperation>>(iter: I) -> Self {
			Self(iter.into_iter().collect())
		}
	}

	impl From<OperationQueue> for AsyncOperation {
		fn from(queue: OperationQueue) -> Self {
			Self::Queue(queue)
		}
	}
}

type CowStr = Cow<'static, str>;

/// Adds asynchronous ECS operations to Bevy `App`s.
#[derive(Debug)]
pub struct AsyncEcsPlugin;

impl Plugin for AsyncEcsPlugin {
	fn build(&self, app: &mut App) {
		app.init_resource::<WorldOperationQueue>()
			.add_systems(
				Last,
				(receive_operations, apply_operations, apply_deferred).chain(),
			)
			.add_systems(
				PostUpdate,
				(wait_for_reflect_components, wait_for_reflect_resources),
			);
	}
}

#[derive(Clone, Debug)]
struct OperationSender(Sender<AsyncOperation>);

impl OperationSender {
	async fn send<O: Into<AsyncOperation>>(&self, operation: O) {
		let operation = operation.into();
		self.send_inner(operation).await;
	}

	async fn send_inner(&self, operation: AsyncOperation) {
		self.0.send(operation).await.expect("invariant broken");
	}
}

#[derive(Component)]
struct OperationReceiver(Receiver<AsyncOperation>);

impl OperationReceiver {
	fn enqueue_into(&self, queue: &mut WorldOperationQueue) -> Result<(), ()> {
		loop {
			match self.0.try_recv() {
				Ok(system) => queue.0.push(system),
				Err(TryRecvError::Closed) => break Err(()),
				Err(TryRecvError::Empty) => break Ok(()),
			}
		}
	}
}

#[derive(Resource)]
struct WorldOperationQueue(Vec<AsyncOperation>);

impl Default for WorldOperationQueue {
	fn default() -> Self {
		Self(Vec::with_capacity(16))
	}
}

fn receive_operations(
	mut commands: Commands,
	receivers: Query<(Entity, &OperationReceiver)>,
	mut queue: ResMut<WorldOperationQueue>,
) {
	for (id, receiver) in receivers.iter() {
		if receiver.enqueue_into(&mut queue).is_err() {
			commands.entity(id).despawn()
		}
	}
}

fn apply_operations(world: &mut World) {
	world.resource_scope::<WorldOperationQueue, _>(|world, mut queue| {
		for operation in queue.0.drain(..) {
			operation.apply(world);
		}
	})
}

#[cfg(test)]
mod tests {
	use super::operations::*;
	use super::*;
	use bevy::prelude::*;
	use futures_lite::future;
	use std::any::TypeId;

	#[derive(Default, Component, Reflect)]
	#[reflect(Component)]
	struct Counter(u8);

	#[test]
	fn queue() {
		let mut app = App::new();
		app.register_type::<Counter>();
		app.add_plugins((MinimalPlugins, AsyncEcsPlugin));

		let (value_tx, value_rx) = async_channel::bounded(1);
		let async_world = AsyncWorld::from_world(&mut app.world);
		let id = app.world.spawn_empty().id();

		let type_id = TypeId::of::<Counter>();

		std::thread::spawn(move || {
			future::block_on(async move {
				let counter = Box::new(Counter(3));

				let operation = OperationQueue::from_iter([
					ReflectOperation::InsertComponent(id, counter).into(),
					ReflectOperation::WaitForComponent(id, type_id, value_tx).into(),
					ReflectOperation::RemoveComponent(id, type_id).into(),
				]);

				async_world.apply_operation(operation.into()).await;
			});
		});

		let value = loop {
			match value_rx.try_recv() {
				Ok(value) => break value,
				Err(_) => app.update(),
			}
		};
		app.update();

		let counter = Counter::take_from_reflect(value).unwrap();
		assert_eq!(3, counter.0);
		assert!(app.world.entity(id).get::<Counter>().is_none());
	}

	#[test]
	fn coverage() {
		let id = Entity::PLACEHOLDER;

		let queue1 = {
			let mut queue = OperationQueue::default();
			queue.push(EntityOperation::Despawn(id));
			queue
		};

		let queue2 = OperationQueue::from_iter([EntityOperation::Despawn(id).into()]);

		assert_eq!(queue1.len(), queue2.len());
	}
}