garbage collection integer

Author: wlandau

NEWS.md

@@ -1,9 +1,10 @@
-# targets 1.8.0.9003 (development)
+# targets 1.8.0.9004 (development)
 
 * Un-break workflows that use `format = "file_fast"` (#1339, @koefoeden).
 * Fix deadlock in `error = "trim"` (#1340, @koefoeden).
 * Remove tailored debugging message (#1341, @koefoeden).
 * Store warnings while writing to storage (#1345, @Aariq).
+* Deprecate the `garbage_collection` argument of `tar_make()`, `tar_make_future()`, and `tar_make_clusterm()` (#1351).
 
 # targets 1.8.0
 

R/class_active.R

@@ -8,7 +8,6 @@ active_new <- function(
   seconds_meta_append = NULL,
   seconds_meta_upload = NULL,
   seconds_reporter = NULL,
-  garbage_collection = NULL,
   envir = NULL
 ) {
   active_class$new(
@@ -21,7 +20,6 @@ active_new <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir
   )
 }
@@ -32,7 +30,6 @@ active_class <- R6::R6Class(
   portable = FALSE,
   cloneable = FALSE,
   public = list(
-    garbage_collection = NULL,
     envir = NULL,
     exports = NULL,
     process = NULL,
@@ -49,8 +46,7 @@ active_class <- R6::R6Class(
       seconds_meta_append = NULL,
       seconds_meta_upload = NULL,
       seconds_reporter = NULL,
-      envir = NULL,
-      garbage_collection = NULL
+      envir = NULL
     ) {
       super$initialize(
         pipeline = pipeline,
@@ -63,7 +59,6 @@ active_class <- R6::R6Class(
         seconds_meta_upload = seconds_meta_upload,
         seconds_reporter = seconds_reporter
       )
-      self$garbage_collection <- garbage_collection
       self$envir <- envir
     },
     ensure_meta = function() {
@@ -229,9 +224,6 @@ active_class <- R6::R6Class(
       if (!is.null(self$process)) {
         self$process$validate()
       }
-      tar_assert_lgl(self$garbage_collection)
-      tar_assert_scalar(self$garbage_collection)
-      tar_assert_none_na(self$garbage_collection)
     }
   )
 )

R/class_clustermq.R

@@ -8,7 +8,6 @@ clustermq_init <- function(
   seconds_meta_append = 0,
   seconds_meta_upload = 15,
   seconds_reporter = 0,
-  garbage_collection = FALSE,
   envir = tar_option_get("envir"),
   workers = 1L,
   log_worker = FALSE
@@ -23,7 +22,6 @@ clustermq_init <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir,
     workers = as.integer(workers),
     log_worker = log_worker
@@ -40,7 +38,6 @@ clustermq_new <- function(
   seconds_meta_append = NULL,
   seconds_meta_upload = NULL,
   seconds_reporter = NULL,
-  garbage_collection = NULL,
   envir = NULL,
   workers = NULL,
   log_worker = NULL
@@ -55,7 +52,6 @@ clustermq_new <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir,
     workers = workers,
     log_worker = log_worker
@@ -81,7 +77,6 @@ clustermq_class <- R6::R6Class(
       seconds_meta_append = NULL,
       seconds_meta_upload = NULL,
       seconds_reporter = NULL,
-      garbage_collection = NULL,
       envir = NULL,
       workers = NULL,
       log_worker = NULL
@@ -96,7 +91,6 @@ clustermq_class <- R6::R6Class(
         seconds_meta_append = seconds_meta_append,
         seconds_meta_upload = seconds_meta_upload,
         seconds_reporter = seconds_reporter,
-        garbage_collection = garbage_collection,
         envir = envir
       )
       self$workers <- as.integer(workers)
@@ -130,9 +124,6 @@ clustermq_class <- R6::R6Class(
     },
     run_worker = function(target) {
       builder_marshal_subpipeline(target)
-      if (self$garbage_collection) {
-        gc()
-      }
       self$worker_list$send(
         cmd = targets::target_run_worker(
           target = target,
@@ -247,7 +238,6 @@ clustermq_class <- R6::R6Class(
         names = self$names,
         queue = self$queue,
         reporter = self$reporter,
-        garbage_collection = self$garbage_collection,
         seconds_meta_append = self$seconds_meta_append,
         seconds_meta_upload = self$seconds_meta_upload,
         seconds_reporter = self$seconds_reporter,

R/class_crew.R

@@ -8,7 +8,6 @@ crew_init <- function(
   seconds_meta_append = 0,
   seconds_meta_upload = 15,
   seconds_reporter = 0,
-  garbage_collection = FALSE,
   envir = tar_option_get("envir"),
   controller = NULL,
   terminate_controller = TRUE
@@ -23,7 +22,6 @@ crew_init <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir,
     controller = controller,
     terminate_controller = terminate_controller
@@ -40,7 +38,6 @@ crew_new <- function(
   seconds_meta_append = NULL,
   seconds_meta_upload = NULL,
   seconds_reporter = NULL,
-  garbage_collection = NULL,
   envir = NULL,
   controller = NULL,
   terminate_controller = NULL
@@ -55,7 +52,6 @@ crew_new <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir,
     controller = controller,
     terminate_controller = terminate_controller
@@ -80,7 +76,6 @@ crew_class <- R6::R6Class(
       seconds_meta_append = NULL,
       seconds_meta_upload = NULL,
       seconds_reporter = NULL,
-      garbage_collection = NULL,
       envir = NULL,
       controller = NULL,
       terminate_controller = NULL
@@ -95,7 +90,6 @@ crew_class <- R6::R6Class(
         seconds_meta_append = seconds_meta_append,
         seconds_meta_upload = seconds_meta_upload,
         seconds_reporter = seconds_reporter,
-        garbage_collection = garbage_collection,
         envir = envir
       )
       self$controller <- controller
@@ -136,9 +130,6 @@ crew_class <- R6::R6Class(
         return()
       }
       # nocov end
-      if (self$garbage_collection) {
-        gc()
-      }
       self$ensure_exports()
       command <- quote(
         targets::target_run_worker(
@@ -262,7 +253,6 @@ crew_class <- R6::R6Class(
         names = self$names,
         queue = self$queue,
         reporter = self$reporter,
-        garbage_collection = self$garbage_collection,
         seconds_meta_append = self$seconds_meta_append,
         seconds_meta_upload = self$seconds_meta_upload,
         seconds_reporter = self$seconds_reporter,

R/class_local.R

@@ -20,7 +20,6 @@ local_init <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = FALSE,
     envir = envir
   )
 }
@@ -35,7 +34,6 @@ local_new <- function(
   seconds_meta_append = NULL,
   seconds_meta_upload = NULL,
   seconds_reporter = NULL,
-  garbage_collection = NULL,
   envir = NULL
 ) {
   local_class$new(
@@ -48,7 +46,6 @@ local_new <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir
   )
 }

R/class_options.R

@@ -317,7 +317,7 @@ options_class <- R6::R6Class(
       self$memory %|||% "persistent"
     },
     get_garbage_collection = function() {
-      self$garbage_collection %|||% FALSE
+      self$garbage_collection %|||% 0L
     },
     get_deployment = function() {
       self$deployment %|||% "worker"
@@ -407,7 +407,7 @@ options_class <- R6::R6Class(
     },
     set_garbage_collection = function(garbage_collection) {
       self$validate_garbage_collection(garbage_collection)
-      self$garbage_collection <- garbage_collection
+      self$garbage_collection <- as.integer(garbage_collection)
     },
     set_deployment = function(deployment) {
       self$validate_deployment(deployment)
@@ -523,8 +523,10 @@ options_class <- R6::R6Class(
       tar_assert_flag(memory, c("persistent", "transient"))
     },
     validate_garbage_collection = function(garbage_collection) {
-      tar_assert_lgl(garbage_collection)
+      tar_assert_dbl(garbage_collection)
       tar_assert_scalar(garbage_collection)
+      tar_assert_none_na(garbage_collection)
+      tar_assert_ge(garbage_collection, 0L)
     },
     validate_deployment = function(deployment) {
       tar_assert_flag(deployment, c("worker", "main"))

R/class_prelocal.R

@@ -7,7 +7,6 @@ prelocal_new <- function(
   seconds_meta_append = NULL,
   seconds_meta_upload = NULL,
   seconds_reporter = NULL,
-  garbage_collection = NULL,
   envir = NULL,
   scheduler = NULL
 ) {
@@ -20,7 +19,6 @@ prelocal_new <- function(
     seconds_meta_append = seconds_meta_append,
     seconds_meta_upload = seconds_meta_upload,
     seconds_reporter = seconds_reporter,
-    garbage_collection = garbage_collection,
     envir = envir,
     scheduler = scheduler
   )
@@ -41,7 +39,6 @@ prelocal_class <- R6::R6Class(
       seconds_meta_append = NULL,
       seconds_meta_upload = NULL,
       seconds_reporter = NULL,
-      garbage_collection = NULL,
       envir = NULL,
       scheduler = NULL
     ) {
@@ -54,7 +51,6 @@ prelocal_class <- R6::R6Class(
         seconds_meta_append = seconds_meta_append,
         seconds_meta_upload = seconds_meta_upload,
         seconds_reporter = seconds_reporter,
-        garbage_collection = garbage_collection,
         envir = envir
       )
       self$scheduler <- scheduler

R/tar_config_get.R

@@ -87,7 +87,7 @@ tar_config_get_project <- function(name, yaml) {
     name,
     inherits = yaml$inherits,
     as_job = yaml$as_job %|||% FALSE,
-    garbage_collection = yaml$garbage_collection %|||% FALSE,
+    garbage_collection = yaml$garbage_collection,
     label = yaml$label %|||% "description",
     label_width = yaml$label_width %|||% 30L,
     level_separation = yaml$level_separation,
@@ -110,7 +110,7 @@ tar_config_get_convert <- function(name, value) {
     name,
     inherits = if_any(is.null(value), NULL, as.character(value)),
     as_job = as.logical(value),
-    garbage_collection = as.logical(value),
+    garbage_collection = if_any(is.null(value), NULL, as.logical(value)),
     label = as.character(value),
     label_width = if_any(is.null(value), NULL, as.integer(value)),
     level_separation = if_any(is.null(value), NULL, as.numeric(value)),

R/tar_config_set.R

@@ -42,15 +42,11 @@
 #'   `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.
-#' @param garbage_collection Logical of length 1, `garbage_collection`
-#'   argument of [tar_make()] (if `crew` is enabled),
-#'   [tar_make_clustermq()], and [tar_make_future()].
-#'   Whether to run garbage collection on the main process
-#'   before sending a target
-#'   to a worker. For [tar_make()], this argument is
-#'   ignored if `tar_option_get("controller")` is `NULL`.
-#'   Independent from the `garbage_collection` argument of [tar_target()],
-#'   which controls garbage collection on the worker.
+#' @param garbage_collection Deprecated. Use the `garbage_collection`
+#'   argument of [tar_option_set()] instead to run garbage collection
+#'   at regular intervals in a pipeline, or use the argument of the same
+#'   name in [tar_target()] to activate garbage collection for
+#'   a specific target.
 #' @param label Argument of [tar_glimpse()] and [tar_visnetwork()]
 #'   to control node labels.
 #' @param label_width Argument of [tar_glimpse()] and [tar_visnetwork()]
@@ -274,6 +270,12 @@ tar_config_assert_garbage_collection <- function(garbage_collection) {
   if (is.null(garbage_collection)) {
     return()
   }
+  tar_warn_deprecate(
+    "The garbage_collection argument of tar_config_set() was deprecated ",
+    "in version 1.8.0.9004 (2024-10-22). The garbage_collection ",
+    "argument of tar_option_set() is more unified and featureful now. ",
+    "Please have a look at its documentation."
+  )
   tar_assert_lgl(garbage_collection)
   tar_assert_scalar(garbage_collection)
   tar_assert_none_na(garbage_collection)