- change options to follow teal.lockfile. pattern

- lockfile logic only in the server

Author: dependabot-preview[bot]

R/module_teal_lockfile.R

@@ -7,9 +7,9 @@
 #'
 #' - User-specified:
 #'     - **Pre-computed lockfile**: Users can provide their own pre-computed lockfile by specifying the path via
-#'     `teal.renv.lockfile` option. Automatic lockfile computation is skipped in such case.
+#'     `teal.lockfile.path` option. Automatic lockfile computation is skipped in such case.
 #' - Automatically computed:
-#'     - **Working directory lockfile**: If `teal.renv.lockfile` is not set, `teal` will, by default, create an
+#'     - **Working directory lockfile**: If `teal.lockfile.path` is not set, `teal` will, by default, create an
 #'      `implicit` type lockfile that uses `renv::dependencies()` to detect all R packages in the current project's
 #'      working directory.
 #'     - **`DESCRIPTION`-based lockfile**: To generate a lockfile based on a `DESCRIPTION` file in your working
@@ -34,13 +34,6 @@ NULL
 
 #' @rdname module_teal_lockfile
 ui_teal_lockfile <- function(id) {
-  if (!isTRUE(getOption("teal.renv.enable"))) {
-    return(NULL)
-  } else if (!.is_lockfile_deps_installed()) {
-    warning("Lockfile feature disabled. `mirai` and `renv` packages must be installed.")
-    return(NULL)
-  }
-
   ns <- NS(id)
   shiny::tagList(
     tags$span("", id = ns("lockFileStatus")),
@@ -50,23 +43,43 @@ ui_teal_lockfile <- function(id) {
 
 #' @rdname module_teal_lockfile
 srv_teal_lockfile <- function(id) {
-  if (!isTRUE(getOption("teal.renv.enable")) || !.is_lockfile_deps_installed()) {
-    return(NULL)
-  }
   moduleServer(id, function(input, output, session) {
     logger::log_debug("Initialize srv_teal_lockfile.")
     enable_lockfile_download <- function() {
       shinyjs::html("lockFileStatus", "Application lockfile ready.")
       shinyjs::hide("lockFileStatus", anim = TRUE)
       shinyjs::enable("lockFileLink")
+      output$lockFileLink <- shiny::downloadHandler(
+        filename = function() {
+          "renv.lock"
+        },
+        content = function(file) {
+          file.copy(lockfile_path, file)
+          file
+        },
+        contentType = "application/json"
+      )
     }
     disable_lockfile_download <- function() {
       warning("Lockfile creation failed.", call. = FALSE)
       shinyjs::html("lockFileStatus", "Lockfile creation failed.")
       shinyjs::disable("lockFileLink")
     }
 
+    is_lockfile_enabled <- isTRUE(getOption("teal.lockfile.enable"))
+    user_lockfile <- getOption("teal.lockfile.path", "")
     lockfile_path <- "teal_app.lock"
+
+    if (!is_lockfile_enabled) {
+      logger::log_debug("'teal.lockfile.enable' option is set to false. Hiding a lockfile download button.")
+      shinyjs::hide("lockFileLink")
+      return(NULL)
+    } else if (identical(user_lockfile, "") && !.is_lockfile_deps_installed()) {
+      warning("Automatic lockfile creation disabled. `mirai` and `renv` packages must be installed.")
+      shinyjs::hide("lockFileLink")
+      return(NULL)
+    }
+
     shiny::onStop(function() {
       if (file.exists(lockfile_path) && !shiny::isRunning()) {
         logger::log_debug("Removing lockfile after shutting down the app")
@@ -81,16 +94,15 @@ srv_teal_lockfile <- function(id) {
       return(NULL)
     }
 
+
     # don't run renv::snapshot when option is set
-    user_lockfile <- getOption("teal.renv.lockfile", "")
     if (!identical(user_lockfile, "")) {
       if (file.exists(user_lockfile)) {
         file.copy(user_lockfile, lockfile_path)
-        logger::log_debug('Lockfile set using option "teal.renv.lockfile" - skipping automatic creation.')
+        logger::log_debug('Lockfile set using option "teal.lockfile.path" - skipping automatic creation.')
         enable_lockfile_download()
-        return(NULL)
       } else {
-        warning("Lockfile provided through options('teal.renv.lockfile') does not exist.", call. = FALSE)
+        warning("Lockfile provided through options('teal.lockfile.path') does not exist.", call. = FALSE)
       }
     }
 
@@ -120,17 +132,6 @@ srv_teal_lockfile <- function(id) {
       }
     })
 
-    output$lockFileLink <- shiny::downloadHandler(
-      filename = function() {
-        "renv.lock"
-      },
-      content = function(file) {
-        file.copy(lockfile_path, file)
-        file
-      },
-      contentType = "application/json"
-    )
-
     NULL
   })
 }

R/zzz.R

@@ -2,9 +2,7 @@
   # adapted from https://github.com/r-lib/devtools/blob/master/R/zzz.R
   teal_default_options <- list(
     teal.show_js_log = FALSE,
-    # todo: make below teal.renv.enable = FALSE during run_examples, test_package, r cmd check
-    #       run_examples probably doesn't set any sysvars but maybe detecting run_examples in sys.calls() helps
-    teal.renv.enable = TRUE,
+    teal.lockfile.enable = TRUE,
     shiny.sanitize.errors = FALSE
   )
 

man/module_teal_lockfile.Rd

@@ -1,7 +1,7 @@
 withr::local_options(
   # we should't run lockfile process multiple times in tests as it starts background process which is not
   # possible to kill once run. It means that background R sessions are being cumulated
-  list(teal.renv.enable = FALSE),
+  list(teal.lockfile.enable = FALSE),
   .local_envir = testthat::teardown_env()
 )
 
@@ -14,7 +14,7 @@ opts_partial_match_old <- list(
   warnPartialMatchAttr = getOption("warnPartialMatchAttr")
 )
 opts_partial_match_new <- list(
-  teal.renv.enable = FALSE,
+  teal.lockfile.enable = FALSE,
   warnPartialMatchDollar = TRUE,
   warnPartialMatchArgs = TRUE,
   warnPartialMatchAttr = TRUE

tests/testthat/setup-options.R

@@ -68,7 +68,7 @@ transform_list <<- list(
 testthat::describe("srv_teal lockfile", {
   testthat::it("creation process is invoked and snapshot is copied to teal_app.lock and removed after session ended", {
     withr::with_options(
-      list(teal.renv.enable = TRUE),
+      list(teal.lockfile.enable = TRUE),
       {
         renv_filename <- "teal_app.lock"
         shiny::testServer(
@@ -91,13 +91,13 @@ testthat::describe("srv_teal lockfile", {
       }
     )
   })
-  testthat::it("is copied from option-teal.renv.lockfile and then removed from an app directory", {
+  testthat::it("is copied from option-teal.lockfile.path and then removed from an app directory", {
     temp_lockfile_mock <- tempfile()
     writeLines("test", temp_lockfile_mock)
     withr::with_options(
       list(
-        teal.renv.enable = TRUE,
-        teal.renv.lockfile = temp_lockfile_mock
+        teal.lockfile.enable = TRUE,
+        teal.lockfile.path = temp_lockfile_mock
       ),
       {
         renv_filename <- "teal_app.lock"

tests/testthat/test-module_teal.R

@@ -84,10 +84,16 @@ This indicates whether to print the `JavaScript` console logs to the `R` console
 
 Default: `FALSE`.
 
-### `teal.renv.lockfile` (`character`)
+### `teal.lockfile.enable` (`logical`)
 
-The path to the pre-computed `renv` lockfile that will be shared through teal app. To read more about lockfile usage creation check `?teal::teal_lockfile`.
+This enables app users to download `renv` lockfile by clicking "download lockfile" in the footer. If 
+`teal.lockfile.path` is not specified then lockfile is created automatically by `teal`. To read more about 
+lockfile usage creation check `?teal::teal_lockfile`.
 
+### `teal.lockfile.path` (`character`)
+
+The path to the pre-computed `renv` lockfile linked by app developer. Lockfile will be available to download if 
+`teal.lockfile.enable` is set to `TRUE`.
 
 # Deprecated options