hydrate_model/editor/

edit_context.rs

use hydrate_data::json_storage::RestoreAssetFromStorageImpl;
use hydrate_data::{
    CanonicalPathReference, OrderedSet, PathReference, PathReferenceNamespaceResolver,
    PropertiesBundle, SingleObject,
};
use hydrate_pipeline::{DynEditContext, HydrateProjectConfiguration};
use std::path::{Path, PathBuf};
use uuid::Uuid;

use crate::editor::undo::{UndoContext, UndoStack};
use crate::{
    AssetId, AssetLocation, AssetName, BuildInfo, DataSet, DataSetAssetInfo, DataSetDiff,
    DataSetResult, EditContextKey, EndContextBehavior, HashMap, HashSet, ImportInfo, NullOverride,
    OverrideBehavior, SchemaFingerprint, SchemaNamedType, SchemaRecord, SchemaSet, Value,
};

//TODO: Delete unused property data when path ancestor is null or in replace mode

//TODO: Should we make a struct that refs the schema/data? We could have transactions and databases
// return the temp struct with refs and move all the functions to that

//TODO: Read-only sources? For things like network cache. Could only sync files we edit and overlay
// files source over net cache source, etc.

// Editor Context
// - Used to edit assets in isolation (for example, a node graph)
// - Expected that edited assets won't be modified by anything else
//   - Might get away with applying diffs, but may result in unintuitive behavior
// - Expected that non-edited assets *may* be modified, but not in a way that is incompatible with the edited assets
//   - Or, make a copy of non-edited assets
// - Maybe end-user needs to decide if they want to read new/old data?
//
// Undo Context
// - Used to demarcate changes that should conceptually be treated as a single operation
// - An undo context is labeled with a string. Within the context, multiple edits can be made
// - An undo context *may* be left in a "resumable" state. If we make modifications with an undo context
//   of the same name, we append to that undo context
// - If an edit is made with an undo context that doesn't match an existing "resumable" undo context,
//   we commit that context and carry on with the operation under a new undo context
// - A wrapper around dataset that understands undo contexts will produce a queue of finished undo
//   contexts, which contain revert/apply diffs
// - These undo contexts can be pushed onto a single global queue or a per-document queue

pub struct EditContext {
    project_config: HydrateProjectConfiguration,
    schema_set: SchemaSet,
    pub(super) data_set: DataSet,
    undo_context: UndoContext,
}

impl PathReferenceNamespaceResolver for EditContext {
    fn namespace_root(
        &self,
        namespace: &str,
    ) -> Option<PathBuf> {
        self.project_config.namespace_root(namespace)
    }

    fn simplify_path(
        &self,
        path: &Path,
    ) -> Option<(String, PathBuf)> {
        self.project_config.simplify_path(path)
    }
}

impl RestoreAssetFromStorageImpl for EditContext {
    fn restore_asset(
        &mut self,
        asset_id: AssetId,
        asset_name: AssetName,
        asset_location: AssetLocation,
        import_info: Option<ImportInfo>,
        build_info: BuildInfo,
        prototype: Option<AssetId>,
        schema: SchemaFingerprint,
        properties: HashMap<String, Value>,
        property_null_overrides: HashMap<String, NullOverride>,
        properties_in_replace_mode: HashSet<String>,
        dynamic_collection_entries: HashMap<String, OrderedSet<Uuid>>,
    ) -> DataSetResult<()> {
        self.restore_asset(
            asset_id,
            asset_name,
            asset_location,
            import_info,
            build_info,
            prototype,
            schema,
            properties,
            property_null_overrides,
            properties_in_replace_mode,
            dynamic_collection_entries,
        )
    }

    fn namespace_resolver(&self) -> &dyn PathReferenceNamespaceResolver {
        self
    }
}

impl DynEditContext for EditContext {
    fn data_set(&self) -> &DataSet {
        &self.data_set
    }

    fn schema_set(&self) -> &SchemaSet {
        &self.schema_set
    }
}

impl EditContext {
    // Call after adding a new asset
    fn track_new_asset(
        &mut self,
        asset_id: AssetId,
    ) {
        if self.undo_context.has_open_context() {
            // If an undo context is open, we use the diff for change tracking
            self.undo_context.track_new_asset(asset_id);
        }
    }

    // Call before editing or deleting an asset
    fn track_existing_asset(
        &mut self,
        asset_id: AssetId,
    ) -> DataSetResult<()> {
        if self.undo_context.has_open_context() {
            // If an undo is open, we use the diff for change tracking
            self.undo_context
                .track_existing_asset(&mut self.data_set, asset_id)?;
        }

        Ok(())
    }

