Improve rstudioapi error messages

ropensci · Feb 6, 2024 · 7fd68b2 · 7fd68b2
1 parent b9642a9
commit 7fd68b2
Show file tree

Hide file tree

Showing 82 changed files with 178 additions and 156 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -117,4 +117,4 @@ Language: en-US
 VignetteBuilder: knitr
 Config/testthat/edition: 3
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.0
+RoxygenNote: 7.3.1
diff --git a/R/tar_make.R b/R/tar_make.R
@@ -99,7 +99,7 @@
 #' @param as_job `TRUE` to run as an RStudio IDE / Posit Workbench job,
 #'   `FALSE` to run as a `callr` process in the main R session
 #'   (depending on the `callr_function` argument).
-#'   If `as_job_` is `TRUE`, then the `rstudioapi` package must be installed.
+#'   If `as_job` is `TRUE`, then the `rstudioapi` package must be installed.
 #' @examples
 #' if (identical(Sys.getenv("TAR_EXAMPLES"), "true")) { # for CRAN
 #' tar_dir({ # tar_dir() runs code from a temp dir for CRAN.
@@ -263,7 +263,29 @@ tar_make_inner <- function(
 # Tested in tests/interactive/test-job.R.
 # nocov start
 tar_make_as_job <- function(call) {
-  tar_assert_package("rstudioapi")
+  tar_assert_package(
+    "rstudioapi",
+    msg = paste(
+      "The 'rstudioapi' package is required to run tar_make()",
+      "with as_job = TRUE. Either install the package or set as_job = FALSE.",
+      "You can set as_job = FALSE either manually",
+      "in tar_make() or persistently",
+      "for the project in _targets.yaml",
+      "using tar_config_set(as_job = FALSE)."
+    )
+  )
+  tar_assert_true(
+    rstudioapi::isAvailable(),
+    msg = paste(
+      "tar_make() can only run with as_job = TRUE inside the RStudio IDE",
+      "or Posit Workbench. If you are running the pipeline in a terminal",
+      "or a different IDE, then please set as_job = FALSE.",
+      "You can set as_job = FALSE either manually",
+      "in tar_make() or persistently",
+      "for the project in _targets.yaml",
+      "using tar_config_set(as_job = FALSE)."
+    )
+  )
   args <- as.list(call)[-1L]
   args$as_job <- FALSE
   args <- paste(names(args), "=", map_chr(args, tar_deparse_safe))

diff --git a/R/utils_assert.R b/R/utils_assert.R
@@ -472,11 +472,11 @@ tar_assert_nzchar <- function(x, msg = NULL) {
 
 #' @export
 #' @rdname tar_assert
-tar_assert_package <- function(package) {
+tar_assert_package <- function(package, msg = NULL) {
   tryCatch(
     rlang::check_installed(package),
     error = function(e) {
-      tar_throw_validate(conditionMessage(e))
+      tar_throw_validate(msg %|||% conditionMessage(e))
     }
   )
 }

diff --git a/man/tar_active.Rd b/man/tar_active.Rd
diff --git a/man/tar_assert.Rd b/man/tar_assert.Rd
diff --git a/man/tar_backoff.Rd b/man/tar_backoff.Rd
diff --git a/man/tar_branch_index.Rd b/man/tar_branch_index.Rd
diff --git a/man/tar_branches.Rd b/man/tar_branches.Rd
diff --git a/man/tar_call.Rd b/man/tar_call.Rd
diff --git a/man/tar_cancel.Rd b/man/tar_cancel.Rd
diff --git a/man/tar_canceled.Rd b/man/tar_canceled.Rd
diff --git a/man/tar_completed.Rd b/man/tar_completed.Rd
diff --git a/man/tar_crew.Rd b/man/tar_crew.Rd
diff --git a/man/tar_cue.Rd b/man/tar_cue.Rd
diff --git a/man/tar_definition.Rd b/man/tar_definition.Rd
diff --git a/man/tar_delete.Rd b/man/tar_delete.Rd
diff --git a/man/tar_destroy.Rd b/man/tar_destroy.Rd
diff --git a/man/tar_dispatched.Rd b/man/tar_dispatched.Rd
diff --git a/man/tar_edit.Rd b/man/tar_edit.Rd
diff --git a/man/tar_envir.Rd b/man/tar_envir.Rd
diff --git a/man/tar_errored.Rd b/man/tar_errored.Rd
diff --git a/man/tar_format.Rd b/man/tar_format.Rd
diff --git a/man/tar_github_actions.Rd b/man/tar_github_actions.Rd
diff --git a/man/tar_group.Rd b/man/tar_group.Rd
diff --git a/man/tar_invalidate.Rd b/man/tar_invalidate.Rd
diff --git a/man/tar_load.Rd b/man/tar_load.Rd
diff --git a/man/tar_load_everything.Rd b/man/tar_load_everything.Rd
diff --git a/man/tar_load_globals.Rd b/man/tar_load_globals.Rd
diff --git a/man/tar_load_raw.Rd b/man/tar_load_raw.Rd
diff --git a/man/tar_make.Rd b/man/tar_make.Rd