workbench_config() -> cloud_config()

Author: shikokuchuo

NAMESPACE

@@ -26,6 +26,7 @@ export(.flat)
 export(.progress)
 export(.stop)
 export(call_mirai)
+export(cloud_config)
 export(cluster_config)
 export(collect_mirai)
 export(daemon)
@@ -60,7 +61,6 @@ export(stop_cluster)
 export(stop_mirai)
 export(unresolved)
 export(with_daemons)
-export(workbench_config)
 importFrom(nanonext,"opt<-")
 importFrom(nanonext,.advance)
 importFrom(nanonext,.context)

NEWS.md

@@ -8,7 +8,7 @@
 
 #### New Features
 
-* Adds `workbench_config()` to launch remote daemons using the default-configured Kubernetes or traditional cluster on Posit Workbench.
+* Adds `cloud_config()` to launch remote daemons using a cloud / cloud-based managed platform. Currently supports Posit Workbench.
 * 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

@@ -409,28 +409,37 @@ cluster_config <- function(command = "sbatch", options = "", rscript = "Rscript"
   list(command = "/bin/sh", args = args, rscript = rscript, quote = NULL)
 }
 
-#' Workbench Remote Launch Configuration
+#' Cloud Remote Launch Configuration
 #'
-#' Generates a remote configuration for launching daemons using the default
-#' configured Kubernetes or traditional cluster in Posit Workbench.
+#' Generates a remote configuration for launching daemons via cloud /
+#' cloud-based managed platforms.
+#'
+#' @param platform \[default "posit"\] character name of the platform
+#'   (case-insensitive). Currently the only option is "posit" to use the Posit
+#'   Workbench launcher.
 #'
 #' @inherit remote_config return
 #'
 #' @seealso [ssh_config()], [cluster_config()], and [remote_config()] for other
-#'   remote launch configurations.
+#'   types of remote launch configuration.
 #'
 #' @examples
-#' tryCatch(workbench_config(), error = identity)
+#' tryCatch(cloud_config(), error = identity)
 #'
 #' \dontrun{
 #'
-#' # Launch 2 daemons using the Workbench default:
-#' daemons(n = 2, url = host_url(), remote = workbench_config())
+#' # Launch 2 daemons using the Posit Workbench default:
+#' daemons(n = 2, url = host_url(), remote = cloud_config(platform = "posit"))
 #' }
 #'
 #' @export
 #'
-workbench_config <- function() {
+cloud_config <- function(platform = "posit") {
+  switch(
+    tolower(platform),
+    posit = TRUE,
+    stop(._[["platform_unsupported"]])
+  )
   get_info <- .subset2(rstudio(), ".rs.api.launcher.getInfo")
   cluster <- get_info()[["clusters"]][[1L]]
   list(name = cluster[["name"]], image = cluster[["defaultImage"]])

R/mirai-package.R

@@ -80,7 +80,8 @@
     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`?",
-    rstudio_api = "workbench launcher requires a Posit Workbench environment",
+    platform_unsupported = "`platform` is currently not supported",
+    rstudio_api = "cannot be used outside of a Posit Workbench environment",
     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

@@ -43,7 +43,7 @@ test_true(grepl("5555", local_url(tcp = TRUE, port = 5555), fixed = TRUE))
 test_type("list", ssh_config("ssh://remotehost"))
 test_type("list", ssh_config("ssh://remotehost", tunnel = TRUE))
 test_type("list", cluster_config())
-test_type("list", tryCatch(workbench_config(), error = function(cnd) list()))
+test_class("error", tryCatch(cloud_config(), error = identity))
 test_true(is_mirai_interrupt(r <- mirai:::mk_interrupt_error()))
 test_print(r)
 test_true(is_mirai_error(r <- `class<-`("Error in: testing\n", c("miraiError", "errorValue", "try-error"))))