Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

replaced single-shot HTTP requests with RETRY logic #235

Merged
merged 2 commits into from
Apr 27, 2020
Merged

replaced single-shot HTTP requests with RETRY logic #235

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ccab34
replaced single-shot HTTP requests with RETRY logic
jameslamb Apr 19, 2020
77d8daf
added more status codes to terminate_on and updated CHANGELOG
jameslamb Apr 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions R/io.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ write_civis.character <- function(x, tablename, database = NULL, if_exists = "fa
credential_id = credential_id),
import_args)
job_r <- do.call(start_import_job, args)
put_r <- httr::PUT(job_r[["uploadUri"]], body = httr::upload_file(x))
put_r <- httr::RETRY("PUT", job_r[["uploadUri"]], body = httr::upload_file(x), terminate_on = c(403, 404))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'd be better to terminate on any 4xx error other 429 here (e.g., terminate_on = setdiff(400:499, 429)). That's what AWS recommends here, and this URI and the one for write_disk below will be S3 URLs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure I can do that! setdiff() is a super clean way to express it, I like it 😀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed the comments in 7cdb800

if (put_r$status_code != 200) {
msg <- httr::content(put_r)
stop(msg)
Expand Down Expand Up @@ -562,9 +562,11 @@ download_civis.numeric <- function(x, file,
}

args <- c(list(files_get(x)$fileUrl),
list(httr::write_disk(file, overwrite = overwrite)))
list(httr::write_disk(file, overwrite = overwrite)),
verb = "GET",
terminate_on = c(403, 404))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also please make this terminate_on = setdiff(400:499, 429)? Sorry, I should have commented about each case rather than just the first.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh sure, no problem!

if (progress) args <- c(args, list(httr::progress()))
resp <- do.call(httr::GET, args)
resp <- do.call(httr::RETRY, args)

httr::stop_for_status(resp, task = "download file from S3")
invisible(file)
Expand Down Expand Up @@ -902,14 +904,14 @@ download_script_results <- function(script_id, run_id,
stop_if_no_output(script_results)

url <- script_results[["output"]][[1]][["path"]]
args <- list(url)
args <- list(url, verb = "GET", terminate_on = c(403, 404))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also please make this terminate_on = setdiff(400:499, 429)?

if (!is.null(filename)) {
args <- c(args, list(httr::write_disk(filename, overwrite = TRUE)))
}
if (progress) {
args <- c(args, list(httr::progress()))
}
r <- do.call(httr::GET, args)
r <- do.call(httr::RETRY, args)
httr::stop_for_status(r)
r
}
Expand Down
3 changes: 0 additions & 3 deletions tests/testthat/test_client_base.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ body_params <- NULL
test_that("call api extracts json content correctly", {
response <- with_mock(
`civis::api_key` = function(...) "fake_key",
`httr::VERB` = function(...) httr_200,
`httr::RETRY` = function(...) httr_200,
call_api("GET", path, path_params, query_params, body_params))
expect_equal(response[[1]]$name, "Leanne Graham")
Expand All @@ -45,7 +44,6 @@ test_that("call api extracts json content correctly", {
test_that("print and str methods for civis_api", {
response <- with_mock(
`civis::api_key` = function(...) "fake_key",
`httr::VERB` = function(...) httr_200,
`httr::RETRY` = function(...) httr_200,
call_api("GET", path, path_params, query_params, body_params))

Expand All @@ -62,7 +60,6 @@ test_that("print and str methods for civis_api", {
test_that("call api catches http error", {
with_mock(
`civis::api_key` = function(...) "fake_key",
`httr::VERB` = function(...) httr_504,
`httr::RETRY` = function(...) httr_504,
expect_error(
call_api("GET", path, path_params, query_params, body_params),
Expand Down
12 changes: 6 additions & 6 deletions tests/testthat/test_io.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ test_that("read_civis.numeric reads a csv", {
}
with_mock(
`civis::files_get` = function(...) list(fileUrl = "fakeurl.com"),
`httr::GET` = mock_response,
`httr::RETRY` = mock_response,
`civis::download_civis` = function(id, fn) write.csv(d, file = fn),
expect_equal(d, read_civis(123, using = read.csv, row.names = 1))
)
Expand Down Expand Up @@ -101,7 +101,7 @@ test_that("write_civis.character returns meta data if successful", {
},
`civis::default_credential` = function(...) 1234,
`civis::tables_post_refresh` = function(id) "",
`httr::PUT` = function(...) list(status_code = 200),
`httr::RETRY` = function(...) list(status_code = 200),
`civis::imports_post_files_runs` = function(...) list(""),
`civis::imports_get_files_runs` = function(...) list(state = "succeeded"),
write_civis("mockfile", "mock.table", "mockdb")
Expand All @@ -116,7 +116,7 @@ test_that("write_civis.character fails if file doesn't exist", {
`civis::start_import_job` = function(...) {
list(uploadUri = "fake")
},
`httr::PUT` = function(...) list(status_code = 200),
`httr::RETRY` = function(...) list(status_code = 200),
`civis::imports_post_files_runs` = function(...) list(""),
`civis::imports_get_files_runs` = function(...) list(state = "succeeded"),
tryCatch(write_civis("mockfile", "mock.table", "mockdb"), error = function(e) e$message)
Expand All @@ -133,7 +133,7 @@ test_that("write_civis.data.frame returns meta data if successful", {
},
`civis::default_credential` = function(...) 1,
`civis::tables_post_refresh` = function(id) "",
`httr::PUT` = function(...) list(status_code = 200),
`httr::RETRY` = function(...) list(status_code = 200),
`civis::imports_post_files_runs` = function(...) list(""),
`civis::imports_get_files_runs` = function(...) list(state = "succeeded"),
`civis::tables_list` = function(...) 1,
Expand All @@ -148,7 +148,7 @@ test_that("write_civis.character warns under failure", {
`civis::start_import_job` = function(...) {
list(uploadUri = "fake", id = -999)
},
`httr::PUT` = function(...) list(status_code = 200),
`httr::RETRY` = function(...) list(status_code = 200),
`civis::imports_post_files_runs` = function(...) "",
`civis::imports_get_files_runs` = function(...) list(state = "failed"),
`httr::content` = function(...) "error",
Expand All @@ -167,7 +167,7 @@ test_that("write_civis.character calls imports endpoints correctly", {
`civis::imports_post_files` = ipf,
`civis::imports_post_files_runs` = function(...) list(id = 44),
`civis::imports_get_files_runs` = function(...) list(state = "succeeded"),
`httr::PUT` = mock(list(status_code = 200)),
`httr::RETRY` = mock(list(status_code = 200)),
res <- write_civis(fn, "mock.table", "mockdb", credential_id = 1),
expect_equal(get_status(res), "succeeded"),
expect_args(ipf, n = 1,
Expand Down