Use ResourceId for referring to Resources (#4176)

* Use ResourceId for referring to Resources

* Use Doc

* use error for preprocessor ResourceId replacement failure

* Keep hashes in DocumentInfo

* Migrate with less mem copy

* Global ResourceMessage -> ResourceStorageMessage

* Add document ResourceMessage

* Move embedding logic

* Fix

* Cleanup

* Review

* Fix

Author: timon-schelling

editor/src/application.rs

@@ -30,7 +30,7 @@ impl Editor {
 		};
 
 		let mut application_io = PlatformApplicationIo::default();
-		application_io.inject_resource_proxy(editor.dispatcher.message_handlers.resource_message_handler.resources());
+		application_io.inject_resource_proxy(editor.dispatcher.message_handlers.resource_storage_message_handler.resources());
 		runtime.replace_application_io(application_io);
 
 		(editor, runtime)
@@ -47,7 +47,7 @@ impl Editor {
 	}
 
 	pub fn replace_application_io(&mut self, mut application_io: PlatformApplicationIo) {
-		application_io.inject_resource_proxy(self.dispatcher.message_handlers.resource_message_handler.resources());
+		application_io.inject_resource_proxy(self.dispatcher.message_handlers.resource_storage_message_handler.resources());
 		crate::node_graph_executor::replace_application_io(application_io)
 	}
 }

editor/src/dispatcher.rs

