Skip to content
Draft
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[workspace]
members = [".", "yewdux-macros"]

[package]
name = "yewdux-middleware"
version = "0.4.0"
Expand All @@ -10,7 +13,22 @@ license = "MIT OR Apache-2.0"
readme = "README.md"
#forced-target = "wasm32-unknown-unknown"

[features]
default = ["future"]
future = []

[dependencies]
yewdux = { version = "0.11.0", default-features = false }
yew = { version = "0.22.0", default-features = false }
anymap2 = "0.13.0"

# === yewdux embedded dependencies (can be removed if switching back to external yewdux) ===
yewdux-macros = { path = "./yewdux-macros" }
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The yewdux-macros crate cannot be published on crates.io under this name, as it is already taken by the yewdux-macros upstream crate.

You need to rename this to yewdux-middleware-macros.

Also please update the CI job to also build the yewdux-middleware-macros crate, and the publish actions to also publish this crate.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed to yewdux-middleware-macros and updated all CI/publish workflows. The macros crate is now built separately in CI and published before the main crate. Changes in commit 97cec3d.

log = "0.4.16"
serde = { version = "1.0.114", features = ["rc"] }
serde_json = "1.0.64"
slab = "0.4"
thiserror = "1.0"
web-sys = "0.3"
chrono = "0.4.22"
wasm-bindgen = "0.2"
# === end yewdux embedded dependencies ===
8 changes: 5 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
use std::rc::Rc;

pub mod yewdux;

pub use yewdux::prelude::{Reducer, Store};

pub use self::context::*;
Expand Down Expand Up @@ -47,7 +49,7 @@ mod context {
use std::rc::Rc;

use anymap2::AnyMap;
use yewdux::{mrc::Mrc, Context};
use crate::yewdux::{mrc::Mrc, Context};

use crate::MiddlewareDispatch;

Expand Down Expand Up @@ -87,8 +89,8 @@ mod context {

pub fn store<M, S>(&self, msg: M)
where
M: yewdux::prelude::Reducer<S>,
S: yewdux::prelude::Store,
M: crate::yewdux::prelude::Reducer<S>,
S: crate::yewdux::prelude::Store,
{
self.context.reduce(move |state| msg.apply(state));
}
Expand Down
37 changes: 37 additions & 0 deletions src/yewdux/anymap.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
use std::{
any::{Any, TypeId},
collections::HashMap,
};

#[derive(Default)]
pub(crate) struct AnyMap {
map: HashMap<TypeId, Box<dyn Any>>,
}

impl AnyMap {
pub(crate) fn entry<T: 'static>(&mut self) -> Entry<T> {
Entry {
map: &mut self.map,
_marker: std::marker::PhantomData,
}
}
}

pub(crate) struct Entry<'a, T: 'static> {
map: &'a mut HashMap<TypeId, Box<dyn Any>>,
_marker: std::marker::PhantomData<T>,
}

impl<'a, T: 'static> Entry<'a, T> {
pub(crate) fn or_insert_with<F>(self, default: F) -> &'a mut T
where
F: FnOnce() -> T,
{
let type_id = TypeId::of::<T>();
let value = self
.map
.entry(type_id)
.or_insert_with(|| Box::new(default()));
value.downcast_mut().expect("type id mismatch")
}
}
271 changes: 271 additions & 0 deletions src/yewdux/context.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
use std::rc::Rc;

use crate::yewdux::{
anymap::AnyMap,
mrc::Mrc,
store::{Reducer, Store},
subscriber::{Callable, SubscriberId, Subscribers},
};

pub(crate) struct Entry<S> {
pub(crate) store: Mrc<Rc<S>>,
}

impl<S> Clone for Entry<S> {
fn clone(&self) -> Self {
Self {
store: Mrc::clone(&self.store),
}
}
}

