sinomo-ui-reactive 0.3.0

Architecture-neutral observable signals and selectors for SUI.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
#![forbid(unsafe_code)]

//! Architecture-neutral observable values for SUI.
//!
//! This crate owns state and change notification only. It does not depend on
//! the SUI widget runtime, so applications may adapt other stores through
//! [`Observable`] without adopting a SUI-owned application architecture.

use std::{
    fmt,
    marker::PhantomData,
    sync::{
        Arc, Mutex, RwLock, Weak,
        atomic::{AtomicU64, Ordering},
    },
};

static NEXT_SOURCE_ID: AtomicU64 = AtomicU64::new(1);

/// Stable identity for one observable source.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct SourceId(u64);

impl SourceId {
    pub const fn get(self) -> u64 {
        self.0
    }

    /// Allocate a process-unique observable source identifier.
    pub fn new() -> Self {
        Self(NEXT_SOURCE_ID.fetch_add(1, Ordering::Relaxed))
    }
}

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

/// Metadata emitted when an observable value changes.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Change {
    pub source_id: SourceId,
    pub source_name: Arc<str>,
    pub version: u64,
}

type ObserverCallback = dyn Fn(Change) + Send + Sync + 'static;

struct ObserverInner {
    callback: Box<ObserverCallback>,
}

/// Cloneable change observer used by observable implementations.
#[derive(Clone)]
pub struct Observer {
    inner: Arc<ObserverInner>,
}

impl Observer {
    pub fn new(callback: impl Fn(Change) + Send + Sync + 'static) -> Self {
        Self {
            inner: Arc::new(ObserverInner {
                callback: Box::new(callback),
            }),
        }
    }

    pub fn notify(&self, change: Change) {
        (self.inner.callback)(change);
    }

    pub fn downgrade(&self) -> WeakObserver {
        WeakObserver {
            inner: Arc::downgrade(&self.inner),
        }
    }
}

impl fmt::Debug for Observer {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.debug_struct("Observer").finish_non_exhaustive()
    }
}

/// Weak observer reference suitable for storage inside custom observables.
#[derive(Clone)]
pub struct WeakObserver {
    inner: Weak<ObserverInner>,
}

impl WeakObserver {
    /// Notify the observer, returning `false` after its subscription was
    /// dropped.
    pub fn notify(&self, change: Change) -> bool {
        let Some(observer) = self.inner.upgrade() else {
            return false;
        };
        (observer.callback)(change);
        true
    }
}

impl fmt::Debug for WeakObserver {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("WeakObserver")
            .finish_non_exhaustive()
    }
}

/// Keeps an observable subscription alive.
///
/// Dropping the guard releases the strong observer reference. Sources retain
/// only weak references and prune them during later notifications.
pub struct Subscription {
    _observer: Observer,
}

impl Subscription {
    pub fn new(observer: Observer) -> Self {
        Self {
            _observer: observer,
        }
    }
}

impl fmt::Debug for Subscription {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("Subscription")
            .finish_non_exhaustive()
    }
}

/// Readable value that can notify subscribers after meaningful changes.
///
/// SUI's runtime consumes this trait, so applications may provide adapters for
/// reducer stores, channels, actor snapshots, or other state architectures.
pub trait Observable<T> {
    fn source_id(&self) -> SourceId;
    fn source_name(&self) -> Arc<str>;
    fn get(&self) -> T;
    fn subscribe(&self, observer: Observer) -> Subscription;
}

struct SignalInner<T> {
    id: SourceId,
    name: Arc<str>,
    value: RwLock<T>,
    version: AtomicU64,
    observers: Mutex<Vec<Weak<ObserverInner>>>,
}

/// Cloneable observable storage with equality-deduplicated writes.
pub struct Signal<T> {
    inner: Arc<SignalInner<T>>,
}

impl<T> Clone for Signal<T> {
    fn clone(&self) -> Self {
        Self {
            inner: Arc::clone(&self.inner),
        }
    }
}

impl<T> fmt::Debug for Signal<T>
where
    T: fmt::Debug + Clone,
{
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("Signal")
            .field("id", &self.inner.id)
            .field("name", &self.inner.name)
            .field("value", &self.read_value())
            .field("version", &self.version())
            .finish()
    }
}

