#[cfg(feature = "observability")]
pub use enabled::*;
#[cfg(not(feature = "observability"))]
pub use disabled::*;
#[cfg(feature = "observability")]
mod enabled {
use alloc::rc::Rc;
use core::any::type_name;
use core::cell::{Cell, RefCell};
use core::fmt;
use core::panic::Location;
use std::thread_local;
use crate::SignalIdentity;
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct SignalNode {
identity: SignalIdentity,
location: &'static Location<'static>,
type_name: &'static str,
}
impl SignalNode {
#[must_use]
pub const fn identity(self) -> SignalIdentity {
self.identity
}
#[must_use]
pub const fn location(self) -> &'static Location<'static> {
self.location
}
#[must_use]
pub const fn type_name(self) -> &'static str {
self.type_name
}
}
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct Origin(Option<SignalNode>);
impl Origin {
#[must_use]
#[track_caller]
pub fn capture<T: ?Sized>(identity: SignalIdentity) -> Self {
Self(Some(SignalNode {
identity,
location: Location::caller(),
type_name: type_name::<T>(),
}))
}
#[must_use]
pub(crate) const fn unattributed() -> Self {
Self(None)
}
#[must_use]
pub const fn node(self) -> Option<SignalNode> {
self.0
}
}
pub trait SignalObserver {
fn on_create(&self, node: SignalNode);
fn on_subscribe(&self, node: SignalNode, subscribers: usize);
fn on_unsubscribe(&self, node: SignalNode, subscribers: usize);
fn on_notify(&self, node: SignalNode, subscribers: usize);
fn on_drop(&self, node: SignalNode);
}
thread_local! {
static OBSERVER: RefCell<Option<Rc<dyn SignalObserver>>> = const { RefCell::new(None) };
static DISPATCHING: Cell<bool> = const { Cell::new(false) };
}
#[must_use = "the observer is uninstalled when the scope is dropped"]
pub struct ObserverScope {
previous: Option<Rc<dyn SignalObserver>>,
}
impl fmt::Debug for ObserverScope {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
formatter
.debug_struct("ObserverScope")
.field("restores_previous", &self.previous.is_some())
.finish()
}
}
impl ObserverScope {
pub fn install(observer: Rc<dyn SignalObserver>) -> Self {
let previous = OBSERVER.with(|slot| slot.borrow_mut().replace(observer));
Self { previous }
}
}
impl Drop for ObserverScope {
fn drop(&mut self) {
let previous = self.previous.take();
let _ = OBSERVER.try_with(|slot| {
*slot.borrow_mut() = previous;
});
}
}
fn dispatch(origin: Origin, run: impl FnOnce(&dyn SignalObserver, SignalNode)) {
let Some(node) = origin.0 else {
return;
};
let Ok(false) = DISPATCHING.try_with(Cell::get) else {
return;
};
let Ok(Some(observer)) = OBSERVER.try_with(|slot| slot.borrow().clone()) else {
return;
};
DISPATCHING.with(|flag| flag.set(true));
run(observer.as_ref(), node);
DISPATCHING.with(|flag| flag.set(false));
}
pub fn on_create(origin: Origin) {
dispatch(origin, |observer, node| observer.on_create(node));
}
pub fn on_subscribe(origin: Origin, subscribers: usize) {
dispatch(origin, |observer, node| {
observer.on_subscribe(node, subscribers);
});
}
pub fn on_unsubscribe(origin: Origin, subscribers: usize) {
dispatch(origin, |observer, node| {
observer.on_unsubscribe(node, subscribers);
});
}
pub fn on_notify(origin: Origin, subscribers: usize) {
dispatch(origin, |observer, node| {
observer.on_notify(node, subscribers);
});
}
pub fn on_drop(origin: Origin) {
dispatch(origin, |observer, node| observer.on_drop(node));
}
}
#[cfg(not(feature = "observability"))]
mod disabled {
use crate::SignalIdentity;
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct Origin;
impl Origin {
#[must_use]
pub const fn capture<T: ?Sized>(_identity: SignalIdentity) -> Self {
Self
}
#[must_use]
pub(crate) const fn unattributed() -> Self {
Self
}
}
pub const fn on_create(_origin: Origin) {}
pub const fn on_subscribe(_origin: Origin, _subscribers: usize) {}
pub const fn on_unsubscribe(_origin: Origin, _subscribers: usize) {}
pub const fn on_notify(_origin: Origin, _subscribers: usize) {}
pub const fn on_drop(_origin: Origin) {}
}
#[cfg(test)]
mod tests {
use super::Origin;
#[cfg(not(feature = "observability"))]
#[test]
fn origin_is_zero_sized_when_disabled() {
assert_eq!(core::mem::size_of::<Origin>(), 0);
}
#[cfg(feature = "observability")]
#[test]
fn attributed_origin_costs_no_more_than_its_node() {
use super::SignalNode;
assert_eq!(
core::mem::size_of::<Origin>(),
core::mem::size_of::<SignalNode>(),
"the Option must be niched into the location reference"
);
assert_eq!(
core::mem::size_of::<SignalNode>(),
4 * core::mem::size_of::<usize>()
);
}
#[cfg(feature = "observability")]
#[test]
fn origin_reports_the_constructor_caller() {
use crate::SignalIdentity;
use alloc::rc::Rc;
#[track_caller]
fn construct(identity: SignalIdentity) -> Origin {
Origin::capture::<i32>(identity)
}
let cell = Rc::new(0_i32);
let node = construct(SignalIdentity::from_rc(&cell))
.node()
.expect("captured origin must be attributed");
assert_eq!(node.location().file(), file!());
assert!(node.type_name().contains("i32"));
}
#[cfg(feature = "observability")]
#[test]
fn default_origin_is_unattributed() {
assert!(Origin::default().node().is_none());
}
}