Don't retain entities after EntityTasks are dropped
This allows us to spawn long-running tasks without leaking entities, but it also ensures that if we *do* hold on to a task, that the entity exists until the future or stream complete so that the task doesn't need to return an Option type. Co-Authored-By: Max Brunsfeld <maxbrunsfeld@gmail.com>
This commit is contained in:
co-authored by
Max Brunsfeld
parent
4eac765f1a
commit
5e08a02ca8
+131
-46
@@ -718,11 +718,12 @@ impl MutableAppContext {
|
|||||||
{
|
{
|
||||||
self.pending_flushes += 1;
|
self.pending_flushes += 1;
|
||||||
let model_id = post_inc(&mut self.next_entity_id);
|
let model_id = post_inc(&mut self.next_entity_id);
|
||||||
|
let handle = ModelHandle::new(model_id, &self.ctx.ref_counts);
|
||||||
let mut ctx = ModelContext::new(self, model_id);
|
let mut ctx = ModelContext::new(self, model_id);
|
||||||
let model = build_model(&mut ctx);
|
let model = build_model(&mut ctx);
|
||||||
self.ctx.models.insert(model_id, Box::new(model));
|
self.ctx.models.insert(model_id, Box::new(model));
|
||||||
self.flush_effects();
|
self.flush_effects();
|
||||||
ModelHandle::new(model_id, &self.ctx.ref_counts)
|
handle
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn add_window<T, F>(&mut self, build_root_view: F) -> (usize, ViewHandle<T>)
|
pub fn add_window<T, F>(&mut self, build_root_view: F) -> (usize, ViewHandle<T>)
|
||||||
@@ -925,6 +926,11 @@ impl MutableAppContext {
|
|||||||
|
|
||||||
if self.pending_effects.is_empty() {
|
if self.pending_effects.is_empty() {
|
||||||
self.flushing_effects = false;
|
self.flushing_effects = false;
|
||||||
|
|
||||||
|
for (key, view) in &self.ctx.views {
|
||||||
|
log::info!("{:?} {}", key, view.ui_name());
|
||||||
|
}
|
||||||
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1136,7 +1142,7 @@ impl MutableAppContext {
|
|||||||
self.flush_effects();
|
self.flush_effects();
|
||||||
}
|
}
|
||||||
|
|
||||||
fn spawn<F, T>(&mut self, future: F) -> EntityTask<T>
|
fn spawn<F, T>(&mut self, spawner: Spawner, future: F) -> EntityTask<T>
|
||||||
where
|
where
|
||||||
F: 'static + Future,
|
F: 'static + Future,
|
||||||
T: 'static,
|
T: 'static,
|
||||||
@@ -1147,20 +1153,20 @@ impl MutableAppContext {
|
|||||||
let app = app.clone();
|
let app = app.clone();
|
||||||
self.foreground.spawn(async move {
|
self.foreground.spawn(async move {
|
||||||
let output = future.await;
|
let output = future.await;
|
||||||
*app.borrow_mut()
|
app.borrow_mut()
|
||||||
.handle_future_output(task_id, Box::new(output))
|
.handle_future_output(task_id, Box::new(output))
|
||||||
.downcast::<T>()
|
.map(|output| *output.downcast::<T>().unwrap())
|
||||||
.unwrap()
|
|
||||||
})
|
})
|
||||||
};
|
};
|
||||||
EntityTask::new(
|
EntityTask::new(
|
||||||
task_id,
|
task_id,
|
||||||
task,
|
task,
|
||||||
|
spawner,
|
||||||
TaskHandlerMap::Future(self.future_handlers.clone()),
|
TaskHandlerMap::Future(self.future_handlers.clone()),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn spawn_stream<F, T>(&mut self, mut stream: F) -> EntityTask<T>
|
fn spawn_stream<F, T>(&mut self, spawner: Spawner, mut stream: F) -> EntityTask<T>
|
||||||
where
|
where
|
||||||
F: 'static + Stream + Unpin,
|
F: 'static + Stream + Unpin,
|
||||||
T: 'static,
|
T: 'static,
|
||||||
@@ -1182,20 +1188,24 @@ impl MutableAppContext {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
*app.borrow_mut()
|
app.borrow_mut()
|
||||||
.stream_completed(task_id)
|
.stream_completed(task_id)
|
||||||
.downcast::<T>()
|
.map(|output| *output.downcast::<T>().unwrap())
|
||||||
.unwrap()
|
|
||||||
});
|
});
|
||||||
|
|
||||||
EntityTask::new(
|
EntityTask::new(
|
||||||
task_id,
|
task_id,
|
||||||
task,
|
task,
|
||||||
|
spawner,
|
||||||
TaskHandlerMap::Stream(self.stream_handlers.clone()),
|
TaskHandlerMap::Stream(self.stream_handlers.clone()),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn handle_future_output(&mut self, task_id: usize, output: Box<dyn Any>) -> Box<dyn Any> {
|
fn handle_future_output(
|
||||||
|
&mut self,
|
||||||
|
task_id: usize,
|
||||||
|
output: Box<dyn Any>,
|
||||||
|
) -> Option<Box<dyn Any>> {
|
||||||
self.pending_flushes += 1;
|
self.pending_flushes += 1;
|
||||||
let future_callback = self.future_handlers.borrow_mut().remove(&task_id).unwrap();
|
let future_callback = self.future_handlers.borrow_mut().remove(&task_id).unwrap();
|
||||||
let result = future_callback(output, self);
|
let result = future_callback(output, self);
|
||||||
@@ -1214,7 +1224,7 @@ impl MutableAppContext {
|
|||||||
halt
|
halt
|
||||||
}
|
}
|
||||||
|
|
||||||
fn stream_completed(&mut self, task_id: usize) -> Box<dyn Any> {
|
fn stream_completed(&mut self, task_id: usize) -> Option<Box<dyn Any>> {
|
||||||
self.pending_flushes += 1;
|
self.pending_flushes += 1;
|
||||||
|
|
||||||
let handler = self.stream_handlers.borrow_mut().remove(&task_id).unwrap();
|
let handler = self.stream_handlers.borrow_mut().remove(&task_id).unwrap();
|
||||||
@@ -1239,9 +1249,9 @@ impl ReadModel for MutableAppContext {
|
|||||||
model
|
model
|
||||||
.as_any()
|
.as_any()
|
||||||
.downcast_ref()
|
.downcast_ref()
|
||||||
.expect("Downcast is type safe")
|
.expect("downcast is type safe")
|
||||||
} else {
|
} else {
|
||||||
panic!("Circular model reference");
|
panic!("circular model reference");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1259,14 +1269,14 @@ impl UpdateModel for MutableAppContext {
|
|||||||
model
|
model
|
||||||
.as_any_mut()
|
.as_any_mut()
|
||||||
.downcast_mut()
|
.downcast_mut()
|
||||||
.expect("Downcast is type safe"),
|
.expect("downcast is type safe"),
|
||||||
&mut ctx,
|
&mut ctx,
|
||||||
);
|
);
|
||||||
self.ctx.models.insert(handle.model_id, model);
|
self.ctx.models.insert(handle.model_id, model);
|
||||||
self.flush_effects();
|
self.flush_effects();
|
||||||
result
|
result
|
||||||
} else {
|
} else {
|
||||||
panic!("Circular model update");
|
panic!("circular model update");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1298,7 +1308,7 @@ impl UpdateView for MutableAppContext {
|
|||||||
let result = update(
|
let result = update(
|
||||||
view.as_any_mut()
|
view.as_any_mut()
|
||||||
.downcast_mut()
|
.downcast_mut()
|
||||||
.expect("Downcast is type safe"),
|
.expect("downcast is type safe"),
|
||||||
&mut ctx,
|
&mut ctx,
|
||||||
);
|
);
|
||||||
self.ctx
|
self.ctx
|
||||||
@@ -1604,13 +1614,20 @@ impl<'a, T: Entity> ModelContext<'a, T> {
|
|||||||
U: 'static,
|
U: 'static,
|
||||||
{
|
{
|
||||||
let handle = self.handle();
|
let handle = self.handle();
|
||||||
let task = self.app.spawn::<S, U>(future);
|
let weak_handle = handle.downgrade();
|
||||||
|
let task = self
|
||||||
|
.app
|
||||||
|
.spawn::<S, U>(Spawner::Model(handle.into()), future);
|
||||||
|
|
||||||
self.app.future_handlers.borrow_mut().insert(
|
self.app.future_handlers.borrow_mut().insert(
|
||||||
task.id,
|
task.id,
|
||||||
Box::new(move |output, ctx| {
|
Box::new(move |output, ctx| {
|
||||||
let output = *output.downcast().unwrap();
|
weak_handle.upgrade(ctx.as_ref()).map(|handle| {
|
||||||
handle.update(ctx, |model, ctx| Box::new(callback(model, output, ctx)))
|
let output = *output.downcast().unwrap();
|
||||||
|
handle.update(ctx, |model, ctx| {
|
||||||
|
Box::new(callback(model, output, ctx)) as Box<dyn Any>
|
||||||
|
})
|
||||||
|
})
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -1630,23 +1647,31 @@ impl<'a, T: Entity> ModelContext<'a, T> {
|
|||||||
U: 'static + Any,
|
U: 'static + Any,
|
||||||
{
|
{
|
||||||
let handle = self.handle();
|
let handle = self.handle();
|
||||||
let task = self.app.spawn_stream(stream);
|
let weak_handle = handle.downgrade();
|
||||||
|
let task = self.app.spawn_stream(Spawner::Model(handle.into()), stream);
|
||||||
|
|
||||||
self.app.stream_handlers.borrow_mut().insert(
|
self.app.stream_handlers.borrow_mut().insert(
|
||||||
task.id,
|
task.id,
|
||||||
StreamHandler {
|
StreamHandler {
|
||||||
item_callback: {
|
item_callback: {
|
||||||
let handle = handle.clone();
|
let weak_handle = weak_handle.clone();
|
||||||
Box::new(move |output, app| {
|
Box::new(move |output, app| {
|
||||||
let output = *output.downcast().unwrap();
|
if let Some(handle) = weak_handle.upgrade(app.as_ref()) {
|
||||||
handle.update(app, |model, ctx| {
|
let output = *output.downcast().unwrap();
|
||||||
item_callback(model, output, ctx);
|
handle.update(app, |model, ctx| {
|
||||||
ctx.halt_stream
|
item_callback(model, output, ctx);
|
||||||
})
|
ctx.halt_stream
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
true
|
||||||
|
}
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
done_callback: Box::new(move |app| {
|
done_callback: Box::new(move |app| {
|
||||||
handle.update(app, |model, ctx| Box::new(done_callback(model, ctx)))
|
weak_handle.upgrade(app.as_ref()).map(|handle| {
|
||||||
|
handle.update(app, |model, ctx| Box::new(done_callback(model, ctx)))
|
||||||
|
as Box<dyn Any>
|
||||||
|
})
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -1896,13 +1921,18 @@ impl<'a, T: View> ViewContext<'a, T> {
|
|||||||
U: 'static,
|
U: 'static,
|
||||||
{
|
{
|
||||||
let handle = self.handle();
|
let handle = self.handle();
|
||||||
let task = self.app.spawn(future);
|
let weak_handle = handle.downgrade();
|
||||||
|
let task = self.app.spawn(Spawner::View(handle.into()), future);
|
||||||
|
|
||||||
self.app.future_handlers.borrow_mut().insert(
|
self.app.future_handlers.borrow_mut().insert(
|
||||||
task.id,
|
task.id,
|
||||||
Box::new(move |output, app| {
|
Box::new(move |output, app| {
|
||||||
let output = *output.downcast().unwrap();
|
weak_handle.upgrade(app.as_ref()).map(|handle| {
|
||||||
handle.update(app, |view, ctx| Box::new(callback(view, output, ctx)))
|
let output = *output.downcast().unwrap();
|
||||||
|
handle.update(app, |view, ctx| {
|
||||||
|
Box::new(callback(view, output, ctx)) as Box<dyn Any>
|
||||||
|
})
|
||||||
|
})
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -1922,22 +1952,31 @@ impl<'a, T: View> ViewContext<'a, T> {
|
|||||||
U: 'static + Any,
|
U: 'static + Any,
|
||||||
{
|
{
|
||||||
let handle = self.handle();
|
let handle = self.handle();
|
||||||
let task = self.app.spawn_stream(stream);
|
let weak_handle = handle.downgrade();
|
||||||
|
let task = self.app.spawn_stream(Spawner::View(handle.into()), stream);
|
||||||
self.app.stream_handlers.borrow_mut().insert(
|
self.app.stream_handlers.borrow_mut().insert(
|
||||||
task.id,
|
task.id,
|
||||||
StreamHandler {
|
StreamHandler {
|
||||||
item_callback: {
|
item_callback: {
|
||||||
let handle = handle.clone();
|
let weak_handle = weak_handle.clone();
|
||||||
Box::new(move |output, app| {
|
Box::new(move |output, ctx| {
|
||||||
let output = *output.downcast().unwrap();
|
if let Some(handle) = weak_handle.upgrade(ctx.as_ref()) {
|
||||||
handle.update(app, |view, ctx| {
|
let output = *output.downcast().unwrap();
|
||||||
item_callback(view, output, ctx);
|
handle.update(ctx, |view, ctx| {
|
||||||
ctx.halt_stream
|
item_callback(view, output, ctx);
|
||||||
})
|
ctx.halt_stream
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
true
|
||||||
|
}
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
done_callback: Box::new(move |app| {
|
done_callback: Box::new(move |ctx| {
|
||||||
handle.update(app, |view, ctx| Box::new(done_callback(view, ctx)))
|
weak_handle.upgrade(ctx.as_ref()).map(|handle| {
|
||||||
|
handle.update(ctx, |view, ctx| {
|
||||||
|
Box::new(done_callback(view, ctx)) as Box<dyn Any>
|
||||||
|
})
|
||||||
|
})
|
||||||
}),
|
}),
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -2178,6 +2217,40 @@ impl<T: Entity> WeakModelHandle<T> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<T> Clone for WeakModelHandle<T> {
|
||||||
|
fn clone(&self) -> Self {
|
||||||
|
Self {
|
||||||
|
model_id: self.model_id,
|
||||||
|
model_type: PhantomData,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct AnyModelHandle {
|
||||||
|
model_id: usize,
|
||||||
|
ref_counts: Weak<Mutex<RefCounts>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T: Entity> From<ModelHandle<T>> for AnyModelHandle {
|
||||||
|
fn from(handle: ModelHandle<T>) -> Self {
|
||||||
|
if let Some(ref_counts) = handle.ref_counts.upgrade() {
|
||||||
|
ref_counts.lock().inc_entity(handle.model_id);
|
||||||
|
}
|
||||||
|
Self {
|
||||||
|
model_id: handle.model_id,
|
||||||
|
ref_counts: handle.ref_counts.clone(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for AnyModelHandle {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
if let Some(ref_counts) = self.ref_counts.upgrade() {
|
||||||
|
ref_counts.lock().dec_model(self.model_id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub struct ViewHandle<T> {
|
pub struct ViewHandle<T> {
|
||||||
window_id: usize,
|
window_id: usize,
|
||||||
view_id: usize,
|
view_id: usize,
|
||||||
@@ -2551,20 +2624,26 @@ struct ViewObservation {
|
|||||||
callback: Box<dyn FnMut(&mut dyn Any, usize, usize, &mut MutableAppContext, usize, usize)>,
|
callback: Box<dyn FnMut(&mut dyn Any, usize, usize, &mut MutableAppContext, usize, usize)>,
|
||||||
}
|
}
|
||||||
|
|
||||||
type FutureHandler = Box<dyn FnOnce(Box<dyn Any>, &mut MutableAppContext) -> Box<dyn Any>>;
|
type FutureHandler = Box<dyn FnOnce(Box<dyn Any>, &mut MutableAppContext) -> Option<Box<dyn Any>>>;
|
||||||
|
|
||||||
struct StreamHandler {
|
struct StreamHandler {
|
||||||
item_callback: Box<dyn FnMut(Box<dyn Any>, &mut MutableAppContext) -> bool>,
|
item_callback: Box<dyn FnMut(Box<dyn Any>, &mut MutableAppContext) -> bool>,
|
||||||
done_callback: Box<dyn FnOnce(&mut MutableAppContext) -> Box<dyn Any>>,
|
done_callback: Box<dyn FnOnce(&mut MutableAppContext) -> Option<Box<dyn Any>>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[must_use]
|
#[must_use]
|
||||||
pub struct EntityTask<T> {
|
pub struct EntityTask<T> {
|
||||||
id: usize,
|
id: usize,
|
||||||
task: Option<executor::Task<T>>,
|
task: Option<executor::Task<Option<T>>>,
|
||||||
|
_spawner: Spawner, // Keeps the spawning entity alive for as long as the task exists
|
||||||
handler_map: TaskHandlerMap,
|
handler_map: TaskHandlerMap,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub enum Spawner {
|
||||||
|
Model(AnyModelHandle),
|
||||||
|
View(AnyViewHandle),
|
||||||
|
}
|
||||||
|
|
||||||
enum TaskHandlerMap {
|
enum TaskHandlerMap {
|
||||||
Detached,
|
Detached,
|
||||||
Future(Rc<RefCell<HashMap<usize, FutureHandler>>>),
|
Future(Rc<RefCell<HashMap<usize, FutureHandler>>>),
|
||||||
@@ -2572,10 +2651,16 @@ enum TaskHandlerMap {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl<T> EntityTask<T> {
|
impl<T> EntityTask<T> {
|
||||||
fn new(id: usize, task: executor::Task<T>, handler_map: TaskHandlerMap) -> Self {
|
fn new(
|
||||||
|
id: usize,
|
||||||
|
task: executor::Task<Option<T>>,
|
||||||
|
spawner: Spawner,
|
||||||
|
handler_map: TaskHandlerMap,
|
||||||
|
) -> Self {
|
||||||
Self {
|
Self {
|
||||||
id,
|
id,
|
||||||
task: Some(task),
|
task: Some(task),
|
||||||
|
_spawner: spawner,
|
||||||
handler_map,
|
handler_map,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2587,7 +2672,7 @@ impl<T> EntityTask<T> {
|
|||||||
|
|
||||||
pub async fn cancel(mut self) -> Option<T> {
|
pub async fn cancel(mut self) -> Option<T> {
|
||||||
let task = self.task.take().unwrap();
|
let task = self.task.take().unwrap();
|
||||||
task.cancel().await
|
task.cancel().await.unwrap()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -2599,7 +2684,7 @@ impl<T> Future for EntityTask<T> {
|
|||||||
ctx: &mut std::task::Context<'_>,
|
ctx: &mut std::task::Context<'_>,
|
||||||
) -> std::task::Poll<Self::Output> {
|
) -> std::task::Poll<Self::Output> {
|
||||||
let task = unsafe { self.map_unchecked_mut(|task| task.task.as_mut().unwrap()) };
|
let task = unsafe { self.map_unchecked_mut(|task| task.task.as_mut().unwrap()) };
|
||||||
task.poll(ctx)
|
task.poll(ctx).map(|output| output.unwrap())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user