cloud_config() -> posit_workbench_config()

Author: shikokuchuo

NAMESPACE

@@ -26,7 +26,6 @@ export(.flat)
 export(.progress)
 export(.stop)
 export(call_mirai)
-export(cloud_config)
 export(cluster_config)
 export(collect_mirai)
 export(daemon)
@@ -51,6 +50,7 @@ export(nextcode)
 export(nextget)
 export(nextstream)
 export(on_daemon)
+export(posit_workbench_config)
 export(register_serial)
 export(remote_config)
 export(require_daemons)

NEWS.md

@@ -8,7 +8,7 @@
 
 #### New Features
 
-* Adds `cloud_config()` to launch remote daemons using a cloud / cloud-based managed platform. Currently supports Posit Workbench.
+* Adds `posit_workbench_config()` to launch remote daemons using the default Posit Workbench launcher (currently only supports Rstudio Pro sessions).
 * Adds `with_daemons()` and `local_daemons()` helper functions for using a particular compute profile.
   This works with daemons that are already set up unlike the existing `with.miraiDaemons()` method, which creates a new scope and tears it down when finished (#360).
 * A mirai now has an attribute `id`, which is a monotonically increasing integer identifier unique to each session.

R/launchers.R

@@ -95,12 +95,9 @@ launch_remote <- function(n = 1L, remote = remote_config(), ..., tls = NULL, .co
   if (is.null(tls)) tls <- envir[["tls"]]
 
   if (length(remote) == 2L) {
-    platform <- remote[["platform"]]
-    args <- remote[["args"]]
-    platform != "posit" && stop(._[["platform_unsupported"]])
     tools <- posit_tools()
     is.environment(tools) || stop(._[["posit_api"]])
-    return(posit_workbench_launch(n, args, tools))
+    return(posit_workbench_launch(n, remote, tools))
   }
 
   command <- remote[["command"]]
@@ -401,45 +398,33 @@ cluster_config <- function(command = "sbatch", options = "", rscript = "Rscript"
   list(command = "/bin/sh", args = args, rscript = rscript, quote = NULL)
 }
 
-#' Cloud Remote Launch Configuration
-#'
-#' Generates a remote configuration for launching daemons via cloud /
-#' cloud-based managed platforms.
+#' Posit Workbench Launch Configuration
 #'
-#' @param platform \[default "posit"\] character name of the platform
-#'   (case-insensitive). Currently the only option is "posit" to use the Posit
-#'   Workbench launcher.
+#' Generates a remote configuration for launching daemons via the default
+#' launcher in Posit Workbench. Currently only supports Rstudio Pro sessions.
 #'
 #' @inherit remote_config return
 #'
 #' @seealso [ssh_config()], [cluster_config()], and [remote_config()] for other
 #'   types of remote launch configuration.
 #'
 #' @examples
-#' tryCatch(cloud_config(), error = identity)
+#' tryCatch(posit_workbench_config(), error = identity)
 #'
 #' \dontrun{
 #'
 #' # Launch 2 daemons using the Posit Workbench default:
-#' daemons(n = 2, url = host_url(), remote = cloud_config(platform = "posit"))
+#' daemons(n = 2, url = host_url(), remote = posit_workbench_config()
 #' }
 #'
 #' @export
 #'
-cloud_config <- function(platform = "posit") {
-  platform <- tolower(platform)
-  args <- switch(
-    platform,
-    posit = {
-      tools <- posit_tools()
-      is.environment(tools) || stop(._[["posit_api"]])
-      get_info <- .subset2(tools, ".rs.api.launcher.getInfo")
-      cluster <- get_info()[["clusters"]][[1L]]
-      list(name = cluster[["name"]], image = cluster[["defaultImage"]])
-    },
-    stop(._[["platform_unsupported"]])
-  )
-  list(platform = platform, args = args)
+posit_workbench_config <- function() {
+  tools <- posit_tools()
+  is.environment(tools) || stop(._[["posit_api"]])
+  get_info <- .subset2(tools, ".rs.api.launcher.getInfo")
+  cluster <- get_info()[["clusters"]][[1L]]
+  list(name = cluster[["name"]], image = cluster[["defaultImage"]])
 }
 
 #' URL Constructors
@@ -536,15 +521,15 @@ posit_tools <- function() {
   tools
 }
 
-posit_workbench_launch <- function(n, args, tools) {
+posit_workbench_launch <- function(n, remote, tools) {
   submit_job <- .subset2(tools, ".rs.api.launcher.submitJob")
   new_container <- .subset2(tools, ".rs.api.launcher.newContainer")
-  cluster <- args[["name"]]
-  container <- new_container(args[["image"]])
+  cluster <- remote[["name"]]
+  container <- new_container(remote[["image"]])
   cmds <- launch_remote(n)
   lapply(cmds, function(cmd)
     submit_job(
-      sprintf("mirai_daemon_%s", random(3L)),
+      sprintf("mirai_daemon_%s", random(4L)),
       cluster = cluster,
       command = cmd,
       container = container

R/mirai-package.R

@@ -80,8 +80,7 @@
     n_zero = "the number of daemons must be zero or greater",
     not_found = "compute profile `%s` not found",
     numeric_n = "`n` must be numeric, did you mean to provide `url`?",
-    platform_unsupported = "`platform` is currently not supported",
-    posit_api = "this launch configuration can only be used from Posit Workbench",
+    posit_api = "requires Posit Workbench (Rstudio Pro session)",
     sync_daemons = "mirai: initial sync with daemon(s) [%d secs elapsed]",
     sync_dispatcher = "mirai: initial sync with dispatcher [%d secs elapsed]",
     within_map = "cannot create local daemons from within mirai map"

man/cloud_config.Rd renamed to man/posit_workbench_config.Rd

@@ -60,24 +60,21 @@ for (i in 0:4)
 test_null(register_serial("test_klass1", serialize, unserialize))
 test_null(register_serial(c("test_klass2", "test_klass3"), list(serialize, serialize), list(unserialize, unserialize)))
 test_equal(length(mirai:::.[["serial"]][[3L]]), 3L)
-# cloud launcher tests
-test_error(cloud_config(platform = ""), "not supported")
+# Posit workbench launcher tests
 is.null(mirai:::posit_tools()) && {
   ns <- new.env(parent = emptyenv())
   `[[<-`(ns, ".rs.api.launcher.jobsFeatureAvailable", function() TRUE)
   `[[<-`(ns, ".rs.api.launcher.getInfo", function() list(clusters = list(list(name = "Kubernetes", defaultImage = "1.a.b.reg.prov.com/int-r-sess:ubuntu2204-20250609"))))
   `[[<-`(ns, ".rs.api.launcher.newContainer", function(image) image)
   `[[<-`(ns, ".rs.api.launcher.submitJob", function(...) NULL)
   attach(ns, name = "tools:rstudio")
-  cfg <- cloud_config(platform = "posit")
+  cfg <- posit_workbench_config()
   test_type("list", cfg)
-  test_zero(daemons(url = local_url(), dispatcher = FALSE))
+  test_true(daemons(url = local_url(), dispatcher = FALSE))
   test_class("miraiLaunchCmd", launch_remote(n = 2L, remote = cfg))
-  cfg$platform <- "wrong"
-  test_error(launch_remote(n = 2L, remote = cfg), "not supported")
-  test_zero(daemons(0))
+  test_false(daemons(0))
   detach()
-  test_error(cloud_config(platform = "posit"), "can only be used from Posit Workbench")
+  test_error(posit_workbench_config(), "requires Posit Workbench")
 }
 # mirai and daemons tests
 connection && {