From 1126c1d3297e5c06f9d5b56f1492267a4ce0bec1 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Thu, 26 Oct 2023 12:47:53 -0500 Subject: [PATCH 01/19] make signal sync --- packages/generational-box/Cargo.toml | 6 +++ packages/generational-box/benches/lock.rs | 24 +++++++++ packages/generational-box/src/lib.rs | 65 +++++++++++++---------- packages/signals/Cargo.toml | 2 + packages/signals/src/impls.rs | 34 ++++++------ packages/signals/src/rt.rs | 15 +++--- packages/signals/src/signal.rs | 35 ++++++------ 7 files changed, 113 insertions(+), 68 deletions(-) create mode 100644 packages/generational-box/benches/lock.rs diff --git a/packages/generational-box/Cargo.toml b/packages/generational-box/Cargo.toml index 6c5a5a841..5567e9ccc 100644 --- a/packages/generational-box/Cargo.toml +++ b/packages/generational-box/Cargo.toml @@ -8,10 +8,16 @@ edition = "2018" [dependencies] bumpalo = { version = "3.6" } +parking_lot = "0.12.1" [dev-dependencies] rand = "0.8.5" +criterion = "0.3" [features] default = ["check_generation"] check_generation = [] + +[[bench]] +name = "lock" +harness = false diff --git a/packages/generational-box/benches/lock.rs b/packages/generational-box/benches/lock.rs new file mode 100644 index 000000000..fa3954fbb --- /dev/null +++ b/packages/generational-box/benches/lock.rs @@ -0,0 +1,24 @@ +#![allow(unused)] +use generational_box::{GenerationalBox, Owner, Store}; + +use criterion::{black_box, criterion_group, criterion_main, Criterion}; + +fn create(owner: &Owner) -> GenerationalBox { + owner.insert(0) +} + +fn set_read(signal: GenerationalBox) -> u32 { + signal.set(1); + *signal.read() +} + +fn bench_fib(c: &mut Criterion) { + let store = Store::default(); + let owner = store.owner(); + c.bench_function("create", |b| b.iter(|| create(black_box(&owner)))); + let signal = create(&owner); + c.bench_function("set_read", |b| b.iter(|| set_read(black_box(signal)))); +} + +criterion_group!(benches, bench_fib); +criterion_main!(benches); diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 4be383b4f..ac97937fd 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -1,11 +1,15 @@ #![doc = include_str!("../README.md")] #![warn(missing_docs)] +use parking_lot::{ + MappedRwLockReadGuard, MappedRwLockWriteGuard, Mutex, RwLock, RwLockReadGuard, RwLockWriteGuard, +}; use std::{ - cell::{Cell, Ref, RefCell, RefMut}, + cell::RefCell, fmt::Debug, marker::PhantomData, rc::Rc, + sync::{atomic::AtomicU32, Arc}, }; use bumpalo::Bump; @@ -29,12 +33,12 @@ fn reused() { let first_ptr; { let owner = store.owner(); - first_ptr = owner.insert(1).raw.data.as_ptr(); + first_ptr = owner.insert(1).raw.data.data_ptr(); drop(owner); } { let owner = store.owner(); - let second_ptr = owner.insert(1234).raw.data.as_ptr(); + let second_ptr = owner.insert(1234).raw.data.data_ptr(); assert_eq!(first_ptr, second_ptr); drop(owner); } @@ -161,7 +165,7 @@ impl Debug for GenerationalBox { #[cfg(any(debug_assertions, feature = "check_generation"))] f.write_fmt(format_args!( "{:?}@{:?}", - self.raw.data.as_ptr(), + self.raw.data.data_ptr(), self.generation ))?; #[cfg(not(any(debug_assertions, feature = "check_generation")))] @@ -175,7 +179,10 @@ impl GenerationalBox { fn validate(&self) -> bool { #[cfg(any(debug_assertions, feature = "check_generation"))] { - self.raw.generation.get() == self.generation + self.raw + .generation + .load(std::sync::atomic::Ordering::Relaxed) + == self.generation } #[cfg(not(any(debug_assertions, feature = "check_generation")))] { @@ -184,10 +191,10 @@ impl GenerationalBox { } /// Try to read the value. Returns None if the value is no longer valid. - pub fn try_read(&self) -> Option> { + pub fn try_read(&self) -> Option> { self.validate() .then(|| { - Ref::filter_map(self.raw.data.borrow(), |any| { + RwLockReadGuard::try_map(self.raw.data.read(), |any| { any.as_ref()?.downcast_ref::() }) .ok() @@ -196,15 +203,15 @@ impl GenerationalBox { } /// Read the value. Panics if the value is no longer valid. - pub fn read(&self) -> Ref<'static, T> { + pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { self.try_read().unwrap() } /// Try to write the value. Returns None if the value is no longer valid. - pub fn try_write(&self) -> Option> { + pub fn try_write(&self) -> Option> { self.validate() .then(|| { - RefMut::filter_map(self.raw.data.borrow_mut(), |any| { + RwLockWriteGuard::try_map(self.raw.data.write(), |any| { any.as_mut()?.downcast_mut::() }) .ok() @@ -213,14 +220,14 @@ impl GenerationalBox { } /// Write the value. Panics if the value is no longer valid. - pub fn write(&self) -> RefMut<'static, T> { + pub fn write(&self) -> MappedRwLockWriteGuard<'static, T> { self.try_write().unwrap() } /// Set the value. Panics if the value is no longer valid. pub fn set(&self, value: T) { self.validate().then(|| { - *self.raw.data.borrow_mut() = Some(Box::new(value)); + *self.raw.data.write() = Some(Box::new(value)); }); } @@ -228,7 +235,8 @@ impl GenerationalBox { pub fn ptr_eq(&self, other: &Self) -> bool { #[cfg(any(debug_assertions, feature = "check_generation"))] { - self.raw.data.as_ptr() == other.raw.data.as_ptr() && self.generation == other.generation + self.raw.data.data_ptr() == other.raw.data.data_ptr() + && self.generation == other.generation } #[cfg(not(any(debug_assertions, feature = "check_generation")))] { @@ -247,25 +255,26 @@ impl Clone for GenerationalBox { #[derive(Clone, Copy)] struct MemoryLocation { - data: &'static RefCell>>, + data: &'static RwLock>>, #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: &'static Cell, + generation: &'static AtomicU32, } impl MemoryLocation { #[allow(unused)] fn drop(&self) { - let old = self.data.borrow_mut().take(); + let old = self.data.write().take(); #[cfg(any(debug_assertions, feature = "check_generation"))] if old.is_some() { drop(old); - let new_generation = self.generation.get() + 1; - self.generation.set(new_generation); + let new_generation = self.generation.load(std::sync::atomic::Ordering::Relaxed) + 1; + self.generation + .store(new_generation, std::sync::atomic::Ordering::Relaxed); } } fn replace(&mut self, value: T) -> GenerationalBox { - let mut inner_mut = self.data.borrow_mut(); + let mut inner_mut = self.data.write(); let raw = Box::new(value); let old = inner_mut.replace(raw); @@ -273,7 +282,7 @@ impl MemoryLocation { GenerationalBox { raw: *self, #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: self.generation.get(), + generation: self.generation.load(std::sync::atomic::Ordering::Relaxed), _marker: PhantomData, } } @@ -282,14 +291,12 @@ impl MemoryLocation { /// Handles recycling generational boxes that have been dropped. Your application should have one store or one store per thread. #[derive(Clone)] pub struct Store { - bump: &'static Bump, - recycled: Rc>>, + recycled: Arc>>, } impl Default for Store { fn default() -> Self { Self { - bump: Box::leak(Box::new(Bump::new())), recycled: Default::default(), } } @@ -298,18 +305,18 @@ impl Default for Store { impl Store { fn recycle(&self, location: MemoryLocation) { location.drop(); - self.recycled.borrow_mut().push(location); + self.recycled.lock().push(location); } fn claim(&self) -> MemoryLocation { - if let Some(location) = self.recycled.borrow_mut().pop() { + if let Some(location) = self.recycled.lock().pop() { location } else { - let data: &'static RefCell<_> = self.bump.alloc(RefCell::new(None)); + let data: &'static RwLock<_> = Box::leak(Box::new(RwLock::new(None))); MemoryLocation { data, #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: self.bump.alloc(Cell::new(0)), + generation: Box::leak(Box::new(Default::default())), } } } @@ -344,7 +351,9 @@ impl Owner { GenerationalBox { raw: location, #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: location.generation.get(), + generation: location + .generation + .load(std::sync::atomic::Ordering::Relaxed), _marker: PhantomData, } } diff --git a/packages/signals/Cargo.toml b/packages/signals/Cargo.toml index 56e19bbd8..6d22ee0c8 100644 --- a/packages/signals/Cargo.toml +++ b/packages/signals/Cargo.toml @@ -12,6 +12,8 @@ generational-box = { workspace = true } tracing = { workspace = true } simple_logger = "4.2.0" serde = { version = "1", features = ["derive"], optional = true } +parking_lot = "0.12.1" +once_cell = "1.18.0" [dev-dependencies] dioxus = { workspace = true } diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index 6427c2e2b..9d6ea3019 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -1,7 +1,6 @@ use crate::rt::CopyValue; use crate::signal::{ReadOnlySignal, Signal, Write}; - -use std::cell::{Ref, RefMut}; +use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; use std::{ fmt::{Debug, Display}, @@ -38,8 +37,8 @@ macro_rules! read_impls { impl $ty> { /// Read a value from the inner vector. - pub fn get(&self, index: usize) -> Option> { - Ref::filter_map(self.read(), |v| v.get(index)).ok() + pub fn get(&self, index: usize) -> Option> { + MappedRwLockReadGuard::try_map(self.read(), |v| v.get(index)).ok() } } @@ -53,8 +52,8 @@ macro_rules! read_impls { } /// Attemps to read the inner value of the Option. - pub fn as_ref(&self) -> Option> { - Ref::filter_map(self.read(), |v| v.as_ref()).ok() + pub fn as_ref(&self) -> Option> { + MappedRwLockReadGuard::try_map(self.read(), |v| v.as_ref()).ok() } } }; @@ -182,19 +181,22 @@ macro_rules! write_impls { } /// Gets the value out of the Option, or inserts the given value if the Option is empty. - pub fn get_or_insert(&self, default: T) -> Ref<'_, T> { + pub fn get_or_insert(&self, default: T) -> MappedRwLockReadGuard<'_, T> { self.get_or_insert_with(|| default) } /// Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty. - pub fn get_or_insert_with(&self, default: impl FnOnce() -> T) -> Ref<'_, T> { + pub fn get_or_insert_with( + &self, + default: impl FnOnce() -> T, + ) -> MappedRwLockReadGuard<'_, T> { let borrow = self.read(); if borrow.is_none() { drop(borrow); self.with_mut(|v| *v = Some(default())); - Ref::map(self.read(), |v| v.as_ref().unwrap()) + MappedRwLockReadGuard::map(self.read(), |v| v.as_ref().unwrap()) } else { - Ref::map(borrow, |v| v.as_ref().unwrap()) + MappedRwLockReadGuard::map(borrow, |v| v.as_ref().unwrap()) } } } @@ -238,15 +240,15 @@ impl IntoIterator for CopyValue> { impl CopyValue> { /// Write to an element in the inner vector. - pub fn get_mut(&self, index: usize) -> Option> { - RefMut::filter_map(self.write(), |v| v.get_mut(index)).ok() + pub fn get_mut(&self, index: usize) -> Option> { + MappedRwLockWriteGuard::try_map(self.write(), |v| v.get_mut(index)).ok() } } impl CopyValue> { /// Deref the inner value mutably. - pub fn as_mut(&self) -> Option> { - RefMut::filter_map(self.write(), |v| v.as_mut()).ok() + pub fn as_mut(&self) -> Option> { + MappedRwLockWriteGuard::try_map(self.write(), |v| v.as_mut()).ok() } } @@ -281,14 +283,14 @@ impl IntoIterator for Signal> { impl Signal> { /// Returns a reference to an element or `None` if out of bounds. - pub fn get_mut(&self, index: usize) -> Option>> { + pub fn get_mut(&self, index: usize) -> Option>> { Write::filter_map(self.write(), |v| v.get_mut(index)) } } impl Signal> { /// Returns a reference to an element or `None` if out of bounds. - pub fn as_mut(&self) -> Option>> { + pub fn as_mut(&self) -> Option>> { Write::filter_map(self.write(), |v| v.as_mut()) } } diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index 0f89a3fe6..c1fb2994d 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -1,5 +1,3 @@ -use std::cell::{Ref, RefMut}; - use std::mem::MaybeUninit; use std::ops::Deref; use std::rc::Rc; @@ -8,9 +6,12 @@ use dioxus_core::prelude::*; use dioxus_core::ScopeId; use generational_box::{GenerationalBox, Owner, Store}; +use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; use crate::Effect; +static STORE: once_cell::sync::Lazy = once_cell::sync::Lazy::new(Store::default); + fn current_store() -> Store { match consume_context() { Some(rt) => rt, @@ -117,22 +118,22 @@ impl CopyValue { } /// Try to read the value. If the value has been dropped, this will return None. - pub fn try_read(&self) -> Option> { + pub fn try_read(&self) -> Option> { self.value.try_read() } /// Read the value. If the value has been dropped, this will panic. - pub fn read(&self) -> Ref<'static, T> { + pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { self.value.read() } /// Try to write the value. If the value has been dropped, this will return None. - pub fn try_write(&self) -> Option> { + pub fn try_write(&self) -> Option> { self.value.try_write() } /// Write the value. If the value has been dropped, this will panic. - pub fn write(&self) -> RefMut<'static, T> { + pub fn write(&self) -> MappedRwLockWriteGuard<'static, T> { self.value.write() } @@ -168,7 +169,7 @@ impl PartialEq for CopyValue { } impl Deref for CopyValue { - type Target = dyn Fn() -> Ref<'static, T>; + type Target = dyn Fn() -> MappedRwLockReadGuard<'static, T>; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 9213307ff..43aa0c904 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -1,5 +1,5 @@ use std::{ - cell::{Ref, RefCell, RefMut}, + cell::RefCell, mem::MaybeUninit, ops::{Deref, DerefMut}, rc::Rc, @@ -10,6 +10,7 @@ use dioxus_core::{ prelude::{current_scope_id, has_context, provide_context, schedule_update_any}, ScopeId, ScopeState, }; +use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; use crate::{get_effect_stack, CopyValue, Effect, EffectStack}; @@ -173,7 +174,7 @@ impl Signal { /// Get the current value of the signal. This will subscribe the current scope to the signal. /// If the signal has been dropped, this will panic. - pub fn read(&self) -> Ref { + pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { let inner = self.inner.read(); if let Some(effect) = inner.effect_stack.current() { let mut effect_subscribers = inner.effect_subscribers.borrow_mut(); @@ -197,14 +198,14 @@ impl Signal { } } } - Ref::map(inner, |v| &v.value) + MappedRwLockReadGuard::map(inner, |v| &v.value) } /// Get a mutable reference to the signal's value. /// If the signal has been dropped, this will panic. - pub fn write(&self) -> Write<'_, T> { + pub fn write(&self) -> Write { let inner = self.inner.write(); - let borrow = RefMut::map(inner, |v| &mut v.value); + let borrow = MappedRwLockWriteGuard::map(inner, |v| &mut v.value); Write { write: borrow, signal: SignalSubscriberDrop { signal: *self }, @@ -281,7 +282,7 @@ impl PartialEq for Signal { } impl Deref for Signal { - type Target = dyn Fn() -> Ref<'static, T>; + type Target = dyn Fn() -> MappedRwLockReadGuard<'static, T>; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types @@ -324,17 +325,17 @@ impl Drop for SignalSubscriberDrop { } /// A mutable reference to a signal's value. -pub struct Write<'a, T: 'static, I: 'static = T> { - write: RefMut<'a, T>, +pub struct Write { + write: MappedRwLockWriteGuard<'static, T>, signal: SignalSubscriberDrop, } -impl<'a, T: 'static, I: 'static> Write<'a, T, I> { +impl Write { /// Map the mutable reference to the signal's value to a new type. - pub fn map(myself: Self, f: impl FnOnce(&mut T) -> &mut O) -> Write<'a, O, I> { + pub fn map(myself: Self, f: impl FnOnce(&mut T) -> &mut O) -> Write { let Self { write, signal } = myself; Write { - write: RefMut::map(write, f), + write: MappedRwLockWriteGuard::map(write, f), signal, } } @@ -343,14 +344,14 @@ impl<'a, T: 'static, I: 'static> Write<'a, T, I> { pub fn filter_map( myself: Self, f: impl FnOnce(&mut T) -> Option<&mut O>, - ) -> Option> { + ) -> Option> { let Self { write, signal } = myself; - let write = RefMut::filter_map(write, f).ok(); + let write = MappedRwLockWriteGuard::try_map(write, f).ok(); write.map(|write| Write { write, signal }) } } -impl<'a, T: 'static, I: 'static> Deref for Write<'a, T, I> { +impl Deref for Write { type Target = T; fn deref(&self) -> &Self::Target { @@ -358,7 +359,7 @@ impl<'a, T: 'static, I: 'static> Deref for Write<'a, T, I> { } } -impl DerefMut for Write<'_, T, I> { +impl DerefMut for Write { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.write } @@ -381,7 +382,7 @@ impl ReadOnlySignal { } /// Get the current value of the signal. This will subscribe the current scope to the signal. - pub fn read(&self) -> Ref { + pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { self.inner.read() } @@ -405,7 +406,7 @@ impl PartialEq for ReadOnlySignal { } impl Deref for ReadOnlySignal { - type Target = dyn Fn() -> Ref<'static, T>; + type Target = dyn Fn() -> MappedRwLockReadGuard<'static, T>; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types From 4ac6aed4824fef652c800120dab01f0fc96f9e51 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Thu, 26 Oct 2023 16:36:41 -0500 Subject: [PATCH 02/19] try specialization --- packages/generational-box/src/lib.rs | 2 +- packages/generational-box/src/testing.rs | 44 ++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 packages/generational-box/src/testing.rs diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index ac97937fd..5d4866d05 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -12,7 +12,7 @@ use std::{ sync::{atomic::AtomicU32, Arc}, }; -use bumpalo::Bump; +mod testing; /// # Example /// diff --git a/packages/generational-box/src/testing.rs b/packages/generational-box/src/testing.rs new file mode 100644 index 000000000..0f8db53dd --- /dev/null +++ b/packages/generational-box/src/testing.rs @@ -0,0 +1,44 @@ +use core::marker::PhantomData; + +#[test] +fn testing() { + let testing1 = Testing::<_, false>::new(&() as *const _); + // std::thread::spawn(move || testing1); +} + +struct Testing { + ptr: *mut (), + phantom: PhantomData, +} + +trait CreateNew { + fn new(data: T) -> Testing { + Testing { + ptr: &mut (), + phantom: PhantomData, + } + } +} + +impl CreateNew for Testing { + fn new(data: T) -> Testing { + Testing { + ptr: &mut (), + phantom: PhantomData, + } + } +} + +impl Testing { + pub fn new(data: T) -> Self { + Testing { + ptr: &mut (), + phantom: PhantomData, + } + } +} + +impl Testing {} + +unsafe impl Send for Testing {} +unsafe impl Sync for Testing {} From 90e04edcdf4d99849aa891be721df8224a45f7e7 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Mon, 30 Oct 2023 14:25:31 -0500 Subject: [PATCH 03/19] make the signal runtime global --- packages/generational-box/benches/lock.rs | 25 +- packages/generational-box/src/lib.rs | 385 +++++++++++++++------- packages/generational-box/src/testing.rs | 44 --- packages/signals/src/effect.rs | 5 +- packages/signals/src/impls.rs | 64 ++-- packages/signals/src/rt.rs | 47 ++- packages/signals/src/selector.rs | 13 +- packages/signals/src/signal.rs | 86 +++-- 8 files changed, 409 insertions(+), 260 deletions(-) delete mode 100644 packages/generational-box/src/testing.rs diff --git a/packages/generational-box/benches/lock.rs b/packages/generational-box/benches/lock.rs index fa3954fbb..14a94dd56 100644 --- a/packages/generational-box/benches/lock.rs +++ b/packages/generational-box/benches/lock.rs @@ -1,23 +1,32 @@ #![allow(unused)] -use generational_box::{GenerationalBox, Owner, Store}; +use generational_box::*; use criterion::{black_box, criterion_group, criterion_main, Criterion}; -fn create(owner: &Owner) -> GenerationalBox { +fn create>(owner: &Owner) -> GenerationalBox { owner.insert(0) } -fn set_read(signal: GenerationalBox) -> u32 { +fn set_read>(signal: GenerationalBox) -> u32 { signal.set(1); *signal.read() } fn bench_fib(c: &mut Criterion) { - let store = Store::default(); - let owner = store.owner(); - c.bench_function("create", |b| b.iter(|| create(black_box(&owner)))); - let signal = create(&owner); - c.bench_function("set_read", |b| b.iter(|| set_read(black_box(signal)))); + { + let owner = UnsyncStorage::owner(); + c.bench_function("create_unsync", |b| b.iter(|| create(black_box(&owner)))); + let signal = create(&owner); + c.bench_function("set_read_unsync", |b| { + b.iter(|| set_read(black_box(signal))) + }); + } + { + let owner = SyncStorage::owner(); + c.bench_function("create_sync", |b| b.iter(|| create(black_box(&owner)))); + let signal = create(&owner); + c.bench_function("set_read_sync", |b| b.iter(|| set_read(black_box(signal)))); + } } criterion_group!(benches, bench_fib); diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 5d4866d05..ec1986f39 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -5,21 +5,19 @@ use parking_lot::{ MappedRwLockReadGuard, MappedRwLockWriteGuard, Mutex, RwLock, RwLockReadGuard, RwLockWriteGuard, }; use std::{ - cell::RefCell, + cell::{Ref, RefCell, RefMut}, fmt::Debug, marker::PhantomData, + ops::{Deref, DerefMut}, rc::Rc, - sync::{atomic::AtomicU32, Arc}, + sync::{atomic::AtomicU32, Arc, OnceLock}, }; -mod testing; - /// # Example /// /// ```compile_fail /// let data = String::from("hello world"); -/// let store = Store::default(); -/// let owner = store.owner(); +/// let owner = UnsyncStorage::owner(); /// let key = owner.insert(&data); /// drop(data); /// assert_eq!(*key.read(), "hello world"); @@ -29,15 +27,14 @@ fn compile_fail() {} #[test] fn reused() { - let store = Store::default(); let first_ptr; { - let owner = store.owner(); + let owner = UnsyncStorage::owner(); first_ptr = owner.insert(1).raw.data.data_ptr(); drop(owner); } { - let owner = store.owner(); + let owner = UnsyncStorage::owner(); let second_ptr = owner.insert(1234).raw.data.data_ptr(); assert_eq!(first_ptr, second_ptr); drop(owner); @@ -47,11 +44,10 @@ fn reused() { #[test] fn leaking_is_ok() { let data = String::from("hello world"); - let store = Store::default(); let key; { // create an owner - let owner = store.owner(); + let owner = UnsyncStorage::owner(); // insert data into the store key = owner.insert(data); // don't drop the owner @@ -63,11 +59,10 @@ fn leaking_is_ok() { #[test] fn drops() { let data = String::from("hello world"); - let store = Store::default(); let key; { // create an owner - let owner = store.owner(); + let owner = UnsyncStorage::owner(); // insert data into the store key = owner.insert(data); // drop the owner @@ -77,8 +72,7 @@ fn drops() { #[test] fn works() { - let store = Store::default(); - let owner = store.owner(); + let owner = UnsyncStorage::owner(); let key = owner.insert(1); assert_eq!(*key.read(), 1); @@ -86,8 +80,7 @@ fn works() { #[test] fn insert_while_reading() { - let store = Store::default(); - let owner = store.owner(); + let owner = UnsyncStorage::owner(); let key; { let data: String = "hello world".to_string(); @@ -101,8 +94,7 @@ fn insert_while_reading() { #[test] #[should_panic] fn panics() { - let store = Store::default(); - let owner = store.owner(); + let owner = UnsyncStorage::owner(); let key = owner.insert(1); drop(owner); @@ -112,7 +104,6 @@ fn panics() { #[test] fn fuzz() { fn maybe_owner_scope( - store: &Store, valid_keys: &mut Vec>, invalid_keys: &mut Vec>, path: &mut Vec, @@ -125,7 +116,7 @@ fn fuzz() { }; for i in 0..children { - let owner = store.owner(); + let owner = UnsyncStorage::owner(); let key = owner.insert(format!("hello world {path:?}")); valid_keys.push(key); path.push(i); @@ -140,27 +131,26 @@ fn fuzz() { for key in invalid_keys.iter() { assert!(!key.validate()); } - maybe_owner_scope(store, valid_keys, invalid_keys, path); + maybe_owner_scope(valid_keys, invalid_keys, path); invalid_keys.push(valid_keys.pop().unwrap()); path.pop(); } } for _ in 0..10 { - let store = Store::default(); - maybe_owner_scope(&store, &mut Vec::new(), &mut Vec::new(), &mut Vec::new()); + maybe_owner_scope(&mut Vec::new(), &mut Vec::new(), &mut Vec::new()); } } /// The core Copy state type. The generational box will be dropped when the [Owner] is dropped. -pub struct GenerationalBox { - raw: MemoryLocation, +pub struct GenerationalBox { + raw: MemoryLocation, #[cfg(any(debug_assertions, feature = "check_generation"))] generation: u32, _marker: PhantomData, } -impl Debug for GenerationalBox { +impl Debug for GenerationalBox { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { #[cfg(any(debug_assertions, feature = "check_generation"))] f.write_fmt(format_args!( @@ -174,7 +164,7 @@ impl Debug for GenerationalBox { } } -impl GenerationalBox { +impl> GenerationalBox { #[inline(always)] fn validate(&self) -> bool { #[cfg(any(debug_assertions, feature = "check_generation"))] @@ -191,43 +181,29 @@ impl GenerationalBox { } /// Try to read the value. Returns None if the value is no longer valid. - pub fn try_read(&self) -> Option> { - self.validate() - .then(|| { - RwLockReadGuard::try_map(self.raw.data.read(), |any| { - any.as_ref()?.downcast_ref::() - }) - .ok() - }) - .flatten() + pub fn try_read(&self) -> Option { + self.validate().then(|| self.raw.data.try_read()).flatten() } /// Read the value. Panics if the value is no longer valid. - pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { + pub fn read(&self) -> S::Ref { self.try_read().unwrap() } /// Try to write the value. Returns None if the value is no longer valid. - pub fn try_write(&self) -> Option> { - self.validate() - .then(|| { - RwLockWriteGuard::try_map(self.raw.data.write(), |any| { - any.as_mut()?.downcast_mut::() - }) - .ok() - }) - .flatten() + pub fn try_write(&self) -> Option where { + self.validate().then(|| self.raw.data.try_write()).flatten() } /// Write the value. Panics if the value is no longer valid. - pub fn write(&self) -> MappedRwLockWriteGuard<'static, T> { + pub fn write(&self) -> S::Mut { self.try_write().unwrap() } /// Set the value. Panics if the value is no longer valid. pub fn set(&self, value: T) { self.validate().then(|| { - *self.raw.data.write() = Some(Box::new(value)); + self.raw.data.set(value); }); } @@ -245,40 +221,252 @@ impl GenerationalBox { } } -impl Copy for GenerationalBox {} +impl Copy for GenerationalBox {} -impl Clone for GenerationalBox { +impl Clone for GenerationalBox { fn clone(&self) -> Self { *self } } #[derive(Clone, Copy)] -struct MemoryLocation { - data: &'static RwLock>>, +pub struct UnsyncStorage(&'static RefCell>>); + +impl Default for UnsyncStorage { + fn default() -> Self { + Self(Box::leak(Box::new(RefCell::new(None)))) + } +} + +#[derive(Clone, Copy)] +pub struct SyncStorage(&'static RwLock>>); + +impl Default for SyncStorage { + fn default() -> Self { + Self(Box::leak(Box::new(RwLock::new(None)))) + } +} + +pub trait Mappable: Deref { + type Mapped: Deref; + + fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped; +} + +impl Mappable for Ref<'static, T> { + type Mapped = Ref<'static, U>; + + fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { + Ref::map(_self, f) + } +} + +impl Mappable for MappedRwLockReadGuard<'static, T> { + type Mapped = MappedRwLockReadGuard<'static, U>; + + fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { + MappedRwLockReadGuard::map(_self, f) + } +} + +pub trait MappableMut: DerefMut { + type Mapped: DerefMut; + + fn map(_self: Self, f: fn(&mut T) -> &mut U) -> Self::Mapped; +} + +impl MappableMut for RefMut<'static, T> { + type Mapped = RefMut<'static, U>; + + fn map(_self: Self, f: fn(&mut T) -> &mut U) -> Self::Mapped { + RefMut::map(_self, f) + } +} + +impl MappableMut for MappedRwLockWriteGuard<'static, T> { + type Mapped = MappedRwLockWriteGuard<'static, U>; + + fn map(_self: Self, f: fn(&mut T) -> &mut U) -> Self::Mapped { + MappedRwLockWriteGuard::map(_self, f) + } +} + +pub trait Storage: Copy + AnyStorage { + type Ref: Deref; + type Mut: DerefMut; + + fn try_read(&self) -> Option; + fn read(&self) -> Self::Ref { + self.try_read() + .expect("generational box has been invalidated or the type has changed") + } + fn try_write(&self) -> Option; + fn write(&self) -> Self::Mut { + self.try_write() + .expect("generational box has been invalidated or the type has changed") + } + + fn set(&self, value: Data); +} + +pub trait AnyStorage: Default { + fn data_ptr(&self) -> *const (); + + fn take(&self) -> bool; + + fn recycle(location: &MemoryLocation); + // { + // location.drop(); + // self.recycled.lock().push(location); + // } + + fn claim() -> MemoryLocation; + // where + // S: Default, + // { + // if let Some(location) = self.recycled.lock().pop() { + // location + // } else { + // MemoryLocation { + // data: Default::default(), + // #[cfg(any(debug_assertions, feature = "check_generation"))] + // generation: Box::leak(Box::new(Default::default())), + // } + // } + // } + + /// Create a new owner. The owner will be responsible for dropping all of the generational boxes that it creates. + fn owner() -> Owner { + Owner { + owned: Default::default(), + phantom: PhantomData, + } + } +} + +impl Storage for UnsyncStorage { + type Ref = Ref<'static, T>; + type Mut = RefMut<'static, T>; + + fn try_read(&self) -> Option { + Ref::filter_map(self.0.borrow(), |any| any.as_ref()?.downcast_ref()).ok() + } + + fn try_write(&self) -> Option { + RefMut::filter_map(self.0.borrow_mut(), |any| any.as_mut()?.downcast_mut()).ok() + } + + fn set(&self, value: T) { + *self.0.borrow_mut() = Some(Box::new(value)); + } +} + +thread_local! { + static UNSYNC_RUNTIME: RefCell>> = RefCell::new(Vec::new()); +} + +impl AnyStorage for UnsyncStorage { + fn data_ptr(&self) -> *const () { + self.0.as_ptr() as *const () + } + + fn take(&self) -> bool { + self.0.borrow_mut().take().is_some() + } + + fn claim() -> MemoryLocation { + UNSYNC_RUNTIME.with(|runtime| { + if let Some(location) = runtime.borrow_mut().pop() { + location + } else { + MemoryLocation { + data: UnsyncStorage(Box::leak(Box::new(RefCell::new(None)))), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: Box::leak(Box::new(Default::default())), + } + } + }) + } + + fn recycle(location: &MemoryLocation) { + location.drop(); + UNSYNC_RUNTIME.with(|runtime| runtime.borrow_mut().push(*location)); + } +} + +impl Storage for SyncStorage { + type Ref = MappedRwLockReadGuard<'static, T>; + type Mut = MappedRwLockWriteGuard<'static, T>; + + fn try_read(&self) -> Option { + RwLockReadGuard::try_map(self.0.read(), |any| any.as_ref()?.downcast_ref()).ok() + } + + fn try_write(&self) -> Option { + RwLockWriteGuard::try_map(self.0.write(), |any| any.as_mut()?.downcast_mut()).ok() + } + + fn set(&self, value: T) { + *self.0.write() = Some(Box::new(value)); + } +} + +static SYNC_RUNTIME: OnceLock>>>> = OnceLock::new(); + +fn sync_runtime() -> &'static Arc>>> { + SYNC_RUNTIME.get_or_init(|| Arc::new(Mutex::new(Vec::new()))) +} + +impl AnyStorage for SyncStorage { + fn data_ptr(&self) -> *const () { + self.0.data_ptr() as *const () + } + + fn take(&self) -> bool { + self.0.write().take().is_some() + } + + fn claim() -> MemoryLocation { + MemoryLocation { + data: SyncStorage(Box::leak(Box::new(RwLock::new(None)))), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: Box::leak(Box::new(Default::default())), + } + } + + fn recycle(location: &MemoryLocation) { + location.drop(); + sync_runtime().lock().push(*location); + } +} + +#[derive(Clone, Copy)] +struct MemoryLocation { + data: S, #[cfg(any(debug_assertions, feature = "check_generation"))] generation: &'static AtomicU32, } -impl MemoryLocation { +impl MemoryLocation { #[allow(unused)] - fn drop(&self) { - let old = self.data.write().take(); + fn drop(&self) + where + S: AnyStorage, + { + let old = self.data.take(); #[cfg(any(debug_assertions, feature = "check_generation"))] - if old.is_some() { - drop(old); + if old { let new_generation = self.generation.load(std::sync::atomic::Ordering::Relaxed) + 1; self.generation .store(new_generation, std::sync::atomic::Ordering::Relaxed); } } - fn replace(&mut self, value: T) -> GenerationalBox { - let mut inner_mut = self.data.write(); - - let raw = Box::new(value); - let old = inner_mut.replace(raw); - assert!(old.is_none()); + fn replace(&mut self, value: T) -> GenerationalBox + where + S: Storage + Copy, + { + self.data.set(value); GenerationalBox { raw: *self, #[cfg(any(debug_assertions, feature = "check_generation"))] @@ -288,66 +476,27 @@ impl MemoryLocation { } } -/// Handles recycling generational boxes that have been dropped. Your application should have one store or one store per thread. -#[derive(Clone)] -pub struct Store { - recycled: Arc>>, -} - -impl Default for Store { - fn default() -> Self { - Self { - recycled: Default::default(), - } - } -} - -impl Store { - fn recycle(&self, location: MemoryLocation) { - location.drop(); - self.recycled.lock().push(location); - } - - fn claim(&self) -> MemoryLocation { - if let Some(location) = self.recycled.lock().pop() { - location - } else { - let data: &'static RwLock<_> = Box::leak(Box::new(RwLock::new(None))); - MemoryLocation { - data, - #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: Box::leak(Box::new(Default::default())), - } - } - } - - /// Create a new owner. The owner will be responsible for dropping all of the generational boxes that it creates. - pub fn owner(&self) -> Owner { - Owner { - store: self.clone(), - owned: Default::default(), - } - } -} - /// Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped. -pub struct Owner { - store: Store, - owned: Rc>>, +pub struct Owner { + owned: Arc>>>, + phantom: PhantomData, } -impl Owner { +impl Owner { /// Insert a value into the store. The value will be dropped when the owner is dropped. - pub fn insert(&self, value: T) -> GenerationalBox { - let mut location = self.store.claim(); + pub fn insert(&self, value: T) -> GenerationalBox + where + S: Storage, + { + let mut location = S::claim(); let key = location.replace(value); - self.owned.borrow_mut().push(location); + self.owned.lock().push(location); key } /// Creates an invalid handle. This is useful for creating a handle that will be filled in later. If you use this before the value is filled in, you will get may get a panic or an out of date value. - pub fn invalid(&self) -> GenerationalBox { - let location = self.store.claim(); + pub fn invalid(&self) -> GenerationalBox { + let location = S::claim(); GenerationalBox { raw: location, #[cfg(any(debug_assertions, feature = "check_generation"))] @@ -359,10 +508,10 @@ impl Owner { } } -impl Drop for Owner { +impl Drop for Owner { fn drop(&mut self) { - for location in self.owned.borrow().iter() { - self.store.recycle(*location) + for location in self.owned.lock().iter() { + S::recycle(location) } } } diff --git a/packages/generational-box/src/testing.rs b/packages/generational-box/src/testing.rs deleted file mode 100644 index 0f8db53dd..000000000 --- a/packages/generational-box/src/testing.rs +++ /dev/null @@ -1,44 +0,0 @@ -use core::marker::PhantomData; - -#[test] -fn testing() { - let testing1 = Testing::<_, false>::new(&() as *const _); - // std::thread::spawn(move || testing1); -} - -struct Testing { - ptr: *mut (), - phantom: PhantomData, -} - -trait CreateNew { - fn new(data: T) -> Testing { - Testing { - ptr: &mut (), - phantom: PhantomData, - } - } -} - -impl CreateNew for Testing { - fn new(data: T) -> Testing { - Testing { - ptr: &mut (), - phantom: PhantomData, - } - } -} - -impl Testing { - pub fn new(data: T) -> Self { - Testing { - ptr: &mut (), - phantom: PhantomData, - } - } -} - -impl Testing {} - -unsafe impl Send for Testing {} -unsafe impl Sync for Testing {} diff --git a/packages/signals/src/effect.rs b/packages/signals/src/effect.rs index 307ee98ab..2ab29780d 100644 --- a/packages/signals/src/effect.rs +++ b/packages/signals/src/effect.rs @@ -2,13 +2,14 @@ use core::{self, fmt::Debug}; use std::fmt::{self, Formatter}; // use dioxus_core::prelude::*; +use generational_box::SyncStorage; use crate::use_signal; use crate::{dependency::Dependency, CopyValue}; #[derive(Copy, Clone, PartialEq)] pub(crate) struct EffectStack { - pub(crate) effects: CopyValue>, + pub(crate) effects: CopyValue, SyncStorage>, } impl Default for EffectStack { @@ -68,7 +69,7 @@ pub fn use_effect_with_dependencies( #[derive(Copy, Clone, PartialEq)] pub struct Effect { pub(crate) source: ScopeId, - pub(crate) callback: CopyValue>, + pub(crate) callback: CopyValue, SyncStorage>, pub(crate) effect_stack: EffectStack, } diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index 9d6ea3019..e97ebc452 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -1,5 +1,7 @@ use crate::rt::CopyValue; use crate::signal::{ReadOnlySignal, Signal, Write}; +use crate::SignalData; +use generational_box::{MappableMut, Storage}; use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; use std::{ @@ -203,19 +205,19 @@ macro_rules! write_impls { }; } -read_impls!(CopyValue); -write_impls!(CopyValue); -read_impls!(Signal); -write_impls!(Signal); -read_impls!(ReadOnlySignal); +// read_impls!(CopyValue); +// write_impls!(CopyValue); +// read_impls!(Signal); +// write_impls!(Signal); +// read_impls!(ReadOnlySignal); /// An iterator over the values of a `CopyValue>`. -pub struct CopyValueIterator { +pub struct CopyValueIterator> { index: usize, - value: CopyValue>, + value: CopyValue, S>, } -impl Iterator for CopyValueIterator { +impl> Iterator for CopyValueIterator { type Item = T; fn next(&mut self) -> Option { @@ -225,8 +227,8 @@ impl Iterator for CopyValueIterator { } } -impl IntoIterator for CopyValue> { - type IntoIter = CopyValueIterator; +impl> IntoIterator for CopyValue, S> { + type IntoIter = CopyValueIterator; type Item = T; @@ -238,27 +240,33 @@ impl IntoIterator for CopyValue> { } } -impl CopyValue> { +impl>> CopyValue, S> +where + >>::Mut: MappableMut, T>, +{ /// Write to an element in the inner vector. - pub fn get_mut(&self, index: usize) -> Option> { + pub fn get_mut(&self, index: usize) -> Option<, T>>::Mapped> { MappedRwLockWriteGuard::try_map(self.write(), |v| v.get_mut(index)).ok() } } -impl CopyValue> { +impl>> CopyValue, S> +where + >>::Mut: MappableMut, T>, +{ /// Deref the inner value mutably. - pub fn as_mut(&self) -> Option> { - MappedRwLockWriteGuard::try_map(self.write(), |v| v.as_mut()).ok() + pub fn as_mut(&self) -> Option<, T>>::Mapped> { + S::Mut::map(self.try_write(), |v| v.as_mut()).ok() } } /// An iterator over items in a `Signal>`. -pub struct SignalIterator { +pub struct SignalIterator> { index: usize, - value: Signal>, + value: Signal, S>, } -impl Iterator for SignalIterator { +impl> Iterator for SignalIterator { type Item = T; fn next(&mut self) -> Option { @@ -268,8 +276,8 @@ impl Iterator for SignalIterator { } } -impl IntoIterator for Signal> { - type IntoIter = SignalIterator; +impl> IntoIterator for Signal, S> { + type IntoIter = SignalIterator; type Item = T; @@ -281,16 +289,22 @@ impl IntoIterator for Signal> { } } -impl Signal> { +impl>>> Signal, S> +where + S::Mut: MappableMut, T>, +{ /// Returns a reference to an element or `None` if out of bounds. - pub fn get_mut(&self, index: usize) -> Option>> { - Write::filter_map(self.write(), |v| v.get_mut(index)) + pub fn get_mut( + &self, + index: usize, + ) -> Option, T>>::Mapped, S, Vec>> { + S::Mut::map(self.write(), |v| v.get_mut(index)) } } -impl Signal> { +impl>>> Signal, S> { /// Returns a reference to an element or `None` if out of bounds. - pub fn as_mut(&self) -> Option>> { + pub fn as_mut(&self) -> Option>, S::Mut, S, Option>> { Write::filter_map(self.write(), |v| v.as_mut()) } } diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index c1fb2994d..3499de21a 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -5,23 +5,12 @@ use std::rc::Rc; use dioxus_core::prelude::*; use dioxus_core::ScopeId; -use generational_box::{GenerationalBox, Owner, Store}; -use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; +use generational_box::AnyStorage; +use generational_box::Storage; +use generational_box::{GenerationalBox, Owner}; use crate::Effect; -static STORE: once_cell::sync::Lazy = once_cell::sync::Lazy::new(Store::default); - -fn current_store() -> Store { - match consume_context() { - Some(rt) => rt, - None => { - let store = Store::default(); - provide_root_context(store).expect("in a virtual dom") - } - } -} - fn current_owner() -> Rc { match Effect::current() { // If we are inside of an effect, we should use the owner of the effect as the owner of the value. @@ -50,14 +39,22 @@ fn owner_in_scope(scope: ScopeId) -> Rc { } } +#[derive(Debug)] /// CopyValue is a wrapper around a value to make the value mutable and Copy. /// /// It is internally backed by [`generational_box::GenerationalBox`]. -pub struct CopyValue { - pub(crate) value: GenerationalBox, +pub struct CopyValue { + pub(crate) value: GenerationalBox, origin_scope: ScopeId, } +impl Copy for CopyValue {} +impl Clone for CopyValue { + fn clone(&self) -> Self { + *self + } +} + #[cfg(feature = "serde")] impl serde::Serialize for CopyValue where @@ -80,7 +77,7 @@ where } } -impl CopyValue { +impl> CopyValue { /// Create a new CopyValue. The value will be stored in the current component. /// /// Once the component this value is created in is dropped, the value will be dropped. @@ -118,22 +115,22 @@ impl CopyValue { } /// Try to read the value. If the value has been dropped, this will return None. - pub fn try_read(&self) -> Option> { + pub fn try_read(&self) -> Option { self.value.try_read() } /// Read the value. If the value has been dropped, this will panic. - pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { + pub fn read(&self) -> S::Ref { self.value.read() } /// Try to write the value. If the value has been dropped, this will return None. - pub fn try_write(&self) -> Option> { + pub fn try_write(&self) -> Option { self.value.try_write() } /// Write the value. If the value has been dropped, this will panic. - pub fn write(&self) -> MappedRwLockWriteGuard<'static, T> { + pub fn write(&self) -> S::Mut { self.value.write() } @@ -155,21 +152,21 @@ impl CopyValue { } } -impl CopyValue { +impl> CopyValue { /// Get the value. If the value has been dropped, this will panic. pub fn value(&self) -> T { self.read().clone() } } -impl PartialEq for CopyValue { +impl> PartialEq for CopyValue { fn eq(&self, other: &Self) -> bool { self.value.ptr_eq(&other.value) } } -impl Deref for CopyValue { - type Target = dyn Fn() -> MappedRwLockReadGuard<'static, T>; +impl> Deref for CopyValue { + type Target = dyn Fn() -> S::Ref; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types diff --git a/packages/signals/src/selector.rs b/packages/signals/src/selector.rs index 556c8437c..de3f206eb 100644 --- a/packages/signals/src/selector.rs +++ b/packages/signals/src/selector.rs @@ -1,4 +1,5 @@ use dioxus_core::prelude::*; +use generational_box::Storage; use crate::dependency::Dependency; use crate::use_signal; @@ -22,10 +23,10 @@ use crate::{get_effect_stack, signal::SignalData, CopyValue, Effect, ReadOnlySig /// } /// ``` #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] -pub fn use_selector( +pub fn use_selector>>( cx: &ScopeState, f: impl FnMut() -> R + 'static, -) -> ReadOnlySignal { +) -> ReadOnlySignal { *cx.use_hook(|| selector(f)) } @@ -46,11 +47,11 @@ pub fn use_selector( /// } /// ``` #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] -pub fn use_selector_with_dependencies( +pub fn use_selector_with_dependencies>>( cx: &ScopeState, dependencies: D, mut f: impl FnMut(D::Out) -> R + 'static, -) -> ReadOnlySignal +) -> ReadOnlySignal where D::Out: 'static, { @@ -71,7 +72,9 @@ where /// Creates a new Selector. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. -pub fn selector(mut f: impl FnMut() -> R + 'static) -> ReadOnlySignal { +pub fn selector>>( + mut f: impl FnMut() -> R + 'static, +) -> ReadOnlySignal { let state = Signal:: { inner: CopyValue::invalid(), }; diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 43aa0c904..a12b43648 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -10,6 +10,7 @@ use dioxus_core::{ prelude::{current_scope_id, has_context, provide_context, schedule_update_any}, ScopeId, ScopeState, }; +use generational_box::{AnyStorage, Mappable, MappableMut, Storage}; use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; use crate::{get_effect_stack, CopyValue, Effect, EffectStack}; @@ -46,7 +47,10 @@ use crate::{get_effect_stack, CopyValue, Effect, EffectStack}; /// } /// ``` #[must_use] -pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal { +pub fn use_signal>>( + cx: &ScopeState, + f: impl FnOnce() -> T, +) -> Signal { *cx.use_hook(|| Signal::new(f())) } @@ -119,8 +123,8 @@ pub(crate) struct SignalData { /// } /// } /// ``` -pub struct Signal { - pub(crate) inner: CopyValue>, +pub struct Signal { + pub(crate) inner: CopyValue, S>, } #[cfg(feature = "serde")] @@ -137,7 +141,7 @@ impl<'de, T: serde::Deserialize<'de> + 'static> serde::Deserialize<'de> for Sign } } -impl Signal { +impl>> Signal { /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. pub fn new(value: T) -> Self { Self { @@ -174,7 +178,10 @@ impl Signal { /// Get the current value of the signal. This will subscribe the current scope to the signal. /// If the signal has been dropped, this will panic. - pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { + pub fn read(&self) -> <>>::Ref as Mappable, T>>::Mapped + where + >>::Ref: Mappable, T>, + { let inner = self.inner.read(); if let Some(effect) = inner.effect_stack.current() { let mut effect_subscribers = inner.effect_subscribers.borrow_mut(); @@ -198,14 +205,19 @@ impl Signal { } } } - MappedRwLockReadGuard::map(inner, |v| &v.value) + S::Ref::map(inner, |v| &v.value) } /// Get a mutable reference to the signal's value. /// If the signal has been dropped, this will panic. - pub fn write(&self) -> Write { + pub fn write( + &self, + ) -> Write>>::Mut as MappableMut, T>>::Mapped, S> + where + >>::Mut: MappableMut, T>, + { let inner = self.inner.write(); - let borrow = MappedRwLockWriteGuard::map(inner, |v| &mut v.value); + let borrow = S::Mut::map(inner, |v| &mut v.value); Write { write: borrow, signal: SignalSubscriberDrop { signal: *self }, @@ -260,7 +272,7 @@ impl Signal { } } -impl Signal { +impl>> Signal { /// Get the current value of the signal. This will subscribe the current scope to the signal. /// If the signal has been dropped, this will panic. pub fn value(&self) -> T { @@ -268,21 +280,21 @@ impl Signal { } } -impl Signal { +impl> Signal { /// Invert the boolean value of the signal. This will trigger an update on all subscribers. pub fn toggle(&self) { self.set(!self.value()); } } -impl PartialEq for Signal { +impl>> PartialEq for Signal { fn eq(&self, other: &Self) -> bool { self.inner == other.inner } } -impl Deref for Signal { - type Target = dyn Fn() -> MappedRwLockReadGuard<'static, T>; +impl>> Deref for Signal { + type Target = dyn Fn() -> S::Ref; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types @@ -314,28 +326,31 @@ impl Deref for Signal { } } -struct SignalSubscriberDrop { - signal: Signal, +struct SignalSubscriberDrop>> { + signal: Signal, } -impl Drop for SignalSubscriberDrop { +impl>> Drop for SignalSubscriberDrop { fn drop(&mut self) { self.signal.update_subscribers(); } } /// A mutable reference to a signal's value. -pub struct Write { - write: MappedRwLockWriteGuard<'static, T>, - signal: SignalSubscriberDrop, +pub struct Write, S: Storage>, I: 'static = T> { + write: B, + signal: SignalSubscriberDrop, } -impl Write { +impl, S: Storage>, I: 'static> Write { /// Map the mutable reference to the signal's value to a new type. - pub fn map(myself: Self, f: impl FnOnce(&mut T) -> &mut O) -> Write { + pub fn map(myself: Self, f: impl FnOnce(&mut T) -> &mut O) -> Write + where + S: MappableMut, + { let Self { write, signal } = myself; Write { - write: MappedRwLockWriteGuard::map(write, f), + write: S::map(write, f), signal, } } @@ -344,14 +359,19 @@ impl Write { pub fn filter_map( myself: Self, f: impl FnOnce(&mut T) -> Option<&mut O>, - ) -> Option> { + ) -> Option> + where + S: MappableMut, + { let Self { write, signal } = myself; let write = MappedRwLockWriteGuard::try_map(write, f).ok(); write.map(|write| Write { write, signal }) } } -impl Deref for Write { +impl, S: Storage>, I: 'static> Deref + for Write +{ type Target = T; fn deref(&self) -> &Self::Target { @@ -359,20 +379,20 @@ impl Deref for Write { } } -impl DerefMut for Write { +impl, S: Storage>, I> DerefMut for Write { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.write } } /// A signal that can only be read from. -pub struct ReadOnlySignal { - inner: Signal, +pub struct ReadOnlySignal>> { + inner: Signal, } -impl ReadOnlySignal { +impl>> ReadOnlySignal { /// Create a new read-only signal. - pub fn new(signal: Signal) -> Self { + pub fn new(signal: Signal) -> Self { Self { inner: signal } } @@ -392,21 +412,21 @@ impl ReadOnlySignal { } } -impl ReadOnlySignal { +impl>> ReadOnlySignal { /// Get the current value of the signal. This will subscribe the current scope to the signal. pub fn value(&self) -> T { self.read().clone() } } -impl PartialEq for ReadOnlySignal { +impl>> PartialEq for ReadOnlySignal { fn eq(&self, other: &Self) -> bool { self.inner == other.inner } } -impl Deref for ReadOnlySignal { - type Target = dyn Fn() -> MappedRwLockReadGuard<'static, T>; +impl>> Deref for ReadOnlySignal { + type Target = dyn Fn() -> S::Ref; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types From 0a8de1d40f3154133e3bc3cf779dfe9eee7a4cfa Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Thu, 2 Nov 2023 19:35:53 -0500 Subject: [PATCH 04/19] clean up ref mapping with GATs --- packages/generational-box/src/lib.rs | 81 ++++++++++----- packages/signals/src/effect.rs | 9 +- packages/signals/src/impls.rs | 100 ++++++++++-------- packages/signals/src/rt.rs | 57 +++++------ packages/signals/src/selector.rs | 3 +- packages/signals/src/signal.rs | 145 +++++++++++++++++++-------- 6 files changed, 245 insertions(+), 150 deletions(-) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index ec1986f39..87941c99e 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -247,53 +247,82 @@ impl Default for SyncStorage { } } -pub trait Mappable: Deref { - type Mapped: Deref; +pub trait Mappable: Deref { + type Mapped: Mappable + Deref; - fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped; + fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped; + + fn try_map(_self: Self, f: fn(&T) -> Option<&U>) -> Option>; } -impl Mappable for Ref<'static, T> { - type Mapped = Ref<'static, U>; +impl Mappable for Ref<'static, T> { + type Mapped = Ref<'static, U>; - fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { + fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { Ref::map(_self, f) } + + fn try_map(_self: Self, f: fn(&T) -> Option<&U>) -> Option> { + Ref::try_map(_self, f) + } } -impl Mappable for MappedRwLockReadGuard<'static, T> { - type Mapped = MappedRwLockReadGuard<'static, U>; +impl Mappable for MappedRwLockReadGuard<'static, T> { + type Mapped = MappedRwLockReadGuard<'static, U>; - fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { + fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { MappedRwLockReadGuard::map(_self, f) } -} -pub trait MappableMut: DerefMut { - type Mapped: DerefMut; - - fn map(_self: Self, f: fn(&mut T) -> &mut U) -> Self::Mapped; -} - -impl MappableMut for RefMut<'static, T> { - type Mapped = RefMut<'static, U>; - - fn map(_self: Self, f: fn(&mut T) -> &mut U) -> Self::Mapped { - RefMut::map(_self, f) + fn try_map(_self: Self, f: fn(&T) -> Option<&U>) -> Option> { + MappedRwLockReadGuard::try_map(_self, f).ok() } } -impl MappableMut for MappedRwLockWriteGuard<'static, T> { - type Mapped = MappedRwLockWriteGuard<'static, U>; +pub trait MappableMut: DerefMut { + type Mapped: MappableMut + DerefMut; - fn map(_self: Self, f: fn(&mut T) -> &mut U) -> Self::Mapped { + fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped; + + fn try_map( + _self: Self, + f: impl FnOnce(&mut T) -> Option<&mut U>, + ) -> Option>; +} + +impl MappableMut for RefMut<'static, T> { + type Mapped = RefMut<'static, U>; + + fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { + RefMut::map(_self, f) + } + + fn try_map( + _self: Self, + f: impl FnOnce(&mut T) -> Option<&mut U>, + ) -> Option> { + RefMut::try_map(_self, f) + } +} + +impl MappableMut for MappedRwLockWriteGuard<'static, T> { + type Mapped = MappedRwLockWriteGuard<'static, U>; + + fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { MappedRwLockWriteGuard::map(_self, f) } + + fn try_map( + _self: Self, + f: impl FnOnce(&mut T) -> Option<&mut U>, + ) -> Option> { + MappedRwLockWriteGuard::try_map(_self, f).ok() + } } pub trait Storage: Copy + AnyStorage { - type Ref: Deref; - type Mut: DerefMut; + type Ref: Mappable + Deref; + type Mut: MappableMut + DerefMut; fn try_read(&self) -> Option; fn read(&self) -> Self::Ref { diff --git a/packages/signals/src/effect.rs b/packages/signals/src/effect.rs index 2ab29780d..9d6231eb3 100644 --- a/packages/signals/src/effect.rs +++ b/packages/signals/src/effect.rs @@ -1,15 +1,14 @@ use core::{self, fmt::Debug}; -use std::fmt::{self, Formatter}; -// use dioxus_core::prelude::*; -use generational_box::SyncStorage; +use generational_box::UnsyncStorage; +use std::fmt::{self, Formatter}; use crate::use_signal; use crate::{dependency::Dependency, CopyValue}; #[derive(Copy, Clone, PartialEq)] pub(crate) struct EffectStack { - pub(crate) effects: CopyValue, SyncStorage>, + pub(crate) effects: CopyValue, UnsyncStorage>, } impl Default for EffectStack { @@ -69,7 +68,7 @@ pub fn use_effect_with_dependencies( #[derive(Copy, Clone, PartialEq)] pub struct Effect { pub(crate) source: ScopeId, - pub(crate) callback: CopyValue, SyncStorage>, + pub(crate) callback: CopyValue, UnsyncStorage>, pub(crate) effect_stack: EffectStack, } diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index e97ebc452..a217dfaa4 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -1,6 +1,7 @@ use crate::rt::CopyValue; use crate::signal::{ReadOnlySignal, Signal, Write}; use crate::SignalData; +use generational_box::Mappable; use generational_box::{MappableMut, Storage}; use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; @@ -11,40 +12,40 @@ use std::{ macro_rules! read_impls { ($ty:ident) => { - impl Default for $ty { + impl> Default for $ty { fn default() -> Self { Self::new(Default::default()) } } - impl std::clone::Clone for $ty { + impl> std::clone::Clone for $ty { fn clone(&self) -> Self { *self } } - impl Copy for $ty {} + impl + Copy> Copy for $ty {} - impl Display for $ty { + impl> Display for $ty { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.with(|v| Display::fmt(v, f)) } } - impl Debug for $ty { + impl> Debug for $ty { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.with(|v| Debug::fmt(v, f)) } } - impl $ty> { + impl> $ty, S> { /// Read a value from the inner vector. pub fn get(&self, index: usize) -> Option> { MappedRwLockReadGuard::try_map(self.read(), |v| v.get(index)).ok() } } - impl $ty> { + impl> $ty, S> { /// Unwraps the inner value and clones it. pub fn unwrap(&self) -> T where @@ -63,7 +64,7 @@ macro_rules! read_impls { macro_rules! write_impls { ($ty:ident) => { - impl + Copy + 'static> std::ops::Add for $ty { + impl + Copy + 'static, S: Storage> std::ops::Add for $ty { type Output = T; fn add(self, rhs: T) -> Self::Output { @@ -71,19 +72,23 @@ macro_rules! write_impls { } } - impl + Copy + 'static> std::ops::AddAssign for $ty { + impl + Copy + 'static, S: Storage> std::ops::AddAssign + for $ty + { fn add_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v + rhs) } } - impl + Copy + 'static> std::ops::SubAssign for $ty { + impl + Copy + 'static, S: Storage> std::ops::SubAssign + for $ty + { fn sub_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v - rhs) } } - impl + Copy + 'static> std::ops::Sub for $ty { + impl + Copy + 'static, S: Storage> std::ops::Sub for $ty { type Output = T; fn sub(self, rhs: T) -> Self::Output { @@ -91,13 +96,15 @@ macro_rules! write_impls { } } - impl + Copy + 'static> std::ops::MulAssign for $ty { + impl + Copy + 'static, S: Storage> std::ops::MulAssign + for $ty + { fn mul_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v * rhs) } } - impl + Copy + 'static> std::ops::Mul for $ty { + impl + Copy + 'static, S: Storage> std::ops::Mul for $ty { type Output = T; fn mul(self, rhs: T) -> Self::Output { @@ -105,13 +112,15 @@ macro_rules! write_impls { } } - impl + Copy + 'static> std::ops::DivAssign for $ty { + impl + Copy + 'static, S: Storage> std::ops::DivAssign + for $ty + { fn div_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v / rhs) } } - impl + Copy + 'static> std::ops::Div for $ty { + impl + Copy + 'static, S: Storage> std::ops::Div for $ty { type Output = T; fn div(self, rhs: T) -> Self::Output { @@ -119,7 +128,7 @@ macro_rules! write_impls { } } - impl $ty> { + impl> $ty, S> { /// Pushes a new value to the end of the vector. pub fn push(&self, value: T) { self.with_mut(|v| v.push(value)) @@ -171,7 +180,7 @@ macro_rules! write_impls { } } - impl $ty> { + impl> $ty, S> { /// Takes the value out of the Option. pub fn take(&self) -> Option { self.with_mut(|v| v.take()) @@ -183,7 +192,7 @@ macro_rules! write_impls { } /// Gets the value out of the Option, or inserts the given value if the Option is empty. - pub fn get_or_insert(&self, default: T) -> MappedRwLockReadGuard<'_, T> { + pub fn get_or_insert(&self, default: T) -> S::Ref { self.get_or_insert_with(|| default) } @@ -191,25 +200,25 @@ macro_rules! write_impls { pub fn get_or_insert_with( &self, default: impl FnOnce() -> T, - ) -> MappedRwLockReadGuard<'_, T> { + ) -> >::Mapped { let borrow = self.read(); if borrow.is_none() { drop(borrow); self.with_mut(|v| *v = Some(default())); - MappedRwLockReadGuard::map(self.read(), |v| v.as_ref().unwrap()) + S::Ref::map(self.read(), |v| v.as_ref().unwrap()) } else { - MappedRwLockReadGuard::map(borrow, |v| v.as_ref().unwrap()) + S::Ref::map(borrow, |v| v.as_ref().unwrap()) } } } }; } -// read_impls!(CopyValue); -// write_impls!(CopyValue); -// read_impls!(Signal); -// write_impls!(Signal); -// read_impls!(ReadOnlySignal); +read_impls!(CopyValue); +write_impls!(CopyValue); +read_impls!(Signal); +write_impls!(Signal); +read_impls!(ReadOnlySignal); /// An iterator over the values of a `CopyValue>`. pub struct CopyValueIterator> { @@ -240,23 +249,19 @@ impl> IntoIterator for CopyValue, S> { } } -impl>> CopyValue, S> -where - >>::Mut: MappableMut, T>, -{ +impl>> CopyValue, S> { /// Write to an element in the inner vector. - pub fn get_mut(&self, index: usize) -> Option<, T>>::Mapped> { - MappedRwLockWriteGuard::try_map(self.write(), |v| v.get_mut(index)).ok() + pub fn get_mut(&self, index: usize) -> Option<>>::Mapped> { + S::Mut::try_map(self.write(), |v: &mut Vec| v.get_mut(index)) } } -impl>> CopyValue, S> -where - >>::Mut: MappableMut, T>, -{ +impl>> CopyValue, S> { /// Deref the inner value mutably. - pub fn as_mut(&self) -> Option<, T>>::Mapped> { - S::Mut::map(self.try_write(), |v| v.as_mut()).ok() + pub fn as_mut( + &self, + ) -> Option<<>>::Mut as MappableMut>>::Mapped> { + S::Mut::try_map(self.write(), |v: &mut Option| v.as_mut()) } } @@ -291,20 +296,31 @@ impl> IntoIterator for Signal, S> { impl>>> Signal, S> where - S::Mut: MappableMut, T>, + <>>>::Mut as MappableMut< + SignalData>, + >>::Mapped>: MappableMut>, { /// Returns a reference to an element or `None` if out of bounds. pub fn get_mut( &self, index: usize, - ) -> Option, T>>::Mapped, S, Vec>> { - S::Mut::map(self.write(), |v| v.get_mut(index)) + ) -> Option< + Write< + T, + <<>>>::Mut as MappableMut>>>::Mapped< + Vec, + > as MappableMut>>::Mapped, + S, + Vec, + >, + > { + Write::filter_map(self.write(), |v| v.get_mut(index)) } } impl>>> Signal, S> { /// Returns a reference to an element or `None` if out of bounds. - pub fn as_mut(&self) -> Option>, S::Mut, S, Option>> { + pub fn as_mut(&self) -> Option>>>::Mut as MappableMut>>>::Mapped> as MappableMut>>::Mapped, S, Option>>{ Write::filter_map(self.write(), |v| v.as_mut()) } } diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index 3499de21a..7ae6365f7 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -11,32 +11,34 @@ use generational_box::{GenerationalBox, Owner}; use crate::Effect; -fn current_owner() -> Rc { - match Effect::current() { - // If we are inside of an effect, we should use the owner of the effect as the owner of the value. - Some(effect) => { - let scope_id = effect.source; - owner_in_scope(scope_id) - } - // Otherwise either get an owner from the current scope or create a new one. - None => match has_context() { - Some(rt) => rt, - None => { - let owner = Rc::new(current_store().owner()); - provide_context(owner).expect("in a virtual dom") - } - }, - } +fn current_owner, T>() -> Rc> { + todo!() + // match Effect::current() { + // // If we are inside of an effect, we should use the owner of the effect as the owner of the value. + // Some(effect) => { + // let scope_id = effect.source; + // owner_in_scope(scope_id) + // } + // // Otherwise either get an owner from the current scope or create a new one. + // None => match has_context() { + // Some(rt) => rt, + // None => { + // let owner = Rc::new(current_store().owner()); + // provide_context(owner).expect("in a virtual dom") + // } + // }, + // } } -fn owner_in_scope(scope: ScopeId) -> Rc { - match consume_context_from_scope(scope) { - Some(rt) => rt, - None => { - let owner = Rc::new(current_store().owner()); - provide_context_to_scope(scope, owner).expect("in a virtual dom") - } - } +fn owner_in_scope, T>(scope: ScopeId) -> Rc> { + todo!() + // match consume_context_from_scope(scope) { + // Some(rt) => rt, + // None => { + // let owner = Rc::new(current_store().owner()); + // provide_context_to_scope(scope, owner).expect("in a virtual dom") + // } + // } } #[derive(Debug)] @@ -48,13 +50,6 @@ pub struct CopyValue { origin_scope: ScopeId, } -impl Copy for CopyValue {} -impl Clone for CopyValue { - fn clone(&self) -> Self { - *self - } -} - #[cfg(feature = "serde")] impl serde::Serialize for CopyValue where diff --git a/packages/signals/src/selector.rs b/packages/signals/src/selector.rs index de3f206eb..28d8ca38e 100644 --- a/packages/signals/src/selector.rs +++ b/packages/signals/src/selector.rs @@ -75,7 +75,7 @@ where pub fn selector>>( mut f: impl FnMut() -> R + 'static, ) -> ReadOnlySignal { - let state = Signal:: { + let state = Signal:: { inner: CopyValue::invalid(), }; let effect = Effect { @@ -89,7 +89,6 @@ pub fn selector>>( } state.inner.value.set(SignalData { subscribers: Default::default(), - effect_subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value: f(), effect_stack: get_effect_stack(), diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index a12b43648..501f736dd 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -1,5 +1,6 @@ use std::{ cell::RefCell, + marker::PhantomData, mem::MaybeUninit, ops::{Deref, DerefMut}, rc::Rc, @@ -10,8 +11,8 @@ use dioxus_core::{ prelude::{current_scope_id, has_context, provide_context, schedule_update_any}, ScopeId, ScopeState, }; -use generational_box::{AnyStorage, Mappable, MappableMut, Storage}; -use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; +use generational_box::{AnyStorage, Mappable, MappableMut, Storage, SyncStorage, UnsyncStorage}; +use parking_lot::RwLock; use crate::{get_effect_stack, CopyValue, Effect, EffectStack}; @@ -47,11 +48,51 @@ use crate::{get_effect_stack, CopyValue, Effect, EffectStack}; /// } /// ``` #[must_use] -pub fn use_signal>>( +pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal { + *cx.use_hook(|| Signal::new(f())) +} + +/// Creates a new `Send + Sync`` Signal. Signals are a Copy state management solution with automatic dependency tracking. +/// +/// ```rust +/// use dioxus::prelude::*; +/// use dioxus_signals::*; +/// +/// fn App(cx: Scope) -> Element { +/// let mut count = use_signal(cx, || 0); +/// +/// // Because signals have automatic dependency tracking, if you never read them in a component, that component will not be re-rended when the signal is updated. +/// // The app component will never be rerendered in this example. +/// render! { Child { state: count } } +/// } +/// +/// #[component] +/// fn Child(cx: Scope, state: Signal) -> Element { +/// let state = *state; +/// +/// use_future!(cx, |()| async move { +/// // This signal is Send + Sync, so we can use it in an another thread +/// tokio::spawn(async move { +/// // Because the signal is a Copy type, we can use it in an async block without cloning it. +/// *state.write() += 1; +/// }).await; +/// }); +/// +/// render! { +/// button { +/// onclick: move |_| *state.write() += 1, +/// "{state}" +/// } +/// } +/// } +/// ``` +#[must_use] +pub fn use_signal_sync( cx: &ScopeState, f: impl FnOnce() -> T, -) -> Signal { - *cx.use_hook(|| Signal::new(f())) +) -> Signal { + // *cx.use_hook(|| Signal::new(f())) + todo!() } #[derive(Clone)] @@ -83,10 +124,15 @@ fn current_unsubscriber() -> Unsubscriber { } } +#[derive(Default)] +pub(crate) struct SignalSubscribers { + pub(crate) subscribers: Vec, + pub(crate) effect_subscribers: Vec, +} + pub(crate) struct SignalData { - pub(crate) subscribers: Rc>>, - pub(crate) effect_subscribers: Rc>>, - pub(crate) update_any: Arc, + pub(crate) subscribers: Arc>, + pub(crate) update_any: Arc, pub(crate) effect_stack: EffectStack, pub(crate) value: T, } @@ -123,7 +169,7 @@ pub(crate) struct SignalData { /// } /// } /// ``` -pub struct Signal { +pub struct Signal>> { pub(crate) inner: CopyValue, S>, } @@ -147,7 +193,6 @@ impl>> Signal { Self { inner: CopyValue::new(SignalData { subscribers: Default::default(), - effect_subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value, effect_stack: get_effect_stack(), @@ -161,7 +206,6 @@ impl>> Signal { inner: CopyValue::new_in_scope( SignalData { subscribers: Default::default(), - effect_subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value, effect_stack: get_effect_stack(), @@ -178,13 +222,13 @@ impl>> Signal { /// Get the current value of the signal. This will subscribe the current scope to the signal. /// If the signal has been dropped, this will panic. - pub fn read(&self) -> <>>::Ref as Mappable, T>>::Mapped - where - >>::Ref: Mappable, T>, - { + pub fn read( + &self, + ) -> <>>::Ref as Mappable>>::Mapped { let inner = self.inner.read(); if let Some(effect) = inner.effect_stack.current() { - let mut effect_subscribers = inner.effect_subscribers.borrow_mut(); + let mut subscribers = inner.subscribers.write(); + let mut effect_subscribers = &mut subscribers.effect_subscribers; if !effect_subscribers.contains(&effect) { effect_subscribers.push(effect); } @@ -196,12 +240,17 @@ impl>> Signal { self.inner.value, current_scope_id ); - let mut subscribers = inner.subscribers.borrow_mut(); + let mut subscribers = inner.subscribers.write(); + let subscribers = &mut subscribers.subscribers; if !subscribers.contains(¤t_scope_id) { subscribers.push(current_scope_id); drop(subscribers); let unsubscriber = current_unsubscriber(); - inner.subscribers.borrow_mut().push(unsubscriber.scope); + inner + .subscribers + .write() + .subscribers + .push(unsubscriber.scope); } } } @@ -212,22 +261,21 @@ impl>> Signal { /// If the signal has been dropped, this will panic. pub fn write( &self, - ) -> Write>>::Mut as MappableMut, T>>::Mapped, S> - where - >>::Mut: MappableMut, T>, + ) -> Write>>::Mut as MappableMut>>::Mapped, S> { let inner = self.inner.write(); let borrow = S::Mut::map(inner, |v| &mut v.value); Write { write: borrow, signal: SignalSubscriberDrop { signal: *self }, + phantom: std::marker::PhantomData, } } fn update_subscribers(&self) { { let inner = self.inner.read(); - for &scope_id in &*inner.subscribers.borrow() { + for &scope_id in &*inner.subscribers.read().subscribers { tracing::trace!( "Write on {:?} triggered update on {:?}", self.inner.value, @@ -239,7 +287,7 @@ impl>> Signal { let subscribers = { let self_read = self.inner.read(); - let mut effects = self_read.effect_subscribers.borrow_mut(); + let mut effects = &mut self_read.subscribers.write().effect_subscribers; std::mem::take(&mut *effects) }; for effect in subscribers { @@ -280,7 +328,7 @@ impl>> Signal { } } -impl> Signal { +impl>> Signal { /// Invert the boolean value of the signal. This will trigger an update on all subscribers. pub fn toggle(&self) { self.set(!self.value()); @@ -294,7 +342,8 @@ impl>> PartialEq for Signal { } impl>> Deref for Signal { - type Target = dyn Fn() -> S::Ref; + type Target = + dyn Fn() -> <>>::Ref as Mappable>>::Mapped; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types @@ -337,21 +386,25 @@ impl>> Drop for SignalSubscriberDrop } /// A mutable reference to a signal's value. -pub struct Write, S: Storage>, I: 'static = T> { +/// +/// T is the current type of the write +/// B is the dynamicly checked type of the write (RefMut) +/// S is the storage type of the signal +/// I is the type of the original signal +pub struct Write, S: Storage>, I: 'static = T> { write: B, signal: SignalSubscriberDrop, + phantom: std::marker::PhantomData, } -impl, S: Storage>, I: 'static> Write { +impl, S: Storage>, I: 'static> Write { /// Map the mutable reference to the signal's value to a new type. - pub fn map(myself: Self, f: impl FnOnce(&mut T) -> &mut O) -> Write - where - S: MappableMut, - { - let Self { write, signal } = myself; + pub fn map(myself: Self, f: impl FnOnce(&mut T) -> &mut O) -> Write, S, I> { + let Self { write, signal, .. } = myself; Write { - write: S::map(write, f), + write: B::map(write, f), signal, + phantom: std::marker::PhantomData, } } @@ -359,17 +412,18 @@ impl, S: Storage>, I: 'static> pub fn filter_map( myself: Self, f: impl FnOnce(&mut T) -> Option<&mut O>, - ) -> Option> - where - S: MappableMut, - { - let Self { write, signal } = myself; - let write = MappedRwLockWriteGuard::try_map(write, f).ok(); - write.map(|write| Write { write, signal }) + ) -> Option, S, I>> { + let Self { write, signal, .. } = myself; + let write = B::try_map(write, f); + write.map(|write| Write { + write, + signal, + phantom: PhantomData, + }) } } -impl, S: Storage>, I: 'static> Deref +impl, S: Storage>, I: 'static> Deref for Write { type Target = T; @@ -379,7 +433,7 @@ impl, S: Storage>, I: 'static> } } -impl, S: Storage>, I> DerefMut for Write { +impl, S: Storage>, I> DerefMut for Write { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.write } @@ -402,7 +456,9 @@ impl>> ReadOnlySignal { } /// Get the current value of the signal. This will subscribe the current scope to the signal. - pub fn read(&self) -> MappedRwLockReadGuard<'static, T> { + pub fn read( + &self, + ) -> <>>::Ref as Mappable>>::Mapped { self.inner.read() } @@ -426,7 +482,8 @@ impl>> PartialEq for ReadOnlySignal { } impl>> Deref for ReadOnlySignal { - type Target = dyn Fn() -> S::Ref; + type Target = + dyn Fn() -> <>>::Ref as Mappable>>::Mapped; fn deref(&self) -> &Self::Target { // https://github.com/dtolnay/case-studies/tree/master/callable-types From ebbaacf073ac7eef14bf32eeac72f1532351b66b Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Fri, 3 Nov 2023 10:27:21 -0500 Subject: [PATCH 05/19] fix read and write impls --- packages/generational-box/src/lib.rs | 23 ++- packages/signals/src/impls.rs | 250 +++++++++++++++++---------- packages/signals/src/rt.rs | 3 +- packages/signals/src/signal.rs | 9 +- 4 files changed, 182 insertions(+), 103 deletions(-) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 87941c99e..040fb842b 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -250,19 +250,25 @@ impl Default for SyncStorage { pub trait Mappable: Deref { type Mapped: Mappable + Deref; - fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped; + fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped; - fn try_map(_self: Self, f: fn(&T) -> Option<&U>) -> Option>; + fn try_map( + _self: Self, + f: impl FnOnce(&T) -> Option<&U>, + ) -> Option>; } impl Mappable for Ref<'static, T> { type Mapped = Ref<'static, U>; - fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { + fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { Ref::map(_self, f) } - fn try_map(_self: Self, f: fn(&T) -> Option<&U>) -> Option> { + fn try_map( + _self: Self, + f: impl FnOnce(&T) -> Option<&U>, + ) -> Option> { Ref::try_map(_self, f) } } @@ -270,11 +276,14 @@ impl Mappable for Ref<'static, T> { impl Mappable for MappedRwLockReadGuard<'static, T> { type Mapped = MappedRwLockReadGuard<'static, U>; - fn map(_self: Self, f: fn(&T) -> &U) -> Self::Mapped { + fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { MappedRwLockReadGuard::map(_self, f) } - fn try_map(_self: Self, f: fn(&T) -> Option<&U>) -> Option> { + fn try_map( + _self: Self, + f: impl FnOnce(&T) -> Option<&U>, + ) -> Option> { MappedRwLockReadGuard::try_map(_self, f).ok() } } @@ -320,7 +329,7 @@ impl MappableMut for MappedRwLockWriteGuard<'static, T> { } } -pub trait Storage: Copy + AnyStorage { +pub trait Storage: Copy + AnyStorage + 'static { type Ref: Mappable + Deref; type Mut: MappableMut + DerefMut; diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index a217dfaa4..bf994cf4b 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -3,7 +3,7 @@ use crate::signal::{ReadOnlySignal, Signal, Write}; use crate::SignalData; use generational_box::Mappable; use generational_box::{MappableMut, Storage}; -use parking_lot::{MappedRwLockReadGuard, MappedRwLockWriteGuard}; +use std::ops::Deref; use std::{ fmt::{Debug, Display}, @@ -11,60 +11,38 @@ use std::{ }; macro_rules! read_impls { - ($ty:ident) => { - impl> Default for $ty { + ($ty:ident, $bound:path) => { + impl Default for $ty { fn default() -> Self { Self::new(Default::default()) } } - impl> std::clone::Clone for $ty { + impl std::clone::Clone for $ty { fn clone(&self) -> Self { *self } } - impl + Copy> Copy for $ty {} + impl Copy for $ty {} - impl> Display for $ty { + impl Display for $ty { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.with(|v| Display::fmt(v, f)) } } - impl> Debug for $ty { + impl Debug for $ty { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.with(|v| Debug::fmt(v, f)) } } - - impl> $ty, S> { - /// Read a value from the inner vector. - pub fn get(&self, index: usize) -> Option> { - MappedRwLockReadGuard::try_map(self.read(), |v| v.get(index)).ok() - } - } - - impl> $ty, S> { - /// Unwraps the inner value and clones it. - pub fn unwrap(&self) -> T - where - T: Clone, - { - self.with(|v| v.clone()).unwrap() - } - - /// Attemps to read the inner value of the Option. - pub fn as_ref(&self) -> Option> { - MappedRwLockReadGuard::try_map(self.read(), |v| v.as_ref()).ok() - } - } }; } macro_rules! write_impls { - ($ty:ident) => { - impl + Copy + 'static, S: Storage> std::ops::Add for $ty { + ($ty:ident, $bound:path, $vec_bound:path) => { + impl + Copy + 'static, S: $bound> std::ops::Add for $ty { type Output = T; fn add(self, rhs: T) -> Self::Output { @@ -72,23 +50,19 @@ macro_rules! write_impls { } } - impl + Copy + 'static, S: Storage> std::ops::AddAssign - for $ty - { + impl + Copy + 'static, S: $bound> std::ops::AddAssign for $ty { fn add_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v + rhs) } } - impl + Copy + 'static, S: Storage> std::ops::SubAssign - for $ty - { + impl + Copy + 'static, S: $bound> std::ops::SubAssign for $ty { fn sub_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v - rhs) } } - impl + Copy + 'static, S: Storage> std::ops::Sub for $ty { + impl + Copy + 'static, S: $bound> std::ops::Sub for $ty { type Output = T; fn sub(self, rhs: T) -> Self::Output { @@ -96,15 +70,13 @@ macro_rules! write_impls { } } - impl + Copy + 'static, S: Storage> std::ops::MulAssign - for $ty - { + impl + Copy + 'static, S: $bound> std::ops::MulAssign for $ty { fn mul_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v * rhs) } } - impl + Copy + 'static, S: Storage> std::ops::Mul for $ty { + impl + Copy + 'static, S: $bound> std::ops::Mul for $ty { type Output = T; fn mul(self, rhs: T) -> Self::Output { @@ -112,15 +84,13 @@ macro_rules! write_impls { } } - impl + Copy + 'static, S: Storage> std::ops::DivAssign - for $ty - { + impl + Copy + 'static, S: $bound> std::ops::DivAssign for $ty { fn div_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v / rhs) } } - impl + Copy + 'static, S: Storage> std::ops::Div for $ty { + impl + Copy + 'static, S: $bound> std::ops::Div for $ty { type Output = T; fn div(self, rhs: T) -> Self::Output { @@ -128,7 +98,7 @@ macro_rules! write_impls { } } - impl> $ty, S> { + impl $ty, S> { /// Pushes a new value to the end of the vector. pub fn push(&self, value: T) { self.with_mut(|v| v.push(value)) @@ -179,54 +149,154 @@ macro_rules! write_impls { self.with_mut(|v| v.split_off(at)) } } - - impl> $ty, S> { - /// Takes the value out of the Option. - pub fn take(&self) -> Option { - self.with_mut(|v| v.take()) - } - - /// Replace the value in the Option. - pub fn replace(&self, value: T) -> Option { - self.with_mut(|v| v.replace(value)) - } - - /// Gets the value out of the Option, or inserts the given value if the Option is empty. - pub fn get_or_insert(&self, default: T) -> S::Ref { - self.get_or_insert_with(|| default) - } - - /// Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty. - pub fn get_or_insert_with( - &self, - default: impl FnOnce() -> T, - ) -> >::Mapped { - let borrow = self.read(); - if borrow.is_none() { - drop(borrow); - self.with_mut(|v| *v = Some(default())); - S::Ref::map(self.read(), |v| v.as_ref().unwrap()) - } else { - S::Ref::map(borrow, |v| v.as_ref().unwrap()) - } - } - } }; } -read_impls!(CopyValue); -write_impls!(CopyValue); -read_impls!(Signal); -write_impls!(Signal); -read_impls!(ReadOnlySignal); +read_impls!(CopyValue, Storage); + +impl>> CopyValue, S> { + /// Read a value from the inner vector. + pub fn get(&self, index: usize) -> Option<>>::Mapped> { + S::Ref::try_map(self.read(), move |v| v.get(index)) + } +} + +impl>> CopyValue, S> { + /// Unwraps the inner value and clones it. + pub fn unwrap(&self) -> T + where + T: Clone, + { + self.with(|v| v.clone()).unwrap() + } + + /// Attempts to read the inner value of the Option. + pub fn as_ref(&self) -> Option<>>::Mapped> { + S::Ref::try_map(self.read(), |v| v.as_ref()) + } +} + +write_impls!(CopyValue, Storage, Storage>); + +impl>> CopyValue, S> { + /// Takes the value out of the Option. + pub fn take(&self) -> Option { + self.with_mut(|v| v.take()) + } + + /// Replace the value in the Option. + pub fn replace(&self, value: T) -> Option { + self.with_mut(|v| v.replace(value)) + } + + /// Gets the value out of the Option, or inserts the given value if the Option is empty. + pub fn get_or_insert(&self, default: T) -> >>::Mapped { + self.get_or_insert_with(|| default) + } + + /// Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty. + pub fn get_or_insert_with( + &self, + default: impl FnOnce() -> T, + ) -> >>::Mapped { + let borrow = self.read(); + if borrow.is_none() { + drop(borrow); + self.with_mut(|v| *v = Some(default())); + S::Ref::map(self.read(), |v| v.as_ref().unwrap()) + } else { + S::Ref::map(borrow, |v| v.as_ref().unwrap()) + } + } +} + +read_impls!(Signal, Storage>); + +impl>>> Signal, S> { + /// Read a value from the inner vector. + pub fn get( + &self, + index: usize, + ) -> Option< + <<>>>::Ref as Mappable>>>::Mapped> as Mappable< + Vec, + >>::Mapped, + >{ + <>>>::Ref as Mappable>>>::Mapped::>::try_map(self.read(), move |v| v.get(index)) + } +} + +impl>>> Signal, S> { + /// Unwraps the inner value and clones it. + pub fn unwrap(&self) -> T + where + T: Clone, + { + self.with(|v| v.clone()).unwrap() + } + + /// Attempts to read the inner value of the Option. + pub fn as_ref( + &self, + ) -> Option< + <<>>>::Ref as Mappable>>>::Mapped< + Option, + > as Mappable>>::Mapped, + > { + <>>>::Ref as Mappable>>>::Mapped::< + Option, + >::try_map(self.read(), |v| v.as_ref()) + } +} + +write_impls!(Signal, Storage>, Storage>>); + +impl>>> Signal, S> { + /// Takes the value out of the Option. + pub fn take(&self) -> Option { + self.with_mut(|v| v.take()) + } + + /// Replace the value in the Option. + pub fn replace(&self, value: T) -> Option { + self.with_mut(|v| v.replace(value)) + } + + /// Gets the value out of the Option, or inserts the given value if the Option is empty. + pub fn get_or_insert(&self, default: T) -> <>>>::Mapped> as Mappable>>::Mapped{ + self.get_or_insert_with(|| default) + } + + /// Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty. + pub fn get_or_insert_with( + &self, + default: impl FnOnce() -> T, + ) -><>>>::Mapped> as Mappable>>::Mapped{ + let borrow = self.read(); + if borrow.is_none() { + drop(borrow); + self.with_mut(|v| *v = Some(default())); + >>>::Mapped::>::map( + self.read(), + |v| v.as_ref().unwrap(), + ) + } else { + >>>::Mapped::>::map(borrow, |v| { + v.as_ref().unwrap() + }) + } + } +} + +read_impls!(ReadOnlySignal, Storage>); /// An iterator over the values of a `CopyValue>`. -pub struct CopyValueIterator> { +pub struct CopyValueIterator>> { index: usize, value: CopyValue, S>, } -impl> Iterator for CopyValueIterator { +impl>> Iterator for CopyValueIterator { type Item = T; fn next(&mut self) -> Option { @@ -236,7 +306,7 @@ impl> Iterator for CopyValueIterator { } } -impl> IntoIterator for CopyValue, S> { +impl>> IntoIterator for CopyValue, S> { type IntoIter = CopyValueIterator; type Item = T; @@ -266,12 +336,12 @@ impl>> CopyValue, S> { } /// An iterator over items in a `Signal>`. -pub struct SignalIterator> { +pub struct SignalIterator>>> { index: usize, value: Signal, S>, } -impl> Iterator for SignalIterator { +impl>>> Iterator for SignalIterator { type Item = T; fn next(&mut self) -> Option { @@ -281,7 +351,7 @@ impl> Iterator for SignalIterator { } } -impl> IntoIterator for Signal, S> { +impl>>> IntoIterator for Signal, S> { type IntoIter = SignalIterator; type Item = T; diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index 7ae6365f7..a6005748a 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -41,11 +41,10 @@ fn owner_in_scope, T>(scope: ScopeId) -> Rc> { // } } -#[derive(Debug)] /// CopyValue is a wrapper around a value to make the value mutable and Copy. /// /// It is internally backed by [`generational_box::GenerationalBox`]. -pub struct CopyValue { +pub struct CopyValue> { pub(crate) value: GenerationalBox, origin_scope: ScopeId, } diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 501f736dd..61186b92c 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -90,7 +90,7 @@ pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal< pub fn use_signal_sync( cx: &ScopeState, f: impl FnOnce() -> T, -) -> Signal { +) -> Signal { // *cx.use_hook(|| Signal::new(f())) todo!() } @@ -130,7 +130,8 @@ pub(crate) struct SignalSubscribers { pub(crate) effect_subscribers: Vec, } -pub(crate) struct SignalData { +/// The data stored for tracking in a signal. +pub struct SignalData { pub(crate) subscribers: Arc>, pub(crate) update_any: Arc, pub(crate) effect_stack: EffectStack, @@ -341,7 +342,7 @@ impl>> PartialEq for Signal { } } -impl>> Deref for Signal { +impl> + 'static> Deref for Signal { type Target = dyn Fn() -> <>>::Ref as Mappable>>::Mapped; @@ -481,7 +482,7 @@ impl>> PartialEq for ReadOnlySignal { } } -impl>> Deref for ReadOnlySignal { +impl> + 'static> Deref for ReadOnlySignal { type Target = dyn Fn() -> <>>::Ref as Mappable>>::Mapped; From 6eb4e7358bd746d984d4f5a4557d276a6b9baf68 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Mon, 6 Nov 2023 14:46:26 -0600 Subject: [PATCH 06/19] fix selector and signal unsync default --- packages/signals/Cargo.toml | 1 + packages/signals/src/impls.rs | 2 +- packages/signals/src/rt.rs | 21 ++++++-- packages/signals/src/selector.rs | 82 ++++++++++++++++++++++++++++---- packages/signals/src/signal.rs | 58 ++++++++++++++-------- 5 files changed, 130 insertions(+), 34 deletions(-) diff --git a/packages/signals/Cargo.toml b/packages/signals/Cargo.toml index 6d22ee0c8..c081155a8 100644 --- a/packages/signals/Cargo.toml +++ b/packages/signals/Cargo.toml @@ -14,6 +14,7 @@ simple_logger = "4.2.0" serde = { version = "1", features = ["derive"], optional = true } parking_lot = "0.12.1" once_cell = "1.18.0" +ghost = "0.1.16" [dev-dependencies] dioxus = { workspace = true } diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index bf994cf4b..f59b8391f 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -14,7 +14,7 @@ macro_rules! read_impls { ($ty:ident, $bound:path) => { impl Default for $ty { fn default() -> Self { - Self::new(Default::default()) + Self::new_maybe_sync(Default::default()) } } diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index a6005748a..be4810680 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -1,3 +1,4 @@ +use generational_box::UnsyncStorage; use std::mem::MaybeUninit; use std::ops::Deref; use std::rc::Rc; @@ -44,7 +45,7 @@ fn owner_in_scope, T>(scope: ScopeId) -> Rc> { /// CopyValue is a wrapper around a value to make the value mutable and Copy. /// /// It is internally backed by [`generational_box::GenerationalBox`]. -pub struct CopyValue> { +pub struct CopyValue = UnsyncStorage> { pub(crate) value: GenerationalBox, origin_scope: ScopeId, } @@ -71,11 +72,25 @@ where } } -impl> CopyValue { +impl CopyValue { /// Create a new CopyValue. The value will be stored in the current component. /// /// Once the component this value is created in is dropped, the value will be dropped. pub fn new(value: T) -> Self { + Self::new_maybe_sync(value) + } + + /// Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped. + pub fn new_in_scope(value: T, scope: ScopeId) -> Self { + Self::new_maybe_sync_in_scope(value, scope) + } +} + +impl> CopyValue { + /// Create a new CopyValue. The value will be stored in the current component. + /// + /// Once the component this value is created in is dropped, the value will be dropped. + pub fn new_maybe_sync(value: T) -> Self { let owner = current_owner(); Self { @@ -85,7 +100,7 @@ impl> CopyValue { } /// Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped. - pub fn new_in_scope(value: T, scope: ScopeId) -> Self { + pub fn new_maybe_sync_in_scope(value: T, scope: ScopeId) -> Self { let owner = owner_in_scope(scope); Self { diff --git a/packages/signals/src/selector.rs b/packages/signals/src/selector.rs index 28d8ca38e..5de6395d5 100644 --- a/packages/signals/src/selector.rs +++ b/packages/signals/src/selector.rs @@ -5,7 +5,7 @@ use crate::dependency::Dependency; use crate::use_signal; use crate::{get_effect_stack, signal::SignalData, CopyValue, Effect, ReadOnlySignal, Signal}; -/// Creates a new Selector. The selector will be run immediately and whenever any signal it reads changes. +/// Creates a new unsync Selector. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. /// @@ -23,14 +23,41 @@ use crate::{get_effect_stack, signal::SignalData, CopyValue, Effect, ReadOnlySig /// } /// ``` #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] -pub fn use_selector>>( +pub fn use_selector( + cx: &ScopeState, + f: impl FnMut() -> R + 'static, +) -> ReadOnlySignal { + use_maybe_sync_selector(cx, f) +} + + +/// Creates a new Selector that may be sync. The selector will be run immediately and whenever any signal it reads changes. +/// +/// Selectors can be used to efficiently compute derived data from signals. +/// +/// ```rust +/// use dioxus::prelude::*; +/// use dioxus_signals::*; +/// +/// fn App(cx: Scope) -> Element { +/// let mut count = use_signal(cx, || 0); +/// let double = use_selector(cx, move || count * 2); +/// count += 1; +/// assert_eq!(double.value(), count * 2); +/// +/// render! { "{double}" } +/// } +/// ``` +#[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] +pub fn use_maybe_sync_selector>>( cx: &ScopeState, f: impl FnMut() -> R + 'static, ) -> ReadOnlySignal { - *cx.use_hook(|| selector(f)) + *cx.use_hook(|| maybe_sync_selector(f)) } -/// Creates a new Selector with some local dependencies. The selector will be run immediately and whenever any signal it reads or any dependencies it tracks changes + +/// Creates a new unsync Selector with some local dependencies. The selector will be run immediately and whenever any signal it reads or any dependencies it tracks changes /// /// Selectors can be used to efficiently compute derived data from signals. /// @@ -47,7 +74,35 @@ pub fn use_selector>>( /// } /// ``` #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] -pub fn use_selector_with_dependencies>>( +pub fn use_selector_with_dependencies( + cx: &ScopeState, + dependencies: D, + mut f: impl FnMut(D::Out) -> R + 'static, +) -> ReadOnlySignal +where + D::Out: 'static, +{ + use_maybe_sync_selector_with_dependencies(cx, dependencies, f) +} + +/// Creates a new Selector that may be sync with some local dependencies. The selector will be run immediately and whenever any signal it reads or any dependencies it tracks changes +/// +/// Selectors can be used to efficiently compute derived data from signals. +/// +/// ```rust +/// use dioxus::prelude::*; +/// use dioxus_signals::*; +/// +/// fn App(cx: Scope) -> Element { +/// let mut local_state = use_state(cx, || 0); +/// let double = use_selector_with_dependencies(cx, (local_state.get(),), move |(local_state,)| local_state * 2); +/// local_state.set(1); +/// +/// render! { "{double}" } +/// } +/// ``` +#[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] +pub fn use_maybe_sync_selector_with_dependencies>>( cx: &ScopeState, dependencies: D, mut f: impl FnMut(D::Out) -> R + 'static, @@ -57,7 +112,7 @@ where { let dependencies_signal = use_signal(cx, || dependencies.out()); let selector = *cx.use_hook(|| { - selector(move || { + maybe_sync_selector(move || { let deref = &*dependencies_signal.read(); f(deref.clone()) }) @@ -69,10 +124,19 @@ where selector } -/// Creates a new Selector. The selector will be run immediately and whenever any signal it reads changes. +/// Creates a new unsync Selector. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. -pub fn selector>>( +pub fn selector( + mut f: impl FnMut() -> R + 'static, +) -> ReadOnlySignal { + maybe_sync_selector(f) +} + +/// Creates a new Selector that may be Sync + Send. The selector will be run immediately and whenever any signal it reads changes. +/// +/// Selectors can be used to efficiently compute derived data from signals. +pub fn maybe_sync_selector>>( mut f: impl FnMut() -> R + 'static, ) -> ReadOnlySignal { let state = Signal:: { @@ -108,5 +172,5 @@ pub fn selector>>( } })); - ReadOnlySignal::new(state) + ReadOnlySignal::new_maybe_sync(state) } diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 61186b92c..7d83c5d52 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -170,7 +170,7 @@ pub struct SignalData { /// } /// } /// ``` -pub struct Signal>> { +pub struct Signal> = UnsyncStorage> { pub(crate) inner: CopyValue, S>, } @@ -188,11 +188,23 @@ impl<'de, T: serde::Deserialize<'de> + 'static> serde::Deserialize<'de> for Sign } } -impl>> Signal { +impl Signal { /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. pub fn new(value: T) -> Self { + Self::new_maybe_sync(value) + } + + /// Create a new signal with a custom owner scope. The signal will be dropped when the owner scope is dropped instead of the current scope. + pub fn new_in_scope(value: T, owner: ScopeId) -> Self { + Self::new_maybe_sync_in_scope(value, owner) + } +} + +impl>> Signal { + /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. + pub fn new_maybe_sync(value: T) -> Self { Self { - inner: CopyValue::new(SignalData { + inner: CopyValue::, S>::new_maybe_sync(SignalData { subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value, @@ -202,9 +214,9 @@ impl>> Signal { } /// Create a new signal with a custom owner scope. The signal will be dropped when the owner scope is dropped instead of the current scope. - pub fn new_in_scope(value: T, owner: ScopeId) -> Self { + pub fn new_maybe_sync_in_scope(value: T, owner: ScopeId) -> Self { Self { - inner: CopyValue::new_in_scope( + inner: CopyValue::, S>::new_maybe_sync_in_scope( SignalData { subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), @@ -228,10 +240,11 @@ impl>> Signal { ) -> <>>::Ref as Mappable>>::Mapped { let inner = self.inner.read(); if let Some(effect) = inner.effect_stack.current() { - let mut subscribers = inner.subscribers.write(); - let mut effect_subscribers = &mut subscribers.effect_subscribers; - if !effect_subscribers.contains(&effect) { - effect_subscribers.push(effect); + let subscribers = inner.subscribers.read(); + if !subscribers.effect_subscribers.contains(&effect) { + drop(subscribers); + let mut subscribers = inner.subscribers.write(); + subscribers.effect_subscribers.push(effect); } } else if let Some(current_scope_id) = current_scope_id() { // only subscribe if the vdom is rendering @@ -241,17 +254,13 @@ impl>> Signal { self.inner.value, current_scope_id ); - let mut subscribers = inner.subscribers.write(); - let subscribers = &mut subscribers.subscribers; - if !subscribers.contains(¤t_scope_id) { - subscribers.push(current_scope_id); + let subscribers = inner.subscribers.read(); + if !subscribers.subscribers.contains(¤t_scope_id) { drop(subscribers); + let mut subscribers = inner.subscribers.write(); + subscribers.subscribers.push(current_scope_id); let unsubscriber = current_unsubscriber(); - inner - .subscribers - .write() - .subscribers - .push(unsubscriber.scope); + subscribers.subscribers.push(unsubscriber.scope); } } } @@ -441,13 +450,20 @@ impl, S: Storage>, I> DerefMut for Write>> { +pub struct ReadOnlySignal> = UnsyncStorage> { inner: Signal, } -impl>> ReadOnlySignal { +impl ReadOnlySignal { /// Create a new read-only signal. - pub fn new(signal: Signal) -> Self { + pub fn new(signal: Signal) -> Self { + Self::new_maybe_sync(signal) + } +} + +impl>> ReadOnlySignal { + /// Create a new read-only signal that is maybe sync. + pub fn new_maybe_sync(signal: Signal) -> Self { Self { inner: signal } } From c33276e0a000c9f905068c943591d8aed4c29d5f Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Mon, 6 Nov 2023 14:46:38 -0600 Subject: [PATCH 07/19] remove ghost --- packages/signals/Cargo.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/signals/Cargo.toml b/packages/signals/Cargo.toml index c081155a8..6d22ee0c8 100644 --- a/packages/signals/Cargo.toml +++ b/packages/signals/Cargo.toml @@ -14,7 +14,6 @@ simple_logger = "4.2.0" serde = { version = "1", features = ["derive"], optional = true } parking_lot = "0.12.1" once_cell = "1.18.0" -ghost = "0.1.16" [dev-dependencies] dioxus = { workspace = true } From 466005890d08a4b8c6bcc4a32dbeeacda2368e9b Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Mon, 6 Nov 2023 18:47:51 -0600 Subject: [PATCH 08/19] make effect system async to make signals send + sync --- packages/generational-box/src/lib.rs | 27 +++++++ packages/signals/Cargo.toml | 5 +- packages/signals/src/effect.rs | 104 ++++++++++++++++++++++----- packages/signals/src/impls.rs | 1 - packages/signals/src/lib.rs | 1 + packages/signals/src/rt.rs | 55 +++++++------- packages/signals/src/selector.rs | 55 +++++++------- packages/signals/src/signal.rs | 33 +++++---- 8 files changed, 195 insertions(+), 86 deletions(-) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 040fb842b..d358e78e0 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -142,6 +142,24 @@ fn fuzz() { } } +/// The type erased id of a generational box. +#[derive(Clone, Copy, PartialEq, Eq, Hash)] +pub struct GenerationalBoxId { + data_ptr: *const (), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: u32, +} + +impl Debug for GenerationalBoxId { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + #[cfg(any(debug_assertions, feature = "check_generation"))] + f.write_fmt(format_args!("{:?}@{:?}", self.data_ptr, self.generation))?; + #[cfg(not(any(debug_assertions, feature = "check_generation")))] + f.write_fmt(format_args!("{:?}", self.data_ptr))?; + Ok(()) + } +} + /// The core Copy state type. The generational box will be dropped when the [Owner] is dropped. pub struct GenerationalBox { raw: MemoryLocation, @@ -180,6 +198,15 @@ impl> GenerationalBox { } } + /// Get the id of the generational box. + pub fn id(&self) -> GenerationalBoxId { + GenerationalBoxId { + data_ptr: self.raw.data.data_ptr(), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: self.generation, + } + } + /// Try to read the value. Returns None if the value is no longer valid. pub fn try_read(&self) -> Option { self.validate().then(|| self.raw.data.try_read()).flatten() diff --git a/packages/signals/Cargo.toml b/packages/signals/Cargo.toml index 6d22ee0c8..18108b689 100644 --- a/packages/signals/Cargo.toml +++ b/packages/signals/Cargo.toml @@ -14,6 +14,9 @@ simple_logger = "4.2.0" serde = { version = "1", features = ["derive"], optional = true } parking_lot = "0.12.1" once_cell = "1.18.0" +rustc-hash.workspace = true +futures-channel.workspace = true +futures-util.workspace = true [dev-dependencies] dioxus = { workspace = true } @@ -22,4 +25,4 @@ tokio = { version = "1", features = ["full"] } [features] default = [] -serialize = ["serde"] \ No newline at end of file +serialize = ["serde"] diff --git a/packages/signals/src/effect.rs b/packages/signals/src/effect.rs index 9d6231eb3..526caa221 100644 --- a/packages/signals/src/effect.rs +++ b/packages/signals/src/effect.rs @@ -1,20 +1,29 @@ use core::{self, fmt::Debug}; use dioxus_core::prelude::*; -use generational_box::UnsyncStorage; +use futures_channel::mpsc::UnboundedSender; +use futures_util::StreamExt; +use generational_box::GenerationalBoxId; +use parking_lot::RwLock; +use rustc_hash::FxHashMap; use std::fmt::{self, Formatter}; use crate::use_signal; use crate::{dependency::Dependency, CopyValue}; -#[derive(Copy, Clone, PartialEq)] +thread_local! { + pub(crate)static EFFECT_STACK: EffectStack = EffectStack::default(); +} + pub(crate) struct EffectStack { - pub(crate) effects: CopyValue, UnsyncStorage>, + pub(crate) effects: RwLock>, + pub(crate) effect_mapping: RwLock>, } impl Default for EffectStack { fn default() -> Self { Self { - effects: CopyValue::new_in_scope(Vec::new(), ScopeId::ROOT), + effects: RwLock::new(Vec::new()), + effect_mapping: RwLock::new(FxHashMap::default()), } } } @@ -25,13 +34,38 @@ impl EffectStack { } } -pub(crate) fn get_effect_stack() -> EffectStack { +/// This is a thread safe reference to an effect stack running on another thread. +#[derive(Clone)] +pub(crate) struct EffectStackRef { + rerun_effect: UnboundedSender, +} + +impl EffectStackRef { + pub(crate) fn rerun_effect(&self, id: GenerationalBoxId) { + self.rerun_effect.unbounded_send(id).unwrap(); + } +} + +pub(crate) fn get_effect_ref() -> EffectStackRef { match consume_context() { Some(rt) => rt, None => { - let store = EffectStack::default(); - provide_root_context(store); - store + let (sender, mut receiver) = futures_channel::mpsc::unbounded(); + spawn(async move { + while let Some(id) = receiver.next().await { + EFFECT_STACK.with(|stack| { + let effect_mapping = stack.effect_mapping.read(); + if let Some(effect) = effect_mapping.get(&id) { + effect.try_run(); + } + }); + } + }); + let stack_ref = EffectStackRef { + rerun_effect: sender, + }; + provide_root_context(stack_ref.clone()); + stack_ref } } } @@ -68,19 +102,43 @@ pub fn use_effect_with_dependencies( #[derive(Copy, Clone, PartialEq)] pub struct Effect { pub(crate) source: ScopeId, - pub(crate) callback: CopyValue, UnsyncStorage>, - pub(crate) effect_stack: EffectStack, + pub(crate) inner: CopyValue, +} + +pub(crate) struct EffectInner { + pub(crate) callback: Box, + pub(crate) id: GenerationalBoxId, +} + +impl EffectInner { + pub(crate) fn new(callback: Box) -> CopyValue { + let copy = CopyValue::invalid(); + let inner = EffectInner { + callback: Box::new(callback), + id: copy.id(), + }; + copy.set(inner); + copy + } +} + +impl Drop for EffectInner { + fn drop(&mut self) { + EFFECT_STACK.with(|stack| { + stack.effect_mapping.write().remove(&self.id); + }); + } } impl Debug for Effect { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { - f.write_fmt(format_args!("{:?}", self.callback.value)) + f.write_fmt(format_args!("{:?}", self.inner.value)) } } impl Effect { pub(crate) fn current() -> Option { - get_effect_stack().effects.read().last().copied() + EFFECT_STACK.with(|stack| stack.effects.read().last().copied()) } /// Create a new effect. The effect will be run immediately and whenever any signal it reads changes. @@ -89,10 +147,16 @@ impl Effect { pub fn new(callback: impl FnMut() + 'static) -> Self { let myself = Self { source: current_scope_id().expect("in a virtual dom"), - callback: CopyValue::new(Box::new(callback)), - effect_stack: get_effect_stack(), + inner: EffectInner::new(Box::new(callback)), }; + EFFECT_STACK.with(|stack| { + stack + .effect_mapping + .write() + .insert(myself.inner.id(), myself); + }); + myself.try_run(); myself @@ -100,13 +164,17 @@ impl Effect { /// Run the effect callback immediately. Returns `true` if the effect was run. Returns `false` is the effect is dead. pub fn try_run(&self) { - if let Some(mut callback) = self.callback.try_write() { + if let Some(mut inner) = self.inner.try_write() { { - self.effect_stack.effects.write().push(*self); + EFFECT_STACK.with(|stack| { + stack.effects.write().push(*self); + }); } - callback(); + (inner.callback)(); { - self.effect_stack.effects.write().pop(); + EFFECT_STACK.with(|stack| { + stack.effects.write().pop(); + }); } } } diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index f59b8391f..4983f1f33 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -3,7 +3,6 @@ use crate::signal::{ReadOnlySignal, Signal, Write}; use crate::SignalData; use generational_box::Mappable; use generational_box::{MappableMut, Storage}; -use std::ops::Deref; use std::{ fmt::{Debug, Display}, diff --git a/packages/signals/src/lib.rs b/packages/signals/src/lib.rs index dce9af0a8..886f7a1f1 100644 --- a/packages/signals/src/lib.rs +++ b/packages/signals/src/lib.rs @@ -2,6 +2,7 @@ #![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] #![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] #![warn(missing_docs)] +#![allow(clippy::type_complexity)] mod rt; pub use rt::*; diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index be4810680..2e7244a5e 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -1,3 +1,4 @@ +use generational_box::GenerationalBoxId; use generational_box::UnsyncStorage; use std::mem::MaybeUninit; use std::ops::Deref; @@ -6,40 +7,37 @@ use std::rc::Rc; use dioxus_core::prelude::*; use dioxus_core::ScopeId; -use generational_box::AnyStorage; use generational_box::Storage; use generational_box::{GenerationalBox, Owner}; use crate::Effect; fn current_owner, T>() -> Rc> { - todo!() - // match Effect::current() { - // // If we are inside of an effect, we should use the owner of the effect as the owner of the value. - // Some(effect) => { - // let scope_id = effect.source; - // owner_in_scope(scope_id) - // } - // // Otherwise either get an owner from the current scope or create a new one. - // None => match has_context() { - // Some(rt) => rt, - // None => { - // let owner = Rc::new(current_store().owner()); - // provide_context(owner).expect("in a virtual dom") - // } - // }, - // } + match Effect::current() { + // If we are inside of an effect, we should use the owner of the effect as the owner of the value. + Some(effect) => { + let scope_id = effect.source; + owner_in_scope(scope_id) + } + // Otherwise either get an owner from the current scope or create a new one. + None => match has_context() { + Some(rt) => rt, + None => { + let owner = Rc::new(S::owner()); + provide_context(owner).expect("in a virtual dom") + } + }, + } } fn owner_in_scope, T>(scope: ScopeId) -> Rc> { - todo!() - // match consume_context_from_scope(scope) { - // Some(rt) => rt, - // None => { - // let owner = Rc::new(current_store().owner()); - // provide_context_to_scope(scope, owner).expect("in a virtual dom") - // } - // } + match consume_context_from_scope(scope) { + Some(rt) => rt, + None => { + let owner = Rc::new(S::owner()); + provide_context_to_scope(scope, owner).expect("in a virtual dom") + } + } } /// CopyValue is a wrapper around a value to make the value mutable and Copy. @@ -144,7 +142,7 @@ impl> CopyValue { } /// Set the value. If the value has been dropped, this will panic. - pub fn set(&mut self, value: T) { + pub fn set(&self, value: T) { *self.write() = value; } @@ -159,6 +157,11 @@ impl> CopyValue { let mut write = self.write(); f(&mut *write) } + + /// Get the generational id of the value. + pub fn id(&self) -> GenerationalBoxId { + self.value.id() + } } impl> CopyValue { diff --git a/packages/signals/src/selector.rs b/packages/signals/src/selector.rs index 5de6395d5..9ae42fea8 100644 --- a/packages/signals/src/selector.rs +++ b/packages/signals/src/selector.rs @@ -2,8 +2,8 @@ use dioxus_core::prelude::*; use generational_box::Storage; use crate::dependency::Dependency; -use crate::use_signal; -use crate::{get_effect_stack, signal::SignalData, CopyValue, Effect, ReadOnlySignal, Signal}; +use crate::{get_effect_ref, signal::SignalData, CopyValue, Effect, ReadOnlySignal, Signal}; +use crate::{use_signal, EffectInner, EFFECT_STACK}; /// Creates a new unsync Selector. The selector will be run immediately and whenever any signal it reads changes. /// @@ -30,7 +30,6 @@ pub fn use_selector( use_maybe_sync_selector(cx, f) } - /// Creates a new Selector that may be sync. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. @@ -56,7 +55,6 @@ pub fn use_maybe_sync_selector>>( *cx.use_hook(|| maybe_sync_selector(f)) } - /// Creates a new unsync Selector with some local dependencies. The selector will be run immediately and whenever any signal it reads or any dependencies it tracks changes /// /// Selectors can be used to efficiently compute derived data from signals. @@ -74,14 +72,14 @@ pub fn use_maybe_sync_selector>>( /// } /// ``` #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] -pub fn use_selector_with_dependencies( +pub fn use_selector_with_dependencies( cx: &ScopeState, dependencies: D, - mut f: impl FnMut(D::Out) -> R + 'static, + f: impl FnMut(D::Out) -> R + 'static, ) -> ReadOnlySignal where D::Out: 'static, -{ +{ use_maybe_sync_selector_with_dependencies(cx, dependencies, f) } @@ -102,7 +100,11 @@ where /// } /// ``` #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] -pub fn use_maybe_sync_selector_with_dependencies>>( +pub fn use_maybe_sync_selector_with_dependencies< + R: PartialEq, + D: Dependency, + S: Storage>, +>( cx: &ScopeState, dependencies: D, mut f: impl FnMut(D::Out) -> R + 'static, @@ -127,9 +129,7 @@ where /// Creates a new unsync Selector. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. -pub fn selector( - mut f: impl FnMut() -> R + 'static, -) -> ReadOnlySignal { +pub fn selector(f: impl FnMut() -> R + 'static) -> ReadOnlySignal { maybe_sync_selector(f) } @@ -144,33 +144,36 @@ pub fn maybe_sync_selector>>( }; let effect = Effect { source: current_scope_id().expect("in a virtual dom"), - callback: CopyValue::invalid(), - effect_stack: get_effect_stack(), + inner: CopyValue::invalid(), }; { - get_effect_stack().effects.write().push(effect); + EFFECT_STACK.with(|stack| stack.effects.write().push(effect)); } state.inner.value.set(SignalData { subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value: f(), - effect_stack: get_effect_stack(), + effect_ref: get_effect_ref(), }); { - get_effect_stack().effects.write().pop(); + EFFECT_STACK.with(|stack| stack.effects.write().pop()); } - effect.callback.value.set(Box::new(move || { - let value = f(); - let changed = { - let old = state.inner.read(); - value != old.value - }; - if changed { - state.set(value) - } - })); + let invalid_id = state.inner.value.id(); + effect.inner.value.set(EffectInner { + callback: Box::new(move || { + let value = f(); + let changed = { + let old = state.inner.read(); + value != old.value + }; + if changed { + state.set(value) + } + }), + id: invalid_id, + }); ReadOnlySignal::new_maybe_sync(state) } diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 7d83c5d52..9af0ffc86 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -11,10 +11,10 @@ use dioxus_core::{ prelude::{current_scope_id, has_context, provide_context, schedule_update_any}, ScopeId, ScopeState, }; -use generational_box::{AnyStorage, Mappable, MappableMut, Storage, SyncStorage, UnsyncStorage}; +use generational_box::{GenerationalBoxId, Mappable, MappableMut, Storage, UnsyncStorage}; use parking_lot::RwLock; -use crate::{get_effect_stack, CopyValue, Effect, EffectStack}; +use crate::{get_effect_ref, CopyValue, EffectStackRef, EFFECT_STACK}; /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. /// @@ -91,8 +91,7 @@ pub fn use_signal_sync( cx: &ScopeState, f: impl FnOnce() -> T, ) -> Signal { - // *cx.use_hook(|| Signal::new(f())) - todo!() + *cx.use_hook(|| Signal::new(f())) } #[derive(Clone)] @@ -127,14 +126,14 @@ fn current_unsubscriber() -> Unsubscriber { #[derive(Default)] pub(crate) struct SignalSubscribers { pub(crate) subscribers: Vec, - pub(crate) effect_subscribers: Vec, + pub(crate) effect_subscribers: Vec, } /// The data stored for tracking in a signal. pub struct SignalData { pub(crate) subscribers: Arc>, pub(crate) update_any: Arc, - pub(crate) effect_stack: EffectStack, + pub(crate) effect_ref: EffectStackRef, pub(crate) value: T, } @@ -208,7 +207,7 @@ impl>> Signal { subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value, - effect_stack: get_effect_stack(), + effect_ref: get_effect_ref(), }), } } @@ -221,7 +220,7 @@ impl>> Signal { subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value, - effect_stack: get_effect_stack(), + effect_ref: get_effect_ref(), }, owner, ), @@ -239,12 +238,12 @@ impl>> Signal { &self, ) -> <>>::Ref as Mappable>>::Mapped { let inner = self.inner.read(); - if let Some(effect) = inner.effect_stack.current() { + if let Some(effect) = EFFECT_STACK.with(|stack| stack.current()) { let subscribers = inner.subscribers.read(); - if !subscribers.effect_subscribers.contains(&effect) { + if !subscribers.effect_subscribers.contains(&effect.inner.id()) { drop(subscribers); let mut subscribers = inner.subscribers.write(); - subscribers.effect_subscribers.push(effect); + subscribers.effect_subscribers.push(effect.inner.id()); } } else if let Some(current_scope_id) = current_scope_id() { // only subscribe if the vdom is rendering @@ -295,18 +294,19 @@ impl>> Signal { } } + let self_read = &self.inner.read(); let subscribers = { - let self_read = self.inner.read(); - let mut effects = &mut self_read.subscribers.write().effect_subscribers; + let effects = &mut self_read.subscribers.write().effect_subscribers; std::mem::take(&mut *effects) }; + let effect_ref = &self_read.effect_ref; for effect in subscribers { tracing::trace!( "Write on {:?} triggered effect {:?}", self.inner.value, effect ); - effect.try_run(); + effect_ref.rerun_effect(effect); } } @@ -328,6 +328,11 @@ impl>> Signal { let mut write = self.write(); f(&mut *write) } + + /// Get the generational id of the signal. + pub fn id(&self) -> generational_box::GenerationalBoxId { + self.inner.id() + } } impl>> Signal { From 7daa945ae3a49f1170910d10cd41a9ce0f764909 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Mon, 6 Nov 2023 18:54:35 -0600 Subject: [PATCH 09/19] fix effects --- packages/signals/src/rt.rs | 2 +- packages/signals/tests/effect.rs | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index 2e7244a5e..ddcb94b78 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -143,7 +143,7 @@ impl> CopyValue { /// Set the value. If the value has been dropped, this will panic. pub fn set(&self, value: T) { - *self.write() = value; + self.value.set(value); } /// Run a function with a reference to the value. If the value has been dropped, this will panic. diff --git a/packages/signals/tests/effect.rs b/packages/signals/tests/effect.rs index 513b7e929..f06f740f6 100644 --- a/packages/signals/tests/effect.rs +++ b/packages/signals/tests/effect.rs @@ -6,8 +6,8 @@ use dioxus::prelude::*; use dioxus_core::ElementId; use dioxus_signals::*; -#[test] -fn effects_rerun() { +#[tokio::test] +async fn effects_rerun() { simple_logger::SimpleLogger::new().init().unwrap(); #[derive(Default)] @@ -40,6 +40,8 @@ fn effects_rerun() { ); let _ = dom.rebuild().santize(); + dom.render_with_deadline(tokio::time::sleep(std::time::Duration::from_millis(100))) + .await; let current_counter = counter.borrow(); assert_eq!(current_counter.component, 1); From 4e19f8f2be44cf488aa545172c440ac9113fe03e Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Mon, 6 Nov 2023 18:57:55 -0600 Subject: [PATCH 10/19] make GenerationalBoxId send and sync --- packages/generational-box/src/lib.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index d358e78e0..77e209b22 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -150,6 +150,10 @@ pub struct GenerationalBoxId { generation: u32, } +// Safety: GenerationalBoxId is Send and Sync because there is no way to access the pointer. +unsafe impl Send for GenerationalBoxId {} +unsafe impl Sync for GenerationalBoxId {} + impl Debug for GenerationalBoxId { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { #[cfg(any(debug_assertions, feature = "check_generation"))] From e77c1586368e262402d328b7bca02c4da4ffaaa9 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Tue, 7 Nov 2023 09:19:33 -0600 Subject: [PATCH 11/19] fix selector effect id --- packages/signals/src/effect.rs | 13 ++++++++++++- packages/signals/src/selector.rs | 6 +++++- packages/signals/src/signal.rs | 2 ++ 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/packages/signals/src/effect.rs b/packages/signals/src/effect.rs index 526caa221..7e61e8014 100644 --- a/packages/signals/src/effect.rs +++ b/packages/signals/src/effect.rs @@ -51,12 +51,15 @@ pub(crate) fn get_effect_ref() -> EffectStackRef { Some(rt) => rt, None => { let (sender, mut receiver) = futures_channel::mpsc::unbounded(); - spawn(async move { + spawn_forever(async move { while let Some(id) = receiver.next().await { EFFECT_STACK.with(|stack| { let effect_mapping = stack.effect_mapping.read(); if let Some(effect) = effect_mapping.get(&id) { + tracing::trace!("Rerunning effect: {:?}", id); effect.try_run(); + } else { + tracing::trace!("Effect not found: {:?}", id); } }); } @@ -125,6 +128,7 @@ impl EffectInner { impl Drop for EffectInner { fn drop(&mut self) { EFFECT_STACK.with(|stack| { + tracing::trace!("Dropping effect: {:?}", self.id); stack.effect_mapping.write().remove(&self.id); }); } @@ -156,6 +160,7 @@ impl Effect { .write() .insert(myself.inner.id(), myself); }); + tracing::trace!("Created effect: {:?}", myself); myself.try_run(); @@ -164,6 +169,7 @@ impl Effect { /// Run the effect callback immediately. Returns `true` if the effect was run. Returns `false` is the effect is dead. pub fn try_run(&self) { + tracing::trace!("Running effect: {:?}", self); if let Some(mut inner) = self.inner.try_write() { { EFFECT_STACK.with(|stack| { @@ -178,4 +184,9 @@ impl Effect { } } } + + /// Get the id of this effect. + pub fn id(&self) -> GenerationalBoxId { + self.inner.id() + } } diff --git a/packages/signals/src/selector.rs b/packages/signals/src/selector.rs index 9ae42fea8..560c2c94b 100644 --- a/packages/signals/src/selector.rs +++ b/packages/signals/src/selector.rs @@ -160,7 +160,8 @@ pub fn maybe_sync_selector>>( EFFECT_STACK.with(|stack| stack.effects.write().pop()); } - let invalid_id = state.inner.value.id(); + let invalid_id = effect.id(); + tracing::trace!("Creating effect: {:?}", invalid_id); effect.inner.value.set(EffectInner { callback: Box::new(move || { let value = f(); @@ -174,6 +175,9 @@ pub fn maybe_sync_selector>>( }), id: invalid_id, }); + { + EFFECT_STACK.with(|stack| stack.effect_mapping.write().insert(invalid_id, effect)); + } ReadOnlySignal::new_maybe_sync(state) } diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 9af0ffc86..c04fcbc46 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -201,6 +201,7 @@ impl Signal { impl>> Signal { /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. + #[tracing::instrument(skip(value))] pub fn new_maybe_sync(value: T) -> Self { Self { inner: CopyValue::, S>::new_maybe_sync(SignalData { @@ -213,6 +214,7 @@ impl>> Signal { } /// Create a new signal with a custom owner scope. The signal will be dropped when the owner scope is dropped instead of the current scope. + #[tracing::instrument(skip(value))] pub fn new_maybe_sync_in_scope(value: T, owner: ScopeId) -> Self { Self { inner: CopyValue::, S>::new_maybe_sync_in_scope( From 2731ca0b3012f3cd5bdf055b9bf129f6a4fa4809 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Tue, 7 Nov 2023 09:26:12 -0600 Subject: [PATCH 12/19] fix ref try map --- packages/generational-box/src/lib.rs | 3 +-- packages/signals/Cargo.toml | 1 + 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 77e209b22..89844f713 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -9,7 +9,6 @@ use std::{ fmt::Debug, marker::PhantomData, ops::{Deref, DerefMut}, - rc::Rc, sync::{atomic::AtomicU32, Arc, OnceLock}, }; @@ -300,7 +299,7 @@ impl Mappable for Ref<'static, T> { _self: Self, f: impl FnOnce(&T) -> Option<&U>, ) -> Option> { - Ref::try_map(_self, f) + Ref::filter_map(_self, f).ok() } } diff --git a/packages/signals/Cargo.toml b/packages/signals/Cargo.toml index 18108b689..6c66f3faf 100644 --- a/packages/signals/Cargo.toml +++ b/packages/signals/Cargo.toml @@ -22,6 +22,7 @@ futures-util.workspace = true dioxus = { workspace = true } dioxus-desktop = { workspace = true } tokio = { version = "1", features = ["full"] } +tracing-subscriber = "0.3.17" [features] default = [] From b3c51585240aacb4f1e671c29ef11cca184cbe1b Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Tue, 7 Nov 2023 13:15:19 -0600 Subject: [PATCH 13/19] fix tests --- packages/signals/README.md | 4 ++-- packages/signals/examples/send.rs | 26 ++++++++++++++++++++++++++ packages/signals/src/impls.rs | 6 ++++++ packages/signals/src/lib.rs | 1 + packages/signals/src/signal.rs | 12 +++++++----- packages/signals/tests/selector.rs | 20 +++++++++++++++----- 6 files changed, 57 insertions(+), 12 deletions(-) create mode 100644 packages/signals/examples/send.rs diff --git a/packages/signals/README.md b/packages/signals/README.md index d1e772445..9a6f9e17c 100644 --- a/packages/signals/README.md +++ b/packages/signals/README.md @@ -106,7 +106,7 @@ use dioxus_signals::*; #[component] fn App(cx: Scope) -> Element { let signal = use_signal(cx, || 0); - let doubled = use_selector(cx, || signal * 2); + let doubled = use_selector(cx, move || signal * 2); render! { button { @@ -114,7 +114,7 @@ fn App(cx: Scope) -> Element { "Increase" } Child { - signal: signal + signal: doubled } } } diff --git a/packages/signals/examples/send.rs b/packages/signals/examples/send.rs new file mode 100644 index 000000000..9dda4480e --- /dev/null +++ b/packages/signals/examples/send.rs @@ -0,0 +1,26 @@ +use dioxus::prelude::*; +use dioxus_signals::*; + +fn main() { + tracing_subscriber::fmt::init(); + dioxus_desktop::launch(App); +} + +#[component] +fn App(cx: Scope) -> Element { + let mut signal = use_signal_sync(cx, || 0); + cx.use_hook(|| { + std::thread::spawn(move || loop { + std::thread::sleep(std::time::Duration::from_secs(1)); + signal += 1; + }) + }); + + render! { + button { + onclick: move |_| signal += 1, + "Increase" + } + "{signal}" + } +} diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index 4983f1f33..676101b20 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -36,6 +36,12 @@ macro_rules! read_impls { self.with(|v| Debug::fmt(v, f)) } } + + impl PartialEq for $ty { + fn eq(&self, other: &T) -> bool { + self.with(|v| *v == *other) + } + } }; } diff --git a/packages/signals/src/lib.rs b/packages/signals/src/lib.rs index 886f7a1f1..f2876f4a5 100644 --- a/packages/signals/src/lib.rs +++ b/packages/signals/src/lib.rs @@ -15,3 +15,4 @@ pub(crate) mod signal; pub use signal::*; mod dependency; pub use dependency::*; +pub use generational_box::{Storage, SyncStorage, UnsyncStorage}; diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index c04fcbc46..0c89e06a5 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -11,7 +11,9 @@ use dioxus_core::{ prelude::{current_scope_id, has_context, provide_context, schedule_update_any}, ScopeId, ScopeState, }; -use generational_box::{GenerationalBoxId, Mappable, MappableMut, Storage, UnsyncStorage}; +use generational_box::{ + GenerationalBoxId, Mappable, MappableMut, Storage, SyncStorage, UnsyncStorage, +}; use parking_lot::RwLock; use crate::{get_effect_ref, CopyValue, EffectStackRef, EFFECT_STACK}; @@ -59,7 +61,7 @@ pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal< /// use dioxus_signals::*; /// /// fn App(cx: Scope) -> Element { -/// let mut count = use_signal(cx, || 0); +/// let mut count = use_signal_sync(cx, || 0); /// /// // Because signals have automatic dependency tracking, if you never read them in a component, that component will not be re-rended when the signal is updated. /// // The app component will never be rerendered in this example. @@ -67,7 +69,7 @@ pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal< /// } /// /// #[component] -/// fn Child(cx: Scope, state: Signal) -> Element { +/// fn Child(cx: Scope, state: Signal) -> Element { /// let state = *state; /// /// use_future!(cx, |()| async move { @@ -90,8 +92,8 @@ pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal< pub fn use_signal_sync( cx: &ScopeState, f: impl FnOnce() -> T, -) -> Signal { - *cx.use_hook(|| Signal::new(f())) +) -> Signal { + *cx.use_hook(|| Signal::new_maybe_sync(f())) } #[derive(Clone)] diff --git a/packages/signals/tests/selector.rs b/packages/signals/tests/selector.rs index 811871e88..44321bd0f 100644 --- a/packages/signals/tests/selector.rs +++ b/packages/signals/tests/selector.rs @@ -24,7 +24,7 @@ fn memos_rerun() { counter.borrow_mut().component += 1; let mut signal = use_signal(cx, || 0); - let memo = cx.use_hook(move || { + let memo = *cx.use_hook(move || { to_owned![counter]; selector(move || { counter.borrow_mut().effect += 1; @@ -32,9 +32,17 @@ fn memos_rerun() { signal.value() }) }); - assert_eq!(memo.value(), 0); + let generation = use_signal(cx, || cx.generation()); + generation.set(cx.generation()); + dioxus_signals::use_effect(cx, move || { + if generation == 1 { + assert_eq!(memo.value(), 0); + } + if generation == 3 { + assert_eq!(memo.value(), 1); + } + }); signal += 1; - assert_eq!(memo.value(), 1); render! { div {} @@ -44,14 +52,15 @@ fn memos_rerun() { ); let _ = dom.rebuild().santize(); + let _ = dom.render_immediate(); let current_counter = counter.borrow(); assert_eq!(current_counter.component, 1); assert_eq!(current_counter.effect, 2); } -#[test] -fn memos_prevents_component_rerun() { +#[tokio::test] +async fn memos_prevents_component_rerun() { let _ = simple_logger::SimpleLogger::new().init(); #[derive(Default)] @@ -126,6 +135,7 @@ fn memos_prevents_component_rerun() { let _ = dom.rebuild().santize(); dom.mark_dirty(ScopeId::ROOT); dom.render_immediate(); + dom.render_immediate(); { let current_counter = counter.borrow(); From c1bfe9514f42cfd7dd6335100a50bb5859fc1108 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Tue, 7 Nov 2023 13:19:26 -0600 Subject: [PATCH 14/19] document remaining items in generational box --- packages/generational-box/src/lib.rs | 49 ++++++++++++++++------------ 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 89844f713..692af76b0 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -259,6 +259,7 @@ impl Clone for GenerationalBox { } } +/// A unsync storage. This is the default storage type. #[derive(Clone, Copy)] pub struct UnsyncStorage(&'static RefCell>>); @@ -268,6 +269,7 @@ impl Default for UnsyncStorage { } } +/// A thread safe storage. This is slower than the unsync storage, but allows you to share the value between threads. #[derive(Clone, Copy)] pub struct SyncStorage(&'static RwLock>>); @@ -277,11 +279,15 @@ impl Default for SyncStorage { } } +/// A trait for types that can be mapped. pub trait Mappable: Deref { + /// The type after the mapping. type Mapped: Mappable + Deref; + /// Map the value. fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped; + /// Try to map the value. fn try_map( _self: Self, f: impl FnOnce(&T) -> Option<&U>, @@ -318,11 +324,15 @@ impl Mappable for MappedRwLockReadGuard<'static, T> { } } +/// A trait for types that can be mapped mutably. pub trait MappableMut: DerefMut { + /// The type after the mapping. type Mapped: MappableMut + DerefMut; + /// Map the value. fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped; + /// Try to map the value. fn try_map( _self: Self, f: impl FnOnce(&mut T) -> Option<&mut U>, @@ -340,7 +350,7 @@ impl MappableMut for RefMut<'static, T> { _self: Self, f: impl FnOnce(&mut T) -> Option<&mut U>, ) -> Option> { - RefMut::try_map(_self, f) + RefMut::filter_map(_self, f).ok() } } @@ -359,49 +369,45 @@ impl MappableMut for MappedRwLockWriteGuard<'static, T> { } } +/// A trait for a storage backing type. (RefCell, RwLock, etc.) pub trait Storage: Copy + AnyStorage + 'static { + /// The reference this storage type returns. type Ref: Mappable + Deref; + /// The mutable reference this storage type returns. type Mut: MappableMut + DerefMut; + /// Try to read the value. Returns None if the value is no longer valid. fn try_read(&self) -> Option; + /// Read the value. Panics if the value is no longer valid. fn read(&self) -> Self::Ref { self.try_read() .expect("generational box has been invalidated or the type has changed") } + /// Try to write the value. Returns None if the value is no longer valid. fn try_write(&self) -> Option; + /// Write the value. Panics if the value is no longer valid. fn write(&self) -> Self::Mut { self.try_write() .expect("generational box has been invalidated or the type has changed") } + /// Set the value. Panics if the value is no longer valid. fn set(&self, value: Data); } +/// A trait for any storage backing type. pub trait AnyStorage: Default { + /// Get the data pointer. No guarantees are made about the data pointer. It should only be used for debugging. fn data_ptr(&self) -> *const (); + /// Take the value out of the storage. This will return true if the value was taken. fn take(&self) -> bool; + /// Recycle a memory location. This will drop the memory location and return it to the runtime. fn recycle(location: &MemoryLocation); - // { - // location.drop(); - // self.recycled.lock().push(location); - // } + /// Claim a new memory location. This will either create a new memory location or recycle an old one. fn claim() -> MemoryLocation; - // where - // S: Default, - // { - // if let Some(location) = self.recycled.lock().pop() { - // location - // } else { - // MemoryLocation { - // data: Default::default(), - // #[cfg(any(debug_assertions, feature = "check_generation"))] - // generation: Box::leak(Box::new(Default::default())), - // } - // } - // } /// Create a new owner. The owner will be responsible for dropping all of the generational boxes that it creates. fn owner() -> Owner { @@ -450,7 +456,7 @@ impl AnyStorage for UnsyncStorage { MemoryLocation { data: UnsyncStorage(Box::leak(Box::new(RefCell::new(None)))), #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: Box::leak(Box::new(Default::default())), + generation: Box::leak(Box::default()), } } }) @@ -498,7 +504,7 @@ impl AnyStorage for SyncStorage { MemoryLocation { data: SyncStorage(Box::leak(Box::new(RwLock::new(None)))), #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: Box::leak(Box::new(Default::default())), + generation: Box::leak(Box::default()), } } @@ -508,8 +514,9 @@ impl AnyStorage for SyncStorage { } } +/// A memory location. This is the core type that is used to store values. #[derive(Clone, Copy)] -struct MemoryLocation { +pub struct MemoryLocation { data: S, #[cfg(any(debug_assertions, feature = "check_generation"))] generation: &'static AtomicU32, From 70c3abb8df5c7b723977675b4a488ef0622a5546 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Thu, 14 Dec 2023 12:29:32 -0600 Subject: [PATCH 15/19] Merge branch 'master' into maybe-sync-signal --- .github/workflows/docs stable.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/main.yml | 7 +- .github/workflows/miri.yml | 3 +- .github/workflows/playwright.yml | 2 +- Cargo.toml | 8 +- Makefile.toml | 74 ++- examples/calculator.rs | 1 + examples/openid_connect_demo/Cargo.toml | 1 + examples/optional_props.rs | 12 + examples/query_segments_demo/Cargo.toml | 1 + examples/tailwind/Cargo.toml | 2 +- packages/autofmt/src/buffer.rs | 11 +- packages/autofmt/src/element.rs | 12 +- packages/autofmt/src/expr.rs | 6 +- packages/autofmt/src/indent.rs | 108 ++++ packages/autofmt/src/lib.rs | 27 +- packages/autofmt/src/writer.rs | 4 +- packages/autofmt/tests/samples.rs | 2 +- packages/autofmt/tests/wrong.rs | 15 +- .../wrong/{comments.rsx => comments-4sp.rsx} | 0 ...ments.wrong.rsx => comments-4sp.wrong.rsx} | 0 packages/autofmt/tests/wrong/comments-tab.rsx | 7 + .../tests/wrong/comments-tab.wrong.rsx | 5 + .../tests/wrong/{multi.rsx => multi-4sp.rsx} | 0 .../{multi.wrong.rsx => multi-4sp.wrong.rsx} | 0 packages/autofmt/tests/wrong/multi-tab.rsx | 3 + .../autofmt/tests/wrong/multi-tab.wrong.rsx | 5 + .../{multiexpr.rsx => multiexpr-4sp.rsx} | 0 ...expr.wrong.rsx => multiexpr-4sp.wrong.rsx} | 0 .../autofmt/tests/wrong/multiexpr-tab.rsx | 8 + .../tests/wrong/multiexpr-tab.wrong.rsx | 5 + packages/cli/Cargo.toml | 2 +- packages/cli/README.md | 10 +- packages/cli/src/assets/dioxus.toml | 2 +- packages/cli/src/builder.rs | 21 +- packages/cli/src/cli/autoformat.rs | 68 ++- packages/cli/src/cli/build.rs | 8 +- packages/cli/src/config.rs | 2 +- packages/cli/src/error.rs | 3 + packages/cli/src/logging.rs | 14 +- packages/cli/src/main.rs | 86 ++-- packages/cli/src/server/desktop/mod.rs | 27 +- packages/cli/src/server/mod.rs | 24 +- packages/cli/src/server/output.rs | 25 +- .../component_body_deserializers/component.rs | 1 + .../inline_props.rs | 14 +- packages/core-macro/src/props/mod.rs | 51 +- packages/core/src/arena.rs | 12 +- packages/core/src/bump_frame.rs | 44 +- packages/core/src/diff.rs | 2 +- packages/core/src/events.rs | 2 - packages/core/src/lazynodes.rs | 33 +- packages/core/src/mutations.rs | 2 +- packages/core/src/nodes.rs | 8 +- packages/core/src/scope_arena.rs | 4 +- packages/core/src/scopes.rs | 19 +- packages/desktop/Cargo.toml | 1 + packages/desktop/build.rs | 9 + packages/desktop/src/lib.rs | 17 +- packages/desktop/src/webview.rs | 2 +- packages/dioxus-tui/examples/colorpicker.rs | 12 +- packages/extension/src/lib.rs | 46 +- packages/extension/src/main.ts | 8 +- packages/fermi/src/hooks/atom_root.rs | 2 +- packages/fermi/src/hooks/state.rs | 4 +- packages/fermi/src/lib.rs | 2 - packages/fullstack/Cargo.toml | 2 +- .../examples/axum-hello-world/src/main.rs | 1 + .../fullstack/src/adapters/axum_adapter.rs | 66 ++- packages/fullstack/src/adapters/mod.rs | 38 +- packages/fullstack/src/layer.rs | 5 + packages/fullstack/src/lib.rs | 2 + packages/fullstack/src/render.rs | 2 + packages/fullstack/src/router.rs | 2 +- packages/fullstack/src/server_fn.rs | 8 - packages/generational-box/Cargo.toml | 9 +- packages/generational-box/README.md | 2 + packages/generational-box/src/lib.rs | 475 ++++++++++++++++-- packages/hooks/src/lib.rs | 3 + packages/hooks/src/use_const.rs | 76 +++ packages/hooks/src/use_effect.rs | 79 ++- packages/hooks/src/use_future.rs | 11 +- packages/hooks/src/use_shared_state.rs | 1 + packages/hot-reload/src/file_watcher.rs | 15 +- packages/hot-reload/src/lib.rs | 8 +- packages/html/src/elements.rs | 54 +- packages/html/src/global_attributes.rs | 3 + packages/native-core/src/dioxus.rs | 5 + packages/rink/Cargo.toml | 2 +- packages/rink/src/lib.rs | 6 +- packages/rink/src/render.rs | 7 +- packages/rink/src/style.rs | 3 +- packages/rink/src/style_attributes.rs | 8 +- packages/rink/src/widget.rs | 2 +- packages/router-macro/src/redirect.rs | 1 + packages/router/Cargo.toml | 5 + packages/router/examples/simple_routes.rs | 72 ++- .../router/src/components/history_buttons.rs | 2 +- packages/router/src/components/link.rs | 14 + packages/router/src/contexts/router.rs | 2 +- packages/router/src/history/liveview.rs | 441 ++++++++++++++++ packages/router/src/history/mod.rs | 5 + packages/rsx/Cargo.toml | 1 + .../rsx/src/hot_reload/hot_reload_diff.rs | 44 +- .../src/hot_reload/hot_reloading_file_map.rs | 27 +- packages/rsx/src/lib.rs | 2 +- packages/server-macro/Cargo.toml | 2 +- packages/signals/Cargo.toml | 8 +- .../signals/examples/split_subscriptions.rs | 18 +- packages/signals/src/rt.rs | 28 +- packages/signals/src/signal.rs | 66 ++- packages/ssr/Cargo.toml | 3 + packages/ssr/src/eval.rs | 42 ++ packages/ssr/src/incremental.rs | 1 + packages/ssr/src/lib.rs | 2 + packages/web/src/dom.rs | 2 +- packages/web/src/hot_reload.rs | 15 +- 118 files changed, 2206 insertions(+), 412 deletions(-) create mode 100644 packages/autofmt/src/indent.rs rename packages/autofmt/tests/wrong/{comments.rsx => comments-4sp.rsx} (100%) rename packages/autofmt/tests/wrong/{comments.wrong.rsx => comments-4sp.wrong.rsx} (100%) create mode 100644 packages/autofmt/tests/wrong/comments-tab.rsx create mode 100644 packages/autofmt/tests/wrong/comments-tab.wrong.rsx rename packages/autofmt/tests/wrong/{multi.rsx => multi-4sp.rsx} (100%) rename packages/autofmt/tests/wrong/{multi.wrong.rsx => multi-4sp.wrong.rsx} (100%) create mode 100644 packages/autofmt/tests/wrong/multi-tab.rsx create mode 100644 packages/autofmt/tests/wrong/multi-tab.wrong.rsx rename packages/autofmt/tests/wrong/{multiexpr.rsx => multiexpr-4sp.rsx} (100%) rename packages/autofmt/tests/wrong/{multiexpr.wrong.rsx => multiexpr-4sp.wrong.rsx} (100%) create mode 100644 packages/autofmt/tests/wrong/multiexpr-tab.rsx create mode 100644 packages/autofmt/tests/wrong/multiexpr-tab.wrong.rsx create mode 100644 packages/desktop/build.rs create mode 100644 packages/hooks/src/use_const.rs create mode 100644 packages/router/src/history/liveview.rs create mode 100644 packages/ssr/src/eval.rs diff --git a/.github/workflows/docs stable.yml b/.github/workflows/docs stable.yml index 642216f0f..523a24067 100644 --- a/.github/workflows/docs stable.yml +++ b/.github/workflows/docs stable.yml @@ -33,7 +33,7 @@ jobs: # cd fermi && mdbook build -d ../nightly/fermi && cd .. - name: Deploy 🚀 - uses: JamesIves/github-pages-deploy-action@v4.4.3 + uses: JamesIves/github-pages-deploy-action@v4.5.0 with: branch: gh-pages # The branch the action should deploy to. folder: docs/nightly # The folder the action should deploy. diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 88542aea8..7701209c1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,7 +39,7 @@ jobs: # cd fermi && mdbook build -d ../nightly/fermi && cd .. - name: Deploy 🚀 - uses: JamesIves/github-pages-deploy-action@v4.4.3 + uses: JamesIves/github-pages-deploy-action@v4.5.0 with: branch: gh-pages # The branch the action should deploy to. folder: docs/nightly # The folder the action should deploy. diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 037525557..1b1f1ed7b 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -124,8 +124,6 @@ jobs: } steps: - - uses: actions/checkout@v4 - - name: install stable uses: dtolnay/rust-toolchain@master with: @@ -141,6 +139,11 @@ jobs: workspaces: core -> ../target save-if: ${{ matrix.features.key == 'all' }} + - name: Install rustfmt + run: rustup component add rustfmt + + - uses: actions/checkout@v4 + - name: test run: | ${{ env.RUST_CARGO_COMMAND }} ${{ matrix.platform.command }} ${{ matrix.platform.args }} --target ${{ matrix.platform.target }} diff --git a/.github/workflows/miri.yml b/.github/workflows/miri.yml index 4a467b9b2..f9ad3855f 100644 --- a/.github/workflows/miri.yml +++ b/.github/workflows/miri.yml @@ -86,8 +86,7 @@ jobs: # working-directory: tokio env: - # todo: disable memory leaks ignore - MIRIFLAGS: -Zmiri-disable-isolation -Zmiri-strict-provenance -Zmiri-retag-fields -Zmiri-ignore-leaks + MIRIFLAGS: -Zmiri-disable-isolation -Zmiri-strict-provenance -Zmiri-retag-fields PROPTEST_CASES: 10 # Cache the global cargo directory, but NOT the local `target` directory which diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml index 500d41564..cb5a1f1bb 100644 --- a/.github/workflows/playwright.yml +++ b/.github/workflows/playwright.yml @@ -20,7 +20,7 @@ jobs: steps: # Do our best to cache the toolchain and node install steps - uses: actions/checkout@v4 - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v4 with: node-version: 16 - name: Install Rust diff --git a/Cargo.toml b/Cargo.toml index a78f60d3e..1772c1f47 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -50,7 +50,7 @@ members = [ exclude = ["examples/mobile_demo"] [workspace.package] -version = "0.4.2" +version = "0.4.3" # dependencies that are shared across packages [workspace.dependencies] @@ -77,7 +77,7 @@ dioxus-native-core = { path = "packages/native-core", version = "0.4.0" } dioxus-native-core-macro = { path = "packages/native-core-macro", version = "0.4.0" } rsx-rosetta = { path = "packages/rsx-rosetta", version = "0.4.0" } dioxus-signals = { path = "packages/signals" } -generational-box = { path = "packages/generational-box" } +generational-box = { path = "packages/generational-box", version = "0.4.3" } dioxus-hot-reload = { path = "packages/hot-reload", version = "0.4.0" } dioxus-fullstack = { path = "packages/fullstack", version = "0.4.1" } dioxus_server_macro = { path = "packages/server-macro", version = "0.4.1" } @@ -88,7 +88,7 @@ slab = "0.4.2" futures-channel = "0.3.21" futures-util = { version = "0.3", default-features = false } rustc-hash = "1.1.0" -wasm-bindgen = "0.2.87" +wasm-bindgen = "0.2.88" html_parser = "0.7.0" thiserror = "1.0.40" prettyplease = { package = "prettier-please", version = "0.2", features = [ @@ -99,7 +99,7 @@ prettyplease = { package = "prettier-please", version = "0.2", features = [ # It is not meant to be published, but is used so "cargo run --example XYZ" works properly [package] name = "dioxus-examples" -version = "0.0.0" +version = "0.4.3" authors = ["Jonathan Kelley"] edition = "2021" description = "Top level crate for the Dioxus repository" diff --git a/Makefile.toml b/Makefile.toml index 6f331b98f..1bfb02217 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -24,12 +24,64 @@ script = [ ] script_runner = "@duckscript" +[tasks.format] +command = "cargo" +args = ["fmt", "--all"] + +[tasks.check] +command = "cargo" +args = ["check", "--workspace", "--examples", "--tests"] + +[tasks.clippy] +command = "cargo" +args = [ + "clippy", + "--workspace", + "--examples", + "--tests", + "--", + "-D", + "warnings", +] + +[tasks.tidy] +category = "Formatting" +dependencies = ["format", "check", "clippy"] +description = "Format and Check workspace" + +[tasks.install-miri] +toolchain = "nightly" +install_crate = { rustup_component_name = "miri", binary = "cargo +nightly miri", test_arg = "--help" } +private = true + +[tasks.miri-native] +command = "cargo" +toolchain = "nightly" +dependencies = ["install-miri"] +args = [ + "miri", + "test", + "--package", + "dioxus-native-core", + "--test", + "miri_native", +] + +[tasks.miri-stress] +command = "cargo" +toolchain = "nightly" +dependencies = ["install-miri"] +args = ["miri", "test", "--package", "dioxus-core", "--test", "miri_stress"] + +[tasks.miri] +dependencies = ["miri-native", "miri-stress"] + [tasks.tests] category = "Testing" dependencies = ["tests-setup"] description = "Run all tests" -env = {CARGO_MAKE_WORKSPACE_SKIP_MEMBERS = ["**/examples/*"]} -run_task = {name = ["test-flow", "test-with-browser"], fork = true} +env = { CARGO_MAKE_WORKSPACE_SKIP_MEMBERS = ["**/examples/*"] } +run_task = { name = ["test-flow", "test-with-browser"], fork = true } [tasks.build] command = "cargo" @@ -42,10 +94,24 @@ private = true [tasks.test] dependencies = ["build"] command = "cargo" -args = ["test", "--lib", "--bins", "--tests", "--examples", "--workspace", "--exclude", "dioxus-router", "--exclude", "dioxus-desktop"] +args = [ + "test", + "--lib", + "--bins", + "--tests", + "--examples", + "--workspace", + "--exclude", + "dioxus-router", + "--exclude", + "dioxus-desktop", +] private = true [tasks.test-with-browser] -env = { CARGO_MAKE_WORKSPACE_INCLUDE_MEMBERS = ["**/packages/router", "**/packages/desktop"] } +env = { CARGO_MAKE_WORKSPACE_INCLUDE_MEMBERS = [ + "**/packages/router", + "**/packages/desktop", +] } private = true workspace = true diff --git a/examples/calculator.rs b/examples/calculator.rs index bc7f13459..648ccfbc3 100644 --- a/examples/calculator.rs +++ b/examples/calculator.rs @@ -62,6 +62,7 @@ fn app(cx: Scope) -> Element { div { id: "wrapper", div { class: "app", div { class: "calculator", + tabindex: "0", onkeydown: handle_key_down_event, div { class: "calculator-display", val.to_string() } div { class: "calculator-keypad", diff --git a/examples/openid_connect_demo/Cargo.toml b/examples/openid_connect_demo/Cargo.toml index 4c5f47061..2a1abe173 100644 --- a/examples/openid_connect_demo/Cargo.toml +++ b/examples/openid_connect_demo/Cargo.toml @@ -2,6 +2,7 @@ name = "openid_auth_demo" version = "0.1.0" edition = "2021" +publish = false # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/examples/optional_props.rs b/examples/optional_props.rs index c5652a2e7..8108d437d 100644 --- a/examples/optional_props.rs +++ b/examples/optional_props.rs @@ -16,8 +16,20 @@ fn app(cx: Scope) -> Element { a: "asd".to_string(), c: "asd".to_string(), d: Some("asd".to_string()), + e: Some("asd".to_string()), + } + Button { + a: "asd".to_string(), + b: "asd".to_string(), + c: "asd".to_string(), + d: Some("asd".to_string()), e: "asd".to_string(), } + Button { + a: "asd".to_string(), + c: "asd".to_string(), + d: Some("asd".to_string()), + } }) } diff --git a/examples/query_segments_demo/Cargo.toml b/examples/query_segments_demo/Cargo.toml index 4a7d784c7..ee9f49c70 100644 --- a/examples/query_segments_demo/Cargo.toml +++ b/examples/query_segments_demo/Cargo.toml @@ -2,6 +2,7 @@ name = "query_segments_demo" version = "0.1.0" edition = "2021" +publish = false # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/examples/tailwind/Cargo.toml b/examples/tailwind/Cargo.toml index 5c2fbe666..26ac202f1 100644 --- a/examples/tailwind/Cargo.toml +++ b/examples/tailwind/Cargo.toml @@ -18,4 +18,4 @@ dioxus = { path = "../../packages/dioxus" } dioxus-desktop = { path = "../../packages/desktop" } [target.'cfg(target_arch = "wasm32")'.dependencies] -dioxus-web = { path = "../../packages/web" } \ No newline at end of file +dioxus-web = { path = "../../packages/web" } diff --git a/packages/autofmt/src/buffer.rs b/packages/autofmt/src/buffer.rs index fea5a4a3f..f19a7d8dc 100644 --- a/packages/autofmt/src/buffer.rs +++ b/packages/autofmt/src/buffer.rs @@ -8,13 +8,14 @@ use std::fmt::{Result, Write}; use dioxus_rsx::IfmtInput; -use crate::write_ifmt; +use crate::{indent::IndentOptions, write_ifmt}; /// The output buffer that tracks indent and string #[derive(Debug, Default)] pub struct Buffer { pub buf: String, - pub indent: usize, + pub indent_level: usize, + pub indent: IndentOptions, } impl Buffer { @@ -31,16 +32,16 @@ impl Buffer { } pub fn tab(&mut self) -> Result { - self.write_tabs(self.indent) + self.write_tabs(self.indent_level) } pub fn indented_tab(&mut self) -> Result { - self.write_tabs(self.indent + 1) + self.write_tabs(self.indent_level + 1) } pub fn write_tabs(&mut self, num: usize) -> std::fmt::Result { for _ in 0..num { - write!(self.buf, " ")? + write!(self.buf, "{}", self.indent.indent_str())? } Ok(()) } diff --git a/packages/autofmt/src/element.rs b/packages/autofmt/src/element.rs index dbc336401..27e7b31f1 100644 --- a/packages/autofmt/src/element.rs +++ b/packages/autofmt/src/element.rs @@ -66,7 +66,7 @@ impl Writer<'_> { // check if we have a lot of attributes let attr_len = self.is_short_attrs(attributes); - let is_short_attr_list = (attr_len + self.out.indent * 4) < 80; + let is_short_attr_list = (attr_len + self.out.indent_level * 4) < 80; let children_len = self.is_short_children(children); let is_small_children = children_len.is_some(); @@ -86,7 +86,7 @@ impl Writer<'_> { // if we have few children and few attributes, make it a one-liner if is_short_attr_list && is_small_children { - if children_len.unwrap() + attr_len + self.out.indent * 4 < 100 { + if children_len.unwrap() + attr_len + self.out.indent_level * 4 < 100 { opt_level = ShortOptimization::Oneliner; } else { opt_level = ShortOptimization::PropsOnTop; @@ -185,11 +185,11 @@ impl Writer<'_> { } while let Some(attr) = attr_iter.next() { - self.out.indent += 1; + self.out.indent_level += 1; if !sameline { self.write_comments(attr.attr.start())?; } - self.out.indent -= 1; + self.out.indent_level -= 1; if !sameline { self.out.indented_tabbed_line()?; @@ -398,14 +398,14 @@ impl Writer<'_> { for idx in start.line..end.line { let line = &self.src[idx]; if line.trim().starts_with("//") { - for _ in 0..self.out.indent + 1 { + for _ in 0..self.out.indent_level + 1 { write!(self.out, " ")? } writeln!(self.out, "{}", line.trim()).unwrap(); } } - for _ in 0..self.out.indent { + for _ in 0..self.out.indent_level { write!(self.out, " ")? } diff --git a/packages/autofmt/src/expr.rs b/packages/autofmt/src/expr.rs index b0257f8c3..b7a93a4fc 100644 --- a/packages/autofmt/src/expr.rs +++ b/packages/autofmt/src/expr.rs @@ -29,7 +29,7 @@ impl Writer<'_> { let first_line = &self.src[start.line - 1]; write!(self.out, "{}", &first_line[start.column - 1..].trim_start())?; - let prev_block_indent_level = crate::leading_whitespaces(first_line) / 4; + let prev_block_indent_level = self.out.indent.count_indents(first_line); for (id, line) in self.src[start.line..end.line].iter().enumerate() { writeln!(self.out)?; @@ -43,9 +43,9 @@ impl Writer<'_> { }; // trim the leading whitespace - let previous_indent = crate::leading_whitespaces(line) / 4; + let previous_indent = self.out.indent.count_indents(line); let offset = previous_indent.saturating_sub(prev_block_indent_level); - let required_indent = self.out.indent + offset; + let required_indent = self.out.indent_level + offset; self.out.write_tabs(required_indent)?; let line = line.trim_start(); diff --git a/packages/autofmt/src/indent.rs b/packages/autofmt/src/indent.rs new file mode 100644 index 000000000..2cce7cf1e --- /dev/null +++ b/packages/autofmt/src/indent.rs @@ -0,0 +1,108 @@ +#[derive(Clone, Copy, PartialEq, Eq, Debug)] +pub enum IndentType { + Spaces, + Tabs, +} + +#[derive(Debug, Clone)] +pub struct IndentOptions { + width: usize, + indent_string: String, +} + +impl IndentOptions { + pub fn new(typ: IndentType, width: usize) -> Self { + assert_ne!(width, 0, "Cannot have an indent width of 0"); + Self { + width, + indent_string: match typ { + IndentType::Tabs => "\t".into(), + IndentType::Spaces => " ".repeat(width), + }, + } + } + + /// Gets a string containing one indent worth of whitespace + pub fn indent_str(&self) -> &str { + &self.indent_string + } + + /// Computes the line length in characters, counting tabs as the indent width. + pub fn line_length(&self, line: &str) -> usize { + line.chars() + .map(|ch| if ch == '\t' { self.width } else { 1 }) + .sum() + } + + /// Estimates how many times the line has been indented. + pub fn count_indents(&self, mut line: &str) -> usize { + let mut indent = 0; + while !line.is_empty() { + // Try to count tabs + let num_tabs = line.chars().take_while(|ch| *ch == '\t').count(); + if num_tabs > 0 { + indent += num_tabs; + line = &line[num_tabs..]; + continue; + } + + // Try to count spaces + let num_spaces = line.chars().take_while(|ch| *ch == ' ').count(); + if num_spaces >= self.width { + // Intentionally floor here to take only the amount of space that matches an indent + let num_space_indents = num_spaces / self.width; + indent += num_space_indents; + line = &line[num_space_indents * self.width..]; + continue; + } + + // Line starts with either non-indent characters or an unevent amount of spaces, + // so no more indent remains. + break; + } + indent + } +} + +impl Default for IndentOptions { + fn default() -> Self { + Self::new(IndentType::Spaces, 4) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn count_indents() { + assert_eq!( + IndentOptions::new(IndentType::Spaces, 4).count_indents("no indentation here!"), + 0 + ); + assert_eq!( + IndentOptions::new(IndentType::Spaces, 4).count_indents(" v += 2"), + 1 + ); + assert_eq!( + IndentOptions::new(IndentType::Spaces, 4).count_indents(" v += 2"), + 2 + ); + assert_eq!( + IndentOptions::new(IndentType::Spaces, 4).count_indents(" v += 2"), + 2 + ); + assert_eq!( + IndentOptions::new(IndentType::Spaces, 4).count_indents("\t\tv += 2"), + 2 + ); + assert_eq!( + IndentOptions::new(IndentType::Spaces, 4).count_indents("\t\t v += 2"), + 2 + ); + assert_eq!( + IndentOptions::new(IndentType::Spaces, 2).count_indents(" v += 2"), + 2 + ); + } +} diff --git a/packages/autofmt/src/lib.rs b/packages/autofmt/src/lib.rs index 64a342885..0c3fe6bb8 100644 --- a/packages/autofmt/src/lib.rs +++ b/packages/autofmt/src/lib.rs @@ -16,8 +16,11 @@ mod collect_macros; mod component; mod element; mod expr; +mod indent; mod writer; +pub use indent::{IndentOptions, IndentType}; + /// A modification to the original file to be applied by an IDE /// /// Right now this re-writes entire rsx! blocks at a time, instead of precise line-by-line changes. @@ -47,7 +50,7 @@ pub struct FormattedBlock { /// back to the file precisely. /// /// Nested blocks of RSX will be handled automatically -pub fn fmt_file(contents: &str) -> Vec { +pub fn fmt_file(contents: &str, indent: IndentOptions) -> Vec { let mut formatted_blocks = Vec::new(); let parsed = syn::parse_file(contents).unwrap(); @@ -61,6 +64,7 @@ pub fn fmt_file(contents: &str) -> Vec { } let mut writer = Writer::new(contents); + writer.out.indent = indent; // Don't parse nested macros let mut end_span = LineColumn { column: 0, line: 0 }; @@ -76,7 +80,10 @@ pub fn fmt_file(contents: &str) -> Vec { let rsx_start = macro_path.span().start(); - writer.out.indent = leading_whitespaces(writer.src[rsx_start.line - 1]) / 4; + writer.out.indent_level = writer + .out + .indent + .count_indents(writer.src[rsx_start.line - 1]); write_body(&mut writer, &body); @@ -159,12 +166,13 @@ pub fn fmt_block_from_expr(raw: &str, expr: ExprMacro) -> Option { buf.consume() } -pub fn fmt_block(block: &str, indent_level: usize) -> Option { +pub fn fmt_block(block: &str, indent_level: usize, indent: IndentOptions) -> Option { let body = syn::parse_str::(block).unwrap(); let mut buf = Writer::new(block); - buf.out.indent = indent_level; + buf.out.indent = indent; + buf.out.indent_level = indent_level; write_body(&mut buf, &body); @@ -230,14 +238,3 @@ pub(crate) fn write_ifmt(input: &IfmtInput, writable: &mut impl Write) -> std::f let display = DisplayIfmt(input); write!(writable, "{}", display) } - -pub fn leading_whitespaces(input: &str) -> usize { - input - .chars() - .map_while(|c| match c { - ' ' => Some(1), - '\t' => Some(4), - _ => None, - }) - .sum() -} diff --git a/packages/autofmt/src/writer.rs b/packages/autofmt/src/writer.rs index 59f135592..bb333e8df 100644 --- a/packages/autofmt/src/writer.rs +++ b/packages/autofmt/src/writer.rs @@ -96,11 +96,11 @@ impl<'a> Writer<'a> { // Push out the indent level and write each component, line by line pub fn write_body_indented(&mut self, children: &[BodyNode]) -> Result { - self.out.indent += 1; + self.out.indent_level += 1; self.write_body_no_indent(children)?; - self.out.indent -= 1; + self.out.indent_level -= 1; Ok(()) } diff --git a/packages/autofmt/tests/samples.rs b/packages/autofmt/tests/samples.rs index 8145b0e8e..9431d700e 100644 --- a/packages/autofmt/tests/samples.rs +++ b/packages/autofmt/tests/samples.rs @@ -12,7 +12,7 @@ macro_rules! twoway { #[test] fn $name() { let src = include_str!(concat!("./samples/", stringify!($name), ".rsx")); - let formatted = dioxus_autofmt::fmt_file(src); + let formatted = dioxus_autofmt::fmt_file(src, Default::default()); let out = dioxus_autofmt::apply_formats(src, formatted); // normalize line endings let out = out.replace("\r", ""); diff --git a/packages/autofmt/tests/wrong.rs b/packages/autofmt/tests/wrong.rs index 5a0fb8a87..06a0f00d1 100644 --- a/packages/autofmt/tests/wrong.rs +++ b/packages/autofmt/tests/wrong.rs @@ -1,10 +1,12 @@ +use dioxus_autofmt::{IndentOptions, IndentType}; + macro_rules! twoway { - ($val:literal => $name:ident) => { + ($val:literal => $name:ident ($indent:expr)) => { #[test] fn $name() { let src_right = include_str!(concat!("./wrong/", $val, ".rsx")); let src_wrong = include_str!(concat!("./wrong/", $val, ".wrong.rsx")); - let formatted = dioxus_autofmt::fmt_file(src_wrong); + let formatted = dioxus_autofmt::fmt_file(src_wrong, $indent); let out = dioxus_autofmt::apply_formats(src_wrong, formatted); // normalize line endings @@ -16,8 +18,11 @@ macro_rules! twoway { }; } -twoway!("comments" => comments); +twoway!("comments-4sp" => comments_4sp (IndentOptions::new(IndentType::Spaces, 4))); +twoway!("comments-tab" => comments_tab (IndentOptions::new(IndentType::Tabs, 4))); -twoway!("multi" => multi); +twoway!("multi-4sp" => multi_4sp (IndentOptions::new(IndentType::Spaces, 4))); +twoway!("multi-tab" => multi_tab (IndentOptions::new(IndentType::Tabs, 4))); -twoway!("multiexpr" => multiexpr); +twoway!("multiexpr-4sp" => multiexpr_4sp (IndentOptions::new(IndentType::Spaces, 4))); +twoway!("multiexpr-tab" => multiexpr_tab (IndentOptions::new(IndentType::Tabs, 4))); diff --git a/packages/autofmt/tests/wrong/comments.rsx b/packages/autofmt/tests/wrong/comments-4sp.rsx similarity index 100% rename from packages/autofmt/tests/wrong/comments.rsx rename to packages/autofmt/tests/wrong/comments-4sp.rsx diff --git a/packages/autofmt/tests/wrong/comments.wrong.rsx b/packages/autofmt/tests/wrong/comments-4sp.wrong.rsx similarity index 100% rename from packages/autofmt/tests/wrong/comments.wrong.rsx rename to packages/autofmt/tests/wrong/comments-4sp.wrong.rsx diff --git a/packages/autofmt/tests/wrong/comments-tab.rsx b/packages/autofmt/tests/wrong/comments-tab.rsx new file mode 100644 index 000000000..4c05e347e --- /dev/null +++ b/packages/autofmt/tests/wrong/comments-tab.rsx @@ -0,0 +1,7 @@ +rsx! { + div { + // Comments + class: "asdasd", + "hello world" + } +} diff --git a/packages/autofmt/tests/wrong/comments-tab.wrong.rsx b/packages/autofmt/tests/wrong/comments-tab.wrong.rsx new file mode 100644 index 000000000..eac96642d --- /dev/null +++ b/packages/autofmt/tests/wrong/comments-tab.wrong.rsx @@ -0,0 +1,5 @@ +rsx! { + div { + // Comments + class: "asdasd", "hello world" } +} diff --git a/packages/autofmt/tests/wrong/multi.rsx b/packages/autofmt/tests/wrong/multi-4sp.rsx similarity index 100% rename from packages/autofmt/tests/wrong/multi.rsx rename to packages/autofmt/tests/wrong/multi-4sp.rsx diff --git a/packages/autofmt/tests/wrong/multi.wrong.rsx b/packages/autofmt/tests/wrong/multi-4sp.wrong.rsx similarity index 100% rename from packages/autofmt/tests/wrong/multi.wrong.rsx rename to packages/autofmt/tests/wrong/multi-4sp.wrong.rsx diff --git a/packages/autofmt/tests/wrong/multi-tab.rsx b/packages/autofmt/tests/wrong/multi-tab.rsx new file mode 100644 index 000000000..1fb85c3d0 --- /dev/null +++ b/packages/autofmt/tests/wrong/multi-tab.rsx @@ -0,0 +1,3 @@ +fn app(cx: Scope) -> Element { + cx.render(rsx! { div { "hello world" } }) +} diff --git a/packages/autofmt/tests/wrong/multi-tab.wrong.rsx b/packages/autofmt/tests/wrong/multi-tab.wrong.rsx new file mode 100644 index 000000000..d818f9535 --- /dev/null +++ b/packages/autofmt/tests/wrong/multi-tab.wrong.rsx @@ -0,0 +1,5 @@ +fn app(cx: Scope) -> Element { + cx.render(rsx! { + div {"hello world" } + }) +} diff --git a/packages/autofmt/tests/wrong/multiexpr.rsx b/packages/autofmt/tests/wrong/multiexpr-4sp.rsx similarity index 100% rename from packages/autofmt/tests/wrong/multiexpr.rsx rename to packages/autofmt/tests/wrong/multiexpr-4sp.rsx diff --git a/packages/autofmt/tests/wrong/multiexpr.wrong.rsx b/packages/autofmt/tests/wrong/multiexpr-4sp.wrong.rsx similarity index 100% rename from packages/autofmt/tests/wrong/multiexpr.wrong.rsx rename to packages/autofmt/tests/wrong/multiexpr-4sp.wrong.rsx diff --git a/packages/autofmt/tests/wrong/multiexpr-tab.rsx b/packages/autofmt/tests/wrong/multiexpr-tab.rsx new file mode 100644 index 000000000..1fc3401c4 --- /dev/null +++ b/packages/autofmt/tests/wrong/multiexpr-tab.rsx @@ -0,0 +1,8 @@ +fn ItWroks() { + cx.render(rsx! { + div { class: "flex flex-wrap items-center dark:text-white py-16 border-t font-light", + left, + right + } + }) +} diff --git a/packages/autofmt/tests/wrong/multiexpr-tab.wrong.rsx b/packages/autofmt/tests/wrong/multiexpr-tab.wrong.rsx new file mode 100644 index 000000000..073107541 --- /dev/null +++ b/packages/autofmt/tests/wrong/multiexpr-tab.wrong.rsx @@ -0,0 +1,5 @@ +fn ItWroks() { + cx.render(rsx! { + div { class: "flex flex-wrap items-center dark:text-white py-16 border-t font-light", left, right } + }) +} diff --git a/packages/cli/Cargo.toml b/packages/cli/Cargo.toml index adb0239f2..128133602 100644 --- a/packages/cli/Cargo.toml +++ b/packages/cli/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dioxus-cli" -version = "0.4.1" +version = "0.4.3" authors = ["Jonathan Kelley"] edition = "2021" description = "CLI tool for developing, testing, and publishing Dioxus apps" diff --git a/packages/cli/README.md b/packages/cli/README.md index 72a813468..2325d6784 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -10,8 +10,8 @@ It handles building, bundling, development and publishing to simplify developmen ### Install the stable version (recommended) -``` -cargo install dioxus-cli --locked +```shell +cargo install dioxus-cli ``` ### Install the latest development build through git @@ -20,7 +20,7 @@ To get the latest bug fixes and features, you can install the development versio However, this is not fully tested. That means you're probably going to have more bugs despite having the latest bug fixes. -``` +```shell cargo install --git https://github.com/DioxusLabs/dioxus dioxus-cli ``` @@ -29,7 +29,7 @@ and install it in Cargo's global binary directory (`~/.cargo/bin/` by default). ### Install from local folder -``` +```shell cargo install --path . --debug ``` @@ -40,7 +40,7 @@ It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxu Alternatively, you can specify the template path: -``` +```shell dx create hello --template gh:dioxuslabs/dioxus-template ``` diff --git a/packages/cli/src/assets/dioxus.toml b/packages/cli/src/assets/dioxus.toml index 6386fb76e..892a6cdf8 100644 --- a/packages/cli/src/assets/dioxus.toml +++ b/packages/cli/src/assets/dioxus.toml @@ -23,7 +23,7 @@ title = "Dioxus | An elegant GUI library for Rust" index_on_404 = true -watch_path = ["src"] +watch_path = ["src", "examples"] # include `assets` in web platform [web.resource] diff --git a/packages/cli/src/builder.rs b/packages/cli/src/builder.rs index 68c494c42..759be7dec 100644 --- a/packages/cli/src/builder.rs +++ b/packages/cli/src/builder.rs @@ -48,14 +48,25 @@ pub fn build(config: &CrateConfig, quiet: bool) -> Result { // [1] Build the .wasm module log::info!("🚅 Running build command..."); + + let wasm_check_command = std::process::Command::new("rustup") + .args(["show"]) + .output()?; + let wasm_check_output = String::from_utf8(wasm_check_command.stdout).unwrap(); + if !wasm_check_output.contains("wasm32-unknown-unknown") { + log::info!("wasm32-unknown-unknown target not detected, installing.."); + let _ = std::process::Command::new("rustup") + .args(["target", "add", "wasm32-unknown-unknown"]) + .output()?; + } + let cmd = subprocess::Exec::cmd("cargo"); let cmd = cmd .cwd(crate_dir) .arg("build") .arg("--target") .arg("wasm32-unknown-unknown") - .arg("--message-format=json") - .arg("--quiet"); + .arg("--message-format=json"); let cmd = if config.release { cmd.arg("--release") @@ -65,7 +76,7 @@ pub fn build(config: &CrateConfig, quiet: bool) -> Result { let cmd = if config.verbose { cmd.arg("--verbose") } else { - cmd + cmd.arg("--quiet") }; let cmd = if config.custom_profile.is_some() { @@ -261,6 +272,8 @@ pub fn build_desktop(config: &CrateConfig, _is_serve: bool) -> Result String { .unwrap_or_default() .contains_key("tailwindcss") { - style_str.push_str("\n"); + style_str.push_str("\n"); } replace_or_insert_before("{style_include}", &style_str, " { - let edits = dioxus_autofmt::fmt_file(&s); + let edits = dioxus_autofmt::fmt_file(&s, indent); let out = dioxus_autofmt::apply_formats(&s, edits); if file == "-" { print!("{}", out); @@ -93,6 +99,12 @@ async fn autoformat_project(check: bool) -> Result<()> { let mut files_to_format = vec![]; collect_rs_files(&crate_config.crate_dir, &mut files_to_format); + if files_to_format.is_empty() { + return Ok(()); + } + + let indent = indentation_for(&files_to_format[0])?; + let counts = files_to_format .into_iter() .filter(|file| { @@ -104,10 +116,11 @@ async fn autoformat_project(check: bool) -> Result<()> { }) .map(|path| async { let _path = path.clone(); + let _indent = indent.clone(); let res = tokio::spawn(async move { let contents = tokio::fs::read_to_string(&path).await?; - let edits = dioxus_autofmt::fmt_file(&contents); + let edits = dioxus_autofmt::fmt_file(&contents, _indent.clone()); let len = edits.len(); if !edits.is_empty() { @@ -151,6 +164,49 @@ async fn autoformat_project(check: bool) -> Result<()> { Ok(()) } +fn indentation_for(file_or_dir: impl AsRef) -> Result { + let out = std::process::Command::new("cargo") + .args(["fmt", "--", "--print-config", "current"]) + .arg(file_or_dir.as_ref()) + .stdout(std::process::Stdio::piped()) + .stderr(std::process::Stdio::inherit()) + .output()?; + if !out.status.success() { + return Err(Error::CargoError("cargo fmt failed".into())); + } + + let config = String::from_utf8_lossy(&out.stdout); + + let hard_tabs = config + .lines() + .find(|line| line.starts_with("hard_tabs ")) + .and_then(|line| line.split_once('=')) + .map(|(_, value)| value.trim() == "true") + .ok_or_else(|| { + Error::RuntimeError("Could not find hard_tabs option in rustfmt config".into()) + })?; + let tab_spaces = config + .lines() + .find(|line| line.starts_with("tab_spaces ")) + .and_then(|line| line.split_once('=')) + .map(|(_, value)| value.trim().parse::()) + .ok_or_else(|| { + Error::RuntimeError("Could not find tab_spaces option in rustfmt config".into()) + })? + .map_err(|_| { + Error::RuntimeError("Could not parse tab_spaces option in rustfmt config".into()) + })?; + + Ok(IndentOptions::new( + if hard_tabs { + IndentType::Tabs + } else { + IndentType::Spaces + }, + tab_spaces, + )) +} + fn collect_rs_files(folder: &Path, files: &mut Vec) { let Ok(folder) = folder.read_dir() else { return; diff --git a/packages/cli/src/cli/build.rs b/packages/cli/src/cli/build.rs index 7fe29f8ce..63a2969e0 100644 --- a/packages/cli/src/cli/build.rs +++ b/packages/cli/src/cli/build.rs @@ -37,8 +37,8 @@ impl Build { .platform .unwrap_or(crate_config.dioxus_config.application.default_platform); - #[cfg(feature = "plugin")] - let _ = PluginManager::on_build_start(&crate_config, &platform); + // #[cfg(feature = "plugin")] + // let _ = PluginManager::on_build_start(&crate_config, &platform); match platform { Platform::Web => { @@ -66,8 +66,8 @@ impl Build { )?; file.write_all(temp.as_bytes())?; - #[cfg(feature = "plugin")] - let _ = PluginManager::on_build_finish(&crate_config, &platform); + // #[cfg(feature = "plugin")] + // let _ = PluginManager::on_build_finish(&crate_config, &platform); Ok(()) } diff --git a/packages/cli/src/config.rs b/packages/cli/src/config.rs index 0654dc375..3abf47f0c 100644 --- a/packages/cli/src/config.rs +++ b/packages/cli/src/config.rs @@ -105,7 +105,7 @@ impl Default for DioxusConfig { }, proxy: Some(vec![]), watcher: WebWatcherConfig { - watch_path: Some(vec![PathBuf::from("src")]), + watch_path: Some(vec![PathBuf::from("src"), PathBuf::from("examples")]), reload_html: Some(false), index_on_404: Some(true), }, diff --git a/packages/cli/src/error.rs b/packages/cli/src/error.rs index 84b9d4b71..d577b2b40 100644 --- a/packages/cli/src/error.rs +++ b/packages/cli/src/error.rs @@ -29,6 +29,9 @@ pub enum Error { #[error("Cargo Error: {0}")] CargoError(String), + #[error("Couldn't retrieve cargo metadata")] + CargoMetadata(#[source] cargo_metadata::Error), + #[error("{0}")] CustomError(String), diff --git a/packages/cli/src/logging.rs b/packages/cli/src/logging.rs index 48c2a2788..31d088737 100644 --- a/packages/cli/src/logging.rs +++ b/packages/cli/src/logging.rs @@ -28,7 +28,19 @@ pub fn set_up_logging() { message = message, )); }) - .level(log::LevelFilter::Info) + .level(match std::env::var("DIOXUS_LOG") { + Ok(level) => match level.to_lowercase().as_str() { + "error" => log::LevelFilter::Error, + "warn" => log::LevelFilter::Warn, + "info" => log::LevelFilter::Info, + "debug" => log::LevelFilter::Debug, + "trace" => log::LevelFilter::Trace, + _ => { + panic!("Invalid log level: {}", level) + } + }, + Err(_) => log::LevelFilter::Info, + }) .chain(std::io::stdout()) .apply() .unwrap(); diff --git a/packages/cli/src/main.rs b/packages/cli/src/main.rs index fe860a0e6..2358551f2 100644 --- a/packages/cli/src/main.rs +++ b/packages/cli/src/main.rs @@ -9,42 +9,31 @@ use dioxus_cli::plugin::PluginManager; use Commands::*; -fn get_bin(bin: Option) -> Result> { - const ERR_MESSAGE: &str = "The `--bin` flag has to be ran in a Cargo workspace."; +fn get_bin(bin: Option) -> Result { + let metadata = cargo_metadata::MetadataCommand::new() + .exec() + .map_err(Error::CargoMetadata)?; + let package = if let Some(bin) = bin { + metadata + .workspace_packages() + .into_iter() + .find(|p| p.name == bin) + .ok_or(format!("no such package: {}", bin)) + .map_err(Error::CargoError)? + } else { + metadata + .root_package() + .ok_or("no root package?".into()) + .map_err(Error::CargoError)? + }; - if let Some(ref bin) = bin { - let manifest = cargo_toml::Manifest::from_path("./Cargo.toml") - .map_err(|_| Error::CargoError(ERR_MESSAGE.to_string()))?; + let crate_dir = package + .manifest_path + .parent() + .ok_or("couldn't take parent dir".into()) + .map_err(Error::CargoError)?; - if let Some(workspace) = manifest.workspace { - for item in workspace.members.iter() { - let path = PathBuf::from(item); - - if !path.exists() { - continue; - } - - if !path.is_dir() { - continue; - } - - if path.ends_with(bin.clone()) { - return Ok(Some(path)); - } - } - } else { - return Err(Error::CargoError(ERR_MESSAGE.to_string())); - } - } - - // If the bin exists but we couldn't find it - if bin.is_some() { - return Err(Error::CargoError( - "The specified bin does not exist.".to_string(), - )); - } - - Ok(None) + Ok(crate_dir.into()) } #[tokio::main] @@ -53,34 +42,36 @@ async fn main() -> anyhow::Result<()> { set_up_logging(); - let bin = get_bin(args.bin)?; + let bin = get_bin(args.bin); - let _dioxus_config = DioxusConfig::load(bin.clone()) + if let Ok(bin) = &bin { + let _dioxus_config = DioxusConfig::load(Some(bin.clone())) .map_err(|e| anyhow!("Failed to load Dioxus config because: {e}"))? .unwrap_or_else(|| { log::warn!("You appear to be creating a Dioxus project from scratch; we will use the default config"); DioxusConfig::default() }); - #[cfg(feature = "plugin")] - PluginManager::init(_dioxus_config.plugin) - .map_err(|e| anyhow!("🚫 Plugin system initialization failed: {e}"))?; + #[cfg(feature = "plugin")] + PluginManager::init(_dioxus_config.plugin) + .map_err(|e| anyhow!("🚫 Plugin system initialization failed: {e}"))?; + } match args.action { Translate(opts) => opts .translate() .map_err(|e| anyhow!("🚫 Translation of HTML into RSX failed: {}", e)), - Build(opts) => opts - .build(bin.clone()) + Build(opts) if bin.is_ok() => opts + .build(Some(bin.unwrap().clone())) .map_err(|e| anyhow!("🚫 Building project failed: {}", e)), - Clean(opts) => opts - .clean(bin.clone()) + Clean(opts) if bin.is_ok() => opts + .clean(Some(bin.unwrap().clone())) .map_err(|e| anyhow!("🚫 Cleaning project failed: {}", e)), - Serve(opts) => opts - .serve(bin.clone()) + Serve(opts) if bin.is_ok() => opts + .serve(Some(bin.unwrap().clone())) .await .map_err(|e| anyhow!("🚫 Serving project failed: {}", e)), @@ -92,8 +83,8 @@ async fn main() -> anyhow::Result<()> { .config() .map_err(|e| anyhow!("🚫 Configuring new project failed: {}", e)), - Bundle(opts) => opts - .bundle(bin.clone()) + Bundle(opts) if bin.is_ok() => opts + .bundle(Some(bin.unwrap().clone())) .map_err(|e| anyhow!("🚫 Bundling project failed: {}", e)), #[cfg(feature = "plugin")] @@ -118,5 +109,6 @@ async fn main() -> anyhow::Result<()> { Ok(()) } + _ => Err(anyhow::anyhow!(bin.unwrap_err())), } } diff --git a/packages/cli/src/server/desktop/mod.rs b/packages/cli/src/server/desktop/mod.rs index 978b97d43..fec1e5a99 100644 --- a/packages/cli/src/server/desktop/mod.rs +++ b/packages/cli/src/server/desktop/mod.rs @@ -43,8 +43,6 @@ pub async fn startup(config: CrateConfig) -> Result<()> { let hot_reload_tx = broadcast::channel(100).0; - clear_paths(); - Some(HotReloadState { messages: hot_reload_tx.clone(), file_map: file_map.clone(), @@ -73,6 +71,7 @@ pub async fn serve(config: CrateConfig, hot_reload_state: Option move || { let mut current_child = currently_running_child.write().unwrap(); + log::trace!("Killing old process"); current_child.kill()?; let (child, result) = start_desktop(&config)?; *current_child = child; @@ -109,7 +108,14 @@ pub async fn serve(config: CrateConfig, hot_reload_state: Option } async fn start_desktop_hot_reload(hot_reload_state: HotReloadState) -> Result<()> { - match LocalSocketListener::bind("@dioxusin") { + let metadata = cargo_metadata::MetadataCommand::new() + .no_deps() + .exec() + .unwrap(); + let target_dir = metadata.target_directory.as_std_path(); + let path = target_dir.join("dioxusin"); + clear_paths(&path); + match LocalSocketListener::bind(path) { Ok(local_socket_stream) => { let aborted = Arc::new(Mutex::new(false)); // States @@ -121,9 +127,9 @@ async fn start_desktop_hot_reload(hot_reload_state: HotReloadState) -> Result<() let file_map = hot_reload_state.file_map.clone(); let channels = channels.clone(); let aborted = aborted.clone(); - let _ = local_socket_stream.set_nonblocking(true); move || { loop { + //accept() will block the thread when local_socket_stream is in blocking mode (default) match local_socket_stream.accept() { Ok(mut connection) => { // send any templates than have changed before the socket connected @@ -181,17 +187,14 @@ async fn start_desktop_hot_reload(hot_reload_state: HotReloadState) -> Result<() Ok(()) } -fn clear_paths() { +fn clear_paths(file_socket_path: &std::path::Path) { if cfg!(target_os = "macos") { // On unix, if you force quit the application, it can leave the file socket open // This will cause the local socket listener to fail to open // We check if the file socket is already open from an old session and then delete it - let paths = ["./dioxusin", "./@dioxusin"]; - for path in paths { - let path = std::path::PathBuf::from(path); - if path.exists() { - let _ = std::fs::remove_file(path); - } + + if file_socket_path.exists() { + let _ = std::fs::remove_file(file_socket_path); } } } @@ -212,6 +215,7 @@ fn send_msg(msg: HotReloadMsg, channel: &mut impl std::io::Write) -> bool { pub fn start_desktop(config: &CrateConfig) -> Result<(Child, BuildResult)> { // Run the desktop application + log::trace!("Building application"); let result = crate::builder::build_desktop(config, true)?; match &config.executable { @@ -222,6 +226,7 @@ pub fn start_desktop(config: &CrateConfig) -> Result<(Child, BuildResult)> { if cfg!(windows) { file.set_extension("exe"); } + log::trace!("Running application from {:?}", file); let child = Command::new(file.to_str().unwrap()).spawn()?; Ok((child, result)) diff --git a/packages/cli/src/server/mod.rs b/packages/cli/src/server/mod.rs index c6073d787..eb4021184 100644 --- a/packages/cli/src/server/mod.rs +++ b/packages/cli/src/server/mod.rs @@ -32,7 +32,7 @@ async fn setup_file_watcher Result + Send + 'static>( .watcher .watch_path .clone() - .unwrap_or_else(|| vec![PathBuf::from("src")]); + .unwrap_or_else(|| vec![PathBuf::from("src"), PathBuf::from("examples")]); let watcher_config = config.clone(); let mut watcher = notify::recommended_watcher(move |info: notify::Result| { @@ -55,6 +55,16 @@ async fn setup_file_watcher Result + Send + 'static>( break; } + // Workaround for notify and vscode-like editor: + // when edit & save a file in vscode, there will be two notifications, + // the first one is a file with empty content. + // filter the empty file notification to avoid false rebuild during hot-reload + if let Ok(metadata) = fs::metadata(path) { + if metadata.len() == 0 { + continue; + } + } + match rsx_file_map.update_rsx(path, &config.crate_dir) { Ok(UpdateResult::UpdatedRsx(msgs)) => { messages.extend(msgs); @@ -121,12 +131,12 @@ async fn setup_file_watcher Result + Send + 'static>( .unwrap(); for sub_path in allow_watch_path { - watcher - .watch( - &config.crate_dir.join(sub_path), - notify::RecursiveMode::Recursive, - ) - .unwrap(); + if let Err(err) = watcher.watch( + &config.crate_dir.join(sub_path), + notify::RecursiveMode::Recursive, + ) { + log::error!("Failed to watch path: {}", err); + } } Ok(watcher) } diff --git a/packages/cli/src/server/output.rs b/packages/cli/src/server/output.rs index 71323dd29..4e148b0f1 100644 --- a/packages/cli/src/server/output.rs +++ b/packages/cli/src/server/output.rs @@ -22,17 +22,20 @@ pub fn print_console_info( options: PrettierOptions, web_info: Option, ) { - if let Ok(native_clearseq) = Command::new(if cfg!(target_os = "windows") { - "cls" - } else { - "clear" - }) - .output() - { - print!("{}", String::from_utf8_lossy(&native_clearseq.stdout)); - } else { - // Try ANSI-Escape characters - print!("\x1b[2J\x1b[H"); + // Don't clear the screen if the user has set the DIOXUS_LOG environment variable to "trace" so that we can see the logs + if Some("trace") != std::env::var("DIOXUS_LOG").ok().as_deref() { + if let Ok(native_clearseq) = Command::new(if cfg!(target_os = "windows") { + "cls" + } else { + "clear" + }) + .output() + { + print!("{}", String::from_utf8_lossy(&native_clearseq.stdout)); + } else { + // Try ANSI-Escape characters + print!("\x1b[2J\x1b[H"); + } } let mut profile = if config.release { "Release" } else { "Debug" }.to_string(); diff --git a/packages/core-macro/src/component_body_deserializers/component.rs b/packages/core-macro/src/component_body_deserializers/component.rs index e43b1819f..36cda850c 100644 --- a/packages/core-macro/src/component_body_deserializers/component.rs +++ b/packages/core-macro/src/component_body_deserializers/component.rs @@ -31,6 +31,7 @@ fn get_out_comp_fn(orig_comp_fn: &ItemFn, cx_pat: &Pat) -> ItemFn { block: parse_quote! { { #[warn(non_snake_case)] + #[allow(clippy::inline_always)] #[inline(always)] #inner_comp_fn #inner_comp_ident (#cx_pat) diff --git a/packages/core-macro/src/component_body_deserializers/inline_props.rs b/packages/core-macro/src/component_body_deserializers/inline_props.rs index 670a14d88..d51132623 100644 --- a/packages/core-macro/src/component_body_deserializers/inline_props.rs +++ b/packages/core-macro/src/component_body_deserializers/inline_props.rs @@ -186,13 +186,13 @@ fn get_props_docs(fn_ident: &Ident, inputs: Vec<&FnArg>) -> Vec { let arg_name = arg_name.into_token_stream().to_string(); let arg_type = crate::utils::format_type_string(arg_type); - let input_arg_doc = - keep_up_to_n_consecutive_chars(input_arg_doc.trim(), 2, '\n').replace('\n', "
"); + let input_arg_doc = keep_up_to_n_consecutive_chars(input_arg_doc.trim(), 2, '\n') + .replace("\n\n", "

"); let prop_def_link = format!("{props_def_link}::{arg_name}"); let mut arg_doc = format!("- [`{arg_name}`]({prop_def_link}) : `{arg_type}`"); if let Some(deprecation) = deprecation { - arg_doc.push_str("
👎 Deprecated"); + arg_doc.push_str("

👎 Deprecated"); if let Some(since) = deprecation.since { arg_doc.push_str(&format!(" since {since}")); @@ -205,14 +205,16 @@ fn get_props_docs(fn_ident: &Ident, inputs: Vec<&FnArg>) -> Vec { arg_doc.push_str(&format!(": {note}")); } + arg_doc.push_str("

"); + if !input_arg_doc.is_empty() { arg_doc.push_str("
"); } - } else { - arg_doc.push_str("
"); } - arg_doc.push_str(&input_arg_doc); + if !input_arg_doc.is_empty() { + arg_doc.push_str(&format!("

{input_arg_doc}

")); + } props_docs.push(parse_quote! { #[doc = #arg_doc] diff --git a/packages/core-macro/src/props/mod.rs b/packages/core-macro/src/props/mod.rs index 605983afc..d7a580705 100644 --- a/packages/core-macro/src/props/mod.rs +++ b/packages/core-macro/src/props/mod.rs @@ -243,10 +243,6 @@ mod field_info { } .into() } - - pub fn type_from_inside_option(&self, check_option_name: bool) -> Option<&syn::Type> { - type_from_inside_option(self.ty, check_option_name) - } } #[derive(Debug, Default, Clone)] @@ -551,18 +547,16 @@ mod struct_info { let generics_with_empty = modify_types_generics_hack(&ty_generics, |args| { args.insert(0, syn::GenericArgument::Type(empties_tuple.clone().into())); }); - let phantom_generics = self.generics.params.iter().map(|param| match param { + let phantom_generics = self.generics.params.iter().filter_map(|param| match param { syn::GenericParam::Lifetime(lifetime) => { let lifetime = &lifetime.lifetime; - quote!(::core::marker::PhantomData<&#lifetime ()>) + Some(quote!(::core::marker::PhantomData<&#lifetime ()>)) } syn::GenericParam::Type(ty) => { let ty = &ty.ident; - quote!(::core::marker::PhantomData<#ty>) - } - syn::GenericParam::Const(_cnst) => { - quote!() + Some(quote!(::core::marker::PhantomData<#ty>)) } + syn::GenericParam::Const(_cnst) => None, }); let builder_method_doc = match self.builder_attr.builder_method_doc { Some(ref doc) => quote!(#doc), @@ -633,7 +627,7 @@ Finally, call `.build()` to create the instance of `{name}`. Ok(quote! { impl #impl_generics #name #ty_generics #where_clause { #[doc = #builder_method_doc] - #[allow(dead_code)] + #[allow(dead_code, clippy::type_complexity)] #vis fn builder() -> #builder_name #generics_with_empty { #builder_name { fields: #empties_tuple, @@ -785,31 +779,16 @@ Finally, call `.build()` to create the instance of `{name}`. None => quote!(), }; - // NOTE: both auto_into and strip_option affect `arg_type` and `arg_expr`, but the order of - // nesting is different so we have to do this little dance. - let arg_type = if field.builder_attr.strip_option { - field.type_from_inside_option(false).ok_or_else(|| { - Error::new_spanned( - field_type, - "can't `strip_option` - field is not `Option<...>`", + let arg_type = field_type; + let (arg_type, arg_expr) = + if field.builder_attr.auto_into || field.builder_attr.strip_option { + ( + quote!(impl ::core::convert::Into<#arg_type>), + quote!(#field_name.into()), ) - })? - } else { - field_type - }; - let (arg_type, arg_expr) = if field.builder_attr.auto_into { - ( - quote!(impl ::core::convert::Into<#arg_type>), - quote!(#field_name.into()), - ) - } else { - (quote!(#arg_type), quote!(#field_name)) - }; - let arg_expr = if field.builder_attr.strip_option { - quote!(Some(#arg_expr)) - } else { - arg_expr - }; + } else { + (quote!(#arg_type), quote!(#field_name)) + }; let repeated_fields_error_type_name = syn::Ident::new( &format!( @@ -825,6 +804,7 @@ Finally, call `.build()` to create the instance of `{name}`. #[allow(dead_code, non_camel_case_types, missing_docs)] impl #impl_generics #builder_name < #( #ty_generics ),* > #where_clause { #doc + #[allow(clippy::type_complexity)] pub fn #field_name (self, #field_name: #arg_type) -> #builder_name < #( #target_generics ),* > { let #field_name = (#arg_expr,); let ( #(#descructuring,)* ) = self.fields; @@ -843,6 +823,7 @@ Finally, call `.build()` to create the instance of `{name}`. #[deprecated( note = #repeated_fields_error_message )] + #[allow(clippy::type_complexity)] pub fn #field_name (self, _: #repeated_fields_error_type_name) -> #builder_name < #( #target_generics ),* > { self } diff --git a/packages/core/src/arena.rs b/packages/core/src/arena.rs index b7f768755..785d4b174 100644 --- a/packages/core/src/arena.rs +++ b/packages/core/src/arena.rs @@ -164,17 +164,11 @@ impl VirtualDom { }); // Now that all the references are gone, we can safely drop our own references in our listeners. - let mut listeners = scope.attributes_to_drop.borrow_mut(); + let mut listeners = scope.attributes_to_drop_before_render.borrow_mut(); listeners.drain(..).for_each(|listener| { let listener = unsafe { &*listener }; - match &listener.value { - AttributeValue::Listener(l) => { - _ = l.take(); - } - AttributeValue::Any(a) => { - _ = a.take(); - } - _ => (), + if let AttributeValue::Listener(l) = &listener.value { + _ = l.take(); } }); } diff --git a/packages/core/src/bump_frame.rs b/packages/core/src/bump_frame.rs index 0fe7b3867..6927bd8bc 100644 --- a/packages/core/src/bump_frame.rs +++ b/packages/core/src/bump_frame.rs @@ -1,10 +1,16 @@ use crate::nodes::RenderReturn; +use crate::{Attribute, AttributeValue, VComponent}; use bumpalo::Bump; +use std::cell::RefCell; use std::cell::{Cell, UnsafeCell}; pub(crate) struct BumpFrame { pub bump: UnsafeCell, pub node: Cell<*const RenderReturn<'static>>, + + // The bump allocator will not call the destructor of the objects it allocated. Attributes and props need to have there destructor called, so we keep a list of them to drop before the bump allocator is reset. + pub(crate) attributes_to_drop_before_reset: RefCell>>, + pub(crate) props_to_drop_before_reset: RefCell>>, } impl BumpFrame { @@ -13,6 +19,8 @@ impl BumpFrame { Self { bump: UnsafeCell::new(bump), node: Cell::new(std::ptr::null()), + attributes_to_drop_before_reset: Default::default(), + props_to_drop_before_reset: Default::default(), } } @@ -31,8 +39,38 @@ impl BumpFrame { unsafe { &*self.bump.get() } } - #[allow(clippy::mut_from_ref)] - pub(crate) unsafe fn bump_mut(&self) -> &mut Bump { - unsafe { &mut *self.bump.get() } + pub(crate) fn add_attribute_to_drop(&self, attribute: *const Attribute<'static>) { + self.attributes_to_drop_before_reset + .borrow_mut() + .push(attribute); + } + + /// Reset the bump allocator and drop all the attributes and props that were allocated in it. + /// + /// # Safety + /// The caller must insure that no reference to anything allocated in the bump allocator is available after this function is called. + pub(crate) unsafe fn reset(&self) { + let mut attributes = self.attributes_to_drop_before_reset.borrow_mut(); + attributes.drain(..).for_each(|attribute| { + let attribute = unsafe { &*attribute }; + if let AttributeValue::Any(l) = &attribute.value { + _ = l.take(); + } + }); + let mut props = self.props_to_drop_before_reset.borrow_mut(); + props.drain(..).for_each(|prop| { + let prop = unsafe { &*prop }; + _ = prop.props.borrow_mut().take(); + }); + unsafe { + let bump = &mut *self.bump.get(); + bump.reset(); + } + } +} + +impl Drop for BumpFrame { + fn drop(&mut self) { + unsafe { self.reset() } } } diff --git a/packages/core/src/diff.rs b/packages/core/src/diff.rs index 74017db0f..2de862218 100644 --- a/packages/core/src/diff.rs +++ b/packages/core/src/diff.rs @@ -560,7 +560,7 @@ impl<'b> VirtualDom { // If none of the old keys are reused by the new children, then we remove all the remaining old children and // create the new children afresh. if shared_keys.is_empty() { - if old.get(0).is_some() { + if old.first().is_some() { self.remove_nodes(&old[1..]); self.replace(&old[0], new); } else { diff --git a/packages/core/src/events.rs b/packages/core/src/events.rs index 3b8edb05c..784a8c865 100644 --- a/packages/core/src/events.rs +++ b/packages/core/src/events.rs @@ -107,8 +107,6 @@ impl std::fmt::Debug for Event { } } -#[doc(hidden)] - /// The callback type generated by the `rsx!` macro when an `on` field is specified for components. /// /// This makes it possible to pass `move |evt| {}` style closures into components as property fields. diff --git a/packages/core/src/lazynodes.rs b/packages/core/src/lazynodes.rs index 811dbb734..3189086b4 100644 --- a/packages/core/src/lazynodes.rs +++ b/packages/core/src/lazynodes.rs @@ -23,8 +23,37 @@ use crate::{innerlude::VNode, ScopeState}; /// /// /// ```rust, ignore -/// LazyNodes::new(|f| f.element("div", [], [], [] None)) +/// LazyNodes::new(|f| { +/// static TEMPLATE: dioxus::core::Template = dioxus::core::Template { +/// name: "main.rs:5:5:20", // Source location of the template for hot reloading +/// roots: &[ +/// dioxus::core::TemplateNode::Element { +/// tag: dioxus_elements::div::TAG_NAME, +/// namespace: dioxus_elements::div::NAME_SPACE, +/// attrs: &[], +/// children: &[], +/// }, +/// ], +/// node_paths: &[], +/// attr_paths: &[], +/// }; +/// dioxus::core::VNode { +/// parent: None, +/// key: None, +/// template: std::cell::Cell::new(TEMPLATE), +/// root_ids: dioxus::core::exports::bumpalo::collections::Vec::with_capacity_in( +/// 1usize, +/// f.bump(), +/// ) +/// .into(), +/// dynamic_nodes: f.bump().alloc([]), +/// dynamic_attrs: f.bump().alloc([]), +/// }) +/// } /// ``` +/// +/// Find more information about how to construct [`VNode`] at + pub struct LazyNodes<'a, 'b> { #[cfg(not(miri))] inner: SmallBox VNode<'a> + 'b, S16>, @@ -61,7 +90,7 @@ impl<'a, 'b> LazyNodes<'a, 'b> { /// Call the closure with the given factory to produce real [`VNode`]. /// /// ```rust, ignore - /// let f = LazyNodes::new(move |f| f.element("div", [], [], [] None)); + /// let f = LazyNodes::new(/* Closure for creating VNodes */); /// /// let node = f.call(cac); /// ``` diff --git a/packages/core/src/mutations.rs b/packages/core/src/mutations.rs index 27976c157..f33590e2e 100644 --- a/packages/core/src/mutations.rs +++ b/packages/core/src/mutations.rs @@ -91,7 +91,7 @@ pub enum Mutation<'a> { id: ElementId, }, - /// Create an placeholder int he DOM that we will use later. + /// Create a placeholder in the DOM that we will use later. /// /// Dioxus currently requires the use of placeholders to maintain a re-entrance point for things like list diffing CreatePlaceholder { diff --git a/packages/core/src/nodes.rs b/packages/core/src/nodes.rs index c83b1059a..78868d29f 100644 --- a/packages/core/src/nodes.rs +++ b/packages/core/src/nodes.rs @@ -707,7 +707,7 @@ impl<'a, 'b> IntoDynNode<'b> for &'a str { impl IntoDynNode<'_> for String { fn into_vnode(self, cx: &ScopeState) -> DynamicNode { DynamicNode::Text(VText { - value: cx.bump().alloc(self), + value: cx.bump().alloc_str(&self), id: Default::default(), }) } @@ -791,6 +791,12 @@ impl<'a> IntoAttributeValue<'a> for &'a str { } } +impl<'a> IntoAttributeValue<'a> for String { + fn into_value(self, cx: &'a Bump) -> AttributeValue<'a> { + AttributeValue::Text(cx.alloc_str(&self)) + } +} + impl<'a> IntoAttributeValue<'a> for f64 { fn into_value(self, _: &'a Bump) -> AttributeValue<'a> { AttributeValue::Float(self) diff --git a/packages/core/src/scope_arena.rs b/packages/core/src/scope_arena.rs index 1ed5b816c..397f5328e 100644 --- a/packages/core/src/scope_arena.rs +++ b/packages/core/src/scope_arena.rs @@ -35,7 +35,7 @@ impl VirtualDom { hook_idx: Default::default(), borrowed_props: Default::default(), - attributes_to_drop: Default::default(), + attributes_to_drop_before_render: Default::default(), })); let context = @@ -54,7 +54,7 @@ impl VirtualDom { let new_nodes = unsafe { let scope = &self.scopes[scope_id.0]; - scope.previous_frame().bump_mut().reset(); + scope.previous_frame().reset(); scope.context().suspended.set(false); diff --git a/packages/core/src/scopes.rs b/packages/core/src/scopes.rs index 996529a0d..f0bbd776c 100644 --- a/packages/core/src/scopes.rs +++ b/packages/core/src/scopes.rs @@ -94,7 +94,7 @@ pub struct ScopeState { pub(crate) hook_idx: Cell, pub(crate) borrowed_props: RefCell>>, - pub(crate) attributes_to_drop: RefCell>>, + pub(crate) attributes_to_drop_before_render: RefCell>>, pub(crate) props: Option>>, } @@ -348,25 +348,36 @@ impl<'src> ScopeState { pub fn render(&'src self, rsx: LazyNodes<'src, '_>) -> Element<'src> { let element = rsx.call(self); - let mut listeners = self.attributes_to_drop.borrow_mut(); + let mut listeners = self.attributes_to_drop_before_render.borrow_mut(); for attr in element.dynamic_attrs { match attr.value { - AttributeValue::Any(_) | AttributeValue::Listener(_) => { + // We need to drop listeners before the next render because they may borrow data from the borrowed props which will be dropped + AttributeValue::Listener(_) => { let unbounded = unsafe { std::mem::transmute(attr as *const Attribute) }; listeners.push(unbounded); } + // We need to drop any values manually to make sure that their drop implementation is called before the next render + AttributeValue::Any(_) => { + let unbounded = unsafe { std::mem::transmute(attr as *const Attribute) }; + self.previous_frame().add_attribute_to_drop(unbounded); + } _ => (), } } let mut props = self.borrowed_props.borrow_mut(); + let mut drop_props = self + .previous_frame() + .props_to_drop_before_reset + .borrow_mut(); for node in element.dynamic_nodes { if let DynamicNode::Component(comp) = node { + let unbounded = unsafe { std::mem::transmute(comp as *const VComponent) }; if !comp.static_props { - let unbounded = unsafe { std::mem::transmute(comp as *const VComponent) }; props.push(unbounded); } + drop_props.push(unbounded); } } diff --git a/packages/desktop/Cargo.toml b/packages/desktop/Cargo.toml index dcb994120..f0ea9e189 100644 --- a/packages/desktop/Cargo.toml +++ b/packages/desktop/Cargo.toml @@ -59,6 +59,7 @@ devtools = ["wry/devtools"] tray = ["wry/tray"] dox = ["wry/dox"] hot-reload = ["dioxus-hot-reload"] +gnu = [] [package.metadata.docs.rs] default-features = false diff --git a/packages/desktop/build.rs b/packages/desktop/build.rs new file mode 100644 index 000000000..2061732e8 --- /dev/null +++ b/packages/desktop/build.rs @@ -0,0 +1,9 @@ +fn main() { + // WARN about wry support on windows gnu targets. GNU windows targets don't work well in wry currently + if std::env::var("CARGO_CFG_WINDOWS").is_ok() + && std::env::var("CARGO_CFG_TARGET_ENV").unwrap() == "gnu" + && !cfg!(feature = "gnu") + { + println!("cargo:warning=GNU windows targets have some limitations within Wry. Using the MSVC windows toolchain is recommended. If you would like to use continue using GNU, you can read https://github.com/wravery/webview2-rs#cross-compilation and disable this warning by adding the gnu feature to dioxus-desktop in your Cargo.toml") + } +} diff --git a/packages/desktop/src/lib.rs b/packages/desktop/src/lib.rs index badbe3276..63a8914f3 100644 --- a/packages/desktop/src/lib.rs +++ b/packages/desktop/src/lib.rs @@ -54,7 +54,7 @@ use wry::{application::window::WindowId, webview::WebContext}; /// /// This function will start a multithreaded Tokio runtime as well the WebView event loop. /// -/// ```rust, ignore +/// ```rust, no_run /// use dioxus::prelude::*; /// /// fn main() { @@ -77,11 +77,12 @@ pub fn launch(root: Component) { /// /// You can configure the WebView window with a configuration closure /// -/// ```rust, ignore +/// ```rust, no_run /// use dioxus::prelude::*; +/// use dioxus_desktop::*; /// /// fn main() { -/// dioxus_desktop::launch_cfg(app, |c| c.with_window(|w| w.with_title("My App"))); +/// dioxus_desktop::launch_cfg(app, Config::default().with_window(WindowBuilder::new().with_title("My App"))); /// } /// /// fn app(cx: Scope) -> Element { @@ -100,8 +101,9 @@ pub fn launch_cfg(root: Component, config_builder: Config) { /// /// You can configure the WebView window with a configuration closure /// -/// ```rust, ignore +/// ```rust, no_run /// use dioxus::prelude::*; +/// use dioxus_desktop::Config; /// /// fn main() { /// dioxus_desktop::launch_with_props(app, AppProps { name: "asd" }, Config::default()); @@ -161,6 +163,7 @@ pub fn launch_with_props(root: Component

, props: P, cfg: Config) // iOS panics if we create a window before the event loop is started let props = Rc::new(Cell::new(Some(props))); let cfg = Rc::new(Cell::new(Some(cfg))); + let mut is_visible_before_start = true; event_loop.run(move |window_event, event_loop, control_flow| { *control_flow = ControlFlow::Wait; @@ -210,6 +213,8 @@ pub fn launch_with_props(root: Component

, props: P, cfg: Config) // Create a dom let dom = VirtualDom::new_with_props(root, props); + is_visible_before_start = cfg.window.window.visible; + let handler = create_new_window( cfg, event_loop, @@ -323,6 +328,10 @@ pub fn launch_with_props(root: Component

, props: P, cfg: Config) EventData::Ipc(msg) if msg.method() == "initialize" => { let view = webviews.get_mut(&event.1).unwrap(); send_edits(view.dom.rebuild(), &view.desktop_context.webview); + view.desktop_context + .webview + .window() + .set_visible(is_visible_before_start); } EventData::Ipc(msg) if msg.method() == "browser_open" => { diff --git a/packages/desktop/src/webview.rs b/packages/desktop/src/webview.rs index 469aa8068..6e6d26b17 100644 --- a/packages/desktop/src/webview.rs +++ b/packages/desktop/src/webview.rs @@ -13,7 +13,7 @@ pub fn build( proxy: EventLoopProxy, ) -> (WebView, WebContext) { let builder = cfg.window.clone(); - let window = builder.build(event_loop).unwrap(); + let window = builder.with_visible(false).build(event_loop).unwrap(); let file_handler = cfg.file_drop_handler.take(); let custom_head = cfg.custom_head.clone(); let index_file = cfg.custom_index.clone(); diff --git a/packages/dioxus-tui/examples/colorpicker.rs b/packages/dioxus-tui/examples/colorpicker.rs index 00f8ef7e0..01cc38cda 100644 --- a/packages/dioxus-tui/examples/colorpicker.rs +++ b/packages/dioxus-tui/examples/colorpicker.rs @@ -15,21 +15,21 @@ fn app(cx: Scope) -> Element { let mapping: DioxusElementToNodeId = cx.consume_context().unwrap(); // disable templates so that every node has an id and can be queried cx.render(rsx! { - div{ + div { width: "100%", background_color: "hsl({hue}, 70%, {brightness}%)", onmousemove: move |evt| { if let RenderReturn::Ready(node) = cx.root_node() { - if let Some(id) = node.root_ids.borrow().get(0).cloned() { + if let Some(id) = node.root_ids.borrow().first().cloned() { let node = tui_query.get(mapping.get_node_id(id).unwrap()); - let Size{width, height} = node.size().unwrap(); + let Size { width, height } = node.size().unwrap(); let pos = evt.inner().element_coordinates(); - hue.set((pos.x as f32/width as f32)*255.0); - brightness.set((pos.y as f32/height as f32)*100.0); + hue.set((pos.x as f32 / width as f32) * 255.0); + brightness.set((pos.y as f32 / height as f32) * 100.0); } } }, - "hsl({hue}, 70%, {brightness}%)", + "hsl({hue}, 70%, {brightness}%)" } }) } diff --git a/packages/extension/src/lib.rs b/packages/extension/src/lib.rs index abcdaf598..fb9cca8a9 100644 --- a/packages/extension/src/lib.rs +++ b/packages/extension/src/lib.rs @@ -1,17 +1,39 @@ //! This file exports functions into the vscode extension -use dioxus_autofmt::FormattedBlock; +use dioxus_autofmt::{FormattedBlock, IndentOptions, IndentType}; use wasm_bindgen::prelude::*; #[wasm_bindgen] -pub fn format_rsx(raw: String) -> String { - let block = dioxus_autofmt::fmt_block(&raw, 0); +pub fn format_rsx(raw: String, use_tabs: bool, indent_size: usize) -> String { + let block = dioxus_autofmt::fmt_block( + &raw, + 0, + IndentOptions::new( + if use_tabs { + IndentType::Tabs + } else { + IndentType::Spaces + }, + indent_size, + ), + ); block.unwrap() } #[wasm_bindgen] -pub fn format_selection(raw: String) -> String { - let block = dioxus_autofmt::fmt_block(&raw, 0); +pub fn format_selection(raw: String, use_tabs: bool, indent_size: usize) -> String { + let block = dioxus_autofmt::fmt_block( + &raw, + 0, + IndentOptions::new( + if use_tabs { + IndentType::Tabs + } else { + IndentType::Spaces + }, + indent_size, + ), + ); block.unwrap() } @@ -35,8 +57,18 @@ impl FormatBlockInstance { } #[wasm_bindgen] -pub fn format_file(contents: String) -> FormatBlockInstance { - let _edits = dioxus_autofmt::fmt_file(&contents); +pub fn format_file(contents: String, use_tabs: bool, indent_size: usize) -> FormatBlockInstance { + let _edits = dioxus_autofmt::fmt_file( + &contents, + IndentOptions::new( + if use_tabs { + IndentType::Tabs + } else { + IndentType::Spaces + }, + indent_size, + ), + ); let out = dioxus_autofmt::apply_formats(&contents, _edits.clone()); FormatBlockInstance { new: out, _edits } } diff --git a/packages/extension/src/main.ts b/packages/extension/src/main.ts index fc12457ad..76b7261f1 100644 --- a/packages/extension/src/main.ts +++ b/packages/extension/src/main.ts @@ -90,7 +90,13 @@ function fmtDocument(document: vscode.TextDocument) { if (!editor) return; // Need an editor to apply text edits. const contents = editor.document.getText(); - const formatted = dioxus.format_file(contents); + let tabSize: number; + if (typeof editor.options.tabSize === 'number') { + tabSize = editor.options.tabSize; + } else { + tabSize = 4; + } + const formatted = dioxus.format_file(contents, !editor.options.insertSpaces, tabSize); // Replace the entire text document // Yes, this is a bit heavy handed, but the dioxus side doesn't know the line/col scheme that vscode is using diff --git a/packages/fermi/src/hooks/atom_root.rs b/packages/fermi/src/hooks/atom_root.rs index 24fd70093..468f5f980 100644 --- a/packages/fermi/src/hooks/atom_root.rs +++ b/packages/fermi/src/hooks/atom_root.rs @@ -7,6 +7,6 @@ use dioxus_core::ScopeState; pub fn use_atom_root(cx: &ScopeState) -> &Rc { cx.use_hook(|| match cx.consume_context::>() { Some(root) => root, - None => panic!("No atom root found in context. Did you forget place an AtomRoot component at the top of your app?"), + None => panic!("No atom root found in context. Did you forget to call use_init_atom_root at the top of your app?"), }) } diff --git a/packages/fermi/src/hooks/state.rs b/packages/fermi/src/hooks/state.rs index d4ebc529c..7d473588a 100644 --- a/packages/fermi/src/hooks/state.rs +++ b/packages/fermi/src/hooks/state.rs @@ -86,7 +86,9 @@ impl AtomState { /// ``` #[must_use] pub fn current(&self) -> Rc { - self.value.as_ref().unwrap().clone() + let atoms = self.root.atoms.borrow(); + let slot = atoms.get(&self.id).unwrap(); + slot.value.clone().downcast().unwrap() } /// Get the `setter` function directly without the `AtomState` wrapper. diff --git a/packages/fermi/src/lib.rs b/packages/fermi/src/lib.rs index 52bf4cd09..dc5ccf010 100644 --- a/packages/fermi/src/lib.rs +++ b/packages/fermi/src/lib.rs @@ -22,8 +22,6 @@ mod atoms { pub use atom::*; pub use atomfamily::*; pub use atomref::*; - pub use selector::*; - pub use selectorfamily::*; } pub mod hooks { diff --git a/packages/fullstack/Cargo.toml b/packages/fullstack/Cargo.toml index 8ab213e78..8de27a9b1 100644 --- a/packages/fullstack/Cargo.toml +++ b/packages/fullstack/Cargo.toml @@ -11,7 +11,7 @@ keywords = ["ui", "gui", "react", "ssr", "fullstack"] [dependencies] # server functions -server_fn = { version = "0.4.6", default-features = false } +server_fn = { version = "0.5.2", default-features = false } dioxus_server_macro = { workspace = true } # warp diff --git a/packages/fullstack/examples/axum-hello-world/src/main.rs b/packages/fullstack/examples/axum-hello-world/src/main.rs index 8f1d3c8c6..64e5b44a0 100644 --- a/packages/fullstack/examples/axum-hello-world/src/main.rs +++ b/packages/fullstack/examples/axum-hello-world/src/main.rs @@ -24,6 +24,7 @@ fn app(cx: Scope) -> Element { let mut count = use_state(cx, || 0); let text = use_state(cx, || "...".to_string()); + let eval = use_eval(cx); cx.render(rsx! { div { diff --git a/packages/fullstack/src/adapters/axum_adapter.rs b/packages/fullstack/src/adapters/axum_adapter.rs index 95d9ee6cd..41a7c92be 100644 --- a/packages/fullstack/src/adapters/axum_adapter.rs +++ b/packages/fullstack/src/adapters/axum_adapter.rs @@ -369,15 +369,65 @@ fn apply_request_parts_to_response( } } -/// SSR renderer handler for Axum -pub async fn render_handler( - State((cfg, ssr_state)): State<(ServeConfig

, SSRState)>, +/// SSR renderer handler for Axum with added context injection. +/// +/// # Example +/// ```rust,no_run +/// #![allow(non_snake_case)] +/// use std::sync::{Arc, Mutex}; +/// +/// use axum::routing::get; +/// use dioxus::prelude::*; +/// use dioxus_fullstack::{axum_adapter::render_handler_with_context, prelude::*}; +/// +/// fn app(cx: Scope) -> Element { +/// render! { +/// "hello!" +/// } +/// } +/// +/// #[tokio::main] +/// async fn main() { +/// let cfg = ServeConfigBuilder::new(app, ()) +/// .assets_path("dist") +/// .build(); +/// let ssr_state = SSRState::new(&cfg); +/// +/// // This could be any state you want to be accessible from your server +/// // functions using `[DioxusServerContext::get]`. +/// let state = Arc::new(Mutex::new("state".to_string())); +/// +/// let addr = std::net::SocketAddr::from(([127, 0, 0, 1], 8080)); +/// axum::Server::bind(&addr) +/// .serve( +/// axum::Router::new() +/// // Register server functions, etc. +/// // Note you probably want to use `register_server_fns_with_handler` +/// // to inject the context into server functions running outside +/// // of an SSR render context. +/// .fallback(get(render_handler_with_context).with_state(( +/// move |ctx| ctx.insert(state.clone()).unwrap(), +/// cfg, +/// ssr_state, +/// ))) +/// .into_make_service(), +/// ) +/// .await +/// .unwrap(); +/// } +/// ``` +pub async fn render_handler_with_context< + P: Clone + serde::Serialize + Send + Sync + 'static, + F: FnMut(&mut DioxusServerContext), +>( + State((mut inject_context, cfg, ssr_state)): State<(F, ServeConfig

, SSRState)>, request: Request, ) -> impl IntoResponse { let (parts, _) = request.into_parts(); let url = parts.uri.path_and_query().unwrap().to_string(); let parts: Arc> = Arc::new(RwLock::new(parts.into())); - let server_context = DioxusServerContext::new(parts.clone()); + let mut server_context = DioxusServerContext::new(parts.clone()); + inject_context(&mut server_context); match ssr_state.render(url, &cfg, &server_context).await { Ok(rendered) => { @@ -395,6 +445,14 @@ pub async fn render_handler } } +/// SSR renderer handler for Axum +pub async fn render_handler( + State((cfg, ssr_state)): State<(ServeConfig

, SSRState)>, + request: Request, +) -> impl IntoResponse { + render_handler_with_context(State((|_: &mut _| (), cfg, ssr_state)), request).await +} + fn report_err(e: E) -> Response { Response::builder() .status(StatusCode::INTERNAL_SERVER_ERROR) diff --git a/packages/fullstack/src/adapters/mod.rs b/packages/fullstack/src/adapters/mod.rs index 98d190919..d368b9c73 100644 --- a/packages/fullstack/src/adapters/mod.rs +++ b/packages/fullstack/src/adapters/mod.rs @@ -89,26 +89,26 @@ impl Service for ServerFnHandler { let parts = Arc::new(RwLock::new(parts)); // Because the future returned by `server_fn_handler` is `Send`, and the future returned by this function must be send, we need to spawn a new runtime - let (resp_tx, resp_rx) = tokio::sync::oneshot::channel(); let pool = get_local_pool(); - pool.spawn_pinned({ - let function = function.clone(); - let mut server_context = server_context.clone(); - server_context.parts = parts; - move || async move { - let data = match function.encoding() { - Encoding::Url | Encoding::Cbor => &body, - Encoding::GetJSON | Encoding::GetCBOR => &query, - }; - let server_function_future = function.call((), data); - let server_function_future = - ProvideServerContext::new(server_function_future, server_context.clone()); - let resp = server_function_future.await; - - resp_tx.send(resp).unwrap(); - } - }); - let result = resp_rx.await.unwrap(); + let result = pool + .spawn_pinned({ + let function = function.clone(); + let mut server_context = server_context.clone(); + server_context.parts = parts; + move || async move { + let data = match function.encoding() { + Encoding::Url | Encoding::Cbor => &body, + Encoding::GetJSON | Encoding::GetCBOR => &query, + }; + let server_function_future = function.call((), data); + let server_function_future = ProvideServerContext::new( + server_function_future, + server_context.clone(), + ); + server_function_future.await + } + }) + .await?; let mut res = http::Response::builder(); // Set the headers from the server context diff --git a/packages/fullstack/src/layer.rs b/packages/fullstack/src/layer.rs index 10e67b3f5..60f76107b 100644 --- a/packages/fullstack/src/layer.rs +++ b/packages/fullstack/src/layer.rs @@ -3,7 +3,9 @@ use tracing_futures::Instrument; use http::{Request, Response}; +/// A layer that wraps a service. This can be used to add additional information to the request, or response on top of some other service pub trait Layer: Send + Sync + 'static { + /// Wrap a boxed service with this layer fn layer(&self, inner: BoxedService) -> BoxedService; } @@ -17,7 +19,9 @@ where } } +/// A service is a function that takes a request and returns an async response pub trait Service { + /// Run the service and produce a future that resolves to a response fn run( &mut self, req: http::Request, @@ -55,6 +59,7 @@ where } } +/// A boxed service is a type-erased service that can be used without knowing the underlying type pub struct BoxedService(pub Box); impl tower::Service> for BoxedService { diff --git a/packages/fullstack/src/lib.rs b/packages/fullstack/src/lib.rs index 1fe7504f1..7ef582da1 100644 --- a/packages/fullstack/src/lib.rs +++ b/packages/fullstack/src/lib.rs @@ -40,6 +40,8 @@ pub mod prelude { #[cfg(not(feature = "ssr"))] pub use crate::html_storage::deserialize::get_root_props_from_document; pub use crate::launch::LaunchBuilder; + #[cfg(feature = "ssr")] + pub use crate::layer::{Layer, Service}; #[cfg(all(feature = "ssr", feature = "router"))] pub use crate::render::pre_cache_static_routes_with_props; #[cfg(feature = "ssr")] diff --git a/packages/fullstack/src/render.rs b/packages/fullstack/src/render.rs index cda41f82c..886a5bd99 100644 --- a/packages/fullstack/src/render.rs +++ b/packages/fullstack/src/render.rs @@ -45,6 +45,8 @@ impl SsrRendererPool { .expect("couldn't spawn runtime") .block_on(async move { let mut vdom = VirtualDom::new_with_props(component, props); + // Make sure the evaluator is initialized + dioxus_ssr::eval::init_eval(vdom.base_scope()); let mut to = WriteBuffer { buffer: Vec::new() }; // before polling the future, we need to set the context let prev_context = diff --git a/packages/fullstack/src/router.rs b/packages/fullstack/src/router.rs index b556aa000..b8d93f0e0 100644 --- a/packages/fullstack/src/router.rs +++ b/packages/fullstack/src/router.rs @@ -53,7 +53,7 @@ fn default_external_navigation_handler() -> fn(Scope) -> Element { dioxus_router::prelude::FailureExternalNavigation } -/// The configeration for the router +/// The configuration for the router #[derive(Props, serde::Serialize, serde::Deserialize)] pub struct FullstackRouterConfig where diff --git a/packages/fullstack/src/server_fn.rs b/packages/fullstack/src/server_fn.rs index 539a0d70a..fd0639372 100644 --- a/packages/fullstack/src/server_fn.rs +++ b/packages/fullstack/src/server_fn.rs @@ -125,14 +125,6 @@ impl server_fn::ServerFunctionRegistry<()> for DioxusServerFnRegistry { } } - fn register( - url: &'static str, - server_function: ServerFunction, - encoding: server_fn::Encoding, - ) -> Result<(), Self::Error> { - Self::register_explicit("", url, server_function, encoding) - } - /// Returns the server function registered at the given URL, or `None` if no function is registered at that URL. fn get(url: &str) -> Option> { REGISTERED_SERVER_FUNCTIONS diff --git a/packages/generational-box/Cargo.toml b/packages/generational-box/Cargo.toml index 5567e9ccc..1bc298e25 100644 --- a/packages/generational-box/Cargo.toml +++ b/packages/generational-box/Cargo.toml @@ -1,9 +1,12 @@ [package] name = "generational-box" authors = ["Evan Almloff"] -version = "0.0.0" +version = "0.4.3" edition = "2018" - +description = "A box backed by a generational runtime" +license = "MIT OR Apache-2.0" +repository = "https://github.com/DioxusLabs/dioxus/" +keywords = ["generational", "box", "memory", "allocator"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] @@ -17,6 +20,8 @@ criterion = "0.3" [features] default = ["check_generation"] check_generation = [] +debug_borrows = [] +debug_ownership = [] [[bench]] name = "lock" diff --git a/packages/generational-box/README.md b/packages/generational-box/README.md index 7d3088eda..95aab8402 100644 --- a/packages/generational-box/README.md +++ b/packages/generational-box/README.md @@ -11,6 +11,8 @@ Three main types manage state in Generational Box: Example: ```rust +use generational_box::Store; + // Create a store for this thread let store = Store::default(); diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 692af76b0..293bf6c5b 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -4,12 +4,16 @@ use parking_lot::{ MappedRwLockReadGuard, MappedRwLockWriteGuard, Mutex, RwLock, RwLockReadGuard, RwLockWriteGuard, }; +use std::any::Any; +use std::error::Error; +use std::fmt::Display; +use std::sync::atomic::AtomicU32; use std::{ cell::{Ref, RefCell, RefMut}, fmt::Debug, marker::PhantomData, ops::{Deref, DerefMut}, - sync::{atomic::AtomicU32, Arc, OnceLock}, + sync::{Arc, OnceLock}, }; /// # Example @@ -52,7 +56,10 @@ fn leaking_is_ok() { // don't drop the owner std::mem::forget(owner); } - assert_eq!(key.try_read().as_deref(), Some(&"hello world".to_string())); + assert_eq!( + key.try_read().as_deref().unwrap(), + &"hello world".to_string() + ); } #[test] @@ -66,7 +73,7 @@ fn drops() { key = owner.insert(data); // drop the owner } - assert!(key.try_read().is_none()); + assert!(key.try_read().is_err()); } #[test] @@ -123,7 +130,7 @@ fn fuzz() { println!("{:?}", path); for key in valid_keys.iter() { let value = key.read(); - println!("{:?}", value); + println!("{:?}", &*value); assert!(value.starts_with("hello world")); } #[cfg(any(debug_assertions, feature = "check_generation"))] @@ -164,10 +171,12 @@ impl Debug for GenerationalBoxId { } /// The core Copy state type. The generational box will be dropped when the [Owner] is dropped. -pub struct GenerationalBox { +pub struct GenerationalBox { raw: MemoryLocation, #[cfg(any(debug_assertions, feature = "check_generation"))] generation: u32, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, _marker: PhantomData, } @@ -176,11 +185,11 @@ impl Debug for GenerationalBox { #[cfg(any(debug_assertions, feature = "check_generation"))] f.write_fmt(format_args!( "{:?}@{:?}", - self.raw.data.data_ptr(), + self.raw.0.data.data_ptr(), self.generation ))?; #[cfg(not(any(debug_assertions, feature = "check_generation")))] - f.write_fmt(format_args!("{:?}", self.raw.data.as_ptr()))?; + f.write_fmt(format_args!("{:?}", self.raw.0.data.as_ptr()))?; Ok(()) } } @@ -191,6 +200,7 @@ impl> GenerationalBox { #[cfg(any(debug_assertions, feature = "check_generation"))] { self.raw + .0 .generation .load(std::sync::atomic::Ordering::Relaxed) == self.generation @@ -204,28 +214,54 @@ impl> GenerationalBox { /// Get the id of the generational box. pub fn id(&self) -> GenerationalBoxId { GenerationalBoxId { - data_ptr: self.raw.data.data_ptr(), + data_ptr: self.raw.0.data.data_ptr(), #[cfg(any(debug_assertions, feature = "check_generation"))] generation: self.generation, } } /// Try to read the value. Returns None if the value is no longer valid. - pub fn try_read(&self) -> Option { - self.validate().then(|| self.raw.data.try_read()).flatten() + #[track_caller] + pub fn try_read(&self) -> Result { + if !self.validate() { + return Err(BorrowError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + created_at: self.created_at, + })); + } + self.raw.0.data.try_read().ok_or_else(|| { + BorrowError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: self.created_at, + }) + }) } /// Read the value. Panics if the value is no longer valid. + #[track_caller] pub fn read(&self) -> S::Ref { self.try_read().unwrap() } /// Try to write the value. Returns None if the value is no longer valid. - pub fn try_write(&self) -> Option where { - self.validate().then(|| self.raw.data.try_write()).flatten() + #[track_caller] + pub fn try_write(&self) -> Result { + if !self.validate() { + return Err(BorrowMutError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + created_at: self.created_at, + })); + } + self.raw.0.data.try_write().ok_or_else(|| { + BorrowMutError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: self.created_at, + }) + }) } /// Write the value. Panics if the value is no longer valid. + #[track_caller] pub fn write(&self) -> S::Mut { self.try_write().unwrap() } @@ -233,7 +269,7 @@ impl> GenerationalBox { /// Set the value. Panics if the value is no longer valid. pub fn set(&self, value: T) { self.validate().then(|| { - self.raw.data.set(value); + self.raw.0.data.set(value); }); } @@ -241,7 +277,7 @@ impl> GenerationalBox { pub fn ptr_eq(&self, other: &Self) -> bool { #[cfg(any(debug_assertions, feature = "check_generation"))] { - self.raw.data.data_ptr() == other.raw.data.data_ptr() + self.raw.0.data.data_ptr() == other.raw.0.data.data_ptr() && self.generation == other.generation } #[cfg(not(any(debug_assertions, feature = "check_generation")))] @@ -251,7 +287,7 @@ impl> GenerationalBox { } } -impl Copy for GenerationalBox {} +impl Copy for GenerationalBox {} impl Clone for GenerationalBox { fn clone(&self) -> Self { @@ -260,12 +296,11 @@ impl Clone for GenerationalBox { } /// A unsync storage. This is the default storage type. -#[derive(Clone, Copy)] -pub struct UnsyncStorage(&'static RefCell>>); +pub struct UnsyncStorage(RefCell>>); impl Default for UnsyncStorage { fn default() -> Self { - Self(Box::leak(Box::new(RefCell::new(None)))) + Self(RefCell::new(None)) } } @@ -370,7 +405,7 @@ impl MappableMut for MappedRwLockWriteGuard<'static, T> { } /// A trait for a storage backing type. (RefCell, RwLock, etc.) -pub trait Storage: Copy + AnyStorage + 'static { +pub trait Storage: AnyStorage + 'static { /// The reference this storage type returns. type Ref: Mappable + Deref; /// The mutable reference this storage type returns. @@ -453,11 +488,17 @@ impl AnyStorage for UnsyncStorage { if let Some(location) = runtime.borrow_mut().pop() { location } else { - MemoryLocation { - data: UnsyncStorage(Box::leak(Box::new(RefCell::new(None)))), - #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: Box::leak(Box::default()), - } + let data: &'static MemoryLocationInner = + &*Box::leak(Box::new(MemoryLocationInner { + data: Self::default(), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: 0.into(), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_at: Default::default(), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_mut_at: Default::default(), + })); + MemoryLocation(data) } }) } @@ -501,11 +542,19 @@ impl AnyStorage for SyncStorage { } fn claim() -> MemoryLocation { - MemoryLocation { - data: SyncStorage(Box::leak(Box::new(RwLock::new(None)))), - #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: Box::leak(Box::default()), - } + sync_runtime().lock().pop().unwrap_or_else(|| { + let data: &'static MemoryLocationInner = + &*Box::leak(Box::new(MemoryLocationInner { + data: Self::default(), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: 0.into(), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_at: Default::default(), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_mut_at: Default::default(), + })); + MemoryLocation(data) + }) } fn recycle(location: &MemoryLocation) { @@ -514,12 +563,17 @@ impl AnyStorage for SyncStorage { } } -/// A memory location. This is the core type that is used to store values. #[derive(Clone, Copy)] -pub struct MemoryLocation { +struct MemoryLocation(&'static MemoryLocationInner); + +struct MemoryLocationInner { data: S, #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: &'static AtomicU32, + generation: AtomicU32, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_at: RwLock>>, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_mut_at: RwLock>>, } impl MemoryLocation { @@ -528,47 +582,383 @@ impl MemoryLocation { where S: AnyStorage, { - let old = self.data.take(); + let old = self.0.data.take(); #[cfg(any(debug_assertions, feature = "check_generation"))] if old { - let new_generation = self.generation.load(std::sync::atomic::Ordering::Relaxed) + 1; - self.generation + let new_generation = self.0.generation.load(std::sync::atomic::Ordering::Relaxed) + 1; + self.0 + .generation .store(new_generation, std::sync::atomic::Ordering::Relaxed); } } - fn replace(&mut self, value: T) -> GenerationalBox + fn replace_with_caller( + &mut self, + value: T, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + caller: &'static std::panic::Location<'static>, + ) -> GenerationalBox where - S: Storage + Copy, + S: Storage, { - self.data.set(value); + self.0.data.set(value); GenerationalBox { raw: *self, #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: self.generation.load(std::sync::atomic::Ordering::Relaxed), + generation: self.0.generation.load(std::sync::atomic::Ordering::Relaxed), + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: caller, _marker: PhantomData, } } + + #[track_caller] + fn try_borrow( + &self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + ) -> Result, BorrowError> + where + S: Storage, + { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + self.0 + .borrowed_at + .write() + .push(std::panic::Location::caller()); + match self.0.data.try_read() { + Some(borrow) => { + match Ref::filter_map(borrow, |any| any.as_ref()?.downcast_ref::()) { + Ok(reference) => Ok(GenerationalRef { + inner: reference, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo { + borrowed_at: std::panic::Location::caller(), + borrowed_from: self.0, + }, + }), + Err(_) => Err(BorrowError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at, + })), + } + } + None => Err(BorrowError::AlreadyBorrowedMut(AlreadyBorrowedMutError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_mut_at: self.0.borrowed_mut_at.read().unwrap(), + })), + } + } + + #[track_caller] + fn try_borrow_mut( + &self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + ) -> Result, BorrowMutError> { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + { + self.0.borrowed_mut_at.write().unwrap() = Some(std::panic::Location::caller()); + } + match self.0.data.try_borrow_mut() { + Ok(borrow_mut) => { + match RefMut::filter_map(borrow_mut, |any| any.as_mut()?.downcast_mut::()) { + Ok(reference) => Ok(GenerationalRefMut { + inner: reference, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefMutBorrowInfo { + borrowed_from: self.0, + }, + }), + Err(_) => Err(BorrowMutError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at, + })), + } + } + Err(_) => Err(BorrowMutError::AlreadyBorrowed(AlreadyBorrowedError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_at: self.0.borrowed_at.read().clone(), + })), + } + } +} + +#[derive(Debug, Clone)] +/// An error that can occur when trying to borrow a value. +pub enum BorrowError { + /// The value was dropped. + Dropped(ValueDroppedError), + /// The value was already borrowed mutably. + AlreadyBorrowedMut(AlreadyBorrowedMutError), +} + +impl Display for BorrowError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + BorrowError::Dropped(error) => Display::fmt(error, f), + BorrowError::AlreadyBorrowedMut(error) => Display::fmt(error, f), + } + } +} + +impl Error for BorrowError {} + +#[derive(Debug, Clone)] +/// An error that can occur when trying to borrow a value mutably. +pub enum BorrowMutError { + /// The value was dropped. + Dropped(ValueDroppedError), + /// The value was already borrowed. + AlreadyBorrowed(AlreadyBorrowedError), + /// The value was already borrowed mutably. + AlreadyBorrowedMut(AlreadyBorrowedMutError), +} + +impl Display for BorrowMutError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + BorrowMutError::Dropped(error) => Display::fmt(error, f), + BorrowMutError::AlreadyBorrowedMut(error) => Display::fmt(error, f), + BorrowMutError::AlreadyBorrowed(error) => Display::fmt(error, f), + } + } +} + +impl Error for BorrowMutError {} + +/// An error that can occur when trying to use a value that has been dropped. +#[derive(Debug, Copy, Clone)] +pub struct ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, +} + +impl Display for ValueDroppedError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("Failed to borrow because the value was dropped.")?; + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + f.write_fmt(format_args!("created_at: {}", self.created_at))?; + Ok(()) + } +} + +impl std::error::Error for ValueDroppedError {} + +/// An error that can occur when trying to borrow a value that has already been borrowed mutably. +#[derive(Debug, Copy, Clone)] +pub struct AlreadyBorrowedMutError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_mut_at: &'static std::panic::Location<'static>, +} + +impl Display for AlreadyBorrowedMutError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("Failed to borrow because the value was already borrowed mutably.")?; + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + f.write_fmt(format_args!("borrowed_mut_at: {}", self.borrowed_mut_at))?; + Ok(()) + } +} + +impl std::error::Error for AlreadyBorrowedMutError {} + +/// An error that can occur when trying to borrow a value mutably that has already been borrowed immutably. +#[derive(Debug, Clone)] +pub struct AlreadyBorrowedError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_at: Vec<&'static std::panic::Location<'static>>, +} + +impl Display for AlreadyBorrowedError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("Failed to borrow mutably because the value was already borrowed immutably.")?; + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + f.write_str("borrowed_at:")?; + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + for location in self.borrowed_at.iter() { + f.write_fmt(format_args!("\t{}", location))?; + } + Ok(()) + } +} + +impl std::error::Error for AlreadyBorrowedError {} + +/// A reference to a value in a generational box. +pub struct GenerationalRef { + inner: Ref<'static, T>, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo, +} + +impl GenerationalRef { + /// Map one ref type to another. + pub fn map(orig: GenerationalRef, f: F) -> GenerationalRef + where + F: FnOnce(&T) -> &U, + { + GenerationalRef { + inner: Ref::map(orig.inner, f), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo { + borrowed_at: orig.borrow.borrowed_at, + borrowed_from: orig.borrow.borrowed_from, + }, + } + } + + /// Filter one ref type to another. + pub fn filter_map(orig: GenerationalRef, f: F) -> Option> + where + F: FnOnce(&T) -> Option<&U>, + { + let Self { + inner, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + } = orig; + Ref::filter_map(inner, f).ok().map(|inner| GenerationalRef { + inner, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo { + borrowed_at: borrow.borrowed_at, + borrowed_from: borrow.borrowed_from, + }, + }) + } +} + +impl Deref for GenerationalRef { + type Target = T; + + fn deref(&self) -> &Self::Target { + self.inner.deref() + } +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +struct GenerationalRefBorrowInfo { + borrowed_at: &'static std::panic::Location<'static>, + borrowed_from: &'static MemoryLocationInner, +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +impl Drop for GenerationalRefBorrowInfo { + fn drop(&mut self) { + self.borrowed_from + .borrowed_at + .borrow_mut() + .retain(|location| std::ptr::eq(*location, self.borrowed_at as *const _)); + } +} + +/// A mutable reference to a value in a generational box. +pub struct GenerationalRefMut { + inner: RefMut<'static, T>, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefMutBorrowInfo, +} + +impl GenerationalRefMut { + /// Map one ref type to another. + pub fn map(orig: GenerationalRefMut, f: F) -> GenerationalRefMut + where + F: FnOnce(&mut T) -> &mut U, + { + GenerationalRefMut { + inner: RefMut::map(orig.inner, f), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: orig.borrow, + } + } + + /// Filter one ref type to another. + pub fn filter_map(orig: GenerationalRefMut, f: F) -> Option> + where + F: FnOnce(&mut T) -> Option<&mut U>, + { + let Self { + inner, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + } = orig; + RefMut::filter_map(inner, f) + .ok() + .map(|inner| GenerationalRefMut { + inner, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + }) + } +} + +impl Deref for GenerationalRefMut { + type Target = T; + + fn deref(&self) -> &Self::Target { + self.inner.deref() + } +} + +impl DerefMut for GenerationalRefMut { + fn deref_mut(&mut self) -> &mut Self::Target { + self.inner.deref_mut() + } +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +struct GenerationalRefMutBorrowInfo { + borrowed_from: &'static MemoryLocationInner, +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +impl Drop for GenerationalRefMutBorrowInfo { + fn drop(&mut self) { + self.borrowed_from.borrowed_mut_at.take(); + } } /// Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped. -pub struct Owner { +pub struct Owner { owned: Arc>>>, phantom: PhantomData, } impl Owner { /// Insert a value into the store. The value will be dropped when the owner is dropped. + #[track_caller] pub fn insert(&self, value: T) -> GenerationalBox where S: Storage, { let mut location = S::claim(); - let key = location.replace(value); + let key = location.replace_with_caller( + value, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + std::panic::Location::caller(), + ); self.owned.lock().push(location); key } + /// Insert a value into the store with a specific location blamed for creating the value. The value will be dropped when the owner is dropped. + pub fn insert_with_caller( + &self, + value: T, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + caller: &'static std::panic::Location<'static>, + ) -> GenerationalBox { + let mut location = self.store.claim(); + let key = location.replace_with_caller( + value, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + caller, + ); + self.owned.borrow_mut().push(location); + key + } + /// Creates an invalid handle. This is useful for creating a handle that will be filled in later. If you use this before the value is filled in, you will get may get a panic or an out of date value. pub fn invalid(&self) -> GenerationalBox { let location = S::claim(); @@ -576,8 +966,11 @@ impl Owner { raw: location, #[cfg(any(debug_assertions, feature = "check_generation"))] generation: location + .0 .generation .load(std::sync::atomic::Ordering::Relaxed), + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: std::panic::Location::caller(), _marker: PhantomData, } } diff --git a/packages/hooks/src/lib.rs b/packages/hooks/src/lib.rs index a5b92a036..8178d4d3d 100644 --- a/packages/hooks/src/lib.rs +++ b/packages/hooks/src/lib.rs @@ -60,6 +60,9 @@ pub mod computed; mod use_on_destroy; pub use use_on_destroy::*; +mod use_const; +pub use use_const::*; + mod use_context; pub use use_context::*; diff --git a/packages/hooks/src/use_const.rs b/packages/hooks/src/use_const.rs new file mode 100644 index 000000000..47ddb1ed2 --- /dev/null +++ b/packages/hooks/src/use_const.rs @@ -0,0 +1,76 @@ +use std::rc::Rc; + +use dioxus_core::prelude::*; + +/// Store constant state between component renders. +/// +/// UseConst allows you to store state that is initialized once and then remains constant across renders. +/// You can only get an immutable reference after initalization. +/// This can be useful for values that don't need to update reactively, thus can be memoized easily +/// +/// ```rust, ignore +/// struct ComplexData(i32); +/// +/// fn Component(cx: Scope) -> Element { +/// let id = use_const(cx, || ComplexData(100)); +/// +/// cx.render(rsx! { +/// div { "{id.0}" } +/// }) +/// } +/// ``` +#[must_use] +pub fn use_const( + cx: &ScopeState, + initial_state_fn: impl FnOnce() -> T, +) -> &UseConst { + cx.use_hook(|| UseConst { + value: Rc::new(initial_state_fn()), + }) +} + +#[derive(Clone)] +pub struct UseConst { + value: Rc, +} + +impl PartialEq for UseConst { + fn eq(&self, other: &Self) -> bool { + Rc::ptr_eq(&self.value, &other.value) + } +} + +impl core::fmt::Display for UseConst { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + self.value.fmt(f) + } +} + +impl UseConst { + pub fn get_rc(&self) -> &Rc { + &self.value + } +} + +impl std::ops::Deref for UseConst { + type Target = T; + + fn deref(&self) -> &Self::Target { + self.value.as_ref() + } +} + +#[test] +fn use_const_makes_sense() { + #[allow(unused)] + + fn app(cx: Scope) -> Element { + let const_val = use_const(cx, || vec![0, 1, 2, 3]); + + assert!(const_val[0] == 0); + + // const_val.remove(0); // Cannot Compile, cannot get mutable reference now + + None + } +} diff --git a/packages/hooks/src/use_effect.rs b/packages/hooks/src/use_effect.rs index e72afe27f..6fb2fcf9e 100644 --- a/packages/hooks/src/use_effect.rs +++ b/packages/hooks/src/use_effect.rs @@ -1,5 +1,10 @@ use dioxus_core::{ScopeState, TaskId}; -use std::{any::Any, cell::Cell, future::Future}; +use std::{ + any::Any, + cell::{Cell, RefCell}, + future::Future, + rc::Rc, +}; use crate::UseFutureDep; @@ -14,7 +19,7 @@ use crate::UseFutureDep; /// ## Arguments /// /// - `dependencies`: a tuple of references to values that are `PartialEq` + `Clone`. -/// - `future`: a closure that takes the `dependencies` as arguments and returns a `'static` future. +/// - `future`: a closure that takes the `dependencies` as arguments and returns a `'static` future. That future may return nothing or a closure that will be executed when the dependencies change to clean up the effect. /// /// ## Examples /// @@ -33,6 +38,16 @@ use crate::UseFutureDep; /// } /// }); /// +/// // Only fetch the user data when the id changes. +/// use_effect(cx, (id,), |(id,)| { +/// to_owned![name]; +/// async move { +/// let user = fetch_user(id).await; +/// name.set(user.name); +/// move || println!("Cleaning up from {}", id) +/// } +/// }); +/// /// let name = name.get().clone().unwrap_or("Loading...".to_string()); /// /// render!( @@ -45,34 +60,80 @@ use crate::UseFutureDep; /// render!(Profile { id: 0 }) /// } /// ``` -pub fn use_effect(cx: &ScopeState, dependencies: D, future: impl FnOnce(D::Out) -> F) +pub fn use_effect(cx: &ScopeState, dependencies: D, future: impl FnOnce(D::Out) -> R) where - T: 'static, - F: Future + 'static, D: UseFutureDep, + R: UseEffectReturn, { struct UseEffect { needs_regen: bool, task: Cell>, dependencies: Vec>, + cleanup: UseEffectCleanup, + } + + impl Drop for UseEffect { + fn drop(&mut self) { + if let Some(cleanup) = self.cleanup.borrow_mut().take() { + cleanup(); + } + } } let state = cx.use_hook(move || UseEffect { needs_regen: true, task: Cell::new(None), dependencies: Vec::new(), + cleanup: Rc::new(RefCell::new(None)), }); if dependencies.clone().apply(&mut state.dependencies) || state.needs_regen { + // Call the cleanup function if it exists + if let Some(cleanup) = state.cleanup.borrow_mut().take() { + cleanup(); + } + // We don't need regen anymore state.needs_regen = false; // Create the new future - let fut = future(dependencies.out()); + let return_value = future(dependencies.out()); - state.task.set(Some(cx.push_future(async move { - fut.await; - }))); + if let Some(task) = return_value.apply(state.cleanup.clone(), cx) { + state.task.set(Some(task)); + } + } +} + +type UseEffectCleanup = Rc>>>; + +/// Something that can be returned from a `use_effect` hook. +pub trait UseEffectReturn { + fn apply(self, oncleanup: UseEffectCleanup, cx: &ScopeState) -> Option; +} + +impl UseEffectReturn<()> for T +where + T: Future + 'static, +{ + fn apply(self, _: UseEffectCleanup, cx: &ScopeState) -> Option { + Some(cx.push_future(self)) + } +} + +#[doc(hidden)] +pub struct CleanupFutureMarker; +impl UseEffectReturn for T +where + T: Future + 'static, + F: FnOnce() + 'static, +{ + fn apply(self, oncleanup: UseEffectCleanup, cx: &ScopeState) -> Option { + let task = cx.push_future(async move { + let cleanup = self.await; + *oncleanup.borrow_mut() = Some(Box::new(cleanup) as Box); + }); + Some(task) } } diff --git a/packages/hooks/src/use_future.rs b/packages/hooks/src/use_future.rs index 67bcdc74e..b9aa20c31 100644 --- a/packages/hooks/src/use_future.rs +++ b/packages/hooks/src/use_future.rs @@ -31,13 +31,14 @@ where let state = cx.use_hook(move || UseFuture { update: cx.schedule_update(), - needs_regen: Cell::new(true), + needs_regen: Rc::new(Cell::new(true)), state: val.clone(), task: Default::default(), - dependencies: Vec::new(), }); - if dependencies.clone().apply(&mut state.dependencies) || state.needs_regen.get() { + let state_dependencies = cx.use_hook(Vec::new); + + if dependencies.clone().apply(state_dependencies) || state.needs_regen.get() { // kill the old one, if it exists if let Some(task) = state.task.take() { cx.remove_future(task); @@ -69,11 +70,11 @@ pub enum FutureState<'a, T> { Regenerating(&'a T), // the old value } +#[derive(Clone)] pub struct UseFuture { update: Arc, - needs_regen: Cell, + needs_regen: Rc>, task: Rc>>, - dependencies: Vec>, state: UseState>, } diff --git a/packages/hooks/src/use_shared_state.rs b/packages/hooks/src/use_shared_state.rs index 37226c759..0c0f43508 100644 --- a/packages/hooks/src/use_shared_state.rs +++ b/packages/hooks/src/use_shared_state.rs @@ -26,6 +26,7 @@ macro_rules! debug_location { } pub mod error { + #[cfg(debug_assertions)] fn locations_display(locations: &[&'static std::panic::Location<'static>]) -> String { locations .iter() diff --git a/packages/hot-reload/src/file_watcher.rs b/packages/hot-reload/src/file_watcher.rs index 2509dd789..0323561fe 100644 --- a/packages/hot-reload/src/file_watcher.rs +++ b/packages/hot-reload/src/file_watcher.rs @@ -122,7 +122,7 @@ pub fn init(cfg: Config) { } = cfg; if let Ok(crate_dir) = PathBuf::from_str(root_path) { - // try to find the gitingore file + // try to find the gitignore file let gitignore_file_path = crate_dir.join(".gitignore"); let (gitignore, _) = ignore::gitignore::Gitignore::new(gitignore_file_path); @@ -152,21 +152,20 @@ pub fn init(cfg: Config) { } let file_map = Arc::new(Mutex::new(file_map)); + let target_dir = crate_dir.join("target"); + let hot_reload_socket_path = target_dir.join("dioxusin"); + #[cfg(target_os = "macos")] { // On unix, if you force quit the application, it can leave the file socket open // This will cause the local socket listener to fail to open // We check if the file socket is already open from an old session and then delete it - let paths = ["./dioxusin", "./@dioxusin"]; - for path in paths { - let path = PathBuf::from(path); - if path.exists() { - let _ = std::fs::remove_file(path); - } + if hot_reload_socket_path.exists() { + let _ = std::fs::remove_file(hot_reload_socket_path); } } - match LocalSocketListener::bind("@dioxusin") { + match LocalSocketListener::bind(hot_reload_socket_path) { Ok(local_socket_stream) => { let aborted = Arc::new(Mutex::new(false)); diff --git a/packages/hot-reload/src/lib.rs b/packages/hot-reload/src/lib.rs index 68692b72b..46efb8341 100644 --- a/packages/hot-reload/src/lib.rs +++ b/packages/hot-reload/src/lib.rs @@ -1,4 +1,7 @@ -use std::io::{BufRead, BufReader}; +use std::{ + io::{BufRead, BufReader}, + path::PathBuf, +}; use dioxus_core::Template; #[cfg(feature = "file_watcher")] @@ -24,7 +27,8 @@ pub enum HotReloadMsg { /// Connect to the hot reloading listener. The callback provided will be called every time a template change is detected pub fn connect(mut f: impl FnMut(HotReloadMsg) + Send + 'static) { std::thread::spawn(move || { - if let Ok(socket) = LocalSocketStream::connect("@dioxusin") { + let path = PathBuf::from("./").join("target").join("dioxusin"); + if let Ok(socket) = LocalSocketStream::connect(path) { let mut buf_reader = BufReader::new(socket); loop { let mut buf = String::new(); diff --git a/packages/html/src/elements.rs b/packages/html/src/elements.rs index 6a0e546fa..a42c01950 100644 --- a/packages/html/src/elements.rs +++ b/packages/html/src/elements.rs @@ -74,7 +74,7 @@ macro_rules! impl_attribute_match { $attr:ident $fil:ident: $vil:ident (in $ns:literal), ) => { if $attr == stringify!($fil) { - return Some((stringify!(fil), Some(ns))); + return Some((stringify!(fil), Some($ns))); } }; } @@ -180,14 +180,26 @@ macro_rules! impl_element_match { }; ( - $el:ident $name:ident $namespace:tt { + $el:ident $name:ident $namespace:literal { $( $fil:ident: $vil:ident $extra:tt, )* } ) => { if $el == stringify!($name) { - return Some((stringify!($name), Some(stringify!($namespace)))); + return Some((stringify!($name), Some($namespace))); + } + }; + + ( + $el:ident $name:ident [$_:literal, $namespace:tt] { + $( + $fil:ident: $vil:ident $extra:tt, + )* + } + ) => { + if $el == stringify!($name) { + return Some((stringify!($name), Some($namespace))); } }; } @@ -207,6 +219,8 @@ macro_rules! impl_element_match_attributes { $attr $fil: $vil ($extra), ); )* + + return impl_map_global_attributes!($el $attr $name None); } }; @@ -223,10 +237,41 @@ macro_rules! impl_element_match_attributes { $attr $fil: $vil ($extra), ); )* + + return impl_map_global_attributes!($el $attr $name $namespace); } } } +#[cfg(feature = "hot-reload-context")] +macro_rules! impl_map_global_attributes { + ( + $el:ident $attr:ident $element:ident None + ) => { + map_global_attributes($attr) + }; + + ( + $el:ident $attr:ident $element:ident $namespace:literal + ) => { + if $namespace == "http://www.w3.org/2000/svg" { + map_svg_attributes($attr) + } else { + map_global_attributes($attr) + } + }; + + ( + $el:ident $attr:ident $element:ident [$name:literal, $namespace:tt] + ) => { + if $namespace == "http://www.w3.org/2000/svg" { + map_svg_attributes($attr) + } else { + map_global_attributes($attr) + } + }; +} + macro_rules! builder_constructors { ( $( @@ -254,7 +299,7 @@ macro_rules! builder_constructors { } ); )* - map_global_attributes(attribute).or_else(|| map_svg_attributes(attribute)) + None } fn map_element(element: &str) -> Option<(&'static str, Option<&'static str>)> { @@ -782,6 +827,7 @@ builder_constructors! { decoding: ImageDecoding DEFAULT, height: usize DEFAULT, ismap: Bool DEFAULT, + loading: String DEFAULT, src: Uri DEFAULT, srcset: String DEFAULT, // FIXME this is much more complicated usemap: String DEFAULT, // FIXME should be a fragment starting with '#' diff --git a/packages/html/src/global_attributes.rs b/packages/html/src/global_attributes.rs index 3792397ad..02b0b32ed 100644 --- a/packages/html/src/global_attributes.rs +++ b/packages/html/src/global_attributes.rs @@ -269,6 +269,9 @@ trait_methods! { /// azimuth: "azimuth", "style"; + /// + backdrop_filter: "backdrop-filter", "style"; + /// backface_visibility: "backface-visibility", "style"; diff --git a/packages/native-core/src/dioxus.rs b/packages/native-core/src/dioxus.rs index 3e9ff9ee0..c245de4fc 100644 --- a/packages/native-core/src/dioxus.rs +++ b/packages/native-core/src/dioxus.rs @@ -57,7 +57,12 @@ impl DioxusState { node.insert(ElementIdComponent(element_id)); if self.node_id_mapping.len() <= element_id.0 { self.node_id_mapping.resize(element_id.0 + 1, None); + } else if let Some(mut node) = + self.node_id_mapping[element_id.0].and_then(|id| node.real_dom_mut().get_mut(id)) + { + node.remove(); } + self.node_id_mapping[element_id.0] = Some(node_id); } diff --git a/packages/rink/Cargo.toml b/packages/rink/Cargo.toml index ba3d549f8..92d1eae8c 100644 --- a/packages/rink/Cargo.toml +++ b/packages/rink/Cargo.toml @@ -14,7 +14,7 @@ dioxus-html = { workspace = true } dioxus-native-core = { workspace = true, features = ["layout-attributes"] } dioxus-native-core-macro = { workspace = true } -tui = "0.17.0" +ratatui = "0.24.0" crossterm = "0.26.1" anyhow = "1.0.42" tokio = { workspace = true, features = ["full"] } diff --git a/packages/rink/src/lib.rs b/packages/rink/src/lib.rs index 2eba1b98a..4a7261b55 100644 --- a/packages/rink/src/lib.rs +++ b/packages/rink/src/lib.rs @@ -17,6 +17,7 @@ use futures::{channel::mpsc::UnboundedSender, pin_mut, Future, StreamExt}; use futures_channel::mpsc::unbounded; use layout::TaffyLayout; use prevent_default::PreventDefault; +use ratatui::{backend::CrosstermBackend, Terminal}; use std::{io, time::Duration}; use std::{ pin::Pin, @@ -26,7 +27,6 @@ use std::{rc::Rc, sync::RwLock}; use style_attributes::StyleModifier; pub use taffy::{geometry::Point, prelude::*}; use tokio::select; -use tui::{backend::CrosstermBackend, Terminal}; use widgets::{register_widgets, RinkWidgetResponder, RinkWidgetTraitObject}; mod config; @@ -180,7 +180,7 @@ pub fn render( if !to_rerender.is_empty() || updated { updated = false; - fn resize(dims: tui::layout::Rect, taffy: &mut Taffy, rdom: &RealDom) { + fn resize(dims: ratatui::layout::Rect, taffy: &mut Taffy, rdom: &RealDom) { let width = screen_to_layout_space(dims.width); let height = screen_to_layout_space(dims.height); let root_node = rdom @@ -222,7 +222,7 @@ pub fn render( } else { let rdom = rdom.read().unwrap(); resize( - tui::layout::Rect { + ratatui::layout::Rect { x: 0, y: 0, width: 1000, diff --git a/packages/rink/src/render.rs b/packages/rink/src/render.rs index 19d642720..4185f3a62 100644 --- a/packages/rink/src/render.rs +++ b/packages/rink/src/render.rs @@ -1,11 +1,10 @@ use dioxus_native_core::{prelude::*, tree::TreeRef}; -use std::io::Stdout; +use ratatui::{layout::Rect, style::Color}; use taffy::{ geometry::Point, prelude::{Dimension, Layout, Size}, Taffy, }; -use tui::{backend::CrosstermBackend, layout::Rect, style::Color}; use crate::{ focus::Focused, @@ -20,7 +19,7 @@ use crate::{ const RADIUS_MULTIPLIER: [f32; 2] = [1.0, 0.5]; pub(crate) fn render_vnode( - frame: &mut tui::Frame>, + frame: &mut ratatui::Frame, layout: &Taffy, node: NodeRef, cfg: Config, @@ -96,7 +95,7 @@ pub(crate) fn render_vnode( impl RinkWidget for NodeRef<'_> { fn render(self, area: Rect, mut buf: RinkBuffer<'_>) { - use tui::symbols::line::*; + use ratatui::symbols::line::*; enum Direction { Left, diff --git a/packages/rink/src/style.rs b/packages/rink/src/style.rs index 857322079..905cc4b34 100644 --- a/packages/rink/src/style.rs +++ b/packages/rink/src/style.rs @@ -1,6 +1,6 @@ use std::{num::ParseFloatError, str::FromStr}; -use tui::style::{Color, Modifier, Style}; +use ratatui::style::{Color, Modifier, Style}; use crate::RenderingMode; @@ -442,6 +442,7 @@ impl RinkStyle { impl From for Style { fn from(val: RinkStyle) -> Self { Style { + underline_color: None, fg: val.fg.map(|c| c.color), bg: val.bg.map(|c| c.color), add_modifier: val.add_modifier, diff --git a/packages/rink/src/style_attributes.rs b/packages/rink/src/style_attributes.rs index 0c87e3f83..d1e8c6bee 100644 --- a/packages/rink/src/style_attributes.rs +++ b/packages/rink/src/style_attributes.rs @@ -187,8 +187,8 @@ pub enum BorderStyle { } impl BorderStyle { - pub fn symbol_set(&self) -> Option { - use tui::symbols::line::*; + pub fn symbol_set(&self) -> Option { + use ratatui::symbols::line::*; const DASHED: Set = Set { horizontal: "╌", vertical: "╎", @@ -570,7 +570,7 @@ fn apply_animation(name: &str, _value: &str, _style: &mut StyleModifier) { } fn apply_font(name: &str, value: &str, style: &mut StyleModifier) { - use tui::style::Modifier; + use ratatui::style::Modifier; match name { "font" => (), "font-family" => (), @@ -593,7 +593,7 @@ fn apply_font(name: &str, value: &str, style: &mut StyleModifier) { } fn apply_text(name: &str, value: &str, style: &mut StyleModifier) { - use tui::style::Modifier; + use ratatui::style::Modifier; match name { "text-align" => todo!(), diff --git a/packages/rink/src/widget.rs b/packages/rink/src/widget.rs index ab9044998..91af5b4f6 100644 --- a/packages/rink/src/widget.rs +++ b/packages/rink/src/widget.rs @@ -1,4 +1,4 @@ -use tui::{ +use ratatui::{ buffer::Buffer, layout::Rect, style::{Color, Modifier}, diff --git a/packages/router-macro/src/redirect.rs b/packages/router-macro/src/redirect.rs index c1efb8b4d..2933bbc8e 100644 --- a/packages/router-macro/src/redirect.rs +++ b/packages/router-macro/src/redirect.rs @@ -75,6 +75,7 @@ impl Redirect { let (segments, query) = parse_route_segments( path.span(), + #[allow(clippy::map_identity)] closure_arguments.iter().map(|(name, ty)| (name, ty)), &path.value(), )?; diff --git a/packages/router/Cargo.toml b/packages/router/Cargo.toml index 80923d539..da9d3fe85 100644 --- a/packages/router/Cargo.toml +++ b/packages/router/Cargo.toml @@ -19,6 +19,7 @@ thiserror = { workspace = true } futures-util = { workspace = true } urlencoding = "2.1.3" serde = { version = "1", features = ["derive"], optional = true } +serde_json = { version = "1.0.91", optional = true } url = "2.3.1" wasm-bindgen = { workspace = true, optional = true } web-sys = { version = "0.3.60", optional = true, features = [ @@ -26,18 +27,22 @@ web-sys = { version = "0.3.60", optional = true, features = [ ] } js-sys = { version = "0.3.63", optional = true } gloo-utils = { version = "0.1.6", optional = true } +dioxus-liveview = { workspace = true, optional = true } dioxus-ssr = { workspace = true, optional = true } tokio = { workspace = true, features = ["full"], optional = true } [features] default = ["web"] ssr = ["dioxus-ssr", "tokio"] +liveview = ["dioxus-liveview", "tokio", "dep:serde", "serde_json"] wasm_test = [] serde = ["dep:serde", "gloo-utils/serde"] web = ["gloo", "web-sys", "wasm-bindgen", "gloo-utils", "js-sys"] [dev-dependencies] +axum = { version = "0.6.1", features = ["ws"] } dioxus = { path = "../dioxus" } +dioxus-liveview = { workspace = true, features = ["axum"] } dioxus-ssr = { path = "../ssr" } criterion = { version = "0.5", features = ["async_tokio", "html_reports"] } diff --git a/packages/router/examples/simple_routes.rs b/packages/router/examples/simple_routes.rs index 3634f7df3..aac1e8658 100644 --- a/packages/router/examples/simple_routes.rs +++ b/packages/router/examples/simple_routes.rs @@ -2,6 +2,47 @@ use dioxus::prelude::*; use dioxus_router::prelude::*; use std::str::FromStr; +#[cfg(feature = "liveview")] +#[tokio::main] +async fn main() { + use axum::{extract::ws::WebSocketUpgrade, response::Html, routing::get, Router}; + + let listen_address: std::net::SocketAddr = ([127, 0, 0, 1], 3030).into(); + let view = dioxus_liveview::LiveViewPool::new(); + let app = Router::new() + .fallback(get(move || async move { + Html(format!( + r#" + + + +

+ {glue} + + "#, + glue = dioxus_liveview::interpreter_glue(&format!("ws://{listen_address}/ws")) + )) + })) + .route( + "/ws", + get(move |ws: WebSocketUpgrade| async move { + ws.on_upgrade(move |socket| async move { + _ = view + .launch(dioxus_liveview::axum_socket(socket), Root) + .await; + }) + }), + ); + + println!("Listening on http://{listen_address}"); + + axum::Server::bind(&listen_address.to_string().parse().unwrap()) + .serve(app.into_make_service()) + .await + .unwrap(); +} + +#[cfg(not(feature = "liveview"))] fn main() { #[cfg(not(target_arch = "wasm32"))] dioxus_desktop::launch(Root); @@ -10,21 +51,26 @@ fn main() { dioxus_web::launch(root); } +#[cfg(feature = "liveview")] #[component] fn Root(cx: Scope) -> Element { - render! { - Router:: {} - } + let history = LiveviewHistory::new(cx); + render! { Router:: { + config: || RouterConfig::default().history(history), + } } +} + +#[cfg(not(feature = "liveview"))] +#[component] +fn Root(cx: Scope) -> Element { + render! { Router:: {} } } #[component] fn UserFrame(cx: Scope, user_id: usize) -> Element { render! { - pre { - "UserFrame{{\n\tuser_id:{user_id}\n}}" - } - div { - background_color: "rgba(0,0,0,50%)", + pre { "UserFrame{{\n\tuser_id:{user_id}\n}}" } + div { background_color: "rgba(0,0,0,50%)", "children:" Outlet:: {} } @@ -88,6 +134,16 @@ fn Route3(cx: Scope, dynamic: String) -> Element { to: Route::Route2 { user_id: 8888 }, "hello world link" } + button { + disabled: !navigator.can_go_back(), + onclick: move |_| { navigator.go_back(); }, + "go back" + } + button { + disabled: !navigator.can_go_forward(), + onclick: move |_| { navigator.go_forward(); }, + "go forward" + } button { onclick: move |_| { navigator.push("https://www.google.com"); }, "google link" diff --git a/packages/router/src/components/history_buttons.rs b/packages/router/src/components/history_buttons.rs index eb62e9285..ae11ad276 100644 --- a/packages/router/src/components/history_buttons.rs +++ b/packages/router/src/components/history_buttons.rs @@ -142,7 +142,7 @@ pub fn GoForwardButton<'a>(cx: Scope<'a, HistoryButtonProps<'a>>) -> Element { } }; - let disabled = !router.can_go_back(); + let disabled = !router.can_go_forward(); render! { button { diff --git a/packages/router/src/components/link.rs b/packages/router/src/components/link.rs index 787f9cdc9..639d99ae7 100644 --- a/packages/router/src/components/link.rs +++ b/packages/router/src/components/link.rs @@ -11,6 +11,8 @@ use crate::navigation::NavigationTarget; use crate::prelude::Routable; use crate::utils::use_router_internal::use_router_internal; +use url::Url; + /// Something that can be converted into a [`NavigationTarget`]. #[derive(Clone)] pub enum IntoRoutable { @@ -53,6 +55,18 @@ impl From<&str> for IntoRoutable { } } +impl From for IntoRoutable { + fn from(url: Url) -> Self { + IntoRoutable::FromStr(url.to_string()) + } +} + +impl From<&Url> for IntoRoutable { + fn from(url: &Url) -> Self { + IntoRoutable::FromStr(url.to_string()) + } +} + /// The properties for a [`Link`]. #[derive(Props)] pub struct LinkProps<'a> { diff --git a/packages/router/src/contexts/router.rs b/packages/router/src/contexts/router.rs index b15956991..079640e61 100644 --- a/packages/router/src/contexts/router.rs +++ b/packages/router/src/contexts/router.rs @@ -232,7 +232,7 @@ impl RouterContext { IntoRoutable::FromStr(url) => { let parsed_route: NavigationTarget> = match self.route_from_str(&url) { Ok(route) => NavigationTarget::Internal(route), - Err(err) => NavigationTarget::External(err), + Err(_) => NavigationTarget::External(url), }; parsed_route } diff --git a/packages/router/src/history/liveview.rs b/packages/router/src/history/liveview.rs new file mode 100644 index 000000000..9ffb09c34 --- /dev/null +++ b/packages/router/src/history/liveview.rs @@ -0,0 +1,441 @@ +use super::HistoryProvider; +use crate::routable::Routable; +use dioxus::prelude::*; +use serde::{Deserialize, Serialize}; +use std::sync::{Mutex, RwLock}; +use std::{collections::BTreeMap, rc::Rc, str::FromStr, sync::Arc}; + +/// A [`HistoryProvider`] that evaluates history through JS. +pub struct LiveviewHistory +where + ::Err: std::fmt::Display, +{ + action_tx: tokio::sync::mpsc::UnboundedSender>, + timeline: Arc>>, + updater_callback: Arc>>, +} + +struct Timeline +where + ::Err: std::fmt::Display, +{ + current_index: usize, + routes: BTreeMap, +} + +#[derive(Serialize, Deserialize, Debug)] +struct State { + index: usize, +} + +#[derive(Serialize, Deserialize, Debug)] +struct Session +where + ::Err: std::fmt::Display, +{ + #[serde(with = "routes")] + routes: BTreeMap, + last_visited: usize, +} + +#[derive(Serialize, Deserialize)] +struct SessionStorage { + liveview: Option, +} + +enum Action { + GoBack, + GoForward, + Push(R), + Replace(R), + External(String), +} + +impl Timeline +where + ::Err: std::fmt::Display, +{ + fn new(initial_path: R) -> Self { + Self { + current_index: 0, + routes: BTreeMap::from([(0, initial_path)]), + } + } + + fn init( + &mut self, + route: R, + state: Option, + session: Option>, + depth: usize, + ) -> State { + if let Some(session) = session { + self.routes = session.routes; + if state.is_none() { + // top of stack + let last_visited = session.last_visited; + self.routes.retain(|&lhs, _| lhs <= last_visited); + } + }; + let state = match state { + Some(state) => { + self.current_index = state.index; + state + } + None => { + let index = depth - 1; + self.current_index = index; + State { index } + } + }; + self.routes.insert(state.index, route); + state + } + + fn update(&mut self, route: R, state: Option) -> State { + if let Some(state) = state { + self.current_index = state.index; + self.routes.insert(self.current_index, route); + state + } else { + self.push(route) + } + } + + fn push(&mut self, route: R) -> State { + // top of stack + let index = self.current_index + 1; + self.current_index = index; + self.routes.insert(index, route); + self.routes.retain(|&rhs, _| index >= rhs); + State { + index: self.current_index, + } + } + + fn replace(&mut self, route: R) -> State { + self.routes.insert(self.current_index, route); + State { + index: self.current_index, + } + } + + fn current_route(&self) -> &R { + &self.routes[&self.current_index] + } + + fn session(&self) -> Session { + Session { + routes: self.routes.clone(), + last_visited: self.current_index, + } + } +} + +impl LiveviewHistory +where + ::Err: std::fmt::Display, +{ + /// Create a [`LiveviewHistory`] in the given scope. + /// When using a [`LiveviewHistory`] in combination with use_eval, history must be untampered with. + /// + /// # Panics + /// + /// Panics if not in a Liveview context. + pub fn new(cx: &ScopeState) -> Self { + Self::new_with_initial_path( + cx, + "/".parse().unwrap_or_else(|err| { + panic!("index route does not exist:\n{}\n use LiveviewHistory::new_with_initial_path to set a custom path", err) + }), + ) + } + + /// Create a [`LiveviewHistory`] in the given scope, starting at `initial_path`. + /// When using a [`LiveviewHistory`] in combination with use_eval, history must be untampered with. + /// + /// # Panics + /// + /// Panics if not in a Liveview context. + pub fn new_with_initial_path(cx: &ScopeState, initial_path: R) -> Self { + let (action_tx, action_rx) = tokio::sync::mpsc::unbounded_channel::>(); + let action_rx = Arc::new(Mutex::new(action_rx)); + let timeline = Arc::new(Mutex::new(Timeline::new(initial_path))); + let updater_callback: Arc>> = + Arc::new(RwLock::new(Arc::new(|| {}))); + + let eval_provider = cx + .consume_context::>() + .expect("evaluator not provided"); + + let create_eval = Rc::new(move |script: &str| { + eval_provider + .new_evaluator(script.to_string()) + .map(UseEval::new) + }) as Rc Result>; + + // Listen to server actions + cx.push_future({ + let timeline = timeline.clone(); + let action_rx = action_rx.clone(); + let create_eval = create_eval.clone(); + async move { + let mut action_rx = action_rx.lock().expect("unpoisoned mutex"); + loop { + let eval = action_rx.recv().await.expect("sender to exist"); + let _ = match eval { + Action::GoBack => create_eval( + r#" + // this triggers a PopState event + history.back(); + "#, + ), + Action::GoForward => create_eval( + r#" + // this triggers a PopState event + history.forward(); + "#, + ), + Action::Push(route) => { + let mut timeline = timeline.lock().expect("unpoisoned mutex"); + let state = timeline.push(route.clone()); + let state = serde_json::to_string(&state).expect("serializable state"); + let session = serde_json::to_string(&timeline.session()) + .expect("serializable session"); + create_eval(&format!( + r#" + // this does not trigger a PopState event + history.pushState({state}, "", "{route}"); + sessionStorage.setItem("liveview", '{session}'); + "# + )) + } + Action::Replace(route) => { + let mut timeline = timeline.lock().expect("unpoisoned mutex"); + let state = timeline.replace(route.clone()); + let state = serde_json::to_string(&state).expect("serializable state"); + let session = serde_json::to_string(&timeline.session()) + .expect("serializable session"); + create_eval(&format!( + r#" + // this does not trigger a PopState event + history.replaceState({state}, "", "{route}"); + sessionStorage.setItem("liveview", '{session}'); + "# + )) + } + Action::External(url) => create_eval(&format!( + r#" + location.href = "{url}"; + "# + )), + }; + } + } + }); + + // Listen to browser actions + cx.push_future({ + let updater = updater_callback.clone(); + let timeline = timeline.clone(); + let create_eval = create_eval.clone(); + async move { + let popstate_eval = { + let init_eval = create_eval( + r#" + return [ + document.location.pathname + "?" + document.location.search + "\#" + document.location.hash, + history.state, + JSON.parse(sessionStorage.getItem("liveview")), + history.length, + ]; + "#, + ).expect("failed to load state").await.expect("serializable state"); + let (route, state, session, depth) = serde_json::from_value::<( + String, + Option, + Option>, + usize, + )>(init_eval).expect("serializable state"); + let Ok(route) = R::from_str(&route.to_string()) else { + return; + }; + let mut timeline = timeline.lock().expect("unpoisoned mutex"); + let state = timeline.init(route.clone(), state, session, depth); + let state = serde_json::to_string(&state).expect("serializable state"); + let session = serde_json::to_string(&timeline.session()) + .expect("serializable session"); + + // Call the updater callback + (updater.read().unwrap())(); + + create_eval(&format!(r#" + // this does not trigger a PopState event + history.replaceState({state}, "", "{route}"); + sessionStorage.setItem("liveview", '{session}'); + + window.addEventListener("popstate", (event) => {{ + dioxus.send([ + document.location.pathname + "?" + document.location.search + "\#" + document.location.hash, + event.state, + ]); + }}); + "#)).expect("failed to initialize popstate") + }; + + loop { + let event = match popstate_eval.recv().await { + Ok(event) => event, + Err(_) => continue, + }; + let (route, state) = serde_json::from_value::<(String, Option)>(event).expect("serializable state"); + let Ok(route) = R::from_str(&route.to_string()) else { + return; + }; + let mut timeline = timeline.lock().expect("unpoisoned mutex"); + let state = timeline.update(route.clone(), state); + let state = serde_json::to_string(&state).expect("serializable state"); + let session = serde_json::to_string(&timeline.session()) + .expect("serializable session"); + + let _ = create_eval(&format!( + r#" + // this does not trigger a PopState event + history.replaceState({state}, "", "{route}"); + sessionStorage.setItem("liveview", '{session}'); + "#)); + + // Call the updater callback + (updater.read().unwrap())(); + } + } + }); + + Self { + action_tx, + timeline, + updater_callback, + } + } +} + +impl HistoryProvider for LiveviewHistory +where + ::Err: std::fmt::Display, +{ + fn go_back(&mut self) { + let _ = self.action_tx.send(Action::GoBack); + } + + fn go_forward(&mut self) { + let _ = self.action_tx.send(Action::GoForward); + } + + fn push(&mut self, route: R) { + let _ = self.action_tx.send(Action::Push(route)); + } + + fn replace(&mut self, route: R) { + let _ = self.action_tx.send(Action::Replace(route)); + } + + fn external(&mut self, url: String) -> bool { + let _ = self.action_tx.send(Action::External(url)); + true + } + + fn current_route(&self) -> R { + let timeline = self.timeline.lock().expect("unpoisoned mutex"); + timeline.current_route().clone() + } + + fn can_go_back(&self) -> bool { + let timeline = self.timeline.lock().expect("unpoisoned mutex"); + // Check if the one before is contiguous (i.e., not an external page) + let visited_indices: Vec = timeline.routes.keys().cloned().collect(); + visited_indices + .iter() + .position(|&rhs| timeline.current_index == rhs) + .map_or(false, |index| { + index > 0 && visited_indices[index - 1] == timeline.current_index - 1 + }) + } + + fn can_go_forward(&self) -> bool { + let timeline = self.timeline.lock().expect("unpoisoned mutex"); + // Check if the one after is contiguous (i.e., not an external page) + let visited_indices: Vec = timeline.routes.keys().cloned().collect(); + visited_indices + .iter() + .rposition(|&rhs| timeline.current_index == rhs) + .map_or(false, |index| { + index < visited_indices.len() - 1 + && visited_indices[index + 1] == timeline.current_index + 1 + }) + } + + fn updater(&mut self, callback: Arc) { + let mut updater_callback = self.updater_callback.write().unwrap(); + *updater_callback = callback; + } +} + +mod routes { + use crate::prelude::Routable; + use core::str::FromStr; + use serde::de::{MapAccess, Visitor}; + use serde::{ser::SerializeMap, Deserializer, Serializer}; + use std::collections::BTreeMap; + + pub fn serialize(routes: &BTreeMap, serializer: S) -> Result + where + S: Serializer, + R: Routable, + { + let mut map = serializer.serialize_map(Some(routes.len()))?; + for (index, route) in routes.iter() { + map.serialize_entry(&index.to_string(), &route.to_string())?; + } + map.end() + } + + pub fn deserialize<'de, D, R>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + R: Routable, + ::Err: std::fmt::Display, + { + struct BTreeMapVisitor { + marker: std::marker::PhantomData, + } + + impl<'de, R> Visitor<'de> for BTreeMapVisitor + where + R: Routable, + ::Err: std::fmt::Display, + { + type Value = BTreeMap; + + fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result { + formatter.write_str("a map with indices and routable values") + } + + fn visit_map(self, mut map: M) -> Result + where + M: MapAccess<'de>, + { + let mut routes = BTreeMap::new(); + while let Some((index, route)) = map.next_entry::()? { + let index = index.parse::().map_err(serde::de::Error::custom)?; + let route = R::from_str(&route).map_err(serde::de::Error::custom)?; + routes.insert(index, route); + } + Ok(routes) + } + } + + deserializer.deserialize_map(BTreeMapVisitor { + marker: std::marker::PhantomData, + }) + } +} diff --git a/packages/router/src/history/mod.rs b/packages/router/src/history/mod.rs index e9668b979..cf7183366 100644 --- a/packages/router/src/history/mod.rs +++ b/packages/router/src/history/mod.rs @@ -22,6 +22,11 @@ pub use web::*; #[cfg(feature = "web")] pub(crate) mod web_history; +#[cfg(feature = "liveview")] +mod liveview; +#[cfg(feature = "liveview")] +pub use liveview::*; + // #[cfg(feature = "web")] // mod web_hash; // #[cfg(feature = "web")] diff --git a/packages/rsx/Cargo.toml b/packages/rsx/Cargo.toml index bc866acb7..72b51a051 100644 --- a/packages/rsx/Cargo.toml +++ b/packages/rsx/Cargo.toml @@ -20,6 +20,7 @@ quote = { version = "1.0" } serde = { version = "1.0", features = ["derive"], optional = true } internment = { version = "0.7.0", optional = true } krates = { version = "0.12.6", optional = true } +tracing.workspace = true [features] hot_reload = ["krates", "internment"] diff --git a/packages/rsx/src/hot_reload/hot_reload_diff.rs b/packages/rsx/src/hot_reload/hot_reload_diff.rs index 22a01875d..7e19d3aad 100644 --- a/packages/rsx/src/hot_reload/hot_reload_diff.rs +++ b/packages/rsx/src/hot_reload/hot_reload_diff.rs @@ -1,4 +1,5 @@ use proc_macro2::TokenStream; +use quote::ToTokens; use syn::{File, Macro}; pub enum DiffResult { @@ -10,13 +11,30 @@ pub enum DiffResult { pub fn find_rsx(new: &File, old: &File) -> DiffResult { let mut rsx_calls = Vec::new(); if new.items.len() != old.items.len() { + tracing::trace!( + "found not hot reload-able change {:#?} != {:#?}", + new.items + .iter() + .map(|i| i.to_token_stream().to_string()) + .collect::>(), + old.items + .iter() + .map(|i| i.to_token_stream().to_string()) + .collect::>() + ); return DiffResult::CodeChanged; } for (new, old) in new.items.iter().zip(old.items.iter()) { if find_rsx_item(new, old, &mut rsx_calls) { + tracing::trace!( + "found not hot reload-able change {:#?} != {:#?}", + new.to_token_stream().to_string(), + old.to_token_stream().to_string() + ); return DiffResult::CodeChanged; } } + tracing::trace!("found hot reload-able changes {:#?}", rsx_calls); DiffResult::RsxChanged(rsx_calls) } @@ -94,6 +112,9 @@ fn find_rsx_item( (syn::ImplItem::Macro(new_item), syn::ImplItem::Macro(old_item)) => { old_item != new_item } + (syn::ImplItem::Verbatim(stream), syn::ImplItem::Verbatim(stream2)) => { + stream.to_string() != stream2.to_string() + } _ => true, } { return true; @@ -186,10 +207,12 @@ fn find_rsx_trait( } } (syn::TraitItem::Fn(new_item), syn::TraitItem::Fn(old_item)) => { - if let (Some(new_block), Some(old_block)) = (&new_item.default, &old_item.default) { - find_rsx_block(new_block, old_block, rsx_calls) - } else { - true + match (&new_item.default, &old_item.default) { + (Some(new_block), Some(old_block)) => { + find_rsx_block(new_block, old_block, rsx_calls) + } + (None, None) => false, + _ => true, } } (syn::TraitItem::Type(new_item), syn::TraitItem::Type(old_item)) => { @@ -198,6 +221,9 @@ fn find_rsx_trait( (syn::TraitItem::Macro(new_item), syn::TraitItem::Macro(old_item)) => { old_item != new_item } + (syn::TraitItem::Verbatim(stream), syn::TraitItem::Verbatim(stream2)) => { + stream.to_string() != stream2.to_string() + } _ => true, } { return true; @@ -355,6 +381,11 @@ fn find_rsx_expr( || new_expr.or2_token != old_expr.or2_token || new_expr.output != old_expr.output } + (syn::Expr::Const(new_expr), syn::Expr::Const(old_expr)) => { + find_rsx_block(&new_expr.block, &old_expr.block, rsx_calls) + || new_expr.attrs != old_expr.attrs + || new_expr.const_token != old_expr.const_token + } (syn::Expr::Continue(new_expr), syn::Expr::Continue(old_expr)) => old_expr != new_expr, (syn::Expr::Field(new_expr), syn::Expr::Field(old_expr)) => { find_rsx_expr(&new_expr.base, &old_expr.base, rsx_calls) @@ -402,6 +433,7 @@ fn find_rsx_expr( || new_expr.attrs != old_expr.attrs || new_expr.bracket_token != old_expr.bracket_token } + (syn::Expr::Infer(new_expr), syn::Expr::Infer(old_expr)) => new_expr != old_expr, (syn::Expr::Let(new_expr), syn::Expr::Let(old_expr)) => { find_rsx_expr(&new_expr.expr, &old_expr.expr, rsx_calls) || new_expr.attrs != old_expr.attrs @@ -589,7 +621,9 @@ fn find_rsx_expr( _ => true, } } - (syn::Expr::Verbatim(_), syn::Expr::Verbatim(_)) => false, + (syn::Expr::Verbatim(stream), syn::Expr::Verbatim(stream2)) => { + stream.to_string() != stream2.to_string() + } _ => true, } } diff --git a/packages/rsx/src/hot_reload/hot_reloading_file_map.rs b/packages/rsx/src/hot_reload/hot_reloading_file_map.rs index 0393142b4..7e36dddf9 100644 --- a/packages/rsx/src/hot_reload/hot_reloading_file_map.rs +++ b/packages/rsx/src/hot_reload/hot_reloading_file_map.rs @@ -51,17 +51,24 @@ impl FileMap { fn find_rs_files( root: PathBuf, filter: &mut impl FnMut(&Path) -> bool, - ) -> io::Result { + ) -> FileMapSearchResult { let mut files = HashMap::new(); let mut errors = Vec::new(); if root.is_dir() { - for entry in (fs::read_dir(root)?).flatten() { + let read_dir = match fs::read_dir(root) { + Ok(read_dir) => read_dir, + Err(err) => { + errors.push(err); + return FileMapSearchResult { map: files, errors }; + } + }; + for entry in read_dir.flatten() { let path = entry.path(); if !filter(&path) { let FileMapSearchResult { map, errors: child_errors, - } = find_rs_files(path, filter)?; + } = find_rs_files(path, filter); errors.extend(child_errors); files.extend(map); } @@ -69,14 +76,20 @@ impl FileMap { } else if root.extension().and_then(|s| s.to_str()) == Some("rs") { if let Ok(mut file) = File::open(root.clone()) { let mut src = String::new(); - file.read_to_string(&mut src)?; - files.insert(root, (src, None)); + match file.read_to_string(&mut src) { + Ok(_) => { + files.insert(root, (src, None)); + } + Err(err) => { + errors.push(err); + } + } } } - Ok(FileMapSearchResult { map: files, errors }) + FileMapSearchResult { map: files, errors } } - let FileMapSearchResult { map, errors } = find_rs_files(path, &mut filter)?; + let FileMapSearchResult { map, errors } = find_rs_files(path, &mut filter); let result = Self { map, in_workspace: HashMap::new(), diff --git a/packages/rsx/src/lib.rs b/packages/rsx/src/lib.rs index bdf32b272..5db6baee9 100644 --- a/packages/rsx/src/lib.rs +++ b/packages/rsx/src/lib.rs @@ -193,7 +193,7 @@ impl<'a> ToTokens for TemplateRenderer<'a> { fn to_tokens(&self, out_tokens: &mut TokenStream2) { let mut context = DynamicContext::default(); - let key = match self.roots.get(0) { + let key = match self.roots.first() { Some(BodyNode::Element(el)) if self.roots.len() == 1 => el.key.clone(), Some(BodyNode::Component(comp)) if self.roots.len() == 1 => comp.key().cloned(), _ => None, diff --git a/packages/server-macro/Cargo.toml b/packages/server-macro/Cargo.toml index 5a38acb40..a91cc626a 100644 --- a/packages/server-macro/Cargo.toml +++ b/packages/server-macro/Cargo.toml @@ -17,7 +17,7 @@ proc-macro2 = "^1.0.63" quote = "^1.0.26" syn = { version = "2", features = ["full"] } convert_case = "^0.6.0" -server_fn_macro = "^0.4.6" +server_fn_macro = "^0.5.2" [lib] proc-macro = true diff --git a/packages/signals/Cargo.toml b/packages/signals/Cargo.toml index 6c66f3faf..f48120ca2 100644 --- a/packages/signals/Cargo.toml +++ b/packages/signals/Cargo.toml @@ -1,8 +1,14 @@ [package] name = "dioxus-signals" authors = ["Jonathan Kelley"] -version = "0.0.0" +version = "0.4.3" edition = "2018" +description = "Signals for Dioxus" +license = "MIT OR Apache-2.0" +repository = "https://github.com/DioxusLabs/dioxus/" +homepage = "https://dioxuslabs.com" +keywords = ["dom", "ui", "gui", "react", "wasm"] +rust-version = "1.60.0" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/packages/signals/examples/split_subscriptions.rs b/packages/signals/examples/split_subscriptions.rs index 3eb60ed29..bb286b4b7 100644 --- a/packages/signals/examples/split_subscriptions.rs +++ b/packages/signals/examples/split_subscriptions.rs @@ -22,15 +22,9 @@ fn app(cx: Scope) -> Element { use_context_provider(cx, ApplicationData::default); render! { - div { - ReadsFirst {} - } - div { - ReadsSecond {} - } - div { - ReadsManySignals {} - } + div { ReadsFirst {} } + div { ReadsSecond {} } + div { ReadsManySignals {} } } } @@ -107,16 +101,14 @@ fn ReadsManySignals(cx: Scope) -> Element { } button { onclick: move |_| { - if let Some(first) = data.many_signals.read().get(0) { + if let Some(first) = data.many_signals.read().first() { *first.write() += 1; } }, "Increase First Item" } for signal in data.many_signals { - Child { - count: signal, - } + Child { count: signal } } } } diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index ddcb94b78..d9b178e54 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -7,8 +7,10 @@ use std::rc::Rc; use dioxus_core::prelude::*; use dioxus_core::ScopeId; -use generational_box::Storage; -use generational_box::{GenerationalBox, Owner}; +use generational_box::{ + BorrowError, BorrowMutError, GenerationalBox, GenerationalRef, GenerationalRefMut, Owner, + Storage, Store, +}; use crate::Effect; @@ -74,6 +76,7 @@ impl CopyValue { /// Create a new CopyValue. The value will be stored in the current component. /// /// Once the component this value is created in is dropped, the value will be dropped. + #[track_caller] pub fn new(value: T) -> Self { Self::new_maybe_sync(value) } @@ -97,6 +100,22 @@ impl> CopyValue { } } + pub(crate) fn new_with_caller( + value: T, + #[cfg(debug_assertions)] caller: &'static std::panic::Location<'static>, + ) -> Self { + let owner = current_owner(); + + Self { + value: owner.insert_with_caller( + value, + #[cfg(debug_assertions)] + caller, + ), + origin_scope: current_scope_id().expect("in a virtual dom"), + } + } + /// Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped. pub fn new_maybe_sync_in_scope(value: T, scope: ScopeId) -> Self { let owner = owner_in_scope(scope); @@ -122,21 +141,26 @@ impl> CopyValue { } /// Try to read the value. If the value has been dropped, this will return None. + #[track_caller] + pub fn try_read(&self) -> Option { self.value.try_read() } /// Read the value. If the value has been dropped, this will panic. + #[track_caller] pub fn read(&self) -> S::Ref { self.value.read() } /// Try to write the value. If the value has been dropped, this will return None. + #[track_caller] pub fn try_write(&self) -> Option { self.value.try_write() } /// Write the value. If the value has been dropped, this will panic. + #[track_caller] pub fn write(&self) -> S::Mut { self.value.write() } diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 0c89e06a5..8feb7fe95 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -49,9 +49,19 @@ use crate::{get_effect_ref, CopyValue, EffectStackRef, EFFECT_STACK}; /// } /// } /// ``` +#[track_caller] #[must_use] pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal { - *cx.use_hook(|| Signal::new(f())) + #[cfg(debug_assertions)] + let caller = std::panic::Location::caller(); + + *cx.use_hook(|| { + Signal::new_with_caller( + f(), + #[cfg(debug_assertions)] + caller, + ) + }) } /// Creates a new `Send + Sync`` Signal. Signals are a Copy state management solution with automatic dependency tracking. @@ -191,6 +201,7 @@ impl<'de, T: serde::Deserialize<'de> + 'static> serde::Deserialize<'de> for Sign impl Signal { /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. + #[track_caller] pub fn new(value: T) -> Self { Self::new_maybe_sync(value) } @@ -215,6 +226,26 @@ impl>> Signal { } } + /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. + fn new_with_caller( + value: T, + #[cfg(debug_assertions)] caller: &'static std::panic::Location<'static>, + ) -> Self { + Self { + inner: CopyValue::new_with_caller( + SignalData { + subscribers: Default::default(), + effect_subscribers: Default::default(), + update_any: schedule_update_any().expect("in a virtual dom"), + value, + effect_stack: get_effect_stack(), + }, + #[cfg(debug_assertions)] + caller, + ), + } + } + /// Create a new signal with a custom owner scope. The signal will be dropped when the owner scope is dropped instead of the current scope. #[tracing::instrument(skip(value))] pub fn new_maybe_sync_in_scope(value: T, owner: ScopeId) -> Self { @@ -236,8 +267,10 @@ impl>> Signal { self.inner.origin_scope() } - /// Get the current value of the signal. This will subscribe the current scope to the signal. + /// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peek`] instead. + /// /// If the signal has been dropped, this will panic. + #[track_caller] pub fn read( &self, ) -> <>>::Ref as Mappable>>::Mapped { @@ -270,8 +303,20 @@ impl>> Signal { S::Ref::map(inner, |v| &v.value) } - /// Get a mutable reference to the signal's value. + /// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.** + /// /// If the signal has been dropped, this will panic. + pub fn peek( + &self, + ) -> <>>::Ref as Mappable>>::Mapped { + let inner = self.inner.read(); + S::Ref::map(inner, |v| &v.value) + } + + /// Get a mutable reference to the signal's value. + /// + /// If the signal has been dropped, this will panic. + #[track_caller] pub fn write( &self, ) -> Write>>::Mut as MappableMut>>::Mapped, S> @@ -315,12 +360,14 @@ impl>> Signal { } /// Set the value of the signal. This will trigger an update on all subscribers. + #[track_caller] pub fn set(&self, value: T) { *self.write() = value; } /// Run a closure with a reference to the signal's value. /// If the signal has been dropped, this will panic. + #[track_caller] pub fn with(&self, f: impl FnOnce(&T) -> O) -> O { let write = self.read(); f(&*write) @@ -328,6 +375,7 @@ impl>> Signal { /// Run a closure with a mutable reference to the signal's value. /// If the signal has been dropped, this will panic. + #[track_caller] pub fn with_mut(&self, f: impl FnOnce(&mut T) -> O) -> O { let mut write = self.write(); f(&mut *write) @@ -342,6 +390,7 @@ impl>> Signal { impl>> Signal { /// Get the current value of the signal. This will subscribe the current scope to the signal. /// If the signal has been dropped, this will panic. + #[track_caller] pub fn value(&self) -> T { self.read().clone() } @@ -482,13 +531,24 @@ impl>> ReadOnlySignal { } /// Get the current value of the signal. This will subscribe the current scope to the signal. + /// + /// If the signal has been dropped, this will panic. + #[track_caller] pub fn read( &self, ) -> <>>::Ref as Mappable>>::Mapped { self.inner.read() } + /// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.** + /// + /// If the signal has been dropped, this will panic. + pub fn peek(&self) -> GenerationalRef { + self.inner.peek() + } + /// Run a closure with a reference to the signal's value. + #[track_caller] pub fn with(&self, f: impl FnOnce(&T) -> O) -> O { self.inner.with(f) } diff --git a/packages/ssr/Cargo.toml b/packages/ssr/Cargo.toml index f6376452d..71f5b26a0 100644 --- a/packages/ssr/Cargo.toml +++ b/packages/ssr/Cargo.toml @@ -10,6 +10,7 @@ keywords = ["dom", "ui", "gui", "react", "ssr"] [dependencies] dioxus-core = { workspace = true, features = ["serialize"] } +dioxus-html = { workspace = true } askama_escape = "0.10.3" thiserror = "1.0.23" rustc-hash = "1.1.0" @@ -17,6 +18,8 @@ lru = "0.10.0" tracing = { workspace = true } http = "0.2.9" tokio = { version = "1.28", features = ["full"], optional = true } +async-trait = "0.1.58" +serde_json = { version = "1.0" } [dev-dependencies] dioxus = { workspace = true } diff --git a/packages/ssr/src/eval.rs b/packages/ssr/src/eval.rs new file mode 100644 index 000000000..2ab74f4e1 --- /dev/null +++ b/packages/ssr/src/eval.rs @@ -0,0 +1,42 @@ +use async_trait::async_trait; +use dioxus_core::ScopeState; +use dioxus_html::prelude::{EvalError, EvalProvider, Evaluator}; +use std::rc::Rc; + +/// Provides the SSREvalProvider through [`cx.provide_context`]. +pub fn init_eval(cx: &ScopeState) { + let provider: Rc = Rc::new(SSREvalProvider {}); + cx.provide_context(provider); +} + +/// Reprents the ssr-target's provider of evaluators. +pub struct SSREvalProvider; +impl EvalProvider for SSREvalProvider { + fn new_evaluator(&self, _: String) -> Result, EvalError> { + Ok(Rc::new(SSREvaluator) as Rc) + } +} + +/// Represents a ssr-target's JavaScript evaluator. +pub struct SSREvaluator; + +// In ssr rendering we never run or resolve evals. +#[async_trait(?Send)] +impl Evaluator for SSREvaluator { + /// Runs the evaluated JavaScript. + async fn join(&self) -> Result { + std::future::pending::<()>().await; + unreachable!() + } + + /// Sends a message to the evaluated JavaScript. + fn send(&self, _el: serde_json::Value) -> Result<(), EvalError> { + Ok(()) + } + + /// Gets an UnboundedReceiver to receive messages from the evaluated JavaScript. + async fn recv(&self) -> Result { + std::future::pending::<()>().await; + unreachable!() + } +} diff --git a/packages/ssr/src/incremental.rs b/packages/ssr/src/incremental.rs index c3bb25314..34ffa3443 100644 --- a/packages/ssr/src/incremental.rs +++ b/packages/ssr/src/incremental.rs @@ -81,6 +81,7 @@ impl IncrementalRenderer { let mut html_buffer = WriteBuffer { buffer: Vec::new() }; { let mut vdom = VirtualDom::new_with_props(comp, props); + crate::eval::init_eval(vdom.base_scope()); rebuild_with(&mut vdom).await; renderer.render_before_body(&mut *html_buffer)?; diff --git a/packages/ssr/src/lib.rs b/packages/ssr/src/lib.rs index 6794d1f14..fdc0e9333 100644 --- a/packages/ssr/src/lib.rs +++ b/packages/ssr/src/lib.rs @@ -10,6 +10,7 @@ pub mod incremental; #[cfg(feature = "incremental")] mod incremental_cfg; +pub mod eval; pub mod renderer; pub mod template; @@ -42,6 +43,7 @@ pub fn render_lazy(f: LazyNodes<'_, '_>) -> String { }; let mut dom = VirtualDom::new_with_props(lazy_app, props); + crate::eval::init_eval(dom.base_scope()); _ = dom.rebuild(); Renderer::new().render(&dom) diff --git a/packages/web/src/dom.rs b/packages/web/src/dom.rs index 4fa5c9444..f45d6558a 100644 --- a/packages/web/src/dom.rs +++ b/packages/web/src/dom.rs @@ -294,7 +294,7 @@ pub fn virtual_event_from_websys_event(event: web_sys::Event, target: Element) - "select" => Rc::new(SelectionData {}), "touchcancel" | "touchend" | "touchmove" | "touchstart" => Rc::new(TouchData::from(event)), - "scroll" => Rc::new(()), + "scroll" => Rc::new(ScrollData {}), "wheel" => Rc::new(WheelData::from(event)), "animationstart" | "animationend" | "animationiteration" => { Rc::new(AnimationData::from(event)) diff --git a/packages/web/src/hot_reload.rs b/packages/web/src/hot_reload.rs index 6256cc935..e8b4e42e4 100644 --- a/packages/web/src/hot_reload.rs +++ b/packages/web/src/hot_reload.rs @@ -5,7 +5,6 @@ use futures_channel::mpsc::UnboundedReceiver; use dioxus_core::Template; pub(crate) fn init() -> UnboundedReceiver> { - use std::convert::TryInto; use wasm_bindgen::closure::Closure; use wasm_bindgen::JsCast; use web_sys::{MessageEvent, WebSocket}; @@ -31,14 +30,12 @@ pub(crate) fn init() -> UnboundedReceiver> { // change the rsx when new data is received let cl = Closure::wrap(Box::new(move |e: MessageEvent| { if let Ok(text) = e.data().dyn_into::() { - let text: Result = text.try_into(); - if let Ok(string) = text { - let val = serde_json::from_str::(&string).unwrap(); - // leak the value - let val: &'static serde_json::Value = Box::leak(Box::new(val)); - let template: Template<'_> = Template::deserialize(val).unwrap(); - tx.unbounded_send(template).unwrap(); - } + let string: String = text.into(); + let val = serde_json::from_str::(&string).unwrap(); + // leak the value + let val: &'static serde_json::Value = Box::leak(Box::new(val)); + let template: Template<'_> = Template::deserialize(val).unwrap(); + tx.unbounded_send(template).unwrap(); } }) as Box); From 9e388c3c51931d42787283dece0ce6532080d70c Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Fri, 15 Dec 2023 08:50:54 -0600 Subject: [PATCH 16/19] refactor generational box into multiple files --- packages/generational-box/src/error.rs | 104 ++++ packages/generational-box/src/lib.rs | 637 ++++---------------- packages/generational-box/src/references.rs | 169 ++++++ packages/generational-box/src/sync.rs | 135 +++++ packages/generational-box/src/unsync.rs | 137 +++++ packages/signals/src/signal.rs | 3 +- 6 files changed, 651 insertions(+), 534 deletions(-) create mode 100644 packages/generational-box/src/error.rs create mode 100644 packages/generational-box/src/references.rs create mode 100644 packages/generational-box/src/sync.rs create mode 100644 packages/generational-box/src/unsync.rs diff --git a/packages/generational-box/src/error.rs b/packages/generational-box/src/error.rs new file mode 100644 index 000000000..9aef73901 --- /dev/null +++ b/packages/generational-box/src/error.rs @@ -0,0 +1,104 @@ +use std::error::Error; +use std::fmt::Debug; +use std::fmt::Display; + +#[derive(Debug, Clone)] +/// An error that can occur when trying to borrow a value. +pub enum BorrowError { + /// The value was dropped. + Dropped(ValueDroppedError), + /// The value was already borrowed mutably. + AlreadyBorrowedMut(AlreadyBorrowedMutError), +} + +impl Display for BorrowError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + BorrowError::Dropped(error) => Display::fmt(error, f), + BorrowError::AlreadyBorrowedMut(error) => Display::fmt(error, f), + } + } +} + +impl Error for BorrowError {} + +#[derive(Debug, Clone)] +/// An error that can occur when trying to borrow a value mutably. +pub enum BorrowMutError { + /// The value was dropped. + Dropped(ValueDroppedError), + /// The value was already borrowed. + AlreadyBorrowed(AlreadyBorrowedError), + /// The value was already borrowed mutably. + AlreadyBorrowedMut(AlreadyBorrowedMutError), +} + +impl Display for BorrowMutError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + BorrowMutError::Dropped(error) => Display::fmt(error, f), + BorrowMutError::AlreadyBorrowedMut(error) => Display::fmt(error, f), + BorrowMutError::AlreadyBorrowed(error) => Display::fmt(error, f), + } + } +} + +impl Error for BorrowMutError {} + +/// An error that can occur when trying to use a value that has been dropped. +#[derive(Debug, Copy, Clone)] +pub struct ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + pub(crate) created_at: &'static std::panic::Location<'static>, +} + +impl Display for ValueDroppedError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("Failed to borrow because the value was dropped.")?; + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + f.write_fmt(format_args!("created_at: {}", self.created_at))?; + Ok(()) + } +} + +impl std::error::Error for ValueDroppedError {} + +/// An error that can occur when trying to borrow a value that has already been borrowed mutably. +#[derive(Debug, Copy, Clone)] +pub struct AlreadyBorrowedMutError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + pub(crate) borrowed_mut_at: &'static std::panic::Location<'static>, +} + +impl Display for AlreadyBorrowedMutError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("Failed to borrow because the value was already borrowed mutably.")?; + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + f.write_fmt(format_args!("borrowed_mut_at: {}", self.borrowed_mut_at))?; + Ok(()) + } +} + +impl std::error::Error for AlreadyBorrowedMutError {} + +/// An error that can occur when trying to borrow a value mutably that has already been borrowed immutably. +#[derive(Debug, Clone)] +pub struct AlreadyBorrowedError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + pub(crate) borrowed_at: Vec<&'static std::panic::Location<'static>>, +} + +impl Display for AlreadyBorrowedError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("Failed to borrow mutably because the value was already borrowed immutably.")?; + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + f.write_str("borrowed_at:")?; + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + for location in self.borrowed_at.iter() { + f.write_fmt(format_args!("\t{}", location))?; + } + Ok(()) + } +} + +impl std::error::Error for AlreadyBorrowedError {} diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 293bf6c5b..9fe47ba2a 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -1,21 +1,25 @@ #![doc = include_str!("../README.md")] #![warn(missing_docs)] -use parking_lot::{ - MappedRwLockReadGuard, MappedRwLockWriteGuard, Mutex, RwLock, RwLockReadGuard, RwLockWriteGuard, -}; +use error::*; +use parking_lot::{Mutex, RwLock}; +use references::{GenerationalRefBorrowInfo, GenerationalRefMutBorrowInfo}; use std::any::Any; -use std::error::Error; -use std::fmt::Display; use std::sync::atomic::AtomicU32; use std::{ - cell::{Ref, RefCell, RefMut}, fmt::Debug, marker::PhantomData, ops::{Deref, DerefMut}, - sync::{Arc, OnceLock}, + sync::Arc, }; +use unsync::UnsyncStorage; + +mod error; +mod references; +mod sync; +mod unsync; + /// # Example /// /// ```compile_fail @@ -229,12 +233,15 @@ impl> GenerationalBox { created_at: self.created_at, })); } - self.raw.0.data.try_read().ok_or_else(|| { - BorrowError::Dropped(ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: self.created_at, - }) - }) + self.raw.0.data.try_read( + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + self.created_at, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + GenerationalRefBorrowInfo { + borrowed_at: std::panic::Location::caller(), + borrowed_from: &self.raw.0.borrow, + }, + ) } /// Read the value. Panics if the value is no longer valid. @@ -252,12 +259,14 @@ impl> GenerationalBox { created_at: self.created_at, })); } - self.raw.0.data.try_write().ok_or_else(|| { - BorrowMutError::Dropped(ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: self.created_at, - }) - }) + self.raw.0.data.try_write( + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + self.created_at, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + GenerationalRefMutBorrowInfo { + borrowed_from: &self.raw.0.borrow, + }, + ) } /// Write the value. Panics if the value is no longer valid. @@ -295,25 +304,6 @@ impl Clone for GenerationalBox { } } -/// A unsync storage. This is the default storage type. -pub struct UnsyncStorage(RefCell>>); - -impl Default for UnsyncStorage { - fn default() -> Self { - Self(RefCell::new(None)) - } -} - -/// A thread safe storage. This is slower than the unsync storage, but allows you to share the value between threads. -#[derive(Clone, Copy)] -pub struct SyncStorage(&'static RwLock>>); - -impl Default for SyncStorage { - fn default() -> Self { - Self(Box::leak(Box::new(RwLock::new(None)))) - } -} - /// A trait for types that can be mapped. pub trait Mappable: Deref { /// The type after the mapping. @@ -329,36 +319,6 @@ pub trait Mappable: Deref { ) -> Option>; } -impl Mappable for Ref<'static, T> { - type Mapped = Ref<'static, U>; - - fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { - Ref::map(_self, f) - } - - fn try_map( - _self: Self, - f: impl FnOnce(&T) -> Option<&U>, - ) -> Option> { - Ref::filter_map(_self, f).ok() - } -} - -impl Mappable for MappedRwLockReadGuard<'static, T> { - type Mapped = MappedRwLockReadGuard<'static, U>; - - fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { - MappedRwLockReadGuard::map(_self, f) - } - - fn try_map( - _self: Self, - f: impl FnOnce(&T) -> Option<&U>, - ) -> Option> { - MappedRwLockReadGuard::try_map(_self, f).ok() - } -} - /// A trait for types that can be mapped mutably. pub trait MappableMut: DerefMut { /// The type after the mapping. @@ -374,36 +334,6 @@ pub trait MappableMut: DerefMut { ) -> Option>; } -impl MappableMut for RefMut<'static, T> { - type Mapped = RefMut<'static, U>; - - fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { - RefMut::map(_self, f) - } - - fn try_map( - _self: Self, - f: impl FnOnce(&mut T) -> Option<&mut U>, - ) -> Option> { - RefMut::filter_map(_self, f).ok() - } -} - -impl MappableMut for MappedRwLockWriteGuard<'static, T> { - type Mapped = MappedRwLockWriteGuard<'static, U>; - - fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { - MappedRwLockWriteGuard::map(_self, f) - } - - fn try_map( - _self: Self, - f: impl FnOnce(&mut T) -> Option<&mut U>, - ) -> Option> { - MappedRwLockWriteGuard::try_map(_self, f).ok() - } -} - /// A trait for a storage backing type. (RefCell, RwLock, etc.) pub trait Storage: AnyStorage + 'static { /// The reference this storage type returns. @@ -412,22 +342,23 @@ pub trait Storage: AnyStorage + 'static { type Mut: MappableMut + DerefMut; /// Try to read the value. Returns None if the value is no longer valid. - fn try_read(&self) -> Option; - /// Read the value. Panics if the value is no longer valid. - fn read(&self) -> Self::Ref { - self.try_read() - .expect("generational box has been invalidated or the type has changed") - } - /// Try to write the value. Returns None if the value is no longer valid. - fn try_write(&self) -> Option; - /// Write the value. Panics if the value is no longer valid. - fn write(&self) -> Self::Mut { - self.try_write() - .expect("generational box has been invalidated or the type has changed") - } + fn try_read( + &'static self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefBorrowInfo, + ) -> Result; - /// Set the value. Panics if the value is no longer valid. - fn set(&self, value: Data); + /// Try to write the value. Returns None if the value is no longer valid. + fn try_write( + &'static self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefMutBorrowInfo, + ) -> Result; + + /// Set the value + fn set(&'static self, value: Data); } /// A trait for any storage backing type. @@ -453,127 +384,29 @@ pub trait AnyStorage: Default { } } -impl Storage for UnsyncStorage { - type Ref = Ref<'static, T>; - type Mut = RefMut<'static, T>; - - fn try_read(&self) -> Option { - Ref::filter_map(self.0.borrow(), |any| any.as_ref()?.downcast_ref()).ok() - } - - fn try_write(&self) -> Option { - RefMut::filter_map(self.0.borrow_mut(), |any| any.as_mut()?.downcast_mut()).ok() - } - - fn set(&self, value: T) { - *self.0.borrow_mut() = Some(Box::new(value)); - } -} - -thread_local! { - static UNSYNC_RUNTIME: RefCell>> = RefCell::new(Vec::new()); -} - -impl AnyStorage for UnsyncStorage { - fn data_ptr(&self) -> *const () { - self.0.as_ptr() as *const () - } - - fn take(&self) -> bool { - self.0.borrow_mut().take().is_some() - } - - fn claim() -> MemoryLocation { - UNSYNC_RUNTIME.with(|runtime| { - if let Some(location) = runtime.borrow_mut().pop() { - location - } else { - let data: &'static MemoryLocationInner = - &*Box::leak(Box::new(MemoryLocationInner { - data: Self::default(), - #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: 0.into(), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: Default::default(), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: Default::default(), - })); - MemoryLocation(data) - } - }) - } - - fn recycle(location: &MemoryLocation) { - location.drop(); - UNSYNC_RUNTIME.with(|runtime| runtime.borrow_mut().push(*location)); - } -} - -impl Storage for SyncStorage { - type Ref = MappedRwLockReadGuard<'static, T>; - type Mut = MappedRwLockWriteGuard<'static, T>; - - fn try_read(&self) -> Option { - RwLockReadGuard::try_map(self.0.read(), |any| any.as_ref()?.downcast_ref()).ok() - } - - fn try_write(&self) -> Option { - RwLockWriteGuard::try_map(self.0.write(), |any| any.as_mut()?.downcast_mut()).ok() - } - - fn set(&self, value: T) { - *self.0.write() = Some(Box::new(value)); - } -} - -static SYNC_RUNTIME: OnceLock>>>> = OnceLock::new(); - -fn sync_runtime() -> &'static Arc>>> { - SYNC_RUNTIME.get_or_init(|| Arc::new(Mutex::new(Vec::new()))) -} - -impl AnyStorage for SyncStorage { - fn data_ptr(&self) -> *const () { - self.0.data_ptr() as *const () - } - - fn take(&self) -> bool { - self.0.write().take().is_some() - } - - fn claim() -> MemoryLocation { - sync_runtime().lock().pop().unwrap_or_else(|| { - let data: &'static MemoryLocationInner = - &*Box::leak(Box::new(MemoryLocationInner { - data: Self::default(), - #[cfg(any(debug_assertions, feature = "check_generation"))] - generation: 0.into(), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: Default::default(), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: Default::default(), - })); - MemoryLocation(data) - }) - } - - fn recycle(location: &MemoryLocation) { - location.drop(); - sync_runtime().lock().push(*location); - } -} - -#[derive(Clone, Copy)] struct MemoryLocation(&'static MemoryLocationInner); +impl Clone for MemoryLocation { + fn clone(&self) -> Self { + *self + } +} + +impl Copy for MemoryLocation {} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +#[derive(Debug, Default)] +struct MemoryLocationBorrowInfo { + borrowed_at: RwLock>>, + borrowed_mut_at: RwLock>>, +} + struct MemoryLocationInner { data: S, #[cfg(any(debug_assertions, feature = "check_generation"))] generation: AtomicU32, #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: RwLock>>, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: RwLock>>, + borrow: MemoryLocationBorrowInfo, } impl MemoryLocation { @@ -617,36 +450,29 @@ impl MemoryLocation { &self, #[cfg(any(debug_assertions, feature = "debug_ownership"))] created_at: &'static std::panic::Location<'static>, - ) -> Result, BorrowError> + ) -> std::result::Result<>::Ref, error::BorrowError> where S: Storage, { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - self.0 - .borrowed_at - .write() - .push(std::panic::Location::caller()); - match self.0.data.try_read() { - Some(borrow) => { - match Ref::filter_map(borrow, |any| any.as_ref()?.downcast_ref::()) { - Ok(reference) => Ok(GenerationalRef { - inner: reference, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo { - borrowed_at: std::panic::Location::caller(), - borrowed_from: self.0, - }, - }), - Err(_) => Err(BorrowError::Dropped(ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at, - })), - } - } - None => Err(BorrowError::AlreadyBorrowedMut(AlreadyBorrowedMutError { + match self.0.data.try_read( + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + GenerationalRefBorrowInfo { + borrowed_at: std::panic::Location::caller(), + borrowed_from: &self.0.borrow, + }, + ) { + Ok(read) => { #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: self.0.borrowed_mut_at.read().unwrap(), - })), + self.0 + .borrow + .borrowed_at + .write() + .push(std::panic::Location::caller()); + Ok(read) + } + Err(err) => Err(err), } } @@ -655,270 +481,30 @@ impl MemoryLocation { &self, #[cfg(any(debug_assertions, feature = "debug_ownership"))] created_at: &'static std::panic::Location<'static>, - ) -> Result, BorrowMutError> { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - { - self.0.borrowed_mut_at.write().unwrap() = Some(std::panic::Location::caller()); - } - match self.0.data.try_borrow_mut() { - Ok(borrow_mut) => { - match RefMut::filter_map(borrow_mut, |any| any.as_mut()?.downcast_mut::()) { - Ok(reference) => Ok(GenerationalRefMut { - inner: reference, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefMutBorrowInfo { - borrowed_from: self.0, - }, - }), - Err(_) => Err(BorrowMutError::Dropped(ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at, - })), + ) -> std::result::Result<>::Mut, error::BorrowMutError> + where + S: Storage, + { + match self.0.data.try_write( + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + GenerationalRefMutBorrowInfo { + borrowed_from: &self.0.borrow, + }, + ) { + Ok(read) => { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + { + *self.0.borrow.borrowed_mut_at.write() = Some(std::panic::Location::caller()); } + Ok(read) } - Err(_) => Err(BorrowMutError::AlreadyBorrowed(AlreadyBorrowedError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: self.0.borrowed_at.read().clone(), - })), + Err(err) => Err(err), } } } -#[derive(Debug, Clone)] -/// An error that can occur when trying to borrow a value. -pub enum BorrowError { - /// The value was dropped. - Dropped(ValueDroppedError), - /// The value was already borrowed mutably. - AlreadyBorrowedMut(AlreadyBorrowedMutError), -} - -impl Display for BorrowError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - BorrowError::Dropped(error) => Display::fmt(error, f), - BorrowError::AlreadyBorrowedMut(error) => Display::fmt(error, f), - } - } -} - -impl Error for BorrowError {} - -#[derive(Debug, Clone)] -/// An error that can occur when trying to borrow a value mutably. -pub enum BorrowMutError { - /// The value was dropped. - Dropped(ValueDroppedError), - /// The value was already borrowed. - AlreadyBorrowed(AlreadyBorrowedError), - /// The value was already borrowed mutably. - AlreadyBorrowedMut(AlreadyBorrowedMutError), -} - -impl Display for BorrowMutError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - BorrowMutError::Dropped(error) => Display::fmt(error, f), - BorrowMutError::AlreadyBorrowedMut(error) => Display::fmt(error, f), - BorrowMutError::AlreadyBorrowed(error) => Display::fmt(error, f), - } - } -} - -impl Error for BorrowMutError {} - -/// An error that can occur when trying to use a value that has been dropped. -#[derive(Debug, Copy, Clone)] -pub struct ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: &'static std::panic::Location<'static>, -} - -impl Display for ValueDroppedError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("Failed to borrow because the value was dropped.")?; - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - f.write_fmt(format_args!("created_at: {}", self.created_at))?; - Ok(()) - } -} - -impl std::error::Error for ValueDroppedError {} - -/// An error that can occur when trying to borrow a value that has already been borrowed mutably. -#[derive(Debug, Copy, Clone)] -pub struct AlreadyBorrowedMutError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: &'static std::panic::Location<'static>, -} - -impl Display for AlreadyBorrowedMutError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("Failed to borrow because the value was already borrowed mutably.")?; - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - f.write_fmt(format_args!("borrowed_mut_at: {}", self.borrowed_mut_at))?; - Ok(()) - } -} - -impl std::error::Error for AlreadyBorrowedMutError {} - -/// An error that can occur when trying to borrow a value mutably that has already been borrowed immutably. -#[derive(Debug, Clone)] -pub struct AlreadyBorrowedError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: Vec<&'static std::panic::Location<'static>>, -} - -impl Display for AlreadyBorrowedError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("Failed to borrow mutably because the value was already borrowed immutably.")?; - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - f.write_str("borrowed_at:")?; - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - for location in self.borrowed_at.iter() { - f.write_fmt(format_args!("\t{}", location))?; - } - Ok(()) - } -} - -impl std::error::Error for AlreadyBorrowedError {} - -/// A reference to a value in a generational box. -pub struct GenerationalRef { - inner: Ref<'static, T>, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo, -} - -impl GenerationalRef { - /// Map one ref type to another. - pub fn map(orig: GenerationalRef, f: F) -> GenerationalRef - where - F: FnOnce(&T) -> &U, - { - GenerationalRef { - inner: Ref::map(orig.inner, f), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo { - borrowed_at: orig.borrow.borrowed_at, - borrowed_from: orig.borrow.borrowed_from, - }, - } - } - - /// Filter one ref type to another. - pub fn filter_map(orig: GenerationalRef, f: F) -> Option> - where - F: FnOnce(&T) -> Option<&U>, - { - let Self { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow, - } = orig; - Ref::filter_map(inner, f).ok().map(|inner| GenerationalRef { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo { - borrowed_at: borrow.borrowed_at, - borrowed_from: borrow.borrowed_from, - }, - }) - } -} - -impl Deref for GenerationalRef { - type Target = T; - - fn deref(&self) -> &Self::Target { - self.inner.deref() - } -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -struct GenerationalRefBorrowInfo { - borrowed_at: &'static std::panic::Location<'static>, - borrowed_from: &'static MemoryLocationInner, -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -impl Drop for GenerationalRefBorrowInfo { - fn drop(&mut self) { - self.borrowed_from - .borrowed_at - .borrow_mut() - .retain(|location| std::ptr::eq(*location, self.borrowed_at as *const _)); - } -} - -/// A mutable reference to a value in a generational box. -pub struct GenerationalRefMut { - inner: RefMut<'static, T>, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefMutBorrowInfo, -} - -impl GenerationalRefMut { - /// Map one ref type to another. - pub fn map(orig: GenerationalRefMut, f: F) -> GenerationalRefMut - where - F: FnOnce(&mut T) -> &mut U, - { - GenerationalRefMut { - inner: RefMut::map(orig.inner, f), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: orig.borrow, - } - } - - /// Filter one ref type to another. - pub fn filter_map(orig: GenerationalRefMut, f: F) -> Option> - where - F: FnOnce(&mut T) -> Option<&mut U>, - { - let Self { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow, - } = orig; - RefMut::filter_map(inner, f) - .ok() - .map(|inner| GenerationalRefMut { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow, - }) - } -} - -impl Deref for GenerationalRefMut { - type Target = T; - - fn deref(&self) -> &Self::Target { - self.inner.deref() - } -} - -impl DerefMut for GenerationalRefMut { - fn deref_mut(&mut self) -> &mut Self::Target { - self.inner.deref_mut() - } -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -struct GenerationalRefMutBorrowInfo { - borrowed_from: &'static MemoryLocationInner, -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -impl Drop for GenerationalRefMutBorrowInfo { - fn drop(&mut self) { - self.borrowed_from.borrowed_mut_at.take(); - } -} - /// Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped. pub struct Owner { owned: Arc>>>, @@ -926,36 +512,23 @@ pub struct Owner { } impl Owner { - /// Insert a value into the store. The value will be dropped when the owner is dropped. - #[track_caller] - pub fn insert(&self, value: T) -> GenerationalBox + /// Insert a value into the store with a specific location blamed for creating the value. The value will be dropped when the owner is dropped. + pub fn insert_with_caller( + &self, + value: T, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + caller: &'static std::panic::Location<'static>, + ) -> GenerationalBox where S: Storage, { let mut location = S::claim(); - let key = location.replace_with_caller( - value, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - std::panic::Location::caller(), - ); - self.owned.lock().push(location); - key - } - - /// Insert a value into the store with a specific location blamed for creating the value. The value will be dropped when the owner is dropped. - pub fn insert_with_caller( - &self, - value: T, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - caller: &'static std::panic::Location<'static>, - ) -> GenerationalBox { - let mut location = self.store.claim(); let key = location.replace_with_caller( value, #[cfg(any(debug_assertions, feature = "debug_borrows"))] caller, ); - self.owned.borrow_mut().push(location); + self.owned.lock().push(location); key } diff --git a/packages/generational-box/src/references.rs b/packages/generational-box/src/references.rs new file mode 100644 index 000000000..013541bd7 --- /dev/null +++ b/packages/generational-box/src/references.rs @@ -0,0 +1,169 @@ +use std::{ + marker::PhantomData, + ops::{Deref, DerefMut}, +}; + +use crate::{Mappable, MappableMut, MemoryLocationBorrowInfo}; + +/// A reference to a value in a generational box. +pub struct GenerationalRef> { + inner: R, + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo, +} + +impl> GenerationalRef { + pub(crate) fn new( + inner: R, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] borrow: GenerationalRefBorrowInfo, + ) -> Self { + Self { + inner, + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + } + } +} + +impl> Mappable for GenerationalRef { + type Mapped = GenerationalRef>; + + fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { + GenerationalRef { + inner: R::map(_self.inner, f), + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo { + borrowed_at: _self.borrow.borrowed_at, + borrowed_from: _self.borrow.borrowed_from, + }, + } + } + + fn try_map( + _self: Self, + f: impl FnOnce(&T) -> Option<&U>, + ) -> Option> { + let Self { + inner, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + .. + } = _self; + R::try_map(inner, f).map(|inner| GenerationalRef { + inner, + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefBorrowInfo { + borrowed_at: borrow.borrowed_at, + borrowed_from: borrow.borrowed_from, + }, + }) + } +} + +impl> Deref for GenerationalRef { + type Target = T; + + fn deref(&self) -> &Self::Target { + self.inner.deref() + } +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +pub(crate) struct GenerationalRefBorrowInfo { + pub(crate) borrowed_at: &'static std::panic::Location<'static>, + pub(crate) borrowed_from: &'static MemoryLocationBorrowInfo, +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +impl Drop for GenerationalRefBorrowInfo { + fn drop(&mut self) { + self.borrowed_from + .borrowed_at + .write() + .retain(|location| std::ptr::eq(*location, self.borrowed_at as *const _)); + } +} + +/// A mutable reference to a value in a generational box. +pub struct GenerationalRefMut> { + inner: W, + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefMutBorrowInfo, +} + +impl> GenerationalRefMut { + pub(crate) fn new( + inner: R, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: GenerationalRefMutBorrowInfo, + ) -> Self { + Self { + inner, + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + } + } +} + +impl> MappableMut for GenerationalRefMut { + type Mapped = GenerationalRefMut>; + + fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { + GenerationalRefMut { + inner: W::map(_self.inner, f), + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: _self.borrow, + } + } + + fn try_map( + _self: Self, + f: impl FnOnce(&mut T) -> Option<&mut U>, + ) -> Option> { + let Self { + inner, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + .. + } = _self; + W::try_map(inner, f).map(|inner| GenerationalRefMut { + inner, + phantom: PhantomData, + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow, + }) + } +} + +impl> Deref for GenerationalRefMut { + type Target = T; + + fn deref(&self) -> &Self::Target { + self.inner.deref() + } +} + +impl> DerefMut for GenerationalRefMut { + fn deref_mut(&mut self) -> &mut Self::Target { + self.inner.deref_mut() + } +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +pub(crate) struct GenerationalRefMutBorrowInfo { + pub(crate) borrowed_from: &'static MemoryLocationBorrowInfo, +} + +#[cfg(any(debug_assertions, feature = "debug_borrows"))] +impl Drop for GenerationalRefMutBorrowInfo { + fn drop(&mut self) { + self.borrowed_from.borrowed_mut_at.write().take(); + } +} diff --git a/packages/generational-box/src/sync.rs b/packages/generational-box/src/sync.rs new file mode 100644 index 000000000..1432ca6d8 --- /dev/null +++ b/packages/generational-box/src/sync.rs @@ -0,0 +1,135 @@ +use parking_lot::{ + MappedRwLockReadGuard, MappedRwLockWriteGuard, Mutex, RwLock, RwLockReadGuard, RwLockWriteGuard, +}; +use std::sync::{Arc, OnceLock}; + +use crate::{ + error::{self, ValueDroppedError}, + references::{ + GenerationalRef, GenerationalRefBorrowInfo, GenerationalRefMut, + GenerationalRefMutBorrowInfo, + }, + AnyStorage, Mappable, MappableMut, MemoryLocation, MemoryLocationInner, Storage, +}; + +/// A thread safe storage. This is slower than the unsync storage, but allows you to share the value between threads. +#[derive(Default)] +pub struct SyncStorage(RwLock>>); + +static SYNC_RUNTIME: OnceLock>>>> = OnceLock::new(); + +fn sync_runtime() -> &'static Arc>>> { + SYNC_RUNTIME.get_or_init(|| Arc::new(Mutex::new(Vec::new()))) +} + +impl AnyStorage for SyncStorage { + fn data_ptr(&self) -> *const () { + self.0.data_ptr() as *const () + } + + fn take(&self) -> bool { + self.0.write().take().is_some() + } + + fn claim() -> MemoryLocation { + sync_runtime().lock().pop().unwrap_or_else(|| { + let data: &'static MemoryLocationInner = + &*Box::leak(Box::new(MemoryLocationInner { + data: Self::default(), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: 0.into(), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: Default::default(), + })); + MemoryLocation(data) + }) + } + + fn recycle(location: &MemoryLocation) { + location.drop(); + sync_runtime().lock().push(*location); + } +} + +impl Mappable for MappedRwLockReadGuard<'static, T> { + type Mapped = MappedRwLockReadGuard<'static, U>; + + fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { + MappedRwLockReadGuard::map(_self, f) + } + + fn try_map( + _self: Self, + f: impl FnOnce(&T) -> Option<&U>, + ) -> Option> { + MappedRwLockReadGuard::try_map(_self, f).ok() + } +} + +impl MappableMut for MappedRwLockWriteGuard<'static, T> { + type Mapped = MappedRwLockWriteGuard<'static, U>; + + fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { + MappedRwLockWriteGuard::map(_self, f) + } + + fn try_map( + _self: Self, + f: impl FnOnce(&mut T) -> Option<&mut U>, + ) -> Option> { + MappedRwLockWriteGuard::try_map(_self, f).ok() + } +} + +impl Storage for SyncStorage { + type Ref = GenerationalRef>; + type Mut = GenerationalRefMut>; + + fn try_read( + &'static self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefBorrowInfo, + ) -> Result { + RwLockReadGuard::try_map(self.0.read(), |any| any.as_ref()?.downcast_ref()) + .map_err(|_| { + error::BorrowError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at, + }) + }) + .map(|guard| { + GenerationalRef::new( + guard, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at, + ) + }) + } + + fn try_write( + &'static self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefMutBorrowInfo, + ) -> Result { + RwLockWriteGuard::try_map(self.0.write(), |any| any.as_mut()?.downcast_mut()) + .map_err(|_| { + error::BorrowMutError::Dropped(ValueDroppedError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at, + }) + }) + .map(|guard| { + GenerationalRefMut::new( + guard, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at, + ) + }) + } + + fn set(&self, value: T) { + *self.0.write() = Some(Box::new(value)); + } +} diff --git a/packages/generational-box/src/unsync.rs b/packages/generational-box/src/unsync.rs new file mode 100644 index 000000000..83c670480 --- /dev/null +++ b/packages/generational-box/src/unsync.rs @@ -0,0 +1,137 @@ +use crate::{ + references::{ + GenerationalRef, GenerationalRefBorrowInfo, GenerationalRefMut, + GenerationalRefMutBorrowInfo, + }, + AnyStorage, Mappable, MappableMut, MemoryLocation, MemoryLocationInner, Storage, +}; +use std::cell::{Ref, RefCell, RefMut}; + +/// A unsync storage. This is the default storage type. +pub struct UnsyncStorage(RefCell>>); + +impl Default for UnsyncStorage { + fn default() -> Self { + Self(RefCell::new(None)) + } +} + +impl Mappable for Ref<'static, T> { + type Mapped = Ref<'static, U>; + + fn map(_self: Self, f: impl FnOnce(&T) -> &U) -> Self::Mapped { + Ref::map(_self, f) + } + + fn try_map( + _self: Self, + f: impl FnOnce(&T) -> Option<&U>, + ) -> Option> { + Ref::filter_map(_self, f).ok() + } +} + +impl MappableMut for RefMut<'static, T> { + type Mapped = RefMut<'static, U>; + + fn map(_self: Self, f: impl FnOnce(&mut T) -> &mut U) -> Self::Mapped { + RefMut::map(_self, f) + } + + fn try_map( + _self: Self, + f: impl FnOnce(&mut T) -> Option<&mut U>, + ) -> Option> { + RefMut::filter_map(_self, f).ok() + } +} + +impl Storage for UnsyncStorage { + type Ref = GenerationalRef>; + type Mut = GenerationalRefMut>; + + fn try_read( + &'static self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefBorrowInfo, + ) -> Result { + Ref::filter_map(self.0.borrow(), |any| any.as_ref()?.downcast_ref()) + .map_err(|_| { + crate::error::BorrowError::Dropped( + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + crate::error::ValueDroppedError { created_at }, + ) + }) + .map(|guard| { + GenerationalRef::new( + guard, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at, + ) + }) + } + + fn try_write( + &'static self, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + created_at: &'static std::panic::Location<'static>, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefMutBorrowInfo, + ) -> Result { + RefMut::filter_map(self.0.borrow_mut(), |any| any.as_mut()?.downcast_mut()) + .map_err(|_| { + crate::error::BorrowMutError::Dropped( + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + crate::error::ValueDroppedError { created_at }, + ) + }) + .map(|guard| { + GenerationalRefMut::new( + guard, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at, + ) + }) + } + + fn set(&self, value: T) { + *self.0.borrow_mut() = Some(Box::new(value)); + } +} + +thread_local! { + static UNSYNC_RUNTIME: RefCell>> = RefCell::new(Vec::new()); +} + +impl AnyStorage for UnsyncStorage { + fn data_ptr(&self) -> *const () { + self.0.as_ptr() as *const () + } + + fn take(&self) -> bool { + self.0.borrow_mut().take().is_some() + } + + fn claim() -> MemoryLocation { + UNSYNC_RUNTIME.with(|runtime| { + if let Some(location) = runtime.borrow_mut().pop() { + location + } else { + let data: &'static MemoryLocationInner = + &*Box::leak(Box::new(MemoryLocationInner { + data: Self::default(), + #[cfg(any(debug_assertions, feature = "check_generation"))] + generation: 0.into(), + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrow: Default::default(), + })); + MemoryLocation(data) + } + }) + } + + fn recycle(location: &MemoryLocation) { + location.drop(); + UNSYNC_RUNTIME.with(|runtime| runtime.borrow_mut().push(*location)); + } +} diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 8feb7fe95..d99807f0a 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -235,10 +235,9 @@ impl>> Signal { inner: CopyValue::new_with_caller( SignalData { subscribers: Default::default(), - effect_subscribers: Default::default(), update_any: schedule_update_any().expect("in a virtual dom"), value, - effect_stack: get_effect_stack(), + effect_ref: get_effect_ref(), }, #[cfg(debug_assertions)] caller, From 6b17d3db1e98dd0a33149ff3d4c7296b572cb98b Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Fri, 15 Dec 2023 18:35:48 -0600 Subject: [PATCH 17/19] fix signals crate --- packages/generational-box/README.md | 26 ++-- packages/generational-box/src/lib.rs | 147 ++++++++++---------- packages/generational-box/src/references.rs | 13 +- packages/generational-box/src/sync.rs | 23 +-- packages/generational-box/src/unsync.rs | 35 +++-- packages/signals/examples/errors.rs | 90 ++++++++++++ packages/signals/src/effect.rs | 2 +- packages/signals/src/impls.rs | 32 ++++- packages/signals/src/rt.rs | 12 +- packages/signals/src/selector.rs | 6 + packages/signals/src/signal.rs | 20 ++- 11 files changed, 277 insertions(+), 129 deletions(-) create mode 100644 packages/signals/examples/errors.rs diff --git a/packages/generational-box/README.md b/packages/generational-box/README.md index 95aab8402..14dc4e921 100644 --- a/packages/generational-box/README.md +++ b/packages/generational-box/README.md @@ -11,26 +11,20 @@ Three main types manage state in Generational Box: Example: ```rust -use generational_box::Store; +use generational_box::{UnsyncStorage, AnyStorage}; -// Create a store for this thread -let store = Store::default(); +// Create an owner for some state for a scope +let owner = UnsyncStorage::owner(); -{ - // Create an owner for some state for a scope - let owner = store.owner(); +// Create some non-copy data, move it into a owner, and work with copy data +let data: String = "hello world".to_string(); +let key = owner.insert(data); - // Create some non-copy data, move it into a owner, and work with copy data - let data: String = "hello world".to_string(); - let key = owner.insert(data); - - // The generational box can be read from and written to like a RefCell - let value = key.read(); - assert_eq!(*value, "hello world"); -} -// Reading value at this point will cause a panic +// The generational box can be read from and written to like a RefCell +let value = key.read(); +assert_eq!(*value, "hello world"); ``` ## How it works -Internally, `generational-box` creates an arena of generational RefCell's that are recyled when the owner is dropped. You can think of the cells as something like `&'static RefCell>` with a generational check to make recyling a cell easier to debug. Then GenerationalBox's are `Copy` because the `&'static` pointer is `Copy` +Internally, `generational-box` creates an arena of generational `RefCell`'s that are recycled when the owner is dropped. You can think of the cells as something like `&'static RefCell>` with a generational check to make recycling a cell easier to debug. Then GenerationalBox's are `Copy` because the `&'static` pointer is `Copy` diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 9fe47ba2a..b8fdee94b 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -1,10 +1,7 @@ #![doc = include_str!("../README.md")] #![warn(missing_docs)] -use error::*; -use parking_lot::{Mutex, RwLock}; -use references::{GenerationalRefBorrowInfo, GenerationalRefMutBorrowInfo}; -use std::any::Any; +use parking_lot::Mutex; use std::sync::atomic::AtomicU32; use std::{ fmt::Debug, @@ -13,7 +10,10 @@ use std::{ sync::Arc, }; -use unsync::UnsyncStorage; +pub use error::*; +pub use references::*; +pub use sync::SyncStorage; +pub use unsync::UnsyncStorage; mod error; mod references; @@ -37,12 +37,12 @@ fn reused() { let first_ptr; { let owner = UnsyncStorage::owner(); - first_ptr = owner.insert(1).raw.data.data_ptr(); + first_ptr = owner.insert(1).raw.0.data.data_ptr(); drop(owner); } { let owner = UnsyncStorage::owner(); - let second_ptr = owner.insert(1234).raw.data.data_ptr(); + let second_ptr = owner.insert(1234).raw.0.data.data_ptr(); assert_eq!(first_ptr, second_ptr); drop(owner); } @@ -233,7 +233,7 @@ impl> GenerationalBox { created_at: self.created_at, })); } - self.raw.0.data.try_read( + let result = self.raw.0.data.try_read( #[cfg(any(debug_assertions, feature = "debug_ownership"))] self.created_at, #[cfg(any(debug_assertions, feature = "debug_ownership"))] @@ -241,7 +241,18 @@ impl> GenerationalBox { borrowed_at: std::panic::Location::caller(), borrowed_from: &self.raw.0.borrow, }, - ) + ); + + if result.is_ok() { + self.raw + .0 + .borrow + .borrowed_at + .write() + .push(std::panic::Location::caller()); + } + + result } /// Read the value. Panics if the value is no longer valid. @@ -259,14 +270,20 @@ impl> GenerationalBox { created_at: self.created_at, })); } - self.raw.0.data.try_write( + let result = self.raw.0.data.try_write( #[cfg(any(debug_assertions, feature = "debug_ownership"))] self.created_at, #[cfg(any(debug_assertions, feature = "debug_ownership"))] GenerationalRefMutBorrowInfo { borrowed_from: &self.raw.0.borrow, }, - ) + ); + + if result.is_ok() { + *self.raw.0.borrow.borrowed_mut_at.write() = Some(std::panic::Location::caller()); + } + + result } /// Write the value. Panics if the value is no longer valid. @@ -296,9 +313,9 @@ impl> GenerationalBox { } } -impl Copy for GenerationalBox {} +impl Copy for GenerationalBox {} -impl Clone for GenerationalBox { +impl Clone for GenerationalBox { fn clone(&self) -> Self { *self } @@ -384,7 +401,8 @@ pub trait AnyStorage: Default { } } -struct MemoryLocation(&'static MemoryLocationInner); +/// A dynamic memory location that can be used in a generational box. +pub struct MemoryLocation(&'static MemoryLocationInner); impl Clone for MemoryLocation { fn clone(&self) -> Self { @@ -397,8 +415,31 @@ impl Copy for MemoryLocation {} #[cfg(any(debug_assertions, feature = "debug_borrows"))] #[derive(Debug, Default)] struct MemoryLocationBorrowInfo { - borrowed_at: RwLock>>, - borrowed_mut_at: RwLock>>, + pub(crate) borrowed_at: parking_lot::RwLock>>, + pub(crate) borrowed_mut_at: parking_lot::RwLock>>, +} + +impl MemoryLocationBorrowInfo { + fn borrow_mut_error(&self) -> BorrowMutError { + if let Some(borrowed_mut_at) = self.borrowed_mut_at.read().as_ref() { + BorrowMutError::AlreadyBorrowedMut(crate::error::AlreadyBorrowedMutError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_mut_at, + }) + } else { + BorrowMutError::AlreadyBorrowed(crate::error::AlreadyBorrowedError { + #[cfg(any(debug_assertions, feature = "debug_borrows"))] + borrowed_at: self.borrowed_at.read().clone(), + }) + } + } + + fn borrow_error(&self) -> BorrowError { + BorrowError::AlreadyBorrowedMut(crate::error::AlreadyBorrowedMutError { + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + borrowed_mut_at: self.borrowed_mut_at.read().unwrap(), + }) + } } struct MemoryLocationInner { @@ -444,65 +485,6 @@ impl MemoryLocation { _marker: PhantomData, } } - - #[track_caller] - fn try_borrow( - &self, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: &'static std::panic::Location<'static>, - ) -> std::result::Result<>::Ref, error::BorrowError> - where - S: Storage, - { - match self.0.data.try_read( - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - GenerationalRefBorrowInfo { - borrowed_at: std::panic::Location::caller(), - borrowed_from: &self.0.borrow, - }, - ) { - Ok(read) => { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - self.0 - .borrow - .borrowed_at - .write() - .push(std::panic::Location::caller()); - Ok(read) - } - Err(err) => Err(err), - } - } - - #[track_caller] - fn try_borrow_mut( - &self, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: &'static std::panic::Location<'static>, - ) -> std::result::Result<>::Mut, error::BorrowMutError> - where - S: Storage, - { - match self.0.data.try_write( - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - GenerationalRefMutBorrowInfo { - borrowed_from: &self.0.borrow, - }, - ) { - Ok(read) => { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - { - *self.0.borrow.borrowed_mut_at.write() = Some(std::panic::Location::caller()); - } - Ok(read) - } - Err(err) => Err(err), - } - } } /// Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped. @@ -511,7 +493,20 @@ pub struct Owner { phantom: PhantomData, } -impl Owner { +impl Owner { + /// Insert a value into the store. The value will be dropped when the owner is dropped. + #[track_caller] + pub fn insert(&self, value: T) -> GenerationalBox + where + S: Storage, + { + self.insert_with_caller( + value, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + std::panic::Location::caller(), + ) + } + /// Insert a value into the store with a specific location blamed for creating the value. The value will be dropped when the owner is dropped. pub fn insert_with_caller( &self, diff --git a/packages/generational-box/src/references.rs b/packages/generational-box/src/references.rs index 013541bd7..c2f52946c 100644 --- a/packages/generational-box/src/references.rs +++ b/packages/generational-box/src/references.rs @@ -3,7 +3,7 @@ use std::{ ops::{Deref, DerefMut}, }; -use crate::{Mappable, MappableMut, MemoryLocationBorrowInfo}; +use crate::{Mappable, MappableMut}; /// A reference to a value in a generational box. pub struct GenerationalRef> { @@ -73,9 +73,10 @@ impl> Deref for GenerationalRef { } #[cfg(any(debug_assertions, feature = "debug_borrows"))] -pub(crate) struct GenerationalRefBorrowInfo { +/// Information about a borrow. +pub struct GenerationalRefBorrowInfo { pub(crate) borrowed_at: &'static std::panic::Location<'static>, - pub(crate) borrowed_from: &'static MemoryLocationBorrowInfo, + pub(crate) borrowed_from: &'static crate::MemoryLocationBorrowInfo, } #[cfg(any(debug_assertions, feature = "debug_borrows"))] @@ -157,8 +158,10 @@ impl> DerefMut for GenerationalRefMut { } #[cfg(any(debug_assertions, feature = "debug_borrows"))] -pub(crate) struct GenerationalRefMutBorrowInfo { - pub(crate) borrowed_from: &'static MemoryLocationBorrowInfo, +/// Information about a mutable borrow. +pub struct GenerationalRefMutBorrowInfo { + /// The location where the borrow occurred. + pub(crate) borrowed_from: &'static crate::MemoryLocationBorrowInfo, } #[cfg(any(debug_assertions, feature = "debug_borrows"))] diff --git a/packages/generational-box/src/sync.rs b/packages/generational-box/src/sync.rs index 1432ca6d8..e11c17418 100644 --- a/packages/generational-box/src/sync.rs +++ b/packages/generational-box/src/sync.rs @@ -5,10 +5,7 @@ use std::sync::{Arc, OnceLock}; use crate::{ error::{self, ValueDroppedError}, - references::{ - GenerationalRef, GenerationalRefBorrowInfo, GenerationalRefMut, - GenerationalRefMutBorrowInfo, - }, + references::{GenerationalRef, GenerationalRefMut}, AnyStorage, Mappable, MappableMut, MemoryLocation, MemoryLocationInner, Storage, }; @@ -89,9 +86,14 @@ impl Storage for SyncStorage { &'static self, #[cfg(any(debug_assertions, feature = "debug_ownership"))] created_at: &'static std::panic::Location<'static>, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefBorrowInfo, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at: crate::GenerationalRefBorrowInfo, ) -> Result { - RwLockReadGuard::try_map(self.0.read(), |any| any.as_ref()?.downcast_ref()) + let read = self + .0 + .try_read() + .ok_or_else(|| at.borrowed_from.borrow_error())?; + RwLockReadGuard::try_map(read, |any| any.as_ref()?.downcast_ref()) .map_err(|_| { error::BorrowError::Dropped(ValueDroppedError { #[cfg(any(debug_assertions, feature = "debug_ownership"))] @@ -111,9 +113,14 @@ impl Storage for SyncStorage { &'static self, #[cfg(any(debug_assertions, feature = "debug_ownership"))] created_at: &'static std::panic::Location<'static>, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefMutBorrowInfo, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at: crate::GenerationalRefMutBorrowInfo, ) -> Result { - RwLockWriteGuard::try_map(self.0.write(), |any| any.as_mut()?.downcast_mut()) + let write = self + .0 + .try_write() + .ok_or_else(|| at.borrowed_from.borrow_mut_error())?; + RwLockWriteGuard::try_map(write, |any| any.as_mut()?.downcast_mut()) .map_err(|_| { error::BorrowMutError::Dropped(ValueDroppedError { #[cfg(any(debug_assertions, feature = "debug_ownership"))] diff --git a/packages/generational-box/src/unsync.rs b/packages/generational-box/src/unsync.rs index 83c670480..dac9967f0 100644 --- a/packages/generational-box/src/unsync.rs +++ b/packages/generational-box/src/unsync.rs @@ -1,8 +1,5 @@ use crate::{ - references::{ - GenerationalRef, GenerationalRefBorrowInfo, GenerationalRefMut, - GenerationalRefMutBorrowInfo, - }, + references::{GenerationalRef, GenerationalRefMut}, AnyStorage, Mappable, MappableMut, MemoryLocation, MemoryLocationInner, Storage, }; use std::cell::{Ref, RefCell, RefMut}; @@ -54,14 +51,19 @@ impl Storage for UnsyncStorage { &'static self, #[cfg(any(debug_assertions, feature = "debug_ownership"))] created_at: &'static std::panic::Location<'static>, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefBorrowInfo, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at: crate::GenerationalRefBorrowInfo, ) -> Result { - Ref::filter_map(self.0.borrow(), |any| any.as_ref()?.downcast_ref()) + let borrow = self + .0 + .try_borrow() + .map_err(|_| at.borrowed_from.borrow_error())?; + Ref::filter_map(borrow, |any| any.as_ref()?.downcast_ref()) .map_err(|_| { - crate::error::BorrowError::Dropped( + crate::error::BorrowError::Dropped(crate::error::ValueDroppedError { #[cfg(any(debug_assertions, feature = "debug_ownership"))] - crate::error::ValueDroppedError { created_at }, - ) + created_at, + }) }) .map(|guard| { GenerationalRef::new( @@ -76,14 +78,19 @@ impl Storage for UnsyncStorage { &'static self, #[cfg(any(debug_assertions, feature = "debug_ownership"))] created_at: &'static std::panic::Location<'static>, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] at: GenerationalRefMutBorrowInfo, + #[cfg(any(debug_assertions, feature = "debug_ownership"))] + at: crate::GenerationalRefMutBorrowInfo, ) -> Result { - RefMut::filter_map(self.0.borrow_mut(), |any| any.as_mut()?.downcast_mut()) + let borrow = self + .0 + .try_borrow_mut() + .map_err(|_| at.borrowed_from.borrow_mut_error())?; + RefMut::filter_map(borrow, |any| any.as_mut()?.downcast_mut()) .map_err(|_| { - crate::error::BorrowMutError::Dropped( + crate::error::BorrowMutError::Dropped(crate::error::ValueDroppedError { #[cfg(any(debug_assertions, feature = "debug_ownership"))] - crate::error::ValueDroppedError { created_at }, - ) + created_at, + }) }) .map(|guard| { GenerationalRefMut::new( diff --git a/packages/signals/examples/errors.rs b/packages/signals/examples/errors.rs new file mode 100644 index 000000000..d082e55bb --- /dev/null +++ b/packages/signals/examples/errors.rs @@ -0,0 +1,90 @@ +#![allow(non_snake_case)] + +use dioxus::prelude::*; +use dioxus_signals::{use_signal, use_signal_sync, Signal}; +use generational_box::SyncStorage; + +fn main() { + dioxus_desktop::launch(app); +} + +#[derive(Clone, Copy)] +enum ErrorComponent { + ReadsSignal, + ReadsMutSignal, + ReadDroppedSignal, +} + +fn app(cx: Scope) -> Element { + let error = use_signal(cx, || None); + + render! { + match *error() { + Some(ErrorComponent::ReadsSignal) => render! { ReadsSignal {} }, + Some(ErrorComponent::ReadsMutSignal) => render! { ReadsMutSignal {} }, + Some(ErrorComponent::ReadDroppedSignal) => render! { ReadDroppedSignal {} }, + None => render! { + button { + onclick: move |_| error.set(Some(ErrorComponent::ReadsSignal)), + "ReadsSignal" + } + button { + onclick: move |_| error.set(Some(ErrorComponent::ReadsMutSignal)), + "ReadsMutSignal" + } + button { + onclick: move |_| error.set(Some(ErrorComponent::ReadDroppedSignal)), + "ReadDroppedSignal" + } + } + } + } +} + +fn ReadsSignal(cx: Scope) -> Element { + let signal = use_signal_sync(cx, || 0); + + let _write = signal.write(); + let _read = signal.read(); + + todo!() +} + +fn ReadsMutSignal(cx: Scope) -> Element { + let signal = use_signal_sync(cx, || 0); + + let _read = signal.read(); + let _write = signal.write(); + + todo!() +} + +fn ReadDroppedSignal(cx: Scope) -> Element { + let signal = use_signal_sync(cx, || None); + if cx.generation() < 4 { + cx.needs_update(); + } + render! { + if let Some(value) = &*signal() { + render!{"{value:?}"} + } else { + render! { + ReadDroppedSignalChild { parent_signal: signal } + } + } + } +} + +#[component] +fn ReadDroppedSignalChild( + cx: Scope, + parent_signal: Signal>, SyncStorage>, +) -> Element { + let signal = use_signal_sync(cx, || 0); + cx.use_hook(move || { + parent_signal.set(Some(signal.clone())); + }); + render! { + "{signal}" + } +} diff --git a/packages/signals/src/effect.rs b/packages/signals/src/effect.rs index 7e61e8014..84c19ee9c 100644 --- a/packages/signals/src/effect.rs +++ b/packages/signals/src/effect.rs @@ -170,7 +170,7 @@ impl Effect { /// Run the effect callback immediately. Returns `true` if the effect was run. Returns `false` is the effect is dead. pub fn try_run(&self) { tracing::trace!("Running effect: {:?}", self); - if let Some(mut inner) = self.inner.try_write() { + if let Ok(mut inner) = self.inner.try_write() { { EFFECT_STACK.with(|stack| { stack.effects.write().push(*self); diff --git a/packages/signals/src/impls.rs b/packages/signals/src/impls.rs index 676101b20..898fd98d2 100644 --- a/packages/signals/src/impls.rs +++ b/packages/signals/src/impls.rs @@ -12,32 +12,37 @@ use std::{ macro_rules! read_impls { ($ty:ident, $bound:path) => { impl Default for $ty { + #[track_caller] fn default() -> Self { Self::new_maybe_sync(Default::default()) } } impl std::clone::Clone for $ty { + #[track_caller] fn clone(&self) -> Self { *self } } - impl Copy for $ty {} + impl Copy for $ty {} impl Display for $ty { + #[track_caller] fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.with(|v| Display::fmt(v, f)) } } impl Debug for $ty { + #[track_caller] fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { self.with(|v| Debug::fmt(v, f)) } } impl PartialEq for $ty { + #[track_caller] fn eq(&self, other: &T) -> bool { self.with(|v| *v == *other) } @@ -50,18 +55,21 @@ macro_rules! write_impls { impl + Copy + 'static, S: $bound> std::ops::Add for $ty { type Output = T; + #[track_caller] fn add(self, rhs: T) -> Self::Output { self.with(|v| *v + rhs) } } impl + Copy + 'static, S: $bound> std::ops::AddAssign for $ty { + #[track_caller] fn add_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v + rhs) } } impl + Copy + 'static, S: $bound> std::ops::SubAssign for $ty { + #[track_caller] fn sub_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v - rhs) } @@ -70,12 +78,14 @@ macro_rules! write_impls { impl + Copy + 'static, S: $bound> std::ops::Sub for $ty { type Output = T; + #[track_caller] fn sub(self, rhs: T) -> Self::Output { self.with(|v| *v - rhs) } } impl + Copy + 'static, S: $bound> std::ops::MulAssign for $ty { + #[track_caller] fn mul_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v * rhs) } @@ -84,12 +94,14 @@ macro_rules! write_impls { impl + Copy + 'static, S: $bound> std::ops::Mul for $ty { type Output = T; + #[track_caller] fn mul(self, rhs: T) -> Self::Output { self.with(|v| *v * rhs) } } impl + Copy + 'static, S: $bound> std::ops::DivAssign for $ty { + #[track_caller] fn div_assign(&mut self, rhs: T) { self.with_mut(|v| *v = *v / rhs) } @@ -98,6 +110,7 @@ macro_rules! write_impls { impl + Copy + 'static, S: $bound> std::ops::Div for $ty { type Output = T; + #[track_caller] fn div(self, rhs: T) -> Self::Output { self.with(|v| *v / rhs) } @@ -105,51 +118,61 @@ macro_rules! write_impls { impl $ty, S> { /// Pushes a new value to the end of the vector. + #[track_caller] pub fn push(&self, value: T) { self.with_mut(|v| v.push(value)) } /// Pops the last value from the vector. + #[track_caller] pub fn pop(&self) -> Option { self.with_mut(|v| v.pop()) } /// Inserts a new value at the given index. + #[track_caller] pub fn insert(&self, index: usize, value: T) { self.with_mut(|v| v.insert(index, value)) } /// Removes the value at the given index. + #[track_caller] pub fn remove(&self, index: usize) -> T { self.with_mut(|v| v.remove(index)) } /// Clears the vector, removing all values. + #[track_caller] pub fn clear(&self) { self.with_mut(|v| v.clear()) } /// Extends the vector with the given iterator. + #[track_caller] pub fn extend(&self, iter: impl IntoIterator) { self.with_mut(|v| v.extend(iter)) } /// Truncates the vector to the given length. + #[track_caller] pub fn truncate(&self, len: usize) { self.with_mut(|v| v.truncate(len)) } /// Swaps two values in the vector. + #[track_caller] pub fn swap_remove(&self, index: usize) -> T { self.with_mut(|v| v.swap_remove(index)) } /// Retains only the values that match the given predicate. + #[track_caller] pub fn retain(&self, f: impl FnMut(&T) -> bool) { self.with_mut(|v| v.retain(f)) } /// Splits the vector into two at the given index. + #[track_caller] pub fn split_off(&self, at: usize) -> Vec { self.with_mut(|v| v.split_off(at)) } @@ -161,6 +184,7 @@ read_impls!(CopyValue, Storage); impl>> CopyValue, S> { /// Read a value from the inner vector. + #[track_caller] pub fn get(&self, index: usize) -> Option<>>::Mapped> { S::Ref::try_map(self.read(), move |v| v.get(index)) } @@ -168,6 +192,7 @@ impl>> CopyValue, S> { impl>> CopyValue, S> { /// Unwraps the inner value and clones it. + #[track_caller] pub fn unwrap(&self) -> T where T: Clone, @@ -176,6 +201,7 @@ impl>> CopyValue, S> { } /// Attempts to read the inner value of the Option. + #[track_caller] pub fn as_ref(&self) -> Option<>>::Mapped> { S::Ref::try_map(self.read(), |v| v.as_ref()) } @@ -185,21 +211,25 @@ write_impls!(CopyValue, Storage, Storage>); impl>> CopyValue, S> { /// Takes the value out of the Option. + #[track_caller] pub fn take(&self) -> Option { self.with_mut(|v| v.take()) } /// Replace the value in the Option. + #[track_caller] pub fn replace(&self, value: T) -> Option { self.with_mut(|v| v.replace(value)) } /// Gets the value out of the Option, or inserts the given value if the Option is empty. + #[track_caller] pub fn get_or_insert(&self, default: T) -> >>::Mapped { self.get_or_insert_with(|| default) } /// Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty. + #[track_caller] pub fn get_or_insert_with( &self, default: impl FnOnce() -> T, diff --git a/packages/signals/src/rt.rs b/packages/signals/src/rt.rs index d9b178e54..2a8135e3a 100644 --- a/packages/signals/src/rt.rs +++ b/packages/signals/src/rt.rs @@ -7,10 +7,7 @@ use std::rc::Rc; use dioxus_core::prelude::*; use dioxus_core::ScopeId; -use generational_box::{ - BorrowError, BorrowMutError, GenerationalBox, GenerationalRef, GenerationalRefMut, Owner, - Storage, Store, -}; +use generational_box::{GenerationalBox, Owner, Storage}; use crate::Effect; @@ -82,6 +79,7 @@ impl CopyValue { } /// Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped. + #[track_caller] pub fn new_in_scope(value: T, scope: ScopeId) -> Self { Self::new_maybe_sync_in_scope(value, scope) } @@ -91,6 +89,7 @@ impl> CopyValue { /// Create a new CopyValue. The value will be stored in the current component. /// /// Once the component this value is created in is dropped, the value will be dropped. + #[track_caller] pub fn new_maybe_sync(value: T) -> Self { let owner = current_owner(); @@ -117,6 +116,7 @@ impl> CopyValue { } /// Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped. + #[track_caller] pub fn new_maybe_sync_in_scope(value: T, scope: ScopeId) -> Self { let owner = owner_in_scope(scope); @@ -143,7 +143,7 @@ impl> CopyValue { /// Try to read the value. If the value has been dropped, this will return None. #[track_caller] - pub fn try_read(&self) -> Option { + pub fn try_read(&self) -> Result { self.value.try_read() } @@ -155,7 +155,7 @@ impl> CopyValue { /// Try to write the value. If the value has been dropped, this will return None. #[track_caller] - pub fn try_write(&self) -> Option { + pub fn try_write(&self) -> Result { self.value.try_write() } diff --git a/packages/signals/src/selector.rs b/packages/signals/src/selector.rs index 560c2c94b..c9564b08a 100644 --- a/packages/signals/src/selector.rs +++ b/packages/signals/src/selector.rs @@ -22,6 +22,7 @@ use crate::{use_signal, EffectInner, EFFECT_STACK}; /// render! { "{double}" } /// } /// ``` +#[track_caller] #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] pub fn use_selector( cx: &ScopeState, @@ -47,6 +48,7 @@ pub fn use_selector( /// render! { "{double}" } /// } /// ``` +#[track_caller] #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] pub fn use_maybe_sync_selector>>( cx: &ScopeState, @@ -71,6 +73,7 @@ pub fn use_maybe_sync_selector>>( /// render! { "{double}" } /// } /// ``` +#[track_caller] #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] pub fn use_selector_with_dependencies( cx: &ScopeState, @@ -99,6 +102,7 @@ where /// render! { "{double}" } /// } /// ``` +#[track_caller] #[must_use = "Consider using `use_effect` to rerun a callback when dependencies change"] pub fn use_maybe_sync_selector_with_dependencies< R: PartialEq, @@ -129,6 +133,7 @@ where /// Creates a new unsync Selector. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. +#[track_caller] pub fn selector(f: impl FnMut() -> R + 'static) -> ReadOnlySignal { maybe_sync_selector(f) } @@ -136,6 +141,7 @@ pub fn selector(f: impl FnMut() -> R + 'static) -> ReadOnlySignal< /// Creates a new Selector that may be Sync + Send. The selector will be run immediately and whenever any signal it reads changes. /// /// Selectors can be used to efficiently compute derived data from signals. +#[track_caller] pub fn maybe_sync_selector>>( mut f: impl FnMut() -> R + 'static, ) -> ReadOnlySignal { diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index d99807f0a..700d9cb1f 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -99,11 +99,20 @@ pub fn use_signal(cx: &ScopeState, f: impl FnOnce() -> T) -> Signal< /// } /// ``` #[must_use] +#[track_caller] pub fn use_signal_sync( cx: &ScopeState, f: impl FnOnce() -> T, ) -> Signal { - *cx.use_hook(|| Signal::new_maybe_sync(f())) + #[cfg(debug_assertions)] + let caller = std::panic::Location::caller(); + *cx.use_hook(|| { + Signal::new_with_caller( + f(), + #[cfg(debug_assertions)] + caller, + ) + }) } #[derive(Clone)] @@ -207,6 +216,7 @@ impl Signal { } /// Create a new signal with a custom owner scope. The signal will be dropped when the owner scope is dropped instead of the current scope. + #[track_caller] pub fn new_in_scope(value: T, owner: ScopeId) -> Self { Self::new_maybe_sync_in_scope(value, owner) } @@ -214,6 +224,7 @@ impl Signal { impl>> Signal { /// Creates a new Signal. Signals are a Copy state management solution with automatic dependency tracking. + #[track_caller] #[tracing::instrument(skip(value))] pub fn new_maybe_sync(value: T) -> Self { Self { @@ -246,6 +257,7 @@ impl>> Signal { } /// Create a new signal with a custom owner scope. The signal will be dropped when the owner scope is dropped instead of the current scope. + #[track_caller] #[tracing::instrument(skip(value))] pub fn new_maybe_sync_in_scope(value: T, owner: ScopeId) -> Self { Self { @@ -513,6 +525,7 @@ pub struct ReadOnlySignal> = UnsyncStorage> impl ReadOnlySignal { /// Create a new read-only signal. + #[track_caller] pub fn new(signal: Signal) -> Self { Self::new_maybe_sync(signal) } @@ -520,6 +533,7 @@ impl ReadOnlySignal { impl>> ReadOnlySignal { /// Create a new read-only signal that is maybe sync. + #[track_caller] pub fn new_maybe_sync(signal: Signal) -> Self { Self { inner: signal } } @@ -542,7 +556,9 @@ impl>> ReadOnlySignal { /// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.** /// /// If the signal has been dropped, this will panic. - pub fn peek(&self) -> GenerationalRef { + pub fn peek( + &self, + ) -> <>>::Ref as Mappable>>::Mapped { self.inner.peek() } From e0ff6ce4dad3052ec8d07f2033fb6f3b06ab2749 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Sun, 17 Dec 2023 17:42:34 -0600 Subject: [PATCH 18/19] fix some merge changes in generational box --- packages/generational-box/src/lib.rs | 303 --------------------------- 1 file changed, 303 deletions(-) diff --git a/packages/generational-box/src/lib.rs b/packages/generational-box/src/lib.rs index 467868fb1..b8fdee94b 100644 --- a/packages/generational-box/src/lib.rs +++ b/packages/generational-box/src/lib.rs @@ -485,309 +485,6 @@ impl MemoryLocation { _marker: PhantomData, } } - - #[track_caller] - fn try_borrow( - &self, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: &'static std::panic::Location<'static>, - ) -> Result, BorrowError> { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - self.0 - .borrowed_at - .borrow_mut() - .push(std::panic::Location::caller()); - match self.0.data.try_borrow() { - Ok(borrow) => match Ref::filter_map(borrow, |any| any.as_ref()?.downcast_ref::()) { - Ok(reference) => Ok(GenerationalRef { - inner: reference, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo { - borrowed_at: std::panic::Location::caller(), - borrowed_from: self.0, - }, - }), - Err(_) => Err(BorrowError::Dropped(ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at, - })), - }, - Err(_) => Err(BorrowError::AlreadyBorrowedMut(AlreadyBorrowedMutError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: self.0.borrowed_mut_at.get().unwrap(), - })), - } - } - - #[track_caller] - fn try_borrow_mut( - &self, - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: &'static std::panic::Location<'static>, - ) -> Result, BorrowMutError> { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - { - self.0 - .borrowed_mut_at - .set(Some(std::panic::Location::caller())); - } - match self.0.data.try_borrow_mut() { - Ok(borrow_mut) => { - match RefMut::filter_map(borrow_mut, |any| any.as_mut()?.downcast_mut::()) { - Ok(reference) => Ok(GenerationalRefMut { - inner: reference, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefMutBorrowInfo { - borrowed_from: self.0, - }, - }), - Err(_) => Err(BorrowMutError::Dropped(ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at, - })), - } - } - Err(_) => Err(BorrowMutError::AlreadyBorrowed(AlreadyBorrowedError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: self.0.borrowed_at.borrow().clone(), - })), - } - } -} - -#[derive(Debug, Clone)] -/// An error that can occur when trying to borrow a value. -pub enum BorrowError { - /// The value was dropped. - Dropped(ValueDroppedError), - /// The value was already borrowed mutably. - AlreadyBorrowedMut(AlreadyBorrowedMutError), -} - -impl Display for BorrowError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - BorrowError::Dropped(error) => Display::fmt(error, f), - BorrowError::AlreadyBorrowedMut(error) => Display::fmt(error, f), - } - } -} - -impl Error for BorrowError {} - -#[derive(Debug, Clone)] -/// An error that can occur when trying to borrow a value mutably. -pub enum BorrowMutError { - /// The value was dropped. - Dropped(ValueDroppedError), - /// The value was already borrowed. - AlreadyBorrowed(AlreadyBorrowedError), - /// The value was already borrowed mutably. - AlreadyBorrowedMut(AlreadyBorrowedMutError), -} - -impl Display for BorrowMutError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - BorrowMutError::Dropped(error) => Display::fmt(error, f), - BorrowMutError::AlreadyBorrowedMut(error) => Display::fmt(error, f), - BorrowMutError::AlreadyBorrowed(error) => Display::fmt(error, f), - } - } -} - -impl Error for BorrowMutError {} - -/// An error that can occur when trying to use a value that has been dropped. -#[derive(Debug, Copy, Clone)] -pub struct ValueDroppedError { - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - created_at: &'static std::panic::Location<'static>, -} - -impl Display for ValueDroppedError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("Failed to borrow because the value was dropped.")?; - #[cfg(any(debug_assertions, feature = "debug_ownership"))] - f.write_fmt(format_args!("created_at: {}", self.created_at))?; - Ok(()) - } -} - -impl std::error::Error for ValueDroppedError {} - -/// An error that can occur when trying to borrow a value that has already been borrowed mutably. -#[derive(Debug, Copy, Clone)] -pub struct AlreadyBorrowedMutError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_mut_at: &'static std::panic::Location<'static>, -} - -impl Display for AlreadyBorrowedMutError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("Failed to borrow because the value was already borrowed mutably.")?; - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - f.write_fmt(format_args!("borrowed_mut_at: {}", self.borrowed_mut_at))?; - Ok(()) - } -} - -impl std::error::Error for AlreadyBorrowedMutError {} - -/// An error that can occur when trying to borrow a value mutably that has already been borrowed immutably. -#[derive(Debug, Clone)] -pub struct AlreadyBorrowedError { - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrowed_at: Vec<&'static std::panic::Location<'static>>, -} - -impl Display for AlreadyBorrowedError { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - f.write_str("Failed to borrow mutably because the value was already borrowed immutably.")?; - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - f.write_str("borrowed_at:")?; - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - for location in self.borrowed_at.iter() { - f.write_fmt(format_args!("\t{}", location))?; - } - Ok(()) - } -} - -impl std::error::Error for AlreadyBorrowedError {} - -/// A reference to a value in a generational box. -pub struct GenerationalRef { - inner: Ref<'static, T>, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo, -} - -impl GenerationalRef { - /// Map one ref type to another. - pub fn map(orig: GenerationalRef, f: F) -> GenerationalRef - where - F: FnOnce(&T) -> &U, - { - GenerationalRef { - inner: Ref::map(orig.inner, f), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo { - borrowed_at: orig.borrow.borrowed_at, - borrowed_from: orig.borrow.borrowed_from, - }, - } - } - - /// Filter one ref type to another. - pub fn filter_map(orig: GenerationalRef, f: F) -> Option> - where - F: FnOnce(&T) -> Option<&U>, - { - let Self { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow, - } = orig; - Ref::filter_map(inner, f).ok().map(|inner| GenerationalRef { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefBorrowInfo { - borrowed_at: borrow.borrowed_at, - borrowed_from: borrow.borrowed_from, - }, - }) - } -} - -impl Deref for GenerationalRef { - type Target = T; - - fn deref(&self) -> &Self::Target { - self.inner.deref() - } -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -struct GenerationalRefBorrowInfo { - borrowed_at: &'static std::panic::Location<'static>, - borrowed_from: &'static MemoryLocationInner, -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -impl Drop for GenerationalRefBorrowInfo { - fn drop(&mut self) { - self.borrowed_from - .borrowed_at - .borrow_mut() - .retain(|location| std::ptr::eq(*location, self.borrowed_at as *const _)); - } -} - -/// A mutable reference to a value in a generational box. -pub struct GenerationalRefMut { - inner: RefMut<'static, T>, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: GenerationalRefMutBorrowInfo, -} - -impl GenerationalRefMut { - /// Map one ref type to another. - pub fn map(orig: GenerationalRefMut, f: F) -> GenerationalRefMut - where - F: FnOnce(&mut T) -> &mut U, - { - GenerationalRefMut { - inner: RefMut::map(orig.inner, f), - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow: orig.borrow, - } - } - - /// Filter one ref type to another. - pub fn filter_map(orig: GenerationalRefMut, f: F) -> Option> - where - F: FnOnce(&mut T) -> Option<&mut U>, - { - let Self { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow, - } = orig; - RefMut::filter_map(inner, f) - .ok() - .map(|inner| GenerationalRefMut { - inner, - #[cfg(any(debug_assertions, feature = "debug_borrows"))] - borrow, - }) - } -} - -impl Deref for GenerationalRefMut { - type Target = T; - - fn deref(&self) -> &Self::Target { - self.inner.deref() - } -} - -impl DerefMut for GenerationalRefMut { - fn deref_mut(&mut self) -> &mut Self::Target { - self.inner.deref_mut() - } -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -struct GenerationalRefMutBorrowInfo { - borrowed_from: &'static MemoryLocationInner, -} - -#[cfg(any(debug_assertions, feature = "debug_borrows"))] -impl Drop for GenerationalRefMutBorrowInfo { - fn drop(&mut self) { - self.borrowed_from.borrowed_mut_at.take(); - } } /// Owner: Handles dropping generational boxes. The owner acts like a runtime lifetime guard. Any states that you create with an owner will be dropped when that owner is dropped. From 5ab0c48dddd86578bfe260a28446254621823daa Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Sun, 17 Dec 2023 17:55:02 -0600 Subject: [PATCH 19/19] fix clippy --- packages/cli/src/cli/autoformat.rs | 2 -- packages/signals/examples/errors.rs | 32 ++++++++++++++--------------- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/packages/cli/src/cli/autoformat.rs b/packages/cli/src/cli/autoformat.rs index 8cbb86269..2c0691d6c 100644 --- a/packages/cli/src/cli/autoformat.rs +++ b/packages/cli/src/cli/autoformat.rs @@ -147,8 +147,6 @@ async fn autoformat_project(check: bool) -> Result<()> { return Ok(()); } - let indent = indentation_for(&files_to_format[0])?; - if files_to_format.is_empty() { return Ok(()); } diff --git a/packages/signals/examples/errors.rs b/packages/signals/examples/errors.rs index d082e55bb..8155f9192 100644 --- a/packages/signals/examples/errors.rs +++ b/packages/signals/examples/errors.rs @@ -10,9 +10,9 @@ fn main() { #[derive(Clone, Copy)] enum ErrorComponent { - ReadsSignal, - ReadsMutSignal, - ReadDroppedSignal, + Read, + ReadMut, + ReadDropped, } fn app(cx: Scope) -> Element { @@ -20,28 +20,28 @@ fn app(cx: Scope) -> Element { render! { match *error() { - Some(ErrorComponent::ReadsSignal) => render! { ReadsSignal {} }, - Some(ErrorComponent::ReadsMutSignal) => render! { ReadsMutSignal {} }, - Some(ErrorComponent::ReadDroppedSignal) => render! { ReadDroppedSignal {} }, + Some(ErrorComponent::Read) => render! { Read {} }, + Some(ErrorComponent::ReadMut) => render! { ReadMut {} }, + Some(ErrorComponent::ReadDropped) => render! { ReadDropped {} }, None => render! { button { - onclick: move |_| error.set(Some(ErrorComponent::ReadsSignal)), - "ReadsSignal" + onclick: move |_| error.set(Some(ErrorComponent::Read)), + "Read" } button { - onclick: move |_| error.set(Some(ErrorComponent::ReadsMutSignal)), - "ReadsMutSignal" + onclick: move |_| error.set(Some(ErrorComponent::ReadMut)), + "ReadMut" } button { - onclick: move |_| error.set(Some(ErrorComponent::ReadDroppedSignal)), - "ReadDroppedSignal" + onclick: move |_| error.set(Some(ErrorComponent::ReadDropped)), + "ReadDropped" } } } } } -fn ReadsSignal(cx: Scope) -> Element { +fn Read(cx: Scope) -> Element { let signal = use_signal_sync(cx, || 0); let _write = signal.write(); @@ -50,7 +50,7 @@ fn ReadsSignal(cx: Scope) -> Element { todo!() } -fn ReadsMutSignal(cx: Scope) -> Element { +fn ReadMut(cx: Scope) -> Element { let signal = use_signal_sync(cx, || 0); let _read = signal.read(); @@ -59,7 +59,7 @@ fn ReadsMutSignal(cx: Scope) -> Element { todo!() } -fn ReadDroppedSignal(cx: Scope) -> Element { +fn ReadDropped(cx: Scope) -> Element { let signal = use_signal_sync(cx, || None); if cx.generation() < 4 { cx.needs_update(); @@ -82,7 +82,7 @@ fn ReadDroppedSignalChild( ) -> Element { let signal = use_signal_sync(cx, || 0); cx.use_hook(move || { - parent_signal.set(Some(signal.clone())); + parent_signal.set(Some(signal)); }); render! { "{signal}"