Retire 'envir', but keep it temporarily bc civis::CivisFuture needs it

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future
-Version: 1.68.0-9009
+Version: 1.68.0-9031
 Title: Unified Parallel and Distributed Processing in R for Everyone
 Depends:
     R (>= 3.2.0)

R/backend_api-Future-class.R

@@ -228,6 +228,17 @@ Future <- function(expr = NULL, envir = parent.frame(), substitute = TRUE, stdou
   ## Additional named arguments
   for (key in args_names) core[[key]] <- args[[key]]
 
+  ## Backward compatibility: drop field 'envir' in future (> 1.68.0)
+  ## 1. civis::CivisFuture() relies on 'envir'
+  ## 2. there might be other unknown dependencies out there => option
+  if (getOption("future.Future.envir.keep", FALSE)) {
+    core[["envir"]] <- envir
+  } else if (all(c("required_resources", "docker_image_name",
+    "docker_image_tag") %in% args_names) && "civis" %in% loadedNamespaces()) {
+    ## Looks like Future() was called from CivisFuture
+    core[["envir"]] <- envir
+  }
+  
   structure(core, class = c("Future", class(core)))
 }
 
@@ -591,6 +602,7 @@ run.Future <- function(future, ...) {
   args <- list(
     quote(future[["expr"]]),
     substitute = FALSE,
+    envir = future[["envir"]],   ## For backward compatibility with 'civis'
     lazy = TRUE,
     stdout = future[["stdout"]],
     conditions = future[["conditions"]],

R/utils-options.R

@@ -471,4 +471,5 @@ update_package_options <- function(debug = FALSE) {
   update_package_option("future.future.gc", mode = "character", debug = debug)
   update_package_option("future.future.local", mode = "character", debug = debug)
   update_package_option("future.plan.earlySignal", mode = "character", debug = debug)
+  update_package_option("future.Future.envir.keep", mode = "logical", debug = debug)
 }