Improve printing for OAuth clients and tokens (#659)

Fixes #648

Author: hadley

NEWS.md

@@ -1,5 +1,6 @@
 # httr2 (development version)
 
+* `oauth_client()` and `oauth_token()` gain refreshed print methods that use bulleted lists, like other httr2 objects. Additionally, print a `oauth_client()` with a custom `auth` function no longer errors (#648).
 * `req_headers()` always redacts `Authorization` (#649).
 * `req_headers_redacted()` supports dynamic dots (#647)
 * `resp_stream_sse()` now automatically retrieves the next event if the current event contains no data. The data is now returned as a single string (#650).

R/headers.R

@@ -57,10 +57,17 @@ list_redact <- function(x, names, case_sensitive = TRUE) {
   } else {
     i <- match(tolower(names), tolower(names(x)))
   }
-  x[i] <- cli::col_grey("<REDACTED>")
+  x[i] <- redacted()
   x
 }
 
+redacted <- function() {
+  cli::col_grey("<REDACTED>")
+}
+is_redacted <- function(x) {
+  is.character(x) && length(x) == 1 && x == redacted()
+}
+
 
 #' @export
 `[.httr2_headers` <- function(x, i, ...) {

R/oauth-client.R

@@ -93,7 +93,7 @@ oauth_client <- function(
 print.httr2_oauth_client <- function(x, ...) {
   cli::cli_text(cli::style_bold("<", paste(class(x), collapse = "/"), ">"))
   redacted <- list_redact(compact(x), c("secret", "key"))
-  cli::cli_dl(redacted)
+  bullets(redacted)
   invisible(x)
 }
 

R/oauth-token.R

@@ -60,11 +60,7 @@ print.httr2_token <- function(x, ...) {
     redacted$expires_at <- format(.POSIXct(x$expires_at))
   }
 
-  # https://github.com/r-lib/cli/issues/347
-  is_empty <- map_lgl(redacted, ~ .x == "")
-  redacted[is_empty] <- "''"
-
-  cli::cli_dl(compact(redacted))
+  bullets(compact(redacted))
 
   invisible(x)
 }

R/utils.R

@@ -4,22 +4,29 @@ bullets_with_header <- function(header, x) {
   }
 
   cli::cli_text("{.strong {header}}")
+  bullets(x)
+}
 
+bullets <- function(x) {
   as_simple <- function(x) {
     if (is.atomic(x) && length(x) == 1) {
-      if (is.character(x)) {
+      if (is_redacted(x)) {
+        x
+      } else if (is.character(x)) {
         paste0('"', x, '"')
       } else {
         format(x)
       }
     } else {
-      obj_type_friendly(x)
+      paste0("<", class(x)[[1L]], ">")
     }
   }
   vals <- map_chr(x, as_simple)
+  names <- format(names(x))
+  names <- gsub(" ", "\u00a0", names, fixed = TRUE)
 
   for (i in seq_along(x)) {
-    cli::cli_li("{.field {names(x)[[i]]}}: {vals[[i]]}")
+    cli::cli_li("{.field {names[[i]]}}: {vals[[i]]}")
   }
 }
 

tests/testthat/_snaps/oauth-client.md

@@ -43,20 +43,30 @@
 # client has useful print method
 
     Code
-      oauth_client("x", token_url = "http://example.com")
+      oauth_client("x", url)
     Message
       <httr2_oauth_client>
-      name: bf27508f7925b06bf28a10f3805351ab
-      id: x
-      token_url: http://example.com
-      auth: oauth_client_req_auth_body
+      * name     : "bf27508f7925b06bf28a10f3805351ab"
+      * id       : "x"
+      * token_url: "http://example.com"
+      * auth     : "oauth_client_req_auth_body"
     Code
-      oauth_client("x", secret = "SECRET", token_url = "http://example.com")
+      oauth_client("x", url, secret = "SECRET")
     Message
       <httr2_oauth_client>
-      name: bf27508f7925b06bf28a10f3805351ab
-      id: x
-      secret: <REDACTED>
-      token_url: http://example.com
-      auth: oauth_client_req_auth_body
+      * name     : "bf27508f7925b06bf28a10f3805351ab"
+      * id       : "x"
+      * secret   : <REDACTED>
+      * token_url: "http://example.com"
+      * auth     : "oauth_client_req_auth_body"
+    Code
+      oauth_client("x", url, auth = function(...) {
+        xxx
+      })
+    Message
+      <httr2_oauth_client>
+      * name     : "bf27508f7925b06bf28a10f3805351ab"
+      * id       : "x"
+      * token_url: "http://example.com"
+      * auth     : <function>
 

tests/testthat/_snaps/oauth-token.md

@@ -4,8 +4,8 @@
       oauth_token(access_token = "secret", refresh_token = "secret", id_token = "secret")
     Message
       <httr2_token>
-      token_type: bearer
-      access_token: <REDACTED>
-      refresh_token: <REDACTED>
-      id_token: <REDACTED>
+      * token_type   : "bearer"
+      * access_token : <REDACTED>
+      * refresh_token: <REDACTED>
+      * id_token     : <REDACTED>
 

tests/testthat/_snaps/req-headers.md

@@ -6,7 +6,7 @@
       <httr2_request>
       GET http://example.com
       Headers:
-      * a: "<REDACTED>"
+      * a: <REDACTED>
       Body: empty
 
 # checks input types

tests/testthat/_snaps/req.md

@@ -28,7 +28,7 @@
       <httr2_request>
       GET http://test
       Headers:
-      * x: "{z}"
+      * x  : "{z}"
       * {z}: "x"
       Body: empty
 

tests/testthat/test-oauth-client.R

@@ -17,9 +17,12 @@ test_that("checks auth types have needed args", {
 })
 
 test_that("client has useful print method", {
+  url <-"http://example.com"
+
   expect_snapshot({
-    oauth_client("x", token_url = "http://example.com")
-    oauth_client("x", secret = "SECRET", token_url = "http://example.com")
+    oauth_client("x", url)
+    oauth_client("x", url, secret = "SECRET")
+    oauth_client("x", url, auth = function(...) {xxx})
   })
 })