impl<T> Signal<T> {
    pub fn new(value: T) -> Self {
        Self::named("Signal", value)
    }

    pub fn named(name: impl Into<Arc<str>>, value: T) -> Self {
        Self {
            inner: Arc::new(SignalInner {
                id: SourceId::new(),
                name: name.into(),
                value: RwLock::new(value),
                version: AtomicU64::new(0),
                observers: Mutex::new(Vec::new()),
            }),
        }
    }

    pub fn source_id(&self) -> SourceId {
        self.inner.id
    }

    pub fn source_name(&self) -> Arc<str> {
        Arc::clone(&self.inner.name)
    }

    pub fn version(&self) -> u64 {
        self.inner.version.load(Ordering::Acquire)
    }

    pub fn get(&self) -> T
    where
        T: Clone,
    {
        self.read_value()
    }

    pub fn set(&self, value: T) -> bool
    where
        T: PartialEq,
    {
        {
            let mut current = self
                .inner
                .value
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            if *current == value {
                return false;
            }
            *current = value;
        }
        self.notify();
        true
    }

    pub fn update(&self, update: impl FnOnce(&mut T)) -> bool
    where
        T: Clone + PartialEq,
    {
        {
            let mut current = self
                .inner
                .value
                .write()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            let previous = current.clone();
            update(&mut current);
            if *current == previous {
                return false;
            }
        }
        self.notify();
        true
    }

    pub fn select<U>(
        &self,
        select: impl Fn(&T) -> U + Send + Sync + 'static,
    ) -> Selector<Self, T, U>
    where
        T: Clone + Send + Sync + 'static,
        U: Clone + PartialEq + Send + Sync + 'static,
    {
        self.select_named("Selector", select)
    }

    pub fn select_named<U>(
        &self,
        name: impl Into<Arc<str>>,
        select: impl Fn(&T) -> U + Send + Sync + 'static,
    ) -> Selector<Self, T, U>
    where
        T: Clone + Send + Sync + 'static,
        U: Clone + PartialEq + Send + Sync + 'static,
    {
        Selector::new(name, self.clone(), select)
    }

    fn read_value(&self) -> T
    where
        T: Clone,
    {
        self.inner
            .value
            .read()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .clone()
    }

    fn notify(&self) {
        let version = self.inner.version.fetch_add(1, Ordering::AcqRel) + 1;
        let change = Change {
            source_id: self.inner.id,
            source_name: Arc::clone(&self.inner.name),
            version,
        };
        let observers = {
            let mut observers = self
                .inner
                .observers
                .lock()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            let mut live = Vec::with_capacity(observers.len());
            observers.retain(|observer| {
                if let Some(observer) = observer.upgrade() {
                    live.push(observer);
                    true
                } else {
                    false
                }
            });
            live
        };
        for observer in observers {
            (observer.callback)(change.clone());
        }
    }
}

impl<T> Observable<T> for Signal<T>
where
    T: Clone + 'static,
{
    fn source_id(&self) -> SourceId {
        self.source_id()
    }

    fn source_name(&self) -> Arc<str> {
        self.source_name()
    }

    fn get(&self) -> T {
        self.get()
    }

    fn subscribe(&self, observer: Observer) -> Subscription {
        self.inner
            .observers
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .push(Arc::downgrade(&observer.inner));
        Subscription::new(observer)
    }
}

struct SelectorInner<S, I, O> {
    id: SourceId,
    name: Arc<str>,
    source: S,
    select: Arc<dyn Fn(&I) -> O + Send + Sync>,
    version: AtomicU64,
    _input: PhantomData<fn(I)>,
}

/// Equality-deduplicated derived observable.
pub struct Selector<S, I, O> {
    inner: Arc<SelectorInner<S, I, O>>,
}

impl<S, I, O> Clone for Selector<S, I, O> {
    fn clone(&self) -> Self {
        Self {
            inner: Arc::clone(&self.inner),
        }
    }
}

