402 lines
11 KiB
R
402 lines
11 KiB
R
|
|
local({
|
|
|
|
# the requested version of renv
|
|
version <- "0.12.3"
|
|
|
|
# the project directory
|
|
project <- getwd()
|
|
|
|
# avoid recursion
|
|
if (!is.na(Sys.getenv("RENV_R_INITIALIZING", unset = NA)))
|
|
return(invisible(TRUE))
|
|
|
|
# signal that we're loading renv during R startup
|
|
Sys.setenv("RENV_R_INITIALIZING" = "true")
|
|
on.exit(Sys.unsetenv("RENV_R_INITIALIZING"), add = TRUE)
|
|
Sys.setenv("TZDIR" = file.path(R.home(), "share", "zoneinfo"))
|
|
|
|
# signal that we've consented to use renv
|
|
options(renv.consent = TRUE)
|
|
|
|
# load the 'utils' package eagerly -- this ensures that renv shims, which
|
|
# mask 'utils' packages, will come first on the search path
|
|
library(utils, lib.loc = .Library)
|
|
|
|
# check to see if renv has already been loaded
|
|
if ("renv" %in% loadedNamespaces()) {
|
|
|
|
# if renv has already been loaded, and it's the requested version of renv,
|
|
# nothing to do
|
|
spec <- .getNamespaceInfo(.getNamespace("renv"), "spec")
|
|
if (identical(spec[["version"]], version))
|
|
return(invisible(TRUE))
|
|
|
|
# otherwise, unload and attempt to load the correct version of renv
|
|
unloadNamespace("renv")
|
|
|
|
}
|
|
|
|
# load bootstrap tools
|
|
bootstrap <- function(version, library) {
|
|
|
|
# read repos (respecting override if set)
|
|
repos <- Sys.getenv("RENV_CONFIG_REPOS_OVERRIDE", unset = NA)
|
|
if (is.na(repos))
|
|
repos <- getOption("repos")
|
|
|
|
# fix up repos
|
|
on.exit(options(repos = repos), add = TRUE)
|
|
repos[repos == "@CRAN@"] <- "https://cloud.r-project.org"
|
|
options(repos = repos)
|
|
|
|
# attempt to download renv
|
|
tarball <- tryCatch(renv_bootstrap_download(version), error = identity)
|
|
if (inherits(tarball, "error"))
|
|
stop("failed to download renv ", version)
|
|
|
|
# now attempt to install
|
|
status <- tryCatch(renv_bootstrap_install(version, tarball, library), error = identity)
|
|
if (inherits(status, "error"))
|
|
stop("failed to install renv ", version)
|
|
|
|
}
|
|
|
|
renv_bootstrap_download_impl <- function(url, destfile) {
|
|
|
|
mode <- "wb"
|
|
|
|
# https://bugs.r-project.org/bugzilla/show_bug.cgi?id=17715
|
|
fixup <-
|
|
Sys.info()[["sysname"]] == "Windows" &&
|
|
substring(url, 1L, 5L) == "file:"
|
|
|
|
if (fixup)
|
|
mode <- "w+b"
|
|
|
|
download.file(
|
|
url = url,
|
|
destfile = destfile,
|
|
mode = mode,
|
|
quiet = TRUE
|
|
)
|
|
|
|
}
|
|
|
|
renv_bootstrap_download <- function(version) {
|
|
|
|
# if the renv version number has 4 components, assume it must
|
|
# be retrieved via github
|
|
nv <- numeric_version(version)
|
|
components <- unclass(nv)[[1]]
|
|
|
|
methods <- if (length(components) == 4L) {
|
|
list(renv_bootstrap_download_github)
|
|
} else {
|
|
list(
|
|
renv_bootstrap_download_cran_latest,
|
|
renv_bootstrap_download_cran_archive
|
|
)
|
|
}
|
|
|
|
for (method in methods) {
|
|
path <- tryCatch(method(version), error = identity)
|
|
if (is.character(path) && file.exists(path))
|
|
return(path)
|
|
}
|
|
|
|
stop("failed to download renv ", version)
|
|
|
|
}
|
|
|
|
renv_bootstrap_download_cran_latest <- function(version) {
|
|
|
|
repos <- renv_bootstrap_download_cran_latest_find(version)
|
|
|
|
message("* Downloading renv ", version, " from CRAN ... ", appendLF = FALSE)
|
|
|
|
info <- tryCatch(
|
|
download.packages("renv", repos = repos, destdir = tempdir(), quiet = TRUE),
|
|
condition = identity
|
|
)
|
|
|
|
if (inherits(info, "condition")) {
|
|
message("FAILED")
|
|
return(FALSE)
|
|
}
|
|
|
|
message("OK")
|
|
info[1, 2]
|
|
|
|
}
|
|
|
|
renv_bootstrap_download_cran_latest_find <- function(version) {
|
|
|
|
# check for renv on CRAN matching this version
|
|
all <- unique(c(
|
|
getOption("repos"),
|
|
getOption("renv.bootstrap.repos", default = "https://cloud.r-project.org")
|
|
))
|
|
|
|
for (repos in all) {
|
|
|
|
db <- tryCatch(
|
|
as.data.frame(available.packages(repos = repos), stringsAsFactors = FALSE),
|
|
error = identity
|
|
)
|
|
|
|
if (inherits(db, "error"))
|
|
next
|
|
|
|
entry <- db[db$Package %in% "renv" & db$Version %in% version, ]
|
|
if (nrow(entry) == 0)
|
|
next
|
|
|
|
return(repos)
|
|
|
|
}
|
|
|
|
fmt <- "renv %s is not available from your declared package repositories"
|
|
stop(sprintf(fmt, version))
|
|
|
|
}
|
|
|
|
renv_bootstrap_download_cran_archive <- function(version) {
|
|
|
|
name <- sprintf("renv_%s.tar.gz", version)
|
|
repos <- getOption("repos")
|
|
urls <- file.path(repos, "src/contrib/Archive/renv", name)
|
|
destfile <- file.path(tempdir(), name)
|
|
|
|
message("* Downloading renv ", version, " from CRAN archive ... ", appendLF = FALSE)
|
|
|
|
for (url in urls) {
|
|
|
|
status <- tryCatch(
|
|
renv_bootstrap_download_impl(url, destfile),
|
|
condition = identity
|
|
)
|
|
|
|
if (identical(status, 0L)) {
|
|
message("OK")
|
|
return(destfile)
|
|
}
|
|
|
|
}
|
|
|
|
message("FAILED")
|
|
return(FALSE)
|
|
|
|
}
|
|
|
|
renv_bootstrap_download_github <- function(version) {
|
|
|
|
enabled <- Sys.getenv("RENV_BOOTSTRAP_FROM_GITHUB", unset = "TRUE")
|
|
if (!identical(enabled, "TRUE"))
|
|
return(FALSE)
|
|
|
|
# prepare download options
|
|
pat <- Sys.getenv("GITHUB_PAT")
|
|
if (nzchar(Sys.which("curl")) && nzchar(pat)) {
|
|
fmt <- "--location --fail --header \"Authorization: token %s\""
|
|
extra <- sprintf(fmt, pat)
|
|
saved <- options("download.file.method", "download.file.extra")
|
|
options(download.file.method = "curl", download.file.extra = extra)
|
|
on.exit(do.call(base::options, saved), add = TRUE)
|
|
} else if (nzchar(Sys.which("wget")) && nzchar(pat)) {
|
|
fmt <- "--header=\"Authorization: token %s\""
|
|
extra <- sprintf(fmt, pat)
|
|
saved <- options("download.file.method", "download.file.extra")
|
|
options(download.file.method = "wget", download.file.extra = extra)
|
|
on.exit(do.call(base::options, saved), add = TRUE)
|
|
}
|
|
|
|
message("* Downloading renv ", version, " from GitHub ... ", appendLF = FALSE)
|
|
|
|
url <- file.path("https://api.github.com/repos/rstudio/renv/tarball", version)
|
|
name <- sprintf("renv_%s.tar.gz", version)
|
|
destfile <- file.path(tempdir(), name)
|
|
|
|
status <- tryCatch(
|
|
renv_bootstrap_download_impl(url, destfile),
|
|
condition = identity
|
|
)
|
|
|
|
if (!identical(status, 0L)) {
|
|
message("FAILED")
|
|
return(FALSE)
|
|
}
|
|
|
|
message("Done!")
|
|
return(destfile)
|
|
|
|
}
|
|
|
|
renv_bootstrap_install <- function(version, tarball, library) {
|
|
|
|
# attempt to install it into project library
|
|
message("* Installing renv ", version, " ... ", appendLF = FALSE)
|
|
dir.create(library, showWarnings = FALSE, recursive = TRUE)
|
|
|
|
# invoke using system2 so we can capture and report output
|
|
bin <- R.home("bin")
|
|
exe <- if (Sys.info()[["sysname"]] == "Windows") "R.exe" else "R"
|
|
r <- file.path(bin, exe)
|
|
args <- c("--vanilla", "CMD", "INSTALL", "-l", shQuote(library), shQuote(tarball))
|
|
output <- system2(r, args, stdout = TRUE, stderr = TRUE)
|
|
message("Done!")
|
|
|
|
# check for successful install
|
|
status <- attr(output, "status")
|
|
if (is.numeric(status) && !identical(status, 0L)) {
|
|
header <- "Error installing renv:"
|
|
lines <- paste(rep.int("=", nchar(header)), collapse = "")
|
|
text <- c(header, lines, output)
|
|
writeLines(text, con = stderr())
|
|
}
|
|
|
|
status
|
|
|
|
}
|
|
|
|
renv_bootstrap_prefix <- function() {
|
|
|
|
# construct version prefix
|
|
version <- paste(R.version$major, R.version$minor, sep = ".")
|
|
prefix <- paste("R", numeric_version(version)[1, 1:2], sep = "-")
|
|
|
|
# include SVN revision for development versions of R
|
|
# (to avoid sharing platform-specific artefacts with released versions of R)
|
|
devel <-
|
|
identical(R.version[["status"]], "Under development (unstable)") ||
|
|
identical(R.version[["nickname"]], "Unsuffered Consequences")
|
|
|
|
if (devel)
|
|
prefix <- paste(prefix, R.version[["svn rev"]], sep = "-r")
|
|
|
|
# build list of path components
|
|
components <- c(prefix, R.version$platform)
|
|
|
|
# include prefix if provided by user
|
|
prefix <- Sys.getenv("RENV_PATHS_PREFIX")
|
|
if (nzchar(prefix))
|
|
components <- c(prefix, components)
|
|
|
|
# build prefix
|
|
paste(components, collapse = "/")
|
|
|
|
}
|
|
|
|
renv_bootstrap_library_root <- function(project) {
|
|
|
|
path <- Sys.getenv("RENV_PATHS_LIBRARY", unset = NA)
|
|
if (!is.na(path))
|
|
return(path)
|
|
|
|
path <- Sys.getenv("RENV_PATHS_LIBRARY_ROOT", unset = NA)
|
|
if (!is.na(path)) {
|
|
id <- substring(renv_bootstrap_hash_text(project), 1L, 8L)
|
|
name <- paste(basename(project), id, sep = "-")
|
|
return(file.path(path, name))
|
|
}
|
|
|
|
file.path(project, "renv/library")
|
|
|
|
}
|
|
|
|
renv_bootstrap_validate_version <- function(version) {
|
|
|
|
loadedversion <- utils::packageDescription("renv", fields = "Version")
|
|
if (version == loadedversion)
|
|
return(TRUE)
|
|
|
|
# assume four-component versions are from GitHub; three-component
|
|
# versions are from CRAN
|
|
components <- strsplit(loadedversion, "[.-]")[[1]]
|
|
remote <- if (length(components) == 4L)
|
|
paste("rstudio/renv", loadedversion, sep = "@")
|
|
else
|
|
paste("renv", loadedversion, sep = "@")
|
|
|
|
fmt <- paste(
|
|
"renv %1$s was loaded from project library, but this project is configured to use renv %2$s.",
|
|
"Use `renv::record(\"%3$s\")` to record renv %1$s in the lockfile.",
|
|
"Use `renv::restore(packages = \"renv\")` to install renv %2$s into the project library.",
|
|
sep = "\n"
|
|
)
|
|
|
|
msg <- sprintf(fmt, loadedversion, version, remote)
|
|
warning(msg, call. = FALSE)
|
|
|
|
FALSE
|
|
|
|
}
|
|
|
|
renv_bootstrap_hash_text <- function(text) {
|
|
|
|
hashfile <- tempfile("renv-hash-")
|
|
on.exit(unlink(hashfile), add = TRUE)
|
|
|
|
writeLines(text, con = hashfile)
|
|
tools::md5sum(hashfile)
|
|
|
|
}
|
|
|
|
renv_bootstrap_load <- function(project, libpath, version) {
|
|
|
|
# try to load renv from the project library
|
|
if (!requireNamespace("renv", lib.loc = libpath, quietly = TRUE))
|
|
return(FALSE)
|
|
|
|
# warn if the version of renv loaded does not match
|
|
renv_bootstrap_validate_version(version)
|
|
|
|
# load the project
|
|
renv::load(project)
|
|
|
|
TRUE
|
|
|
|
}
|
|
|
|
# construct path to library root
|
|
root <- renv_bootstrap_library_root(project)
|
|
|
|
# construct library prefix for platform
|
|
prefix <- renv_bootstrap_prefix()
|
|
|
|
# construct full libpath
|
|
libpath <- file.path(root, prefix)
|
|
|
|
# attempt to load
|
|
if (renv_bootstrap_load(project, libpath, version))
|
|
return(TRUE)
|
|
|
|
# load failed; inform user we're about to bootstrap
|
|
prefix <- paste("# Bootstrapping renv", version)
|
|
postfix <- paste(rep.int("-", 77L - nchar(prefix)), collapse = "")
|
|
header <- paste(prefix, postfix)
|
|
message(header)
|
|
|
|
# perform bootstrap
|
|
bootstrap(version, libpath)
|
|
|
|
# exit early if we're just testing bootstrap
|
|
if (!is.na(Sys.getenv("RENV_BOOTSTRAP_INSTALL_ONLY", unset = NA)))
|
|
return(TRUE)
|
|
|
|
# try again to load
|
|
if (requireNamespace("renv", lib.loc = libpath, quietly = TRUE)) {
|
|
message("* Successfully installed and loaded renv ", version, ".")
|
|
return(renv::load())
|
|
}
|
|
|
|
# failed to download or load renv; warn the user
|
|
msg <- c(
|
|
"Failed to find an renv installation: the project will not be loaded.",
|
|
"Use `renv::activate()` to re-initialize the project."
|
|
)
|
|
|
|
warning(paste(msg, collapse = "\n"), call. = FALSE)
|
|
|
|
})
|