Skip to content

Commit

Permalink
docs/warnings: don't warn when a resource resolves after its scope ha…
Browse files Browse the repository at this point in the history 
…s been disposed (#1351)
  • Loading branch information
@gbj
gbj authored Jul 14, 2023
1 parent 3eed86f commit 6f5da11
Show file tree
Hide file tree
Showing 2 changed files with 151 additions and 43 deletions.
6 changes: 2 additions & 4 deletions leptos_reactive/src/resource.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -981,10 +981,8 @@ where

if version == last_version.get() {
resolved.set(true);

set_value.update(|n| *n = Some(res));

set_loading.update(|n| *n = false);
set_value.try_update(|n| *n = Some(res));
set_loading.try_update(|n| *n = false);

for suspense_context in
suspense_contexts.borrow().iter()
Expand Down
188 changes: 149 additions & 39 deletions leptos_reactive/src/signal.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -893,8 +893,12 @@ where
)
)]
fn set_untracked(&self, new_value: T) {
self.id
.update_with_no_effect(self.runtime, |v| *v = new_value);
self.id.update_with_no_effect(
self.runtime,
|v| *v = new_value,
#[cfg(debug_assertions)]
Some(self.defined_at),
);
}

#[cfg_attr(
Expand All @@ -913,8 +917,12 @@ where
fn try_set_untracked(&self, new_value: T) -> Option<T> {
let mut new_value = Some(new_value);

self.id
.update(self.runtime, |t| *t = new_value.take().unwrap());
self.id.update(
self.runtime,
|t| *t = new_value.take().unwrap(),
#[cfg(debug_assertions)]
None,
);

new_value
}
Expand All @@ -936,15 +944,25 @@ impl<T> SignalUpdateUntracked<T> for WriteSignal<T> {
)]
#[inline(always)]
fn update_untracked(&self, f: impl FnOnce(&mut T)) {
self.id.update_with_no_effect(self.runtime, f);
self.id.update_with_no_effect(
self.runtime,
f,
#[cfg(debug_assertions)]
Some(self.defined_at),
);
}

#[inline(always)]
fn try_update_untracked<O>(
&self,
f: impl FnOnce(&mut T) -> O,
) -> Option<O> {
self.id.update_with_no_effect(self.runtime, f)
self.id.update_with_no_effect(
self.runtime,
f,
#[cfg(debug_assertions)]
None,
)
}
}

Expand Down Expand Up @@ -980,7 +998,16 @@ impl<T> SignalUpdate<T> for WriteSignal<T> {
)]
#[inline(always)]
fn update(&self, f: impl FnOnce(&mut T)) {
if self.id.update(self.runtime, f).is_none() {
if self
.id
.update(
self.runtime,
f,
#[cfg(debug_assertions)]
Some(self.defined_at),
)
.is_none()
{
warn_updating_dead_signal(
#[cfg(any(debug_assertions, feature = "ssr"))]
self.defined_at,
Expand All @@ -1003,7 +1030,12 @@ impl<T> SignalUpdate<T> for WriteSignal<T> {
)]
#[inline(always)]
fn try_update<O>(&self, f: impl FnOnce(&mut T) -> O) -> Option<O> {
self.id.update(self.runtime, f)
self.id.update(
self.runtime,
f,
#[cfg(debug_assertions)]
None,
)
}
}

Expand Down Expand Up @@ -1039,7 +1071,12 @@ impl<T> SignalSet<T> for WriteSignal<T> {
)
)]
fn set(&self, new_value: T) {
self.id.update(self.runtime, |n| *n = new_value);
self.id.update(
self.runtime,
|n| *n = new_value,
#[cfg(debug_assertions)]
Some(self.defined_at),
);
}

#[cfg_attr(
Expand All @@ -1058,8 +1095,12 @@ impl<T> SignalSet<T> for WriteSignal<T> {
fn try_set(&self, new_value: T) -> Option<T> {
let mut new_value = Some(new_value);

self.id
.update(self.runtime, |t| *t = new_value.take().unwrap());
self.id.update(
self.runtime,
|t| *t = new_value.take().unwrap(),
#[cfg(debug_assertions)]
None,
);

new_value
}
Expand Down Expand Up @@ -1340,8 +1381,12 @@ impl<T> SignalSetUntracked<T> for RwSignal<T> {
)
)]
fn set_untracked(&self, new_value: T) {
self.id
.update_with_no_effect(self.runtime, |v| *v = new_value);
self.id.update_with_no_effect(
self.runtime,
|v| *v = new_value,
#[cfg(debug_assertions)]
Some(self.defined_at),
);
}

#[cfg_attr(
Expand All @@ -1360,8 +1405,12 @@ impl<T> SignalSetUntracked<T> for RwSignal<T> {
fn try_set_untracked(&self, new_value: T) -> Option<T> {
let mut new_value = Some(new_value);

self.id
.update(self.runtime, |t| *t = new_value.take().unwrap());
self.id.update(
self.runtime,
|t| *t = new_value.take().unwrap(),
#[cfg(debug_assertions)]
None,
);

new_value
}
Expand All @@ -1383,7 +1432,12 @@ impl<T> SignalUpdateUntracked<T> for RwSignal<T> {
)]
#[inline(always)]
fn update_untracked(&self, f: impl FnOnce(&mut T)) {
self.id.update_with_no_effect(self.runtime, f);
self.id.update_with_no_effect(
self.runtime,
f,
#[cfg(debug_assertions)]
Some(self.defined_at),
);
}