    pub fn apply_diff(
        &mut self,
        diff: &DataSetDiff,
    ) -> DataSetResult<()> {
        diff.apply(&mut self.data_set, &self.schema_set)?;
        Ok(())
    }

    pub fn new(
        project_config: &HydrateProjectConfiguration,
        edit_context_key: EditContextKey,
        schema_set: SchemaSet,
        undo_stack: &UndoStack,
    ) -> Self {
        EditContext {
            project_config: project_config.clone(),
            schema_set,
            data_set: Default::default(),
            undo_context: UndoContext::new(undo_stack, edit_context_key),
        }
    }

    pub fn new_with_data(
        project_config: &HydrateProjectConfiguration,
        edit_context_key: EditContextKey,
        schema_set: SchemaSet,
        undo_stack: &UndoStack,
    ) -> Self {
        EditContext {
            project_config: project_config.clone(),
            schema_set,
            data_set: Default::default(),
            undo_context: UndoContext::new(undo_stack, edit_context_key),
        }
    }

    pub fn with_undo_context<F: FnOnce(&mut Self) -> EndContextBehavior>(
        &mut self,
        name: &'static str,
        f: F,
    ) {
        self.undo_context.begin_context(&self.data_set, name);
        let end_context_behavior = (f)(self);
        self.undo_context
            .end_context(&self.data_set, end_context_behavior);
    }

    pub fn commit_pending_undo_context(&mut self) {
        self.undo_context.commit_context(&mut self.data_set);
    }

    pub fn cancel_pending_undo_context(&mut self) -> DataSetResult<()> {
        self.undo_context.cancel_context(&mut self.data_set)
    }

    // pub fn apply_diff(&mut self, diff: &DataSetDiff) {
    //     diff.apply(&mut self.data_set);
    // }

    //
    // Schema-related functions
    //
    pub fn schema_set(&self) -> &SchemaSet {
        &self.schema_set
    }

    pub fn schemas(&self) -> &HashMap<SchemaFingerprint, SchemaNamedType> {
        &self.schema_set.schemas()
    }

    //
    // Data-related functions
    //
    pub fn data_set(&self) -> &DataSet {
        &self.data_set
    }

    // pub fn data_set_mut(&mut self) -> &mut DataSet {
    //     &mut self.data_set
    // }

    pub fn assets(&self) -> &HashMap<AssetId, DataSetAssetInfo> {
        self.data_set.assets()
    }

    pub fn has_asset(
        &self,
        asset_id: AssetId,
    ) -> bool {
        self.assets().contains_key(&asset_id)
    }

    pub fn new_asset_with_id(
        &mut self,
        asset_id: AssetId,
        asset_name: &AssetName,
        asset_location: &AssetLocation,
        schema: &SchemaRecord,
    ) -> DataSetResult<()> {
        self.data_set.new_asset_with_id(
            asset_id,
            asset_name.clone(),
            asset_location.clone(),
            schema,
        )?;
        self.track_new_asset(asset_id);
        Ok(())
    }

    pub fn new_asset(
        &mut self,
        asset_name: &AssetName,
        asset_location: &AssetLocation,
        schema: &SchemaRecord,
    ) -> AssetId {
        let asset_id = self
            .data_set
            .new_asset(asset_name.clone(), asset_location.clone(), schema);
        self.track_new_asset(asset_id);
        asset_id
    }

    pub fn new_asset_from_prototype(
        &mut self,
        asset_name: &AssetName,
        asset_location: &AssetLocation,
        prototype: AssetId,
    ) -> DataSetResult<AssetId> {
        let asset_id = self.data_set.new_asset_from_prototype(
            asset_name.clone(),
            asset_location.clone(),
            prototype,
        )?;
        self.track_new_asset(asset_id);
        Ok(asset_id)
    }

    pub fn init_from_single_object(
        &mut self,
        asset_id: AssetId,
        asset_name: AssetName,
        asset_location: AssetLocation,
        single_object: &SingleObject,
    ) -> DataSetResult<()> {
        self.track_new_asset(asset_id);
        self.data_set.new_asset_with_id(
            asset_id,
            asset_name,
            asset_location,
            single_object.schema(),
        )?;
        self.data_set
            .copy_from_single_object(asset_id, single_object)
    }

    pub fn restore_assets_from(
        &mut self,
        data_set: DataSet,
    ) -> DataSetResult<()> {
        for (k, v) in data_set.take_assets() {
            self.restore_asset(
                k,
                v.asset_name().clone(),
                v.asset_location().clone(),
                v.import_info().clone().clone(),
                v.build_info().clone(),
                v.prototype(),
                v.schema().fingerprint(),
                v.properties().clone(),
                v.property_null_overrides().clone(),
                v.properties_in_replace_mode().clone(),
                v.dynamic_collection_entries().clone(),
            )?;
        }

        Ok(())
    }

