Rename DataTool to DataExplorer (#244)

Author: wesm

crates/amalthea/src/comm/data_tool_comm.rs renamed to crates/amalthea/src/comm/data_explorer_comm.rs

@@ -3,7 +3,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 //
-// AUTO-GENERATED from data_tool.json; do not edit.
+// AUTO-GENERATED from data_explorer.json; do not edit.
 //
 
 use serde::Deserialize;
@@ -29,10 +29,10 @@ pub struct TableSchema {
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct TableData {
     /// The columns of data
-    pub columns: Vec<ColumnFormattedData>,
+    pub columns: Vec<Vec<String>>,
 
     /// Zero or more arrays of row labels
-    pub row_labels: Option<Vec<ColumnFormattedData>>,
+    pub row_labels: Option<Vec<Vec<String>>>,
 }
 
 /// The result of applying filters to a table
@@ -331,11 +331,11 @@ pub struct GetColumnProfileParams {
 }
 
 /**
- * Backend RPC request types for the data_tool comm
+ * Backend RPC request types for the data_explorer comm
  */
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 #[serde(tag = "method", content = "params")]
-pub enum DataToolBackendRequest {
+pub enum DataExplorerBackendRequest {
     /// Request schema
     ///
     /// Request full schema for a table-like object
@@ -375,11 +375,11 @@ pub enum DataToolBackendRequest {
 }
 
 /**
- * Backend RPC Reply types for the data_tool comm
+ * Backend RPC Reply types for the data_explorer comm
  */
 #[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 #[serde(tag = "method", content = "result")]
-pub enum DataToolBackendReply {
+pub enum DataExplorerBackendReply {
     /// The schema for a table-like object
     GetSchemaReply(TableSchema),
 

crates/amalthea/src/comm/mod.rs

@@ -8,7 +8,7 @@
 pub mod base_comm;
 pub mod comm_channel;
 pub mod comm_manager;
-pub mod data_tool_comm;
+pub mod data_explorer_comm;
 pub mod event;
 pub mod help_comm;
 pub mod plot_comm;

crates/ark/src/data_viewer/mod.rs renamed to crates/ark/src/data_explorer/mod.rs

@@ -5,4 +5,4 @@
 //
 //
 
-pub mod r_data_tool;
+pub mod r_data_explorer;

crates/ark/src/data_viewer/r_data_tool.rs renamed to crates/ark/src/data_explorer/r_data_explorer.rs

@@ -8,17 +8,17 @@
 use std::cmp;
 
 use amalthea::comm::comm_channel::CommMsg;
-use amalthea::comm::data_tool_comm::ColumnSchema;
-use amalthea::comm::data_tool_comm::ColumnSchemaTypeDisplay;
-use amalthea::comm::data_tool_comm::DataToolBackendReply;
-use amalthea::comm::data_tool_comm::DataToolBackendRequest;
-use amalthea::comm::data_tool_comm::GetColumnProfileParams;
-use amalthea::comm::data_tool_comm::GetDataValuesParams;
-use amalthea::comm::data_tool_comm::GetSchemaParams;
-use amalthea::comm::data_tool_comm::SetColumnFiltersParams;
-use amalthea::comm::data_tool_comm::SetSortColumnsParams;
-use amalthea::comm::data_tool_comm::TableData;
-use amalthea::comm::data_tool_comm::TableSchema;
+use amalthea::comm::data_explorer_comm::ColumnSchema;
+use amalthea::comm::data_explorer_comm::ColumnSchemaTypeDisplay;
+use amalthea::comm::data_explorer_comm::DataExplorerBackendReply;
+use amalthea::comm::data_explorer_comm::DataExplorerBackendRequest;
+use amalthea::comm::data_explorer_comm::GetColumnProfileParams;
+use amalthea::comm::data_explorer_comm::GetDataValuesParams;
+use amalthea::comm::data_explorer_comm::GetSchemaParams;
+use amalthea::comm::data_explorer_comm::SetColumnFiltersParams;
+use amalthea::comm::data_explorer_comm::SetSortColumnsParams;
+use amalthea::comm::data_explorer_comm::TableData;
+use amalthea::comm::data_explorer_comm::TableSchema;
 use amalthea::comm::event::CommManagerEvent;
 use amalthea::socket::comm::CommInitiator;
 use amalthea::socket::comm::CommSocket;
@@ -45,7 +45,7 @@ use crate::r_task;
 use crate::thread::RThreadSafe;
 use crate::variables::variable::WorkspaceVariableDisplayType;
 
-pub struct RDataTool {
+pub struct RDataExplorer {
     title: String,
     table: RThreadSafe<RObject>,
     comm: CommSocket,
@@ -57,7 +57,7 @@ struct Metadata {
     title: String,
 }
 
-impl RDataTool {
+impl RDataExplorer {
     pub fn start(
         title: String,
         data: RObject,
@@ -68,7 +68,7 @@ impl RDataTool {
         let comm = CommSocket::new(
             CommInitiator::BackEnd,
             id.clone(),
-            String::from("positron.dataTool"),
+            String::from("positron.dataExplorer"),
         );
 
         // To be able to `Send` the `data` to the thread to be owned by the data
@@ -136,50 +136,50 @@ impl RDataTool {
         }
     }
 
-    fn handle_rpc(&self, req: DataToolBackendRequest) -> anyhow::Result<DataToolBackendReply> {
+    fn handle_rpc(&self, req: DataExplorerBackendRequest) -> anyhow::Result<DataExplorerBackendReply> {
         match req {
-            DataToolBackendRequest::GetSchema(GetSchemaParams {
+            DataExplorerBackendRequest::GetSchema(GetSchemaParams {
                 start_index,
                 num_columns,
             }) => {
                 // TODO: Support for data frames with over 2B rows
                 // TODO: Check bounds
                 r_task(|| self.r_get_schema(start_index as i32, num_columns as i32))
             },
-            DataToolBackendRequest::GetDataValues(GetDataValuesParams {
+            DataExplorerBackendRequest::GetDataValues(GetDataValuesParams {
                 row_start_index,
                 num_rows,
                 column_indices,
             }) => {
                 // Fetch stringified data values and return
                 r_task(|| self.r_get_data_values(row_start_index, num_rows, column_indices))
             },
-            DataToolBackendRequest::SetSortColumns(SetSortColumnsParams { sort_keys: _ }) => {
+            DataExplorerBackendRequest::SetSortColumns(SetSortColumnsParams { sort_keys: _ }) => {
                 bail!("Data Viewer: Not yet implemented")
             },
-            DataToolBackendRequest::SetColumnFilters(SetColumnFiltersParams { filters: _ }) => {
+            DataExplorerBackendRequest::SetColumnFilters(SetColumnFiltersParams { filters: _ }) => {
                 bail!("Data Viewer: Not yet implemented")
             },
-            DataToolBackendRequest::GetColumnProfile(GetColumnProfileParams {
+            DataExplorerBackendRequest::GetColumnProfile(GetColumnProfileParams {
                 profile_type: _,
                 column_index: _,
             }) => {
                 bail!("Data Viewer: Not yet implemented")
             },
-            DataToolBackendRequest::GetState => {
+            DataExplorerBackendRequest::GetState => {
                 bail!("Data Viewer: Not yet implemented")
             },
         }
     }
 }
 
 // Methods that must be run on the main R thread
-impl RDataTool {
+impl RDataExplorer {
     fn r_get_schema(
         &self,
         start_index: i32,
         num_columns: i32,
-    ) -> anyhow::Result<DataToolBackendReply> {
+    ) -> anyhow::Result<DataExplorerBackendReply> {
         unsafe {
             let table = self.table.get().clone();
             let object = *table;
@@ -233,7 +233,7 @@ impl RDataTool {
                 total_num_columns: total_num_columns as i64,
             };
 
-            Ok(DataToolBackendReply::GetSchemaReply(response))
+            Ok(DataExplorerBackendReply::GetSchemaReply(response))
         }
     }
 
@@ -242,7 +242,7 @@ impl RDataTool {
         row_start_index: i64,
         num_rows: i64,
         column_indices: Vec<i64>,
-    ) -> anyhow::Result<DataToolBackendReply> {
+    ) -> anyhow::Result<DataExplorerBackendReply> {
         unsafe {
             let table = self.table.get().clone();
             let object = *table;
@@ -297,7 +297,7 @@ impl RDataTool {
                 row_labels: Some(vec![row_labels]),
             };
 
-            Ok(DataToolBackendReply::GetDataValuesReply(response))
+            Ok(DataExplorerBackendReply::GetDataValuesReply(response))
         }
     }
 }
@@ -373,7 +373,7 @@ pub unsafe extern "C" fn ps_view_data_frame(x: SEXP, title: SEXP) -> anyhow::Res
     let main = RMain::get();
     let comm_manager_tx = main.get_comm_manager_tx().clone();
 
-    RDataTool::start(title, x, comm_manager_tx)?;
+    RDataExplorer::start(title, x, comm_manager_tx)?;
 
     Ok(R_NilValue)
 }

crates/ark/src/lib.rs

@@ -9,7 +9,7 @@ pub mod browser;
 pub mod connections;
 pub mod control;
 pub mod dap;
-pub mod data_viewer;
+pub mod data_explorer;
 pub mod errors;
 pub mod help;
 pub mod help_proxy;

crates/ark/src/modules/positron/r_data_viewer.R renamed to crates/ark/src/modules/positron/r_data_explorer.R

@@ -1,5 +1,5 @@
 #
-# r_data_viewer.R
+# r_data_explorer.R
 #
 # Copyright (C) 2023-2024 Posit Software, PBC. All rights reserved.
 #

crates/ark/src/variables/r_variables.rs

@@ -37,7 +37,7 @@ use log::error;
 use log::warn;
 use stdext::spawn;
 
-use crate::data_viewer::r_data_tool::RDataTool;
+use crate::data_explorer::r_data_explorer::RDataExplorer;
 use crate::lsp::events::EVENTS;
 use crate::r_task;
 use crate::thread::RThreadSafe;
@@ -326,7 +326,7 @@ impl RVariables {
             let env = self.env.get().clone();
             let data = PositronVariable::resolve_data_object(env, &path)?;
             let name = unsafe { path.get_unchecked(path.len() - 1) };
-            RDataTool::start(name.clone(), data, self.comm_manager_tx.clone())?;
+            RDataExplorer::start(name.clone(), data, self.comm_manager_tx.clone())?;
             Ok(())
         })
     }