#[cfg_attr(
Expand All @@ -1404,7 +1458,12 @@ impl<T> SignalUpdateUntracked<T> for RwSignal<T> {
&self,
f: impl FnOnce(&mut T) -> O,
) -> Option<O> {
self.id.update_with_no_effect(self.runtime, f)
self.id.update_with_no_effect(
self.runtime,
f,
#[cfg(debug_assertions)]
None,
)
}
}

Expand Down Expand Up @@ -1595,7 +1654,16 @@ impl<T> SignalUpdate<T> for RwSignal<T> {
)]
#[inline(always)]
fn update(&self, f: impl FnOnce(&mut T)) {
if self.id.update(self.runtime, f).is_none() {
if self
.id
.update(
self.runtime,
f,
#[cfg(debug_assertions)]
Some(self.defined_at),
)
.is_none()
{
warn_updating_dead_signal(
#[cfg(any(debug_assertions, feature = "ssr"))]
self.defined_at,
Expand All @@ -1618,7 +1686,12 @@ impl<T> SignalUpdate<T> for RwSignal<T> {
)]
#[inline(always)]
fn try_update<O>(&self, f: impl FnOnce(&mut T) -> O) -> Option<O> {
self.id.update(self.runtime, f)
self.id.update(
self.runtime,
f,
#[cfg(debug_assertions)]
None,
)
}
}

Expand Down Expand Up @@ -1649,7 +1722,12 @@ impl<T> SignalSet<T> for RwSignal<T> {
)
)]
fn set(&self, value: T) {
self.id.update(self.runtime, |n| *n = value);
self.id.update(
self.runtime,
|n| *n = value,
#[cfg(debug_assertions)]
Some(self.defined_at),
);
}

#[cfg_attr(
Expand All @@ -1668,8 +1746,12 @@ impl<T> SignalSet<T> for RwSignal<T> {
fn try_set(&self, new_value: T) -> Option<T> {
let mut new_value = Some(new_value);

self.id
.update(self.runtime, |t| *t = new_value.take().unwrap());
self.id.update(
self.runtime,
|t| *t = new_value.take().unwrap(),
#[cfg(debug_assertions)]
None,
);

new_value
}
Expand Down Expand Up @@ -1950,6 +2032,9 @@ impl NodeId {
&self,
runtime: RuntimeId,
f: impl FnOnce(&mut T) -> U,
#[cfg(debug_assertions)] defined_at: Option<
&'static std::panic::Location<'static>,
>,
) -> Option<U>
where
T: 'static,
Expand All @@ -1968,14 +2053,21 @@ impl NodeId {
None
}
} else {
debug_warn!(
"[Signal::update] You’re trying to update a Signal<{}> \
that has already been disposed of. This is probably \
either a logic error in a component that creates and \
disposes of scopes, or a Resource resolving after its \
scope has been dropped without having been cleaned up.",
std::any::type_name::<T>()
);
#[cfg(debug_assertions)]
{
if let Some(defined_at) = defined_at {
debug_warn!(
"[Signal::update] You’re trying to update a \
Signal<{}> (defined at {defined_at}) that has \
already been disposed of. This is probably \
either a logic error in a component that creates \
and disposes of scopes. If it does cause cause \
any issues, it is safe to ignore this warning, \
which occurs only in debug mode.",
std::any::type_name::<T>()
);
}
}
None
}
})
Expand All @@ -1987,6 +2079,9 @@ impl NodeId {
&self,
runtime_id: RuntimeId,
f: impl FnOnce(&mut T) -> U,
#[cfg(debug_assertions)] defined_at: Option<
&'static std::panic::Location<'static>,
>,
) -> Option<U>
where
T: 'static,
Expand All @@ -2005,14 +2100,21 @@ impl NodeId {
None
}
} else {
debug_warn!(
"[Signal::update] You’re trying to update a Signal<{}> \
that has already been disposed of. This is probably \
either a logic error in a component that creates and \
disposes of scopes, or a Resource resolving after its \
scope has been dropped without having been cleaned up.",
std::any::type_name::<T>()
);
#[cfg(debug_assertions)]
{
if let Some(defined_at) = defined_at {
debug_warn!(
"[Signal::update] You’re trying to update a \
Signal<{}> (defined at {defined_at}) that has \
already been disposed of. This is probably \
either a logic error in a component that creates \
and disposes of scopes. If it does cause cause \
any issues, it is safe to ignore this warning, \
which occurs only in debug mode.",
std::any::type_name::<T>()
);
}
}
None
};

Expand All @@ -2034,12 +2136,20 @@ impl NodeId {
&self,
runtime: RuntimeId,
f: impl FnOnce(&mut T) -> U,
#[cfg(debug_assertions)] defined_at: Option<
&'static std::panic::Location<'static>,
>,
) -> Option<U>
where
T: 'static,
{
// update the value
self.update_value(runtime, f)
self.update_value(
runtime,
f,
#[cfg(debug_assertions)]
defined_at,
)
}
}

Expand Down

0 comments on commit 6f5da11

Please sign in to comment.