    pub(crate) fn restore_asset(
        &mut self,
        asset_id: AssetId,
        asset_name: AssetName,
        asset_location: AssetLocation,
        import_info: Option<ImportInfo>,
        build_info: BuildInfo,
        prototype: Option<AssetId>,
        schema: SchemaFingerprint,
        properties: HashMap<String, Value>,
        property_null_overrides: HashMap<String, NullOverride>,
        properties_in_replace_mode: HashSet<String>,
        dynamic_collection_entries: HashMap<String, OrderedSet<Uuid>>,
    ) -> DataSetResult<()> {
        self.track_new_asset(asset_id);
        self.data_set.restore_asset(
            asset_id,
            asset_name,
            asset_location,
            import_info,
            build_info,
            &self.schema_set,
            prototype,
            schema,
            properties,
            property_null_overrides,
            properties_in_replace_mode,
            dynamic_collection_entries,
        )
    }

    pub fn duplicate_asset(
        &mut self,
        asset_id: AssetId,
    ) -> DataSetResult<AssetId> {
        let new_asset_id = self.data_set.duplicate_asset(asset_id, &self.schema_set)?;
        self.track_new_asset(new_asset_id);
        Ok(new_asset_id)
    }

    pub fn delete_asset(
        &mut self,
        asset_id: AssetId,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set.delete_asset(asset_id)
    }

    pub fn set_asset_location(
        &mut self,
        asset_id: AssetId,
        new_location: AssetLocation,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set.set_asset_location(asset_id, new_location)?;
        // Again so that we track the new location too
        self.track_existing_asset(asset_id)?;
        Ok(())
    }

    pub fn set_import_info(
        &mut self,
        asset_id: AssetId,
        import_info: ImportInfo,
    ) -> DataSetResult<()> {
        self.data_set.set_import_info(asset_id, import_info)?;
        self.track_existing_asset(asset_id)?;
        Ok(())
    }

    pub fn asset_name(
        &self,
        asset_id: AssetId,
    ) -> DataSetResult<&AssetName> {
        self.data_set.asset_name(asset_id)
    }

    pub fn asset_name_or_id_string(
        &self,
        asset_id: AssetId,
    ) -> DataSetResult<String> {
        let asset_name = self.data_set.asset_name(asset_id)?;
        Ok(if let Some(name) = asset_name.as_string() {
            name.to_string()
        } else {
            asset_id.as_uuid().to_string()
        })
    }

    pub fn set_asset_name(
        &mut self,
        asset_id: AssetId,
        asset_name: AssetName,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set.set_asset_name(asset_id, asset_name)
    }

    pub fn asset_location(
        &self,
        asset_id: AssetId,
    ) -> Option<AssetLocation> {
        self.data_set.asset_location(asset_id)
    }

    pub fn asset_location_chain(
        &self,
        asset_id: AssetId,
    ) -> DataSetResult<Vec<AssetLocation>> {
        self.data_set.asset_location_chain(asset_id)
    }

    pub fn import_info(
        &self,
        asset_id: AssetId,
    ) -> Option<&ImportInfo> {
        self.data_set.import_info(asset_id)
    }

    pub fn resolve_path_reference<P: Into<PathReference>>(
        &self,
        asset_id: AssetId,
        path: P,
    ) -> DataSetResult<Option<AssetId>> {
        self.data_set.resolve_path_reference(asset_id, path)
    }

    pub fn resolve_canonical_path_reference(
        &self,
        asset_id: AssetId,
        canonical_path: &CanonicalPathReference,
    ) -> DataSetResult<Option<AssetId>> {
        self.data_set
            .resolve_canonical_path_reference(asset_id, canonical_path)
    }

    pub fn resolve_all_path_reference_overrides(
        &self,
        asset_id: AssetId,
    ) -> DataSetResult<HashMap<CanonicalPathReference, AssetId>> {
        self.data_set.resolve_all_path_reference_overrides(asset_id)
    }

    pub fn get_all_path_reference_overrides(
        &mut self,
        asset_id: AssetId,
    ) -> Option<&HashMap<CanonicalPathReference, AssetId>> {
        self.data_set.get_all_path_reference_overrides(asset_id)
    }

    pub fn set_path_reference_override(
        &mut self,
        asset_id: AssetId,
        path: CanonicalPathReference,
        referenced_asset_id: AssetId,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .set_path_reference_override(asset_id, path, referenced_asset_id)
    }