impl<S, I, O> Selector<S, I, O> {
    pub fn new(
        name: impl Into<Arc<str>>,
        source: S,
        select: impl Fn(&I) -> O + Send + Sync + 'static,
    ) -> Self {
        Self {
            inner: Arc::new(SelectorInner {
                id: SourceId::new(),
                name: name.into(),
                source,
                select: Arc::new(select),
                version: AtomicU64::new(0),
                _input: PhantomData,
            }),
        }
    }
}

impl<S, I, O> Observable<O> for Selector<S, I, O>
where
    S: Observable<I> + Clone + Send + Sync + 'static,
    I: Clone + Send + Sync + 'static,
    O: Clone + PartialEq + Send + Sync + 'static,
{
    fn source_id(&self) -> SourceId {
        self.inner.id
    }

    fn source_name(&self) -> Arc<str> {
        Arc::clone(&self.inner.name)
    }

    fn get(&self) -> O {
        (self.inner.select)(&self.inner.source.get())
    }

    fn subscribe(&self, observer: Observer) -> Subscription {
        let last = Arc::new(Mutex::new(self.get()));
        let source = self.inner.source.clone();
        let select = Arc::clone(&self.inner.select);
        let selector = Arc::clone(&self.inner);
        let source_observer = Observer::new(move |_change| {
            let next = select(&source.get());
            let version = {
                let mut previous = last
                    .lock()
                    .unwrap_or_else(std::sync::PoisonError::into_inner);
                if *previous == next {
                    return;
                }
                *previous = next;
                selector.version.fetch_add(1, Ordering::AcqRel) + 1
            };
            // Observers may synchronously write back to the source and reenter
            // this subscription. Never call application code with `last` locked.
            observer.notify(Change {
                source_id: selector.id,
                source_name: Arc::clone(&selector.name),
                version,
            });
        });
        self.inner.source.subscribe(source_observer)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::atomic::AtomicUsize;

    #[test]
    fn signal_notifies_only_for_meaningful_changes() {
        let signal = Signal::named("count", 1usize);
        let notifications = Arc::new(AtomicUsize::new(0));
        let count = Arc::clone(&notifications);
        let _subscription = signal.subscribe(Observer::new(move |_| {
            count.fetch_add(1, Ordering::Relaxed);
        }));

        assert!(!signal.set(1));
        assert!(signal.set(2));
        assert_eq!(notifications.load(Ordering::Relaxed), 1);
        assert_eq!(signal.version(), 1);
    }

    #[test]
    fn selector_deduplicates_unrelated_source_changes() {
        #[derive(Clone, PartialEq)]
        struct State {
            selected: usize,
            detail: String,
        }

        let state = Signal::new(State {
            selected: 0,
            detail: "first".to_string(),
        });
        let selected = state.select_named("selected", |state| state.selected);
        let notifications = Arc::new(AtomicUsize::new(0));
        let count = Arc::clone(&notifications);
        let _subscription = selected.subscribe(Observer::new(move |_| {
            count.fetch_add(1, Ordering::Relaxed);
        }));

        state.update(|state| state.detail = "second".to_string());
        assert_eq!(notifications.load(Ordering::Relaxed), 0);
        state.update(|state| state.selected = 1);
        assert_eq!(notifications.load(Ordering::Relaxed), 1);
        assert_eq!(selected.get(), 1);
    }

    #[test]
    fn selector_observer_can_write_back_to_its_source() {
        let (done, completed) = std::sync::mpsc::channel();
        let worker = std::thread::spawn(move || {
            let source = Signal::new(0_u32);
            let selected = source.select(|value| *value);
            let writer = source.clone();
            let observed = Arc::new(Mutex::new(Vec::new()));
            let values = Arc::clone(&observed);
            let _subscription = selected.subscribe(Observer::new(move |_| {
                let value = writer.get();
                values.lock().unwrap().push(value);
                if value == 1 {
                    writer.set(2);
                }
            }));
            source.set(1);
            // An equal write must still be deduplicated after reentrant delivery.
            assert!(!source.set(2));
            done.send((source.get(), observed.lock().unwrap().clone()))
                .unwrap();
        });
        let (value, observed) = completed
            .recv_timeout(std::time::Duration::from_secs(5))
            .expect("selector source write-back deadlocked");
        worker.join().unwrap();
        assert_eq!(value, 2);
        assert_eq!(observed, vec![1, 2]);
    }
}