From cbe9062fd73e61992b46035e7ac2241cd8de2541 Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Mon, 28 Oct 2024 10:33:23 -0700 Subject: [PATCH 1/3] fix #36 bump timeout to 20 sec --- DESCRIPTION | 2 +- R/onLoad.R | 2 +- R/status.R | 2 +- R/timeout.R | 4 ++-- man/proof_authenticate.Rd | 2 +- man/proof_cancel.Rd | 2 +- man/proof_start.Rd | 2 +- man/proof_status.Rd | 2 +- man/proof_timeout.Rd | 4 ++-- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5f3b6c8..3bf28df 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: proofr Title: Client for the PROOF API -Version: 0.3.0.91 +Version: 0.3.0.96 Authors@R: person("Scott", "Chamberlain", , "sachamber@fredhutch.org", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1444-9135")) diff --git a/R/onLoad.R b/R/onLoad.R index c8123bb..651e0b6 100644 --- a/R/onLoad.R +++ b/R/onLoad.R @@ -2,5 +2,5 @@ proofr_env <- new.env() # nocov start .onLoad <- function(libname, pkgname) { # use the same timezone throughout the package - proofr_env$timeout_sec <<- 5 + proofr_env$timeout_sec <<- 20 } # nocov end diff --git a/R/status.R b/R/status.R index a484c17..30ac406 100644 --- a/R/status.R +++ b/R/status.R @@ -8,7 +8,7 @@ #' this function again until you get the server URL #' @section Timeout: #' If the PROOF API is unavailable, this function will timeout after -#' 5 seconds. Contact the package maintainer if you get a timeout error. +#' 20 seconds. Contact the package maintainer if you get a timeout error. #' See [proof_timeout()]. #' @return A list with fields: #' - `canJobStart` (logical): can a job to make a Cromwell server be started? diff --git a/R/timeout.R b/R/timeout.R index 6bb7941..add0dd7 100644 --- a/R/timeout.R +++ b/R/timeout.R @@ -2,10 +2,10 @@ #' #' @export #' @param sec (integer/numeric) number of seconds after which -#' requests will timeout. default: 10 sec (10000 ms) +#' requests will timeout. default: 20 sec (20000 ms) #' @references #' @return nothing, side effect of setting the timeout for requests -proof_timeout <- function(sec = 10) { +proof_timeout <- function(sec = 20) { assert(sec, c("integer", "numeric")) proofr_env$timeout_sec <- sec } diff --git a/man/proof_authenticate.Rd b/man/proof_authenticate.Rd index c1705ef..82a13ae 100644 --- a/man/proof_authenticate.Rd +++ b/man/proof_authenticate.Rd @@ -27,7 +27,7 @@ pull in your password from an environment variable stored outside of R like \section{Timeout}{ If the PROOF API is unavailable, this function will timeout after -5 seconds. Contact the package maintainer if you get a timeout error. +20 seconds. Contact the package maintainer if you get a timeout error. See \code{\link[=proof_timeout]{proof_timeout()}}. } diff --git a/man/proof_cancel.Rd b/man/proof_cancel.Rd index 3b53b81..136d346 100644 --- a/man/proof_cancel.Rd +++ b/man/proof_cancel.Rd @@ -27,7 +27,7 @@ Cancel/stop PROOF Cromwell server \section{Timeout}{ If the PROOF API is unavailable, this function will timeout after -5 seconds. Contact the package maintainer if you get a timeout error. +20 seconds. Contact the package maintainer if you get a timeout error. See \code{\link[=proof_timeout]{proof_timeout()}}. } diff --git a/man/proof_start.Rd b/man/proof_start.Rd index e6c77f8..f40d7c1 100644 --- a/man/proof_start.Rd +++ b/man/proof_start.Rd @@ -45,7 +45,7 @@ retrieve data. \section{Timeout}{ If the PROOF API is unavailable, this function will timeout after -5 seconds. Contact the package maintainer if you get a timeout error. +20 seconds. Contact the package maintainer if you get a timeout error. See \code{\link[=proof_timeout]{proof_timeout()}}. } diff --git a/man/proof_status.Rd b/man/proof_status.Rd index 283455d..bd08408 100644 --- a/man/proof_status.Rd +++ b/man/proof_status.Rd @@ -36,7 +36,7 @@ Get PROOF API job status - is job running, what's its URL... \section{Timeout}{ If the PROOF API is unavailable, this function will timeout after -5 seconds. Contact the package maintainer if you get a timeout error. +20 seconds. Contact the package maintainer if you get a timeout error. See \code{\link[=proof_timeout]{proof_timeout()}}. } diff --git a/man/proof_timeout.Rd b/man/proof_timeout.Rd index 67adb7a..2034899 100644 --- a/man/proof_timeout.Rd +++ b/man/proof_timeout.Rd @@ -4,11 +4,11 @@ \alias{proof_timeout} \title{Set the timeout for all requests to the PROOF API} \usage{ -proof_timeout(sec = 10) +proof_timeout(sec = 20) } \arguments{ \item{sec}{(integer/numeric) number of seconds after which -requests will timeout. default: 10 sec (10000 ms)} +requests will timeout. default: 20 sec (20000 ms)} } \value{ nothing, side effect of setting the timeout for requests From 5e7a6a362a3a78acf503824e12272d7f0d7cf3d7 Mon Sep 17 00:00:00 2001 From: tefirman Date: Tue, 3 Dec 2024 14:32:07 -0800 Subject: [PATCH 2/3] Bumping version to v0.4.0.0 --- DESCRIPTION | 2 +- NEWS.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3bf28df..4fd2ae5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: proofr Title: Client for the PROOF API -Version: 0.3.0.96 +Version: 0.4.0.0 Authors@R: person("Scott", "Chamberlain", , "sachamber@fredhutch.org", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1444-9135")) diff --git a/NEWS.md b/NEWS.md index 07be1f9..f5b6113 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# proofr v0.4.0 + +* Bumping timeout from 5 seconds to 20 seconds (@sckott in [direct commit](https://github.com/getwilds/proofr/commit/cbe9062fd73e61992b46035e7ac2241cd8de2541)) + # proofr v0.3.0 * Swapping `httr` for `httr2` (@sckott in [#25](https://github.com/getwilds/proofr/pull/25)) From f8f2aed194ede42d264467195d0f412a4bcd4af3 Mon Sep 17 00:00:00 2001 From: tefirman Date: Tue, 3 Dec 2024 15:41:59 -0800 Subject: [PATCH 3/3] Removing fourth version number --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 4fd2ae5..09001db 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: proofr Title: Client for the PROOF API -Version: 0.4.0.0 +Version: 0.4.0 Authors@R: person("Scott", "Chamberlain", , "sachamber@fredhutch.org", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1444-9135"))