implement 'transactional' for install (#1109)

rstudio · Mar 5, 2025 · 78c8620 · 78c8620
1 parent 2d0b9fc
commit 78c8620
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 12 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,10 @@
 
 # renv (development version)
 
+* `renv::install()` gains the `transactional` argument, for parity with
+  `renv::restore()`. (#1109)
+
+
 # renv 1.1.2
 
 * `renv` gains the `sysreqs()` function, which can be used to query the system

diff --git a/R/install.R b/R/install.R
@@ -57,6 +57,11 @@ the$install_step_width <- 48L
 #'   will be used. When `FALSE`, installation output will be emitted only if
 #'   a package fails to install.
 #'
+#' @param transactional Whether or not to use a 'transactional' package
+#'   installation. See **Transactional Restore** in [renv::restore()] for
+#'   more details. When `NULL` (the default), the value of the
+#'   `install.transactional` [`config`] option will be used.
+#'
 #' @param lock Boolean; update the `renv.lock` lockfile after the successful
 #'   installation of the requested packages?
 #'
@@ -92,17 +97,18 @@ the$install_step_width <- 48L
 #' }
 install <- function(packages = NULL,
                     ...,
-                    include      = NULL,
-                    exclude      = NULL,
-                    library      = NULL,
-                    type         = NULL,
-                    rebuild      = FALSE,
-                    repos        = NULL,
-                    prompt       = interactive(),
-                    dependencies = NULL,
-                    verbose      = NULL,
-                    lock         = FALSE,
-                    project      = NULL)
+                    include       = NULL,
+                    exclude       = NULL,
+                    library       = NULL,
+                    type          = NULL,
+                    rebuild       = FALSE,
+                    repos         = NULL,
+                    prompt        = interactive(),
+                    dependencies  = NULL,
+                    verbose       = NULL,
+                    transactional = NULL,
+                    lock          = FALSE,
+                    project       = NULL)
 {
   renv_consent_check()
   renv_scope_error_handler()
@@ -128,6 +134,10 @@ install <- function(packages = NULL,
   verbose <- verbose %||% config$install.verbose()
   renv_scope_options(renv.config.install.verbose = verbose)
 
+  # handle 'transactional'
+  transactional <- transactional %||% config$install.transactional()
+  renv_scope_options(renv.config.install.transactional = transactional)
+
   # set up library paths
   libpaths <- renv_libpaths_resolve(library)
   renv_scope_libpaths(libpaths)

diff --git a/man/install.Rd b/man/install.Rd
diff --git a/tests/testthat/helper-setup.R b/tests/testthat/helper-setup.R
@@ -181,7 +181,7 @@ renv_tests_setup_repos <- function(scope = parent.frame()) {
 
   # update the local packrat package version to match what's available
   version <- tryCatch(
-    renv_package_version("packrat"),
+    renv_package_version("packrat") %||% "0.9.2",
     error = function(cnd) "0.9.2"
   )