@@ -32,15 +32,15 @@ pub struct DispatcherMessageHandlers {
 	menu_bar_message_handler: MenuBarMessageHandler,
 	pub(crate) portfolio_message_handler: PortfolioMessageHandler,
 	preferences_message_handler: PreferencesMessageHandler,
-	pub(crate) resource_message_handler: ResourceMessageHandler,
+	pub(crate) resource_storage_message_handler: ResourceStorageMessageHandler,
 	tool_message_handler: ToolMessageHandler,
 	viewport_message_handler: ViewportMessageHandler,
 }
 
 impl DispatcherMessageHandlers {
 	pub fn with_resource_storage(resource_storage: Box<dyn ResourceStorage>) -> Self {
 		Self {
-			resource_message_handler: ResourceMessageHandler::new(resource_storage),
+			resource_storage_message_handler: ResourceStorageMessageHandler::new(resource_storage),
 			..Self::default()
 		}
 	}
@@ -89,7 +89,7 @@ const DEBUG_MESSAGE_ENDING_BLOCK_LIST: &[&str] = &["PointerMove", "PointerOutsid
 impl Dispatcher {
 	pub fn new(resource_storage: Box<dyn ResourceStorage>) -> Self {
 		let mut s = Self::default();
-		s.message_handlers.resource_message_handler = ResourceMessageHandler::new(resource_storage);
+		s.message_handlers.resource_storage_message_handler = ResourceStorageMessageHandler::new(resource_storage);
 		s
 	}
 
@@ -228,8 +228,10 @@ impl Dispatcher {
 
 					self.message_handlers.layout_message_handler.process_message(message, &mut queue, context);
 				}
-				Message::Resource(message) => {
-					self.message_handlers.resource_message_handler.process_message(message, &mut queue, ResourceMessageContext {});
+				Message::ResourceStorage(message) => {
+					self.message_handlers
+						.resource_storage_message_handler
+						.process_message(message, &mut queue, ResourceStorageMessageContext {});
 				}
 				Message::Portfolio(message) => {
 					self.message_handlers.portfolio_message_handler.process_message(
@@ -243,7 +245,7 @@ impl Dispatcher {
 							timing_information: self.message_handlers.animation_message_handler.timing_information(),
 							animation: &self.message_handlers.animation_message_handler,
 							viewport: &self.message_handlers.viewport_message_handler,
-							resources: &self.message_handlers.resource_message_handler,
+							resource_storage: &self.message_handlers.resource_storage_message_handler,
 						},
 					);
 				}

editor/src/messages/message.rs

@@ -36,7 +36,7 @@ pub enum Message {
 	#[child]
 	Preferences(PreferencesMessage),
 	#[child]
-	Resource(ResourceMessage),
+	ResourceStorage(ResourceStorageMessage),
 	#[child]
 	Tool(ToolMessage),
 	#[child]

editor/src/messages/mod.rs

@@ -17,6 +17,6 @@ pub mod message;
 pub mod portfolio;
 pub mod preferences;
 pub mod prelude;
-pub mod resource;
+pub mod resource_storage;
 pub mod tool;
 pub mod viewport;

editor/src/messages/portfolio/document/document_message.rs

@@ -37,6 +37,8 @@ pub enum DocumentMessage {
 	PropertiesPanel(PropertiesPanelMessage),
 	#[child]
 	DataPanel(DataPanelMessage),
+	#[child]
+	Resource(ResourceMessage),
 
 	// Messages
 	AlignSelectedLayers {

editor/src/messages/portfolio/document/document_message_handler.rs

@@ -19,7 +19,6 @@ use crate::messages::portfolio::document::overlays::grid_overlays::{grid_overlay
 use crate::messages::portfolio::document::overlays::utility_types::{OverlaysType, OverlaysVisibilitySettings, Pivot};
 use crate::messages::portfolio::document::properties_panel::properties_panel_message_handler::PropertiesPanelMessageContext;
 use crate::messages::portfolio::document::utility_types::document_metadata::{DocumentMetadata, LayerNodeIdentifier};
-use crate::messages::portfolio::document::utility_types::embedded_resources::EmbeddedResources;
 use crate::messages::portfolio::document::utility_types::misc::{AlignAggregate, AlignAxis, FlipAxis, PTZ};
 use crate::messages::portfolio::document::utility_types::network_interface::{FlowType, InputConnector, NodeTemplate, OutputConnector};
 use crate::messages::portfolio::utility_types::{CachedData, PanelType};
@@ -30,7 +29,7 @@ use crate::messages::tool::tool_messages::tool_prelude::Key;
 use crate::messages::tool::utility_types::ToolType;
 use crate::node_graph_executor::NodeGraphExecutor;
 use glam::{DAffine2, DVec2};
-use graph_craft::application_io::resource::ResourceHash;
+use graph_craft::application_io::resource::ResourceId;
 use graph_craft::application_io::wgpu_available;
 use graph_craft::descriptor;
 use graph_craft::document::value::TaggedValue;
@@ -61,7 +60,7 @@ pub struct DocumentMessageContext<'a> {
 	pub layers_panel_open: bool,
 	pub properties_panel_open: bool,
 	pub viewport: &'a ViewportMessageHandler,
-	pub resources: &'a ResourceMessageHandler,
+	pub resource_storage: &'a ResourceStorageMessageHandler,
 }
 
 #[derive(Clone, Debug, serde::Serialize, serde::Deserialize, ExtractField)]
@@ -88,6 +87,9 @@ pub struct DocumentMessageHandler {
 	//
 	// Contains the NodeNetwork and acts an an interface to manipulate the NodeNetwork with custom setters in order to keep NetworkMetadata in sync
 	pub network_interface: NodeNetworkInterface,
+	/// Resources embedded in the document.
+	#[serde(default, skip_serializing_if = "ResourceMessageHandler::is_empty")]
+	pub resources: ResourceMessageHandler,
 	/// Tracks which layer occurrences are collapsed in the Layers panel, keyed by tree path.
 	#[serde(deserialize_with = "deserialize_collapsed_layers", default)]
 	pub collapsed: CollapsedLayers,
@@ -110,9 +112,6 @@ pub struct DocumentMessageHandler {
 	pub graph_view_overlay_open: bool,
 	/// The current opacity of the faded node graph background that covers up the artwork.
 	pub graph_fade_artwork_percentage: f64,
-	/// Resources embedded in the document. Only propagated if saving to an external file and never for autosaved documents.
-	#[serde(rename = "resources", default, skip_serializing_if = "EmbeddedResources::is_empty")]
-	pub embedded_resources: EmbeddedResources,
 
 	// =============================================
 	// Fields omitted from the saved document format
@@ -166,6 +165,7 @@ impl Default for DocumentMessageHandler {
 			// Fields that are saved in the document format
 			// ============================================
 			network_interface: default_document_network_interface(),
+			resources: ResourceMessageHandler::default(),
 			collapsed: CollapsedLayers::default(),
 			commit_hash: GRAPHITE_GIT_COMMIT_HASH.to_string(),
 			document_ptz: PTZ::default(),
@@ -175,7 +175,6 @@ impl Default for DocumentMessageHandler {
 			graph_view_overlay_open: false,
 			snapping_state: SnappingState::default(),
 			graph_fade_artwork_percentage: 80.,
-			embedded_resources: EmbeddedResources::default(),
 			// =============================================
 			// Fields omitted from the saved document format
 			// =============================================
@@ -207,7 +206,7 @@ impl MessageHandler<DocumentMessage, DocumentMessageContext<'_>> for DocumentMes
 			data_panel_open,
 			layers_panel_open,
 			properties_panel_open,
-			resources,
+			resource_storage,
 		} = context;
 
 		match message {
@@ -282,6 +281,10 @@ impl MessageHandler<DocumentMessage, DocumentMessageContext<'_>> for DocumentMes
 				let mut graph_operation_message_handler = GraphOperationMessageHandler {};
 				graph_operation_message_handler.process_message(message, responses, context);
 			}
+			DocumentMessage::Resource(message) => {
+				let context = ResourceMessageContext {};
+				self.resources.process_message(message, responses, context);
+			}
 			DocumentMessage::AlignSelectedLayers { axis, aggregate } => {
 				let axis = match axis {
 					AlignAxis::X => DVec2::X,
@@ -920,36 +923,29 @@ impl MessageHandler<DocumentMessage, DocumentMessageContext<'_>> for DocumentMes
 			DocumentMessage::SaveDocument | DocumentMessage::SaveDocumentAs => {
 				responses.add(PortfolioMessage::AutoSaveActiveDocument);
 
+				let name = format!("{}.{}", self.name.clone(), FILE_EXTENSION);
 				let path = if let DocumentMessage::SaveDocumentAs = message { None } else { self.path.clone() };
 				if path.is_some() {
 					responses.add(DocumentMessage::MarkAsSaved);
 				}
 				let folder = self.path.as_ref().and_then(|path| path.parent()).map(|parent| parent.to_path_buf());
 
-				let resource_hashes = Vec::from_iter(self.used_resources(false)).into_boxed_slice();
-				let resources = resources.resources();
 				let mut document = self.clone();
-				let name = format!("{}.{}", self.name.clone(), FILE_EXTENSION);
+				let resources_load_handle = resource_storage.resources();
 
 				responses.add(FrontendMessage::Await {
 					future: FrontendMessageFuture::new(async move {
-						let loads = resource_hashes
-							.into_iter()
-							.map(|hash| {
-								let resource = resources.load(hash);
-								async move { resource.await.map(|resource| (hash, resource)) }
-							})
-							.collect::<Vec<_>>();
+						document.resources.garbage_collect(document.used_resources(false).as_ref());
+						document.resources.embed_resources(resources_load_handle).await;
 
-						document.embedded_resources = EmbeddedResources::from_iter(futures::future::join_all(loads).await.into_iter().flatten());
-						let content = document.serialize_document();
+						let content = document.serialize_document().into_bytes().into();
 
 						FrontendMessage::TriggerSaveDocument {
 							document_id,
 							name,
 							path,
 							folder,
-							content: content.into_bytes().into(),
+							content,
 						}
 					}),
 				});
@@ -3472,14 +3468,19 @@ impl DocumentMessageHandler {
 		self.graph_view_overlay_open
 	}
 
-	pub fn used_resources(&self, include_history: bool) -> HashSet<ResourceHash> {
+	pub fn garbage_collect_resources(&mut self) {
+		let used_resources = self.used_resources(true);
+		self.resources.garbage_collect(&used_resources);
+	}
+
+	pub fn used_resources(&self, include_history: bool) -> Box<[ResourceId]> {
 		let mut resources = HashSet::new();
 		self.network_interface.collect_used_resources(&mut resources);
 		if include_history {
 			self.document_undo_history.iter().for_each(|interface| interface.collect_used_resources(&mut resources));
 			self.document_redo_history.iter().for_each(|interface| interface.collect_used_resources(&mut resources));
 		}
-		resources
+		resources.into_iter().collect::<Vec<_>>().into_boxed_slice()
 	}
 }
 

editor/src/messages/portfolio/document/graph_operation/graph_operation_message_handler.rs

@@ -32,7 +32,7 @@ pub struct GraphOperationMessageHandler {}
 #[message_handler_data]
 impl MessageHandler<GraphOperationMessage, GraphOperationMessageContext<'_>> for GraphOperationMessageHandler {
 	fn process_message(&mut self, message: GraphOperationMessage, responses: &mut VecDeque<Message>, context: GraphOperationMessageContext) {
-		let network_interface = context.network_interface;
+		let GraphOperationMessageContext { network_interface, .. } = context;
 
 		match message {
 			GraphOperationMessage::FillSet { layer, fill } => {

editor/src/messages/portfolio/document/graph_operation/utility_types.rs

@@ -4,6 +4,7 @@ use crate::messages::portfolio::document::utility_types::document_metadata::Laye
 use crate::messages::portfolio::document::utility_types::network_interface::{self, InputConnector, NodeNetworkInterface, OutputConnector};
 use crate::messages::prelude::*;
 use glam::{DAffine2, DVec2};
+use graph_craft::application_io::resource::ResourceId;
 use graph_craft::document::value::TaggedValue;
 use graph_craft::document::{NodeId, NodeInput};
 use graph_craft::{ProtoNodeIdentifier, concrete, descriptor};
@@ -299,13 +300,15 @@ impl<'a> ModifyInputsContext<'a> {
 			.expect("Transform node does not exist")
 			.default_node_template();
 
-		let png_bytes: std::sync::Arc<[u8]> = image.to_png().into();
-		let hash = graphene_std::application_io::resource::ResourceHash::from(png_bytes.as_ref());
-		self.responses.add(ResourceMessage::Store { data: png_bytes });
+		let resource_id = ResourceId::new();
+		self.responses.add(ResourceMessage::StoreEmbedded {
+			resource_id,
+			data: image.to_png().into(),
+		});
 
 		let image_node = resolve_proto_node_type(graphene_std::raster_nodes::std_nodes::image::IDENTIFIER)
 			.expect("Image node does not exist")
-			.node_template_input_override([Some(NodeInput::value(TaggedValue::Resource(hash), false))]);
+			.node_template_input_override([Some(NodeInput::value(TaggedValue::Resource(resource_id), false))]);
 
 		let image_node_id = NodeId::new();
 		self.network_interface.insert_node(image_node_id, image_node, &[]);

editor/src/messages/portfolio/document/mod.rs

@@ -7,6 +7,7 @@ pub mod navigation;
 pub mod node_graph;
 pub mod overlays;
 pub mod properties_panel;
+pub mod resource;
 pub mod utility_types;
 
 #[doc(inline)]

editor/src/messages/portfolio/document/node_graph/node_graph_message_handler.rs

@@ -1557,7 +1557,7 @@ impl<'a> MessageHandler<NodeGraphMessage, NodeGraphMessageContext<'a>> for NodeG
 						// Only disconnect inputs to non selected nodes
 						if network_interface
 							.upstream_output_connector(&input_connector, selection_network_path)
-							.is_some_and(|connector| connector.node_id().map_or(true, |node_id| !all_selected_nodes.contains(&node_id)))
+							.is_some_and(|connector| connector.node_id().is_none_or(|node_id| !all_selected_nodes.contains(&node_id)))
 						{
 							responses.add(NodeGraphMessage::DisconnectInput { input_connector });
 						}