From 9d199ebb6534413865044f03631975371d389554 Mon Sep 17 00:00:00 2001 From: Clement Rey Date: Thu, 31 Oct 2024 21:34:35 +0100 Subject: [PATCH] implement consistent open/import behavior for all cases --- Cargo.lock | 1 + crates/store/re_data_loader/src/lib.rs | 8 +++ crates/store/re_data_loader/src/load_file.rs | 17 +++-- .../store/re_data_source/src/data_source.rs | 3 + crates/store/re_log_types/src/lib.rs | 25 ++++++++ crates/top/re_sdk/src/recording_stream.rs | 1 + crates/viewer/re_viewer/Cargo.toml | 1 + crates/viewer/re_viewer/src/app.rs | 63 ++++++++++++++----- 8 files changed, 96 insertions(+), 23 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index c0e0ad0068724..b0a20f6558080 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -6415,6 +6415,7 @@ dependencies = [ "strum", "strum_macros", "thiserror", + "uuid", "wasm-bindgen", "wasm-bindgen-futures", "web-sys", diff --git a/crates/store/re_data_loader/src/lib.rs b/crates/store/re_data_loader/src/lib.rs index 73c987d01848e..691667faebfc0 100644 --- a/crates/store/re_data_loader/src/lib.rs +++ b/crates/store/re_data_loader/src/lib.rs @@ -64,6 +64,12 @@ pub struct DataLoaderSettings { /// The [`re_log_types::StoreId`] that is currently opened in the viewer, if any. pub opened_store_id: Option, + /// Whether `SetStoreInfo`s should be sent, regardless of the surrounding context. + /// + /// Only useful when creating a recording just-in-time directly in the viewer (which is what + /// happens when importing things into the welcome screen). + pub force_store_info: bool, + /// What should the logged entity paths be prefixed with? pub entity_path_prefix: Option, @@ -79,6 +85,7 @@ impl DataLoaderSettings { opened_application_id: Default::default(), store_id: store_id.into(), opened_store_id: Default::default(), + force_store_info: false, entity_path_prefix: Default::default(), timepoint: Default::default(), } @@ -91,6 +98,7 @@ impl DataLoaderSettings { opened_application_id, store_id, opened_store_id, + force_store_info: _, entity_path_prefix, timepoint, } = self; diff --git a/crates/store/re_data_loader/src/load_file.rs b/crates/store/re_data_loader/src/load_file.rs index 3ed813a002f3c..a7b57cf7bfeb5 100644 --- a/crates/store/re_data_loader/src/load_file.rs +++ b/crates/store/re_data_loader/src/load_file.rs @@ -73,21 +73,20 @@ pub fn load_from_file_contents( /// Prepares an adequate [`re_log_types::StoreInfo`] [`LogMsg`] given the input. pub(crate) fn prepare_store_info( + application_id: re_log_types::ApplicationId, store_id: &re_log_types::StoreId, file_source: FileSource, - path: &std::path::Path, ) -> LogMsg { - re_tracing::profile_function!(path.display().to_string()); + re_tracing::profile_function!(); use re_log_types::SetStoreInfo; - let app_id = re_log_types::ApplicationId(path.display().to_string()); let store_source = re_log_types::StoreSource::File { file_source }; LogMsg::SetStoreInfo(SetStoreInfo { row_id: *re_chunk::RowId::new(), info: re_log_types::StoreInfo { - application_id: app_id.clone(), + application_id, store_id: store_id.clone(), cloned_from: None, is_official_example: false, @@ -310,11 +309,17 @@ pub(crate) fn send( let is_a_preexisting_recording = Some(&store_id) == settings.opened_store_id.as_ref(); - if store_info_already_created || is_a_preexisting_recording { + if !settings.force_store_info + && (store_info_already_created || is_a_preexisting_recording) + { continue; } - let store_info = prepare_store_info(&store_id, file_source.clone(), &path); + let app_id = settings + .opened_application_id + .clone() + .unwrap_or_else(|| re_log_types::ApplicationId(path.display().to_string())); + let store_info = prepare_store_info(app_id, &store_id, file_source.clone()); tx.send(store_info).ok(); } diff --git a/crates/store/re_data_source/src/data_source.rs b/crates/store/re_data_source/src/data_source.rs index 6d9c76a77b546..b480a0e512a47 100644 --- a/crates/store/re_data_source/src/data_source.rs +++ b/crates/store/re_data_source/src/data_source.rs @@ -178,6 +178,7 @@ impl DataSource { let settings = re_data_loader::DataLoaderSettings { opened_application_id: file_source.recommended_application_id().cloned(), opened_store_id: file_source.recommended_recording_id().cloned(), + force_store_info: file_source.force_store_info(), ..re_data_loader::DataLoaderSettings::recommended(shared_store_id) }; re_data_loader::load_from_path(&settings, file_source, &path, &tx) @@ -206,6 +207,7 @@ impl DataSource { let settings = re_data_loader::DataLoaderSettings { opened_application_id: file_source.recommended_application_id().cloned(), opened_store_id: file_source.recommended_recording_id().cloned(), + force_store_info: file_source.force_store_info(), ..re_data_loader::DataLoaderSettings::recommended(shared_store_id) }; re_data_loader::load_from_file_contents( @@ -275,6 +277,7 @@ fn test_data_source_from_uri() { let file_source = FileSource::DragAndDrop { recommended_application_id: None, recommended_recording_id: None, + force_store_info: false, }; for uri in file { diff --git a/crates/store/re_log_types/src/lib.rs b/crates/store/re_log_types/src/lib.rs index 2a0abd433d5c2..c152a098fa4ec 100644 --- a/crates/store/re_log_types/src/lib.rs +++ b/crates/store/re_log_types/src/lib.rs @@ -418,6 +418,12 @@ pub enum FileSource { /// The [`StoreId`] that the viewer heuristically recommends should be used when loading /// this data source, based on the surrounding context. recommended_recording_id: Option, + + /// Whether `SetStoreInfo`s should be sent, regardless of the surrounding context. + /// + /// Only useful when creating a recording just-in-time directly in the viewer (which is what + /// happens when importing things into the welcome screen). + force_store_info: bool, }, FileDialog { @@ -428,6 +434,12 @@ pub enum FileSource { /// The [`StoreId`] that the viewer heuristically recommends should be used when loading /// this data source, based on the surrounding context. recommended_recording_id: Option, + + /// Whether `SetStoreInfo`s should be sent, regardless of the surrounding context. + /// + /// Only useful when creating a recording just-in-time directly in the viewer (which is what + /// happens when importing things into the welcome screen). + force_store_info: bool, }, Sdk, @@ -463,6 +475,19 @@ impl FileSource { Self::Cli | Self::Sdk => None, } } + + #[inline] + pub fn force_store_info(&self) -> bool { + match self { + Self::FileDialog { + force_store_info, .. + } + | Self::DragAndDrop { + force_store_info, .. + } => *force_store_info, + Self::Cli | Self::Sdk => false, + } + } } /// The source of a recording or blueprint. diff --git a/crates/top/re_sdk/src/recording_stream.rs b/crates/top/re_sdk/src/recording_stream.rs index 1e8abc28d071c..19beb4c20a568 100644 --- a/crates/top/re_sdk/src/recording_stream.rs +++ b/crates/top/re_sdk/src/recording_stream.rs @@ -1259,6 +1259,7 @@ impl RecordingStream { opened_application_id: None, store_id: store_info.store_id.clone(), opened_store_id: None, + force_store_info: false, entity_path_prefix, timepoint: (!static_).then(|| { self.with(|inner| { diff --git a/crates/viewer/re_viewer/Cargo.toml b/crates/viewer/re_viewer/Cargo.toml index 1cff704f6e45a..18af92ce86eb9 100644 --- a/crates/viewer/re_viewer/Cargo.toml +++ b/crates/viewer/re_viewer/Cargo.toml @@ -120,6 +120,7 @@ serde = { workspace = true, features = ["derive"] } serde_json.workspace = true serde-wasm-bindgen.workspace = true thiserror.workspace = true +uuid.workspace = true web-time.workspace = true wgpu.workspace = true diff --git a/crates/viewer/re_viewer/src/app.rs b/crates/viewer/re_viewer/src/app.rs index 64976999388cd..5e284f7954c95 100644 --- a/crates/viewer/re_viewer/src/app.rs +++ b/crates/viewer/re_viewer/src/app.rs @@ -573,17 +573,33 @@ impl App { store_context: Option<&StoreContext<'_>>, cmd: UICommand, ) { + let mut force_store_info = false; let active_application_id = store_context .and_then(|ctx| { ctx.hub .active_app() // Don't redirect data to the welcome screen. .filter(|&app_id| app_id != &StoreHub::welcome_screen_app_id()) + .cloned() }) - .cloned(); + // If we don't have any application ID to recommend (which means we are on the welcome screen), + // then just generate a new one using a UUID. + .or_else(|| Some(uuid::Uuid::new_v4().to_string().into())); let active_recording_id = store_context - .and_then(|ctx| ctx.hub.active_recording_id()) - .cloned(); + .and_then(|ctx| ctx.hub.active_recording_id().cloned()) + .or_else(|| { + // When we're on the welcome screen, there is no recording ID to recommend. + // But we want one, otherwise multiple things being dropped simultaneously on the + // welcome screen would end up in different recordings! + + // We're creating a recording just-in-time, directly from the viewer. + // We need those store infos or the data will just be silently ignored. + force_store_info = true; + + // NOTE: We don't override blueprints' store IDs anyhow, so it is sound to assume that + // this can only be a recording. + Some(re_log_types::StoreId::random(StoreKind::Recording)) + }); match cmd { UICommand::SaveRecording => { @@ -615,6 +631,7 @@ impl App { FileSource::FileDialog { recommended_application_id: None, recommended_recording_id: None, + force_store_info, }, file_path, ))); @@ -624,9 +641,6 @@ impl App { UICommand::Open => { let egui_ctx = egui_ctx.clone(); - // Open: we want to try and load into a new dedicated recording. - let recommended_application_id = None; - let recommended_recording_id = None; let promise = poll_promise::Promise::spawn_local(async move { let file = async_open_rrd_dialog().await; egui_ctx.request_repaint(); // Wake ui thread @@ -634,8 +648,8 @@ impl App { }); self.open_files_promise = Some(PendingFilePromise { - recommended_application_id, - recommended_recording_id, + recommended_application_id: None, + recommended_recording_id: None, promise, }); } @@ -648,6 +662,7 @@ impl App { FileSource::FileDialog { recommended_application_id: active_application_id.clone(), recommended_recording_id: active_recording_id.clone(), + force_store_info, }, file_path, ))); @@ -657,10 +672,6 @@ impl App { UICommand::Import => { let egui_ctx = egui_ctx.clone(); - // Import: we want to try and load into the current recording. - let recommended_application_id = active_application_id; - let recommended_recording_id = active_recording_id; - let promise = poll_promise::Promise::spawn_local(async move { let file = async_open_rrd_dialog().await; egui_ctx.request_repaint(); // Wake ui thread @@ -668,8 +679,8 @@ impl App { }); self.open_files_promise = Some(PendingFilePromise { - recommended_application_id, - recommended_recording_id, + recommended_application_id: active_application_id.clone(), + recommended_recording_id: active_recording_id.clone(), promise, }); } @@ -1364,17 +1375,33 @@ impl App { return; } + let mut force_store_info = false; let active_application_id = store_ctx .and_then(|ctx| { ctx.hub .active_app() // Don't redirect data to the welcome screen. .filter(|&app_id| app_id != &StoreHub::welcome_screen_app_id()) + .cloned() }) - .cloned(); + // If we don't have any application ID to recommend (which means we are on the welcome screen), + // then just generate a new one using a UUID. + .or_else(|| Some(uuid::Uuid::new_v4().to_string().into())); let active_recording_id = store_ctx - .and_then(|ctx| ctx.hub.active_recording_id()) - .cloned(); + .and_then(|ctx| ctx.hub.active_recording_id().cloned()) + .or_else(|| { + // When we're on the welcome screen, there is no recording ID to recommend. + // But we want one, otherwise multiple things being dropped simultaneously on the + // welcome screen would end up in different recordings! + + // We're creating a recording just-in-time, directly from the viewer. + // We need those store infos or the data will just be silently ignored. + force_store_info = true; + + // NOTE: We don't override blueprints' store IDs anyhow, so it is sound to assume that + // this can only be a recording. + Some(re_log_types::StoreId::random(StoreKind::Recording)) + }); for file in dropped_files { if let Some(bytes) = file.bytes { @@ -1384,6 +1411,7 @@ impl App { FileSource::DragAndDrop { recommended_application_id: active_application_id.clone(), recommended_recording_id: active_recording_id.clone(), + force_store_info, }, FileContents { name: file.name.clone(), @@ -1400,6 +1428,7 @@ impl App { FileSource::DragAndDrop { recommended_application_id: active_application_id.clone(), recommended_recording_id: active_recording_id.clone(), + force_store_info, }, path, )));