Pass .libPaths() as R_LIBS to quarto subprocess (#228)

Author: cderv

DESCRIPTION

@@ -60,6 +60,6 @@ VignetteBuilder:
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 SystemRequirements: Quarto command line tool
     (<https://github.com/quarto-dev/quarto-cli>).

NEWS.md

@@ -1,5 +1,7 @@
 # quarto (development version)
 
+- `.libPaths()` from the calling R session will now be passed by default to all call to quarto as a subprocess. This should solve issue with **pkgdown** or when building vignettes.
+
 # quarto 1.5.1
 
 - Make sure tests pass on CRAN checks even when Quarto is not installed by adding a gihub action to test when no quarto is available. Also fix tests that were

R/preview.R

@@ -24,7 +24,7 @@
 #' @param quiet Suppress warning and other messages, from R and also Quarto CLI
 #'   (i.e `--quiet` is passed as command line)
 #'
-#' @return The URL of the preview server (invisibly). This can be used to 
+#' @return The URL of the preview server (invisibly). This can be used to
 #'   programmatically access the server location, for example to take screenshots
 #'   with webshot2 or pass to other automation tools.
 #'

R/quarto.R

@@ -128,16 +128,37 @@ quarto_run <- function(
   args = character(),
   quarto_bin = find_quarto(),
   echo = FALSE,
+  libpaths = .libPaths(),
   echo_cmd = getOption("quarto.echo_cmd", FALSE),
   ...,
   .call = rlang::caller_env()
 ) {
+  # To store any environment variables to pass to the process
+  custom_env <- NULL
+
   # This is required due to a bug in QUARTO CLI, fixed only in 1.8+
   # https://github.com/quarto-dev/quarto-cli/pull/12887
-  custom_env <- NULL
   if (!quarto_available(min = "1.8.13")) {
-    custom_env <- c("current", QUARTO_R = R.home("bin"))
+    custom_env <- c(custom_env, QUARTO_R = R.home("bin"))
+  }
+
+  # handle session .libpaths() for background session
+  # It needs to be passed if .libPaths() was modified in the current R session
+  # (e.g. to install dev package in a temporary library)
+  opt_in_libpath <- getOption("quarto.use_libpaths", TRUE)
+  if (isTRUE(opt_in_libpath) && !is.null(libpaths)) {
+    custom_env <- c(
+      custom_env,
+      R_LIBS = paste(libpaths, collapse = .Platform$path.sep)
+    )
   }
+  
+  # This is required because `"current"` only is not supported by processx
+  # FIXME: https://github.com/r-lib/processx/issues/399
+  if (!is.null(custom_env)) {
+    custom_env <- c("current", custom_env)
+  }
+
   res <- withCallingHandlers(
     processx::run(
       quarto_bin,

R/render.R

@@ -51,6 +51,10 @@
 #'   advanced usage and useful for CLI arguments which are not yet mirrored in a
 #'   dedicated parameter of this \R function. See `quarto render --help` for options.
 #' @param pandoc_args Additional command line arguments to pass on to Pandoc.
+#' @param libpaths A character vector of library paths to use for the R session run by Quarto.
+#'   If `NULL`, no library paths will be pass to quarto subprocess and defaults R one will be used.
+#'   Setting `options(quarto.use_libpaths = FALSE)` will disable this behavior and
+#'   never pass library paths to quarto subprocess.
 #' @param as_job Render as an RStudio background job. Default is `"auto"`,
 #'   which will render individual documents normally and projects as
 #'   background jobs. Use the `quarto.render_as_job` \R option to control
@@ -95,6 +99,7 @@ quarto_render <- function(
   profile = NULL,
   quarto_args = NULL,
   pandoc_args = NULL,
+  libpaths = .libPaths(),
   as_job = getOption("quarto.render_as_job", "auto")
 ) {
   # get quarto binary
@@ -222,7 +227,7 @@ quarto_render <- function(
   }
 
   # run quarto
-  quarto_run(args, echo = TRUE, quarto_bin = quarto_bin)
+  quarto_run(args, echo = TRUE, quarto_bin = quarto_bin, libpaths = libpaths)
 
   # no return value
   invisible(NULL)

man/check_newer_version.Rd

@@ -2,5 +2,5 @@
 #' title: Purl Test Document
 #' format: html
 #' ---
-#' 
+#'
 

man/find_project_root.Rd

@@ -24,6 +24,7 @@ test_that("create quiete arg", {
 })
 
 test_that("quarto.quiet options takes over", {
+  withr::local_envvar(list(R_QUARTO_QUIET = NA))
   expect_identical(is_quiet(TRUE), TRUE)
   expect_identical(is_quiet(FALSE), FALSE)
   expect_identical(is_quiet(NA), FALSE)
@@ -63,6 +64,7 @@ test_that("R_QUARTO_QUIET options takes over", {
 })
 
 test_that("quarto.quiet options takes over R_QUARTO_QUIET", {
+  withr::local_envvar(list(R_QUARTO_QUIET = NA))
   withr::with_options(list(quarto.quiet = TRUE), {
     withr::with_envvar(list(R_QUARTO_QUIET = FALSE), {
       expect_identical(is_quiet(TRUE), TRUE)