Merge pull request #19 from conbench/aus/history_pag

add pagination to history()

Author: boshek

Diff for: DESCRIPTION

@@ -1,6 +1,6 @@
 Package: conbenchcoms
 Title: An API wrapper for conbench communications
-Version: 0.0.7
+Version: 0.0.8
 Authors@R: c(
     person("Jonathan", "Keane", , "[email protected]", role = c("aut", "ctb"),
            comment = c(ORCID = "0000-0001-7087-9776")),

Diff for: NEWS.md

@@ -1,3 +1,8 @@
+# conbenchcoms 0.0.8
+* Remove `simplifyVector` and `flatten` arguments from `history`
+* `history` now always returns a `tibble`
+* `history` now paginates until all matching data is returned, which works only with Conbench servers of at least version [649a9ac](https://github.com/conbench/conbench/commit/649a9ac)
+
 # conbenchcoms 0.0.7
 * Remove `sha`, `simplifyVector`, and `flatten` arguments from `runs`
 * Add `commit_hashes` argument to `runs`

Diff for: R/history.R

@@ -1,14 +1,27 @@
 #' Get history for a benchmark
 #'
-#' @param benchmark_id the hash of a benchmark to get the history for
-#' @inheritParams jsonlite::fromJSON
+#' @param benchmark_id the ID of a benchmark result to get the history for
 #'
-#' @return the response
+#' @return a tibble of history
 #' @export
-history <- function(benchmark_id, simplifyVector = TRUE, flatten = TRUE, ...) {
+history <- function(benchmark_id) {
   req <- req_url_path_append(conbench_request(), "history", benchmark_id)
-
+  req <- req_url_query(req, page_size = 1000)
   resp <- conbench_perform(req)
+  json <- resp_body_json(resp, simplifyVector = TRUE, flatten = TRUE)
+  data <- dplyr::as_tibble(json[["data"]])
+
+  while (!is.null(json[["metadata"]][["next_page_cursor"]])) {
+    req <- req_url_path_append(conbench_request(), "history", benchmark_id)
+    req <- req_url_query(
+      req,
+      page_size = 1000,
+      cursor = json[["metadata"]][["next_page_cursor"]]
+    )
+    resp <- conbench_perform(req)
+    json <- resp_body_json(resp, simplifyVector = TRUE, flatten = TRUE)
+    data <- dplyr::bind_rows(data, dplyr::as_tibble(json[["data"]]))
+  }
 
-  resp_body_json(resp, simplifyVector = simplifyVector, flatten = flatten, ...)
+  data
 }

Diff for: man/history.Rd

@@ -0,0 +1,12 @@
+{
+    "data": [
+        {
+            "benchmark_id": "hist-id",
+            "timestamp": "2022-04-07T21:11:19",
+            "unit": "s"
+        }
+    ],
+    "metadata": {
+        "next_page_cursor": null
+    }
+}

Diff for: tests/testthat/resp-class/localhost/api/history/hist-id-981e53.json

@@ -2,28 +2,20 @@ with_mock_dir(test_path("logged-in"), {
   test_that("history()", {
     expect_GET(
       history("C0C0A"),
-      "http://localhost/api/history/C0C0A"
+      "http://localhost/api/history/C0C0A?page_size=1000"
     )
   })
 })
 
 
 with_mock_dir(test_path("resp-class"), {
   the_id <- "hist-id"
-  test_that("history() returns a data.frame", {
+  test_that("history() returns a tibble", {
     the_history <- history(benchmark_id = the_id)
     expect_s3_class(
       the_history,
-      "data.frame"
+      "tbl_df"
     )
     expect_identical(the_id, the_history$benchmark_id)
   })
-  test_that("history(...,simplifyVector = FALSE, flatten = FALSE) returns a list", {
-    the_list_history <- history(benchmark_id = the_id, simplifyVector = FALSE, flatten = FALSE)
-    expect_type(
-      the_list_history,
-      "list"
-    )
-    expect_identical(the_id, the_list_history[[1]]$benchmark_id)
-  })
-})
+})