    pub fn asset_prototype(
        &self,
        asset_id: AssetId,
    ) -> Option<AssetId> {
        self.data_set.asset_prototype(asset_id)
    }

    pub fn asset_schema(
        &self,
        asset_id: AssetId,
    ) -> Option<&SchemaRecord> {
        self.data_set.asset_schema(asset_id)
    }

    pub fn get_null_override(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<NullOverride> {
        self.data_set
            .get_null_override(&self.schema_set, asset_id, path)
    }

    pub fn set_null_override(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
        null_override: NullOverride,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .set_null_override(&self.schema_set, asset_id, path, null_override)
    }

    pub fn resolve_null_override(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<NullOverride> {
        self.data_set
            .resolve_null_override(&self.schema_set, asset_id, path)
    }

    pub fn has_property_override(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<bool> {
        self.data_set.has_property_override(asset_id, path)
    }

    // Just gets if this asset has a property without checking prototype chain for fallback or returning a default
    // Returning none means it is not overridden
    pub fn get_property_override(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<Option<&Value>> {
        self.data_set.get_property_override(asset_id, path)
    }

    // Just sets a property on this asset, making it overridden, or replacing the existing override
    pub fn set_property_override(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
        value: Option<Value>,
    ) -> DataSetResult<Option<Value>> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .set_property_override(&self.schema_set, asset_id, path, value)
    }

    pub fn apply_property_override_to_prototype(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        if let Some(prototype) = self.asset_prototype(asset_id) {
            self.track_existing_asset(prototype)?;
        }

        self.data_set
            .apply_property_override_to_prototype(&self.schema_set, asset_id, path)
    }

    pub fn resolve_property(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<&Value> {
        self.data_set
            .resolve_property(&self.schema_set, asset_id, path)
    }

    pub fn get_dynamic_array_entries(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<std::slice::Iter<Uuid>> {
        self.data_set
            .get_dynamic_array_entries(&self.schema_set, asset_id, path)
    }

    pub fn get_map_entries(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<std::slice::Iter<Uuid>> {
        self.data_set
            .get_map_entries(&self.schema_set, asset_id, path)
    }

    pub fn add_dynamic_array_entry(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<Uuid> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .add_dynamic_array_entry(&self.schema_set, asset_id, path)
    }

    pub fn add_map_entry(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<Uuid> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .add_map_entry(&self.schema_set, asset_id, path)
    }

    pub fn insert_dynamic_array_entry(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
        index: usize,
        entry_uuid: Uuid,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set.insert_dynamic_array_entry(
            &self.schema_set,
            asset_id,
            path,
            index,
            entry_uuid,
        )
    }

    pub fn remove_dynamic_array_entry(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
        element_id: Uuid,
    ) -> DataSetResult<bool> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .remove_dynamic_array_entry(&self.schema_set, asset_id, path, element_id)
    }

    pub fn remove_map_entry(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
        element_id: Uuid,
    ) -> DataSetResult<bool> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .remove_map_entry(&self.schema_set, asset_id, path, element_id)
    }

    pub fn resolve_dynamic_array_entries(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<Box<[Uuid]>> {
        self.data_set
            .resolve_dynamic_array_entries(&self.schema_set, asset_id, path)
    }

    pub fn resolve_map_entries(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<Box<[Uuid]>> {
        self.data_set
            .resolve_map_entries(&self.schema_set, asset_id, path)
    }

    pub fn get_override_behavior(
        &self,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<OverrideBehavior> {
        self.data_set
            .get_override_behavior(&self.schema_set, asset_id, path)
    }

    pub fn set_override_behavior(
        &mut self,
        asset_id: AssetId,
        path: impl AsRef<str>,
        behavior: OverrideBehavior,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .set_override_behavior(&self.schema_set, asset_id, path, behavior)
    }

    pub fn read_properties_bundle(
        &self,
        schema_set: &SchemaSet,
        asset_id: AssetId,
        path: impl AsRef<str>,
    ) -> DataSetResult<PropertiesBundle> {
        self.data_set
            .read_properties_bundle(schema_set, asset_id, path)
    }

    pub fn write_properties_bundle(
        &mut self,
        schema_set: &SchemaSet,
        asset_id: AssetId,
        path: impl AsRef<str>,
        properties_bundle: &PropertiesBundle,
    ) -> DataSetResult<()> {
        self.track_existing_asset(asset_id)?;
        self.data_set
            .write_properties_bundle(schema_set, asset_id, path, properties_bundle)
    }
}