Merge branch 'main' into resp_url

NEWS.md

@@ -3,6 +3,11 @@
 * New `resp_url()`, `resp_url_path()`, `resp_url_queries()` and
   `resp_url_query()` to extract various part of the response url (#57).
 
+* Progress bars displayed while waiting for some time to pass are now
+  more informative (#206).
+
+* `url_build()` automatically adds leading `/` to `path` if missing (#276).
+
 * Cached responses now combine the headers of the new response with the headers
   of the cached response. In particular, this fixes `resp_body_json/xml/html()`
   on cached responses (@mgirlich, #277).

R/req-cache.R

@@ -15,7 +15,11 @@
 #' [HTTP caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching).
 #'
 #' @inheritParams req_perform
-#' @param path Path to cache directory
+#' @param path Path to cache directory.
+#'
+#'   httr2 doesn't provide helpers to manage the cache, but if you want to
+#'   empty it, you can use something like
+#'   `unlink(dir(cache_path, full.names = TRUE))`.
 #' @param use_on_error If the request errors, and there's a cache response,
 #'   should `req_perform()` return that instead of generating an error?
 #' @param debug When `TRUE` will emit useful messages telling you about

R/req-perform.R

@@ -86,7 +86,7 @@ req_perform <- function(
 
   delay <- 0
   while(tries < max_tries && Sys.time() < deadline) {
-    sys_sleep(delay)
+    sys_sleep(delay, "for retry backoff")
     n <- n + 1
 
     resp <- tryCatch(

R/req-throttle.R

@@ -39,7 +39,7 @@ req_throttle <- function(req, rate, realm = NULL) {
       wait <- delay - (unix_time() - last)
     }
 
-    sys_sleep(wait)
+    sys_sleep(wait, "for throttling delay")
     throttle_touch(realm)
     wait
   }

R/url.R

@@ -139,6 +139,10 @@ url_build <- function(url) {
     authority <- NULL
   }
 
+  if (!is.null(url$path) && !startsWith(url$path, "/")) {
+    url$path <- paste0("/", url$path)
+  }
+
   prefix <- function(prefix, x) if (!is.null(x)) paste0(prefix, x)
   paste0(
     url$scheme, if (!is.null(url$scheme)) ":",

R/utils.R

@@ -40,8 +40,8 @@ modify_list <- function(.x, ..., error_call = caller_env()) {
 }
 
 
-sys_sleep <- function(seconds, fps = 10, error_call = caller_env()) {
-  check_number_decimal(seconds, call = error_call)
+sys_sleep <- function(seconds, task, fps = 10) {
+  check_number_decimal(seconds)
 
   if (seconds == 0) {
     return(invisible())
@@ -51,7 +51,7 @@ sys_sleep <- function(seconds, fps = 10, error_call = caller_env()) {
   signal("", class = "httr2_sleep", seconds = seconds)
 
   cli::cli_progress_bar(
-    format = "Waiting {round(seconds)}s to retry {cli::pb_bar}",
+    format = "Waiting {round(seconds)}s {task} {cli::pb_bar}",
     total = seconds * fps
   )
 

tests/testthat/test-req-url.R

@@ -26,12 +26,12 @@ test_that("can append multiple components", {
 
 test_that("can handle empty path", {
   req <- request("http://example.com/x")
-  expect_equal(req_url_path(req)$url, "http://example.com")
+  expect_equal(req_url_path(req)$url, "http://example.com/")
   expect_equal(req_url_path_append(req)$url, "http://example.com/x")
-  expect_equal(req_url_path(req, NULL)$url, "http://example.com")
+  expect_equal(req_url_path(req, NULL)$url, "http://example.com/")
   expect_equal(req_url_path_append(req, NULL)$url, "http://example.com/x")
 
-  expect_equal(req_url_path(req, "")$url, "http://example.com")
+  expect_equal(req_url_path(req, "")$url, "http://example.com/")
   expect_equal(req_url_path_append(req, "")$url, "http://example.com/x")
 })
 

tests/testthat/test-url.R

@@ -37,6 +37,13 @@ test_that("can print all url details", {
   )
 })
 
+test_that("ensures path always starts with /", {
+  expect_equal(
+    url_modify("https://example.com/abc", path = "def"),
+    "https://example.com/def"
+  )
+})
+
 # query -------------------------------------------------------------------
 
 test_that("missing query values become empty strings", {