impl<S: Store> Entry<S> {
/// Apply a function to state, returning if it should notify subscribers or not.
pub(crate) fn reduce<R: Reducer<S>>(&self, reducer: R) -> bool {
let old = Rc::clone(&self.store.borrow());
// Apply the reducer.
let new = reducer.apply(Rc::clone(&old));
// Update to new state.
*self.store.borrow_mut() = new;
// Return whether or not subscribers should be notified.
self.store.borrow().should_notify(&old)
}
}

/// Execution context for a dispatch
///
/// # Example
///
/// ```
/// use yewdux::prelude::*;
///
/// #[derive(Clone, PartialEq, Default, Store)]
/// struct Counter(usize);
///
/// // In a real application, you'd typically get the context from a parent component
/// let cx = yewdux::Context::new();
/// let dispatch = Dispatch::<Counter>::new(&cx);
/// ```
#[derive(Clone, Default, PartialEq)]
pub struct Context {
inner: Mrc<AnyMap>,
}

impl Context {
pub fn new() -> Self {
Default::default()
}

#[cfg(any(doc, feature = "doctests", target_arch = "wasm32"))]
pub fn global() -> Self {
thread_local! {
static CONTEXT: Context = Default::default();
}

CONTEXT
.try_with(|cx| cx.clone())
.expect("CONTEXTS thread local key init failed")
}

/// Initialize a store using a custom constructor. `Store::new` will not be called in this
/// case. If already initialized, the custom constructor will not be called.
pub fn init<S: Store, F: FnOnce(&Self) -> S>(&self, new_store: F) {
self.get_or_init(new_store);
}

/// Get or initialize a store using a custom constructor. `Store::new` will not be called in
/// this case. If already initialized, the custom constructor will not be called.
pub(crate) fn get_or_init<S: Store, F: FnOnce(&Self) -> S>(&self, new_store: F) -> Entry<S> {
// Get context, or None if it doesn't exist.
//
// We use an option here because a new Store should not be created during this borrow. We
// want to allow this store access to other stores during creation, so cannot be borrowing
// the global resource while initializing. Instead we create a temporary placeholder, which
// indicates the store needs to be created. Without this indicator we would have needed to
// check if the map contains the entry beforehand, which would have meant two map lookups
// per call instead of just one.
let maybe_entry = self.inner.with_mut(|x| {
x.entry::<Mrc<Option<Entry<S>>>>()
.or_insert_with(|| None.into())
.clone()
});

// If it doesn't exist, create and save the new store.
let exists = maybe_entry.borrow().is_some();
if !exists {
// Init store outside of borrow. This allows the store to access other stores when it
// is being created.
let entry = Entry {
store: Mrc::new(Rc::new(new_store(self))),
};

*maybe_entry.borrow_mut() = Some(entry);
}

// Now we get the context, which must be initialized because we already checked above.
let entry = maybe_entry
.borrow()
.clone()
.expect("Context not initialized");

entry
}

/// Get or initialize a store with a default Store::new implementation.
pub(crate) fn get_or_init_default<S: Store>(&self) -> Entry<S> {
self.get_or_init(S::new)
}

pub fn reduce<S: Store, R: Reducer<S>>(&self, r: R) {
let entry = self.get_or_init_default::<S>();
let should_notify = entry.reduce(r);

if should_notify {
let state = Rc::clone(&entry.store.borrow());
self.notify_subscribers(state)
}
}

pub fn reduce_mut<S: Store + Clone, F: FnOnce(&mut S)>(&self, f: F) {
self.reduce(|mut state| {
f(Rc::make_mut(&mut state));
state
});
}

/// Set state to given value.
pub fn set<S: Store>(&self, value: S) {
self.reduce(move |_| value.into());
}

/// Get current state.
pub fn get<S: Store>(&self) -> Rc<S> {
Rc::clone(&self.get_or_init_default::<S>().store.borrow())
}

/// Send state to all subscribers.
pub fn notify_subscribers<S: Store>(&self, state: Rc<S>) {
let entry = self.get_or_init_default::<Mrc<Subscribers<S>>>();
entry.store.borrow().notify(state);
}

/// Subscribe to a store. `on_change` is called immediately, then every time state changes.
pub fn subscribe<S: Store, N: Callable<S>>(&self, on_change: N) -> SubscriberId<S> {
// Notify subscriber with inital state.
on_change.call(self.get::<S>());

self.get_or_init_default::<Mrc<Subscribers<S>>>()
.store
.borrow()
.subscribe(on_change)
}

/// Similar to [Self::subscribe], however state is not called immediately.
pub fn subscribe_silent<S: Store, N: Callable<S>>(&self, on_change: N) -> SubscriberId<S> {
self.get_or_init_default::<Mrc<Subscribers<S>>>()
.store
.borrow()
.subscribe(on_change)
}

/// Initialize a listener
pub fn init_listener<L: crate::yewdux::Listener, F: FnOnce() -> L>(&self, new_listener: F) {
crate::yewdux::init_listener(new_listener, self);
}

pub fn derived_from<Store, Derived>(&self)
where
Store: crate::Store,
Derived: crate::yewdux::derived_from::DerivedFrom<Store>,
{
crate::yewdux::derived_from::derive_from::<Store, Derived>(self);
}

pub fn derived_from_mut<Store, Derived>(&self)
where
Store: crate::Store,
Derived: crate::yewdux::derived_from::DerivedFromMut<Store>,
{
crate::yewdux::derived_from::derive_from_mut::<Store, Derived>(self);
}
}

