Merge branch 'release/0.17.0'

Author: HenrikBengtsson

.github/workflows/revdepcheck-top.yaml

@@ -30,7 +30,7 @@ jobs:
           - { r: "release", pkg: "SimDesign"       }
 #          - { r: "release", pkg: "tidySEM"         }  ## fails to install
           - { r: "release", pkg: "tsdistributions" }
-          - { r: "release", pkg: "tsgarch"         }
+          - { r: "release", pkg: "tsgarch", sysdeps: "libcairo2-dev" }
 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
@@ -50,7 +50,7 @@ jobs:
 
       - name: Install system dependencies (Linux)
         if: runner.os == 'Linux'
-        run: sudo apt-get install -y tidy
+        run: sudo apt-get install -y tidy ${{ matrix.config.sysdeps }}
 
       - uses: r-lib/actions/setup-r@v2
         with:

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: progressr
-Version: 0.16.0
+Version: 0.17.0
 Title: An Inclusive, Unifying API for Progress Updates
 Description: A minimal, unifying API for scripts and packages to report progress updates from anywhere including when using parallel processing.  The package is designed such that the developer can to focus on what progress should be reported on without having to worry about how to present it.  The end user has full control of how, where, and when to render these progress updates, e.g. in the terminal using utils::txtProgressBar(), cli::cli_progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beepr::beep(), or on a file system via the size of a file. Anyone can add additional, customized, progression handlers. The 'progressr' package uses R's condition framework for signaling progress updated. Because of this, progress can be reported from almost anywhere in R, e.g. from classical for and while loops, from map-reduce API:s like the lapply() family of functions, 'purrr', 'plyr', and 'foreach'. It will also work with parallel processing via the 'future' framework, e.g. future.apply::future_lapply(), furrr::future_map(), and 'foreach' with 'doFuture'. The package is compatible with Shiny applications.
 Authors@R: c(person("Henrik", "Bengtsson",

NEWS.md

@@ -1,3 +1,22 @@
+# Version 0.17.0 [2025-10-15]
+
+## New Features
+
+ * Now also `with_progress()` warns about receiving progress updates
+   after the progressor has finished. Previously, only the global
+   'progression' handler would do this.
+ 
+## Bug Fixes
+
+ * Using `with_progress()` together with `handlers(global = TRUE)`
+   would produce a warning on "Received a progression 'update' request
+   (...) but is not listening to this progressor".
+
+ * Shiny apps running as background jobs in RStudio could fail with an
+   error "object 'RStudio.Version' of mode 'function' was not found".
+   This error occurred sporadically.
+   
+
 # Version 0.16.0 [2025-05-18]
 
 ## New Features

R/global_progression_handler.R

@@ -217,14 +217,7 @@ global_progression_handler <- local({
       }
     } else if (type == "update") {
       if (is.null(current_progressor_uuid)) {
-        ## We might receive zero-amount progress updates after the fact that the
-        ## progress has been completed
-        amount <- progression$amount
-        if (!is.numeric(amount) || amount > 0) {
-          msg <- conditionMessage(progression)
-          if (length(msg) == 0) msg <- "character(0)"
-          warning(sprintf("Received a progression %s request (amount=%g; msg=%s) but is not listening to this progressor. This can happen when code signals more progress updates than it configured the progressor to do. When the progressor completes all steps, it shuts down resulting in the global progression handler to no longer listen to it. To troubleshoot this, try with progressr::handlers(\"debug\")", sQuote(type), amount, sQuote(msg)))
-        }
+        warn_about_too_many_progressions(progression, global = TRUE)
         return()
       }
 
@@ -308,9 +301,9 @@ global_progression_handler <- local({
 
     ## Muffle it for now
     if (inherits(condition, "message")) {
-      invokeRestart("muffleMessage")
+      tryInvokeRestart("muffleMessage")
     } else if (inherits(condition, "warning")) {
-      invokeRestart("muffleWarning")
+      tryInvokeRestart("muffleWarning")
     } else if (inherits(condition, "condition")) {
       ## If there is a "muffle" restart for this condition,
       ## then invoke that restart, i.e. "muffle" the condition
@@ -319,7 +312,7 @@ global_progression_handler <- local({
         name <- restart$name
         if (is.null(name)) next
         if (!grepl("^muffle", name)) next
-        invokeRestart(restart)
+        tryInvokeRestart(restart)
         break
       }
     }

R/handler_cli.R

@@ -66,7 +66,7 @@ handler_cli <- function(show_after = 0.0, intrusiveness = getOption("progressr.i
           output <- gsub("[\n\r]+$", "", output)
         }
         cat(output, file = stderr())
-        invokeRestart("muffleMessage")
+        tryInvokeRestart("muffleMessage")
       })
 
       invisible(res)

R/handler_rpushbullet.R

@@ -125,10 +125,10 @@ is_rpushbullet_working <- local({
       })
     }, message = function(cond) {
        conds <<- c(conds, list(cond))
-       if (quiet) invokeRestart("muffleMessage")
+       if (quiet) tryInvokeRestart("muffleMessage")
     }, warning = function(cond) {
        conds <<- c(conds, list(cond))
-       if (quiet) invokeRestart("muffleWarning")
+       if (quiet) tryInvokeRestart("muffleWarning")
     })
 
     if (is.na(res)) res <- FALSE

R/make_calling_handler.R

@@ -6,7 +6,7 @@ make_calling_handler <- function(handlers) {
         handler <- handlers[[kk]]
         if (handler(p)) finished <- TRUE
       }
-      finished
+      invisible(finished)
     }
   } else {
     calling_handler <- handlers[[1]]

R/options.R

@@ -263,4 +263,8 @@ update_package_options <- function(debug = FALSE) {
 
   ## However, not used
   update_package_option("global.handler", mode = "logical", debug = debug)
+
+  ## For RStudio users
+  update_package_option("rstudio.patch", mode = "logical", debug = debug)
 }
+

R/progress_aggregator.R

@@ -41,8 +41,11 @@ progress_aggregator <- function(progress) {
       }
     }
 
-    ## Prevent upstream calling handlers to receive progression 'p'
-    invokeRestart("muffleProgression")
+    ## Prevent upstream calling handlers to receive progression 'p'.
+    ## Restart 'muffleProgression' is not guaranteed to exist, e.g. the
+    ## 'progression' condition might be resignaled by a handler that
+    ## does not define it.
+    tryInvokeRestart("muffleProgression")
   }
 
   handler <- make_progression_handler("progress_aggregator", handler = handler)

R/rstudio-console.R

@@ -2,12 +2,17 @@ get_rstudio_version <- local({
   .version <- NULL
   function() {
     if (is.null(.version)) {
-      if (!"tools:rstudio" %in% search()) {
-        .version <<- package_version("0.0")
-      } else {
+      .version <<- package_version("0.0")
+      if ("tools:rstudio" %in% search()) {
         envir <- as.environment("tools:rstudio")
-        RStudio.Version <- get("RStudio.Version", mode = "function", envir = envir, inherits = FALSE)
-        .version <<- RStudio.Version()[["version"]]
+        ## There are cases where 'tools:rstudio' exist, but there is no
+        ## RStudio.Version() function. See
+        ## https://github.com/futureverse/progressr/issues/183 for
+        ## an example. Not sure how that happens. /HB 2025-09-23
+        if (exists("RStudio.Version", mode = "function", envir = envir, inherits = FALSE)) {
+          RStudio.Version <- get("RStudio.Version", mode = "function", envir = envir, inherits = FALSE)
+          .version <<- RStudio.Version()[["version"]]
+        }
       }
     }
     .version