Add UrlContext which handles getting information for ViewerOpenUrl (#11183)

Author: IsseW

Cargo.lock

@@ -8993,7 +8993,6 @@ dependencies = [
  "itertools 0.14.0",
  "js-sys",
  "parking_lot",
- "percent-encoding",
  "poll-promise",
  "re_analytics",
  "re_auth",
@@ -9107,6 +9106,7 @@ dependencies = [
  "re_types",
  "re_types_core",
  "re_ui",
+ "re_uri",
  "re_video",
  "serde",
  "slotmap",

crates/store/re_log_types/src/index/absolute_time_range.rs

@@ -203,6 +203,12 @@ impl AbsoluteTimeRangeF {
     pub fn length(&self) -> TimeReal {
         self.max - self.min
     }
+
+    /// Creates an [`AbsoluteTimeRange`] from self by rounding the start
+    /// of the range down, and rounding the end of the range up.
+    pub fn to_int(self) -> AbsoluteTimeRange {
+        AbsoluteTimeRange::new(self.min.floor(), self.max.ceil())
+    }
 }
 
 impl From<AbsoluteTimeRangeF> for RangeInclusive<TimeReal> {

crates/viewer/re_global_context/src/command_sender.rs

@@ -96,6 +96,13 @@ pub enum SystemCommand {
         fragment: re_uri::Fragment,
     },
 
+    /// Copies an url to the clipboard to the given a display mode, selection range, and url fragment.
+    CopyUrlWithContext {
+        display_mode: crate::DisplayMode,
+        time_range: Option<re_uri::TimeSelection>,
+        fragment: re_uri::Fragment,
+    },
+
     /// Set the item selection.
     SetSelection(crate::ItemCollection),
 

crates/viewer/re_test_context/src/lib.rs

@@ -588,6 +588,9 @@ impl TestContext {
                     // This adds new system commands, which will be handled later in the loop.
                     self.go_to_dataset_data(store_id, fragment);
                 }
+                SystemCommand::CopyUrlWithContext { .. } => {
+                    // Ignore copying to clipboard here.
+                }
                 SystemCommand::AppendToStore(store_id, chunks) => {
                     let store_hub = self.store_hub.get_mut();
                     let db = store_hub.entity_db_mut(&store_id);

crates/viewer/re_viewer/Cargo.toml

@@ -151,7 +151,6 @@ re_perf_telemetry = { workspace = true, features = ["tracy"], optional = true }
 # web dependencies:
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 js-sys.workspace = true
-percent-encoding.workspace = true
 strum.workspace = true
 strum_macros.workspace = true
 wasm-bindgen-futures.workspace = true

crates/viewer/re_viewer/src/app.rs

@@ -15,8 +15,8 @@ use re_ui::{ContextExt as _, UICommand, UICommandSender as _, UiExt as _, notifi
 use re_viewer_context::{
     AppOptions, AsyncRuntimeHandle, BlueprintUndoState, CommandReceiver, CommandSender,
     ComponentUiRegistry, DisplayMode, Item, PlayState, RecordingConfig, RecordingOrTable,
-    StorageContext, StoreContext, SystemCommand, SystemCommandSender as _, TableStore, ViewClass,
-    ViewClassRegistry, ViewClassRegistryError, command_channel, santitize_file_name,
+    StorageContext, StoreContext, SystemCommand, SystemCommandSender as _, TableStore, UrlContext,
+    ViewClass, ViewClassRegistry, ViewClassRegistryError, command_channel, santitize_file_name,
     store_hub::{BlueprintPersistence, StoreHub, StoreHubStats},
 };
 
@@ -555,25 +555,19 @@ impl App {
         let time_ctrl = rec_cfg.as_ref().map(|cfg| cfg.time_ctrl.read());
 
         let display_mode = self.state.navigation.peek();
-        let selection = self.state.selection_state.selected_items().first_item();
+        let selection = self.state.selection_state.selected_items();
 
-        let Ok(url) = crate::open_url::ViewerOpenUrl::from_display_mode(
+        let Ok(url) = crate::open_url::ViewerOpenUrl::new(
             store_hub,
-            display_mode.clone(),
-            &re_uri::Fragment {
-                selection: selection.and_then(|item| item.to_data_path()),
-                when: time_ctrl
-                    .filter(|time_ctrl| matches!(time_ctrl.play_state(), PlayState::Paused))
-                    .and_then(|when| {
-                        Some((
-                            *when.timeline().name(),
-                            re_log_types::TimeCell {
-                                typ: when.timeline().typ(),
-                                value: when.time_int()?.into(),
-                            },
-                        ))
-                    }),
-            },
+            UrlContext::from_context_expanded(
+                display_mode,
+                time_ctrl
+                    .as_deref()
+                    // Only update `when` fragment when paused.
+                    .filter(|time_ctrl| matches!(time_ctrl.play_state(), PlayState::Paused)),
+                selection,
+            )
+            .without_time_range(),
         )
         // History entries expect the url parameter, not the full url, therefore don't pass a base url.
         .and_then(|url| url.sharable_url(None)) else {
@@ -625,6 +619,20 @@ impl App {
                 // This adds new system commands, which will be handled later in the loop.
                 self.go_to_dataset_data(store_id, fragment);
             }
+            SystemCommand::CopyUrlWithContext {
+                display_mode,
+                time_range,
+                fragment,
+            } => {
+                self.run_copy_link_command(
+                    store_hub,
+                    UrlContext {
+                        display_mode,
+                        time_range,
+                        fragment,
+                    },
+                );
+            }
             SystemCommand::ActivateApp(app_id) => {
                 self.state.navigation.replace(DisplayMode::LocalRecordings);
                 store_hub.set_active_app(app_id);
@@ -1480,11 +1488,30 @@ impl App {
             }
 
             UICommand::CopyDirectLink => {
-                self.run_copy_direct_link_command(storage_context, display_mode);
+                self.run_copy_link_command(
+                    storage_context.hub,
+                    UrlContext::new(display_mode.clone()),
+                );
             }
 
             UICommand::CopyTimeRangeLink => {
-                self.run_copy_time_range_link_command(store_context);
+                let mut url_context = UrlContext::new(display_mode.clone());
+
+                let rec_cfg = storage_context
+                    .hub
+                    .active_recording()
+                    .and_then(|db| self.state.recording_config(db.store_id()));
+                let time_ctrl = rec_cfg.as_ref().map(|cfg| cfg.time_ctrl.read());
+
+                if let Some(time_ctrl) = &time_ctrl {
+                    url_context = url_context.with_time_range(time_ctrl);
+                } else {
+                    re_log::warn!("No timeline in current mode");
+                }
+
+                drop(time_ctrl);
+
+                self.run_copy_link_command(storage_context.hub, url_context);
             }
 
             #[cfg(target_arch = "wasm32")]
@@ -1605,41 +1632,7 @@ impl App {
         }
     }
 
-    /// Retrieve the link to the current viewer.
-    #[cfg(target_arch = "wasm32")]
-    fn get_viewer_url(&self) -> Result<String, wasm_bindgen::JsValue> {
-        let location = web_sys::window()
-            .ok_or_else(|| "failed to get window".to_owned())?
-            .location();
-        let origin = location.origin()?;
-        let host = location.host()?;
-        let pathname = location.pathname()?;
-
-        let hosted_viewer_path = if self.build_info.is_final() {
-            // final release, use version tag
-            format!("version/{}", self.build_info.version)
-        } else {
-            // not a final release, use commit hash
-            format!("commit/{}", self.build_info.short_git_hash())
-        };
-
-        // links to `app.rerun.io` can be made into permanent links:
-        let url = if host == "app.rerun.io" {
-            format!("https://app.rerun.io/{hosted_viewer_path}")
-        } else if host == "rerun.io" && pathname.starts_with("/viewer") {
-            format!("https://rerun.io/viewer/{hosted_viewer_path}")
-        } else {
-            format!("{origin}{pathname}")
-        };
-
-        Ok(url)
-    }
-
-    fn run_copy_direct_link_command(
-        &mut self,
-        storage_context: &StorageContext<'_>,
-        display_mode: &DisplayMode,
-    ) {
+    fn run_copy_link_command(&mut self, store_hub: &StoreHub, context: UrlContext) {
         // TODO(rerun-io/dataplatform#2663): Should take into account dataplatform URLs if any are provided.
         let base_url;
         #[cfg(target_arch = "wasm32")]
@@ -1652,12 +1645,8 @@ impl App {
             base_url = None;
         };
 
-        match crate::open_url::ViewerOpenUrl::from_display_mode(
-            storage_context.hub,
-            display_mode.clone(),
-            &re_uri::Fragment::default(),
-        )
-        .and_then(|content_url| content_url.sharable_url(base_url.as_ref()))
+        match crate::open_url::ViewerOpenUrl::new(store_hub, context)
+            .and_then(|content_url| content_url.sharable_url(base_url.as_ref()))
         {
             Ok(url) => {
                 self.egui_ctx.copy_text(url);
@@ -1670,71 +1659,6 @@ impl App {
         }
     }
 
-    fn run_copy_time_range_link_command(&mut self, store_context: Option<&StoreContext<'_>>) {
-        let Some(entity_db) = store_context.as_ref().map(|ctx| ctx.recording) else {
-            re_log::warn!("Could not copy time range link: No active recording");
-            return;
-        };
-
-        let Some(SmartChannelSource::RedapGrpcStream { mut uri, .. }) =
-            entity_db.data_source.clone()
-        else {
-            re_log::warn!("Could not copy time range link: Data source is not a gRPC stream");
-            return;
-        };
-
-        let rec_cfg = self.state.recording_config_mut(entity_db);
-        let time_ctrl = rec_cfg.time_ctrl.get_mut();
-
-        let Some(range) = time_ctrl.loop_selection() else {
-            // no loop selection
-            re_log::warn!(
-                "Could not copy time range link: No loop selection set. Use shift to drag a selection on the timeline"
-            );
-            return;
-        };
-
-        uri.time_range = Some(re_uri::TimeSelection {
-            timeline: *time_ctrl.timeline(),
-            range: re_log_types::AbsoluteTimeRange::new(range.min.floor(), range.max.ceil()),
-        });
-
-        // On web we can produce a link to the web viewer,
-        // which can be used to share the time range.
-        //
-        // On native we only produce a link to the time range
-        // which can be passed to `rerun-cli`.
-        #[cfg(target_arch = "wasm32")]
-        let url = {
-            use crate::web_tools::JsResultExt as _;
-            let Some(viewer_url) = self.get_viewer_url().ok_or_log_js_error() else {
-                // error was logged already
-                return;
-            };
-
-            let time_range_url = uri.to_string();
-            // %-encode the time range URL, because it's a url-within-a-url.
-            // This results in VERY ugly links.
-            // TODO(jan): Tweak the asciiset used here.
-            //            Alternatively, use a better (shorter, simpler) format
-            //            for linking to recordings that isn't a full url and
-            //            can actually exist in a query value.
-            let url_query = percent_encoding::utf8_percent_encode(
-                &time_range_url,
-                percent_encoding::NON_ALPHANUMERIC,
-            );
-
-            format!("{viewer_url}?url={url_query}")
-        };
-
-        #[cfg(not(target_arch = "wasm32"))]
-        let url = uri.to_string();
-
-        self.egui_ctx.copy_text(url.clone());
-        self.notifications
-            .success(format!("Copied {url:?} to clipboard"));
-    }
-
     fn copy_entity_hierarchy_to_clipboard(
         &mut self,
         egui_ctx: &egui::Context,

crates/viewer/re_viewer/src/app_state.rs

@@ -690,7 +690,6 @@ impl AppState {
         self.focused_item = None;
     }
 
-    #[cfg(target_arch = "wasm32")] // Only used in Wasm
     pub fn recording_config(&self, rec_id: &StoreId) -> Option<&RecordingConfig> {
         self.recording_configs.get(rec_id)
     }