Merge pull request #125 from gladkia/customizable_timeout

feat: add possibility to change the timeout for the curl's connect phase

NEWS.md

@@ -1,5 +1,8 @@
 # pkgsearch (development version)
 
+* pkgsearch now uses the `timeout` option to set the limit for the total
+  time of each HTTP request (#125, @gladkia).
+
 # pkgsearch 3.1.3
 
 * No user visible changes.

R/api.R

@@ -185,11 +185,15 @@ do_query <- function(query, server, from, size) {
   check_count(from)
   check_count(size)
 
+  # timeout for the curl's connect phase (in seconds)
+  timeout <- getOption("timeout", 60)
+
   url <- server %+% "/package/_search?from=" %+%
     as.character(from - 1) %+% "&size=" %+% as.character(size)
   result <- http_post(
     url, body = query,
-    headers = c("Content-Type" = "application/json"))
+    headers = c("Content-Type" = "application/json"),
+    options = list(timeout = timeout))
   chain_error(
     http_stop_for_status(result),
     new_query_error(result, "search server failure")

README.Rmd

@@ -186,6 +186,15 @@ ps("gabor", size = 5)
 ps("Gábor", size = 5)
 ```
 
+## Configuration
+
+### Options
+
+* `timeout`: pkgsearch follows the `timeout` options for HTTP requests
+  (i.e. for `pkg_search()` and `advanced_search()`. `timeout` is the limit
+  for the total time of the HTTP request, and it is in seconds. See
+  `?options` for details.
+
 ## More info
 
 See the [complete documentation](https://r-hub.github.io/pkgsearch/).