Implement executeCommand for rstudioapi as OpenRPC contract (#256)

* Implement `executeCommand` for rstudioapi as OpenRPC contract

* We can of course do more

* We can use the new `executeCode` for other bits of rstudioapi as well

* Use `ps_show_message()`

* Use braces

* Update crates/ark/src/modules/rstudio/commands.R

Co-authored-by: Lionel Henry <[email protected]>

* Remove newly untrue comment

* Bump ark to 0.1.61

---------

Co-authored-by: Lionel Henry <[email protected]>

Author: juliasilge

Cargo.lock

@@ -148,6 +148,13 @@ pub struct DebugSleepParams {
 	pub ms: f64,
 }
 
+/// Parameters for the ExecuteCommand method.
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct ExecuteCommandParams {
+	/// The command to execute
+	pub command: String,
+}
+
 /**
  * Backend RPC request types for the ui comm
  */
@@ -187,6 +194,13 @@ pub enum UiFrontendRequest {
 	#[serde(rename = "debug_sleep")]
 	DebugSleep(DebugSleepParams),
 
+	/// Execute a Positron command
+	///
+	/// Use this to execute a Positron command from the backend (like from a
+	/// runtime)
+	#[serde(rename = "execute_command")]
+	ExecuteCommand(ExecuteCommandParams),
+
 	/// Context metadata for the last editor
 	///
 	/// Returns metadata such as file path for the last editor selected by the
@@ -205,6 +219,9 @@ pub enum UiFrontendReply {
 	/// Reply for the debug_sleep method (no result)
 	DebugSleepReply(),
 
+	/// Reply for the execute_command method (no result)
+	ExecuteCommandReply(),
+
 	/// Editor metadata
 	LastActiveEditorContextReply(Option<EditorContext>),
 
@@ -256,6 +273,7 @@ pub fn ui_frontend_reply_from_value(
 ) -> anyhow::Result<UiFrontendReply> {
 	match request {
 		UiFrontendRequest::DebugSleep(_) => Ok(UiFrontendReply::DebugSleepReply()),
+		UiFrontendRequest::ExecuteCommand(_) => Ok(UiFrontendReply::ExecuteCommandReply()),
 		UiFrontendRequest::LastActiveEditorContext => Ok(UiFrontendReply::LastActiveEditorContextReply(serde_json::from_value(reply)?)),
 	}
 }

crates/amalthea/src/comm/ui_comm.rs

@@ -1,6 +1,6 @@
 [package]
 name = "ark"
-version = "0.1.60"
+version = "0.1.61"
 edition = "2021"
 rust-version = "1.75.0"
 description = """

crates/ark/Cargo.toml

@@ -15,8 +15,6 @@ use stdext::unwrap;
 use crate::interface::RMain;
 
 /// Shows a message in the Positron frontend
-///
-/// Test helper for `R_ShowMessage()` support
 #[harp::register]
 pub unsafe extern "C" fn ps_show_message(message: SEXP) -> anyhow::Result<SEXP> {
     // Convert message to a string

crates/ark/src/lsp/show_message.rs

@@ -10,6 +10,16 @@
     .ps.Call("ps_ui_last_active_editor_context")
 }
 
+#' @export
+.ps.ui.executeCommand <- function(command) {
+    .ps.Call("ps_ui_execute_command", command)
+}
+
+#' @export
+.ps.ui.showMessage <- function(message) {
+    .ps.Call("ps_show_message", message)
+}
+
 #' @export
 .ps.ui.debugSleep <- function(ms) {
     # stopifnot(is.numeric(ms) && length(ms) == 1 && !is.na(ms))

crates/ark/src/modules/positron/frontend-methods.R

@@ -0,0 +1,16 @@
+#' @export
+.rs.api.executeCommand <- function(commandId, quiet = FALSE) {
+    commandId <- switch(
+        commandId,
+        "activateConsole" = "workbench.action.positronConsole.focusConsole",
+        "activateTerminal" = "workbench.action.terminal.focus",
+        "saveAllSourceDocs" = "workbench.action.files.saveAll",
+        {
+            if (!quiet) {
+                .ps.ui.showMessage(paste0("The command '", commandId, "' does not exist."))
+            }
+            return()
+        }
+    )
+    .ps.ui.executeCommand(commandId)
+}

crates/ark/src/modules/rstudio/commands.R

@@ -46,3 +46,8 @@ convert_position <- function(ps_pos) {
         )
     )
 }
+
+#' @export
+.rs.api.documentSaveAll <- function() {
+    invisible(.ps.ui.executeCommand("workbench.action.files.saveAll"))
+}

crates/ark/src/modules/rstudio/document-api.R

@@ -6,6 +6,7 @@
 //
 
 use amalthea::comm::ui_comm::DebugSleepParams;
+use amalthea::comm::ui_comm::ExecuteCommandParams;
 use amalthea::comm::ui_comm::UiFrontendRequest;
 use harp::object::RObject;
 use libr::SEXP;
@@ -19,6 +20,17 @@ pub unsafe extern "C" fn ps_ui_last_active_editor_context() -> anyhow::Result<SE
     Ok(out.sexp)
 }
 
+#[harp::register]
+pub unsafe extern "C" fn ps_ui_execute_command(command: SEXP) -> anyhow::Result<SEXP> {
+    let params = ExecuteCommandParams {
+        command: RObject::view(command).try_into()?,
+    };
+
+    let main = RMain::get();
+    let out = main.call_frontend_method(UiFrontendRequest::ExecuteCommand(params))?;
+    Ok(out.sexp)
+}
+
 #[harp::register]
 pub unsafe extern "C" fn ps_ui_debug_sleep(ms: SEXP) -> anyhow::Result<SEXP> {
     let params = DebugSleepParams {