#[cfg(test)]
mod tests {
use std::cell::Cell;
use std::rc::Rc;

use crate::yewdux::*;

#[derive(Clone, PartialEq, Eq)]
struct TestState(u32);
impl Store for TestState {
fn new(_cx: &Context) -> Self {
Self(0)
}

fn should_notify(&self, other: &Self) -> bool {
self != other
}
}

#[derive(Clone, PartialEq, Eq)]
struct TestState2(u32);
impl Store for TestState2 {
fn new(cx: &Context) -> Self {
cx.get_or_init_default::<TestState>();
Self(0)
}

fn should_notify(&self, other: &Self) -> bool {
self != other
}
}

#[test]
fn can_access_other_store_for_new_of_current_store() {
let _context = Context::new().get_or_init_default::<TestState2>();
}

#[derive(Clone, PartialEq, Eq)]
struct StoreNewIsOnlyCalledOnce(Rc<Cell<u32>>);
impl Store for StoreNewIsOnlyCalledOnce {
fn new(_cx: &Context) -> Self {
thread_local! {
/// Stores all shared state.
static COUNT: Rc<Cell<u32>> = Default::default();
}

let count = COUNT.try_with(|x| x.clone()).unwrap();

count.set(count.get() + 1);

Self(count)
}

fn should_notify(&self, other: &Self) -> bool {
self != other
}
}

#[test]
fn store_new_is_only_called_once() {
let cx = Context::new();
cx.get_or_init_default::<StoreNewIsOnlyCalledOnce>();
let entry = cx.get_or_init_default::<StoreNewIsOnlyCalledOnce>();

assert!(entry.store.borrow().0.get() == 1)
}

#[test]
fn recursive_reduce() {
let cx = Context::new();
let cx2 = cx.clone();
cx.reduce::<TestState, _>(|_s: Rc<TestState>| {
cx2.reduce::<TestState, _>(|s: Rc<TestState>| TestState(s.0 + 1).into());
TestState(cx2.get::<TestState>().0 + 1).into()
});

assert_eq!(cx.get::<TestState>().0, 2);
}
}
18 changes: 18 additions & 0 deletions src/yewdux/context_provider.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
use yew::prelude::*;

use crate::yewdux::context;

#[derive(PartialEq, Clone, Properties)]
pub struct Props {
pub children: Children,
}

#[function_component]
pub fn YewduxRoot(Props { children }: &Props) -> Html {
let ctx = use_state(context::Context::new);
html! {
<ContextProvider<context::Context> context={(*ctx).clone()}>
{ children.clone() }
</ContextProvider<context::Context>>
}
}
Loading