R/utils-httr2.R

In bhklab/AnnotationGx: AnnotationGx: A package for building, updating and querying an annotation database for pharmaco-genomic data

#' Builds a URL by concatenating the input arguments and encoding it.
#'
#' @param ... The components of the URL.
#' @return The encoded URL.
#' @noRd
#' @keywords internal
.buildURL <- function(...) {
  paste0(stats::na.omit(unlist(list(...))), collapse = "/") |> utils::URLencode()
}

#' Builds an HTTP request using the provided URL.
#'
#' @param url The URL for the request.
#' @return The built HTTP request.
#' @noRd
#' @keywords internal
.build_request <- function(url) {
  httr2::request(url) |>
    httr2::req_retry(max_tries = 5, backoff = ~ 10) |>
    httr2::req_error(is_error = \(resp) FALSE)
}

#' Performs an HTTP request.
#'
#' @param request The HTTP request to perform.
#' @return The response of the HTTP request.
#' @noRd
#' @keywords internal
.perform_request <- function(request) {
  httr2::req_perform(request)
}

#' Performs an HTTP request in parallel.
#' @param reqs The HTTP requests to perform.
#' @param on_error The action to take when an error occurs. Can be "stop" or "continue".
#' @param progress Whether to show a progress bar.
#'
#' @return The responses of the HTTP requests.
#'
#' @noRd
#' @keywords internal
.perform_request_parallel <- function(reqs, on_error = "continue", progress = TRUE, ...) {
  httr2::req_perform_parallel(reqs, on_error = on_error, progress = progress, ...)
}


#' Parses the JSON response from an HTTP request.
#'
#' @param resp The response object from the HTTP request.
#' @return The parsed JSON response.
#' @noRd
#' @keywords internal
.parse_resp_json <- function(resp, simplifyVector = TRUE) {
  httr2::resp_body_json(resp, simplifyVector = simplifyVector)
}


#' Parses the TSV response from an HTTP request.
#' @param resp The response object from the HTTP request.
#' @return The parsed TSV response.
#' @noRd
#' @keywords internal
.parse_resp_tsv <- function(resp, show_col_types = FALSE, skip = 0) {
  readr::read_tsv(resp$body, skip = skip, show_col_types = show_col_types)
}