gpui_rhai/

store.rs

use std::collections::{BTreeMap, BTreeSet};
use std::rc::Rc;

use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::{
    ComponentInstancePath, ComponentStateSchema, SchemaValidationError, UiValue, UiValuePath,
    UiValuePathError,
};

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize, Deserialize)]
#[serde(tag = "scope", content = "id", rename_all = "snake_case")]
pub enum StoreScope {
    App,
    Window(String),
}

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize, Deserialize)]
pub struct StoreId {
    pub scope: StoreScope,
    pub name: String,
}

impl StoreId {
    #[must_use]
    pub fn app(name: impl Into<String>) -> Self {
        Self {
            scope: StoreScope::App,
            name: name.into(),
        }
    }

    #[must_use]
    pub fn window(window: impl Into<String>, name: impl Into<String>) -> Self {
        Self {
            scope: StoreScope::Window(window.into()),
            name: name.into(),
        }
    }
}

#[derive(Clone, Debug, Default)]
pub struct StoreRegistry {
    stores: Rc<BTreeMap<StoreId, StoreState>>,
    readers: Rc<BTreeMap<StoreField, BTreeSet<crate::read_dependency::ReadDependency>>>,
}

#[derive(Clone, Debug)]
struct StoreState {
    schema: Rc<ComponentStateSchema>,
    values: Rc<BTreeMap<String, UiValue>>,
}

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
struct StoreField {
    store: StoreId,
    field: String,
    path: Option<UiValuePath>,
}

impl StoreRegistry {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Declare an application- or window-scoped typed store.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError::DuplicateStore`] when the ID already exists.
    pub fn declare(&mut self, id: StoreId, schema: ComponentStateSchema) -> Result<(), StoreError> {
        if self.stores.contains_key(&id) {
            return Err(StoreError::DuplicateStore(id));
        }
        ComponentStateSchema::new(schema.fields().clone())?;
        let values = schema
            .fields()
            .iter()
            .map(|(name, field)| (name.clone(), field.default.clone()))
            .collect();
        Rc::make_mut(&mut self.stores).insert(
            id,
            StoreState {
                schema: Rc::new(schema),
                values: Rc::new(values),
            },
        );
        Ok(())
    }

    /// Begin tracking reads for one component render.
    ///
    /// Previous subscriptions for the component are removed first so
    /// conditional reads cannot leave stale invalidation edges.
    pub fn begin_read<'a>(&'a mut self, reader: &'a ComponentInstancePath) -> StoreReadSession<'a> {
        self.reset_reader(reader);
        StoreReadSession {
            registry: self,
            reader,
        }
    }

    pub fn reset_reader(&mut self, reader: &ComponentInstancePath) {
        self.reset_contribution(&crate::read_dependency::ReadDependency::component(reader));
    }
    pub(crate) fn reset_contribution(&mut self, reader: &crate::read_dependency::ReadDependency) {
        let tracked = Rc::make_mut(&mut self.readers);
        for readers in tracked.values_mut() {
            readers.remove(reader);
        }
        tracked.retain(|_, readers| !readers.is_empty());
    }

    /// Remove stale reader edges inside one successfully reconciled subtree.
    pub(crate) fn retain_contributions(
        &mut self,
        scope: &ComponentInstancePath,
        active: &BTreeSet<crate::read_dependency::ReadContribution>,
    ) {
        crate::read_dependency::retain_readers(Rc::make_mut(&mut self.readers), |reader| {
            reader.retained_in_contribution_scope(scope, active)
        });
    }

    /// Remove stale reader edges inside one successfully reconciled subtree.
    pub fn retain_reader_scope(
        &mut self,
        root: &ComponentInstancePath,
        active: &BTreeSet<ComponentInstancePath>,
    ) {
        let tracked = Rc::make_mut(&mut self.readers);
        for readers in tracked.values_mut() {
            readers.retain(|reader| reader.retained_in_owner_scope(root, active));
        }
        tracked.retain(|_, readers| !readers.is_empty());
    }

    /// Read a field and add one dependency without clearing earlier reads.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError::UnknownStore`] or [`StoreError::UnknownField`].
    pub fn read_tracked(
        &mut self,
        reader: &ComponentInstancePath,
        store: &StoreId,
        field: &str,
    ) -> Result<UiValue, StoreError> {
        self.read_dependency(
            &crate::read_dependency::ReadDependency::component(reader),
            store,
            field,
        )
    }
    pub(crate) fn read_dependency(
        &mut self,
        reader: &crate::read_dependency::ReadDependency,
        store: &StoreId,
        field: &str,
    ) -> Result<UiValue, StoreError> {
        let value = self
            .stores
            .get(store)
            .ok_or_else(|| StoreError::UnknownStore(store.clone()))?
            .values
            .get(field)
            .cloned()
            .ok_or_else(|| StoreError::UnknownField {
                store: store.clone(),
                field: field.to_owned(),
            })?;
        Rc::make_mut(&mut self.readers)
            .entry(StoreField {
                store: store.clone(),
                field: field.to_owned(),
                path: None,
            })
            .or_default()
            .insert(reader.clone());
        Ok(value)
    }

    /// Read one nested path and subscribe only to that value.
    ///
    /// # Errors
    ///
    /// Returns store/field errors or a precise [`UiValuePathError`].
    pub fn read_path_tracked(
        &mut self,
        reader: &ComponentInstancePath,
        store: &StoreId,
        field: &str,
        path: &UiValuePath,
    ) -> Result<UiValue, StoreError> {
        self.read_path_dependency(
            &crate::read_dependency::ReadDependency::component(reader),
            store,
            field,
            path,
        )
    }
    pub(crate) fn read_path_dependency(
        &mut self,
        reader: &crate::read_dependency::ReadDependency,
        store: &StoreId,
        field: &str,
        path: &UiValuePath,
    ) -> Result<UiValue, StoreError> {
        let value = self
            .stores
            .get(store)
            .ok_or_else(|| StoreError::UnknownStore(store.clone()))?
            .values
            .get(field)
            .ok_or_else(|| StoreError::UnknownField {
                store: store.clone(),
                field: field.to_owned(),
            })?
            .get_path(path)?
            .clone();
        Rc::make_mut(&mut self.readers)
            .entry(StoreField {
                store: store.clone(),
                field: field.to_owned(),
                path: Some(path.clone()),
            })
            .or_default()
            .insert(reader.clone());
        Ok(value)
    }

    /// Validate and update a store field, returning only subscribed components.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError::UnknownStore`], [`StoreError::UnknownField`], or
    /// [`StoreError::InvalidValue`].
    pub fn write(
        &mut self,
        store: &StoreId,
        field: &str,
        value: UiValue,
    ) -> Result<BTreeSet<ComponentInstancePath>, StoreError> {
        let state = self
            .stores
            .get(store)
            .ok_or_else(|| StoreError::UnknownStore(store.clone()))?;
        let declared = state
            .schema
            .field(field)
            .ok_or_else(|| StoreError::UnknownField {
                store: store.clone(),
                field: field.to_owned(),
            })?;
        declared
            .schema
            .validate_ui_value(&value)
            .map_err(|source| StoreError::InvalidValue {
                store: store.clone(),
                field: field.to_owned(),
                source,
            })?;

        let previous =
            state
                .values
                .get(field)
                .cloned()
                .ok_or_else(|| StoreError::UnknownField {
                    store: store.clone(),
                    field: field.to_owned(),
                })?;
        if previous == value {
            return Ok(BTreeSet::new());
        }
        let invalidated = self
            .readers
            .iter()
            .filter(|(read, _)| read.store == *store && read.field == field)
            .filter(|(read, _)| {
                read.path
                    .as_ref()
                    .is_none_or(|path| previous.get_path(path).ok() != value.get_path(path).ok())
            })
            .flat_map(|(_, readers)| readers.iter().map(|reader| reader.owner.clone()))
            .collect();
        let state = Rc::make_mut(&mut self.stores)
            .get_mut(store)
            .ok_or_else(|| StoreError::UnknownStore(store.clone()))?;
        Rc::make_mut(&mut state.values).insert(field.to_owned(), value);
        Ok(invalidated)
    }

    /// Replace one existing nested store path and return affected readers.
    ///
    /// # Errors
    ///
    /// Returns store/field/schema errors or a precise path error.
    pub fn write_path(
        &mut self,
        store: &StoreId,
        field: &str,
        path: &UiValuePath,
        value: UiValue,
    ) -> Result<BTreeSet<ComponentInstancePath>, StoreError> {
        let mut root = self
            .stores
            .get(store)
            .ok_or_else(|| StoreError::UnknownStore(store.clone()))?
            .values
            .get(field)
            .cloned()
            .ok_or_else(|| StoreError::UnknownField {
                store: store.clone(),
                field: field.to_owned(),
            })?;
        root.set_path(path, value)?;
        self.write(store, field, root)
    }

    /// Remove a window and all stores/read dependencies scoped to it.
    pub fn remove_window(&mut self, window: &str) {
        Rc::make_mut(&mut self.stores)
            .retain(|id, _| !matches!(&id.scope, StoreScope::Window(id) if id == window));
        Rc::make_mut(&mut self.readers).retain(
            |field, _| !matches!(&field.store.scope, StoreScope::Window(id) if id == window),
        );
    }

    #[must_use]
    pub fn is_sensitive(&self, store: &StoreId, field: &str) -> bool {
        self.stores
            .get(store)
            .and_then(|state| state.schema.field(field))
            .is_some_and(|field| field.sensitive)
    }

    #[must_use]
    pub fn inspect(&self) -> Vec<StoreSnapshot> {
        self.stores
            .iter()
            .map(|(id, state)| StoreSnapshot {
                id: id.clone(),
                fields: state
                    .values
                    .iter()
                    .map(|(name, value)| {
                        let sensitive = state
                            .schema
                            .field(name)
                            .is_some_and(|field| field.sensitive);
                        (
                            name.clone(),
                            crate::StateValueSnapshot {
                                value: if sensitive {
                                    UiValue::String("<sensitive>".to_owned())
                                } else {
                                    value.clone()
                                },
                                sensitive,
                            },
                        )
                    })
                    .collect(),
            })
            .collect()
    }
}

#[derive(Clone, Debug, PartialEq)]
pub struct StoreSnapshot {
    pub id: StoreId,
    pub fields: BTreeMap<String, crate::StateValueSnapshot>,
}

pub struct StoreReadSession<'a> {
    registry: &'a mut StoreRegistry,
    reader: &'a ComponentInstancePath,
}

impl StoreReadSession<'_> {
    /// Read a field and subscribe the current component to that exact field.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError::UnknownStore`] or [`StoreError::UnknownField`].
    pub fn read(&mut self, store: &StoreId, field: &str) -> Result<UiValue, StoreError> {
        self.registry.read_tracked(self.reader, store, field)
    }

    /// Read and subscribe to one exact nested path.
    ///
    /// # Errors
    ///
    /// Returns store/field or path errors.
    pub fn read_path(
        &mut self,
        store: &StoreId,
        field: &str,
        path: &UiValuePath,
    ) -> Result<UiValue, StoreError> {
        self.registry
            .read_path_tracked(self.reader, store, field, path)
    }
}

#[derive(Clone, Debug, Error, Eq, PartialEq)]
pub enum StoreError {
    #[error("store `{0:?}` is already declared")]
    DuplicateStore(StoreId),
    #[error("store `{0:?}` is not declared")]
    UnknownStore(StoreId),
    #[error("field `{field}` is not declared in store `{store:?}`")]
    UnknownField { store: StoreId, field: String },
    #[error("value for `{store:?}.{field}` is invalid: {source}")]
    InvalidValue {
        store: StoreId,
        field: String,
        source: SchemaValidationError,
    },
    #[error(transparent)]
    State(#[from] crate::StateError),
    #[error(transparent)]
    Path(#[from] UiValuePathError),
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{StateField, ValueSchema};

    fn session_schema() -> ComponentStateSchema {
        ComponentStateSchema::new(BTreeMap::from([
            (
                "project".to_owned(),
                StateField::new(ValueSchema::string(), UiValue::String("alpha".to_owned())),
            ),
            (
                "sidebar_open".to_owned(),
                StateField::new(ValueSchema::Bool, UiValue::Bool(true)),
            ),
        ]))
        .unwrap()
    }

    fn nested_schema() -> ComponentStateSchema {
        let row = |id: &str, label: &str| {
            UiValue::Map(BTreeMap::from([
                ("id".to_owned(), UiValue::String(id.to_owned())),
                ("label".to_owned(), UiValue::String(label.to_owned())),
            ]))
        };
        ComponentStateSchema::new(BTreeMap::from([(
            "data".to_owned(),
            StateField::new(
                ValueSchema::UiValue,
                UiValue::Map(BTreeMap::from([
                    (
                        "profile".to_owned(),
                        UiValue::Map(BTreeMap::from([
                            ("name".to_owned(), UiValue::String("Ada".to_owned())),
                            ("avatar".to_owned(), UiValue::String("ada.png".to_owned())),
                        ])),
                    ),
                    (
                        "rows".to_owned(),
                        UiValue::Array(vec![row("alpha", "Alpha"), row("beta", "Beta")]),
                    ),
                ])),
            ),
        )]))
        .unwrap()
    }

    #[test]
    fn writes_invalidate_only_exact_field_readers() {
        let store_id = StoreId::app("session");
        let project = ComponentInstancePath::root("ProjectView", "project");
        let sidebar = ComponentInstancePath::root("Sidebar", "sidebar");
        let mut stores = StoreRegistry::new();
        stores.declare(store_id.clone(), session_schema()).unwrap();

        stores
            .begin_read(&project)
            .read(&store_id, "project")
            .unwrap();
        stores
            .begin_read(&sidebar)
            .read(&store_id, "sidebar_open")
            .unwrap();

        let invalidated = stores
            .write(&store_id, "project", UiValue::String("beta".to_owned()))
            .unwrap();
        assert_eq!(invalidated, BTreeSet::from([project]));
    }

    #[test]
    fn deserialized_schema_defaults_are_validated_before_store_declaration() {
        let schema: ComponentStateSchema = serde_json::from_str(
            r#"{"fields":{"count":{"schema":{"type":"integer"},"default":{"type":"string","value":"wrong"}}}}"#,
        )
        .unwrap();
        let mut stores = StoreRegistry::new();
        assert!(matches!(
            stores.declare(StoreId::app("invalid"), schema),
            Err(StoreError::State(crate::StateError::InvalidDefault { .. }))
        ));
    }

    #[test]
    fn snapshots_share_large_store_values_until_a_write() {
        let id = StoreId::app("session");
        let mut stores = StoreRegistry::new();
        stores.declare(id.clone(), session_schema()).unwrap();
        let snapshot = stores.clone();
        assert!(Rc::ptr_eq(&stores.stores, &snapshot.stores));
        stores
            .write(&id, "sidebar_open", UiValue::Bool(false))
            .unwrap();
        assert!(!Rc::ptr_eq(&stores.stores, &snapshot.stores));
        assert_eq!(
            snapshot.stores[&id].values["sidebar_open"],
            UiValue::Bool(true)
        );
    }

    #[test]
    fn repeated_value_does_not_invalidate() {
        let store_id = StoreId::app("session");
        let reader = ComponentInstancePath::root("App", "root");
        let mut stores = StoreRegistry::new();
        stores.declare(store_id.clone(), session_schema()).unwrap();
        stores
            .begin_read(&reader)
            .read(&store_id, "project")
            .unwrap();

        assert!(
            stores
                .write(&store_id, "project", UiValue::String("alpha".to_owned()),)
                .unwrap()
                .is_empty()
        );
    }

    #[test]
    fn removing_window_clears_window_store() {
        let store_id = StoreId::window("settings", "draft");
        let mut stores = StoreRegistry::new();
        stores.declare(store_id.clone(), session_schema()).unwrap();
        stores.remove_window("settings");
        assert!(matches!(
            stores.write(&store_id, "sidebar_open", UiValue::Bool(false)),
            Err(StoreError::UnknownStore(_))
        ));
    }

    #[test]
    fn successful_subtree_reconcile_removes_stale_app_store_readers() {
        let id = StoreId::app("shared");
        let root = ComponentInstancePath::root("App", "main");
        let removed = root.child("Panel", "removed");
        let mut stores = StoreRegistry::new();
        stores.declare(id.clone(), session_schema()).unwrap();
        stores.read_tracked(&removed, &id, "sidebar_open").unwrap();
        stores.retain_reader_scope(&root, &BTreeSet::new());
        assert!(
            stores
                .write(&id, "sidebar_open", UiValue::Bool(false))
                .unwrap()
                .is_empty()
        );
    }

    #[test]
    fn nested_writes_invalidate_only_changed_path_and_whole_readers() {
        let store_id = StoreId::app("model");
        let whole = ComponentInstancePath::root("Whole", "whole");
        let name = ComponentInstancePath::root("Name", "name");
        let avatar = ComponentInstancePath::root("Avatar", "avatar");
        let mut stores = StoreRegistry::new();
        stores.declare(store_id.clone(), nested_schema()).unwrap();
        let name_path = UiValuePath::new(vec![
            crate::UiValuePathSegment::Key("profile".to_owned()),
            crate::UiValuePathSegment::Key("name".to_owned()),
        ])
        .unwrap();
        let avatar_path = UiValuePath::new(vec![
            crate::UiValuePathSegment::Key("profile".to_owned()),
            crate::UiValuePathSegment::Key("avatar".to_owned()),
        ])
        .unwrap();
        stores.read_tracked(&whole, &store_id, "data").unwrap();
        stores
            .read_path_tracked(&name, &store_id, "data", &name_path)
            .unwrap();
        stores
            .read_path_tracked(&avatar, &store_id, "data", &avatar_path)
            .unwrap();

        assert_eq!(
            stores
                .write_path(
                    &store_id,
                    "data",
                    &name_path,
                    UiValue::String("Grace".to_owned()),
                )
                .unwrap(),
            BTreeSet::from([whole, name])
        );
        assert!(
            stores
                .write_path(
                    &store_id,
                    "data",
                    &name_path,
                    UiValue::String("Grace".to_owned()),
                )
                .unwrap()
                .is_empty()
        );
    }

    #[test]
    fn keyed_item_reader_ignores_reorder_but_observes_item_change() {
        let store_id = StoreId::app("model");
        let reader = ComponentInstancePath::root("Row", "beta");
        let whole = ComponentInstancePath::root("Whole", "whole");
        let mut stores = StoreRegistry::new();
        stores.declare(store_id.clone(), nested_schema()).unwrap();
        let row_path = UiValuePath::new(vec![
            crate::UiValuePathSegment::Key("rows".to_owned()),
            crate::UiValuePathSegment::Item {
                key_field: "id".to_owned(),
                key: "beta".to_owned(),
            },
            crate::UiValuePathSegment::Key("label".to_owned()),
        ])
        .unwrap();
        stores
            .read_path_tracked(&reader, &store_id, "data", &row_path)
            .unwrap();
        stores.read_tracked(&whole, &store_id, "data").unwrap();

        let mut reordered = stores
            .stores
            .get(&store_id)
            .unwrap()
            .values
            .get("data")
            .unwrap()
            .clone();
        if let UiValue::Map(root) = &mut reordered
            && let Some(UiValue::Array(rows)) = root.get_mut("rows")
        {
            rows.reverse();
        }
        assert_eq!(
            stores.write(&store_id, "data", reordered).unwrap(),
            BTreeSet::from([whole.clone()])
        );
        assert_eq!(
            stores
                .write_path(
                    &store_id,
                    "data",
                    &row_path,
                    UiValue::String("Updated".to_owned()),
                )
                .unwrap(),
            BTreeSet::from([whole, reader])
        );
    }
}