Merge pull request #293 from rstudio/feature/workbench-job-detection

workbench job detection
rstudio · Jan 25, 2024 · 9e3f80d · 9e3f80d
2 parents 7bcdf15 + 27cfb3e
commit 9e3f80d
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 13 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -16,7 +16,7 @@ URL: https://rstudio.github.io/rstudioapi/,
     https://github.com/rstudio/rstudioapi
 BugReports: https://github.com/rstudio/rstudioapi/issues
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Suggests:
     testthat,
     knitr,

diff --git a/NAMESPACE b/NAMESPACE
@@ -56,7 +56,9 @@ export(insertText)
 export(is.document_position)
 export(is.document_range)
 export(isAvailable)
+export(isBackgroundJob)
 export(isJob)
+export(isWorkbenchJob)
 export(jobAdd)
 export(jobAddOutput)
 export(jobAddProgress)

diff --git a/R/remote.R b/R/remote.R
@@ -5,6 +5,12 @@
 #' These jobs are normally used for actions taken in the Jobs tab, as well
 #' as within the \R build pane.
 #' 
+#' `isWorkbenchJob()` is used to detect scripts which have been launched as
+#' Workbench jobs, and is only available in RStudio Workbench 2024.04 or newer.
+#' These jobs use the RStudio Launcher to run \R scripts on remote clusters, as
+#' opposed to `isBackgroundJob()`, which is used to detect background jobs
+#' which are run on the local machine.
+#' 
 #' This function is primarily intended to be used by package authors, who
 #' need to customize the behavior of their methods when run within an
 #' RStudio job.
@@ -13,9 +19,21 @@
 #' 
 #' @export
 isJob <- function() {
+  isBackgroundJob() || isWorkbenchJob()
+}
+
+#' @name isJob
+#' @export
+isBackgroundJob <- function() {
   !is.na(Sys.getenv("RSTUDIOAPI_IPC_REQUESTS_FILE", unset = NA))
 }
 
+#' @name isJob
+#' @export
+isWorkbenchJob <- function() {
+  identical(Sys.getenv("RSTUDIO_WORKBENCH_JOB"), "1")
+}
+
 callRemote <- function(call, frame) {
 
   # check for active request / response

diff --git a/man/isJob.Rd b/man/isJob.Rd
diff --git a/man/launcherAvailable.Rd b/man/launcherAvailable.Rd
diff --git a/man/launcherConfig.Rd b/man/launcherConfig.Rd
diff --git a/man/launcherContainer.Rd b/man/launcherContainer.Rd
diff --git a/man/launcherControlJob.Rd b/man/launcherControlJob.Rd
diff --git a/man/launcherGetInfo.Rd b/man/launcherGetInfo.Rd
diff --git a/man/launcherHostMount.Rd b/man/launcherHostMount.Rd
diff --git a/man/launcherNfsMount.Rd b/man/launcherNfsMount.Rd
diff --git a/man/launcherPlacementConstraint.Rd b/man/launcherPlacementConstraint.Rd
diff --git a/man/launcherResourceLimit.Rd b/man/launcherResourceLimit.Rd
diff --git a/man/launcherSubmitJob.Rd b/man/launcherSubmitJob.Rd
diff --git a/man/launcherSubmitR.Rd b/man/launcherSubmitR.Rd
diff --git a/man/setGhostText.Rd b/man/setGhostText.Rd