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.

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

Better handling of failed push due to corrupt packets #140

Merged
merged 1 commit into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: orderly2
Title: Orderly Next Generation
Version: 1.99.14
Version: 1.99.15
Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"),
email = "[email protected]"),
person("Robert", "Ashton", role = "aut"),
Expand Down
10 changes: 8 additions & 2 deletions R/location.R
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,14 @@ orderly_location_push <- function(packet_id, location, root = NULL,
if (length(plan$files) > 0 || length(plan$packet_id) > 0) {
driver <- location_driver(location_name, root)
for (hash in plan$files) {
## TODO: mrc-4505 - needs work
driver$push_file(find_file_by_hash(root, hash), hash)
src <- find_file_by_hash(root, hash)
if (is.null(src)) {
cli::cli_abort(
c("Did not find suitable file, can't push this packet",
i = paste("The original file has been changed or deleted.",
"Details are above")))
}
driver$push_file(src, hash)
}
for (id in plan$packet_id) {
path <- file.path(root$path, ".outpack", "metadata", id)
Expand Down
18 changes: 14 additions & 4 deletions R/outpack_root.R
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,27 @@ find_file_by_hash <- function(root, hash) {
for (id in index$unpacked) {
meta <- index$metadata[[id]]
for (i in which(meta$files$hash == hash)) {
path <- file.path(path_archive, meta$name, id, meta$files$path[[i]])
if (file.exists(path) && hash_file(path, algorithm) == hash) {
filename <- meta$files$path[[i]]
path <- file.path(path_archive, meta$name, id, filename)
if (!file.exists(path)) {
cli::cli_alert_warning(
"Missing file from archive '{filename}' in '{meta$name}/{id}'")
next
}
hash_found <- hash_file(path, algorithm)
if (file.exists(path) && hash_found == hash) {
return(path)
}
p <- meta$files$path[[i]]
## Not actually a warning; formats in a way that works within
## the overal logging. What is not obvious is that this is
## potentially coming from a remote and that's not always clear,
## so we need a way of nesting output
cli::cli_alert_warning(
"Rejecting file from archive '{p}' in '{meta$name}/{id}'")
"Rejecting file from archive '{filename}' in '{meta$name}/{id}'")
cli::cli_alert_info(
"Expected ({cli::symbol$tick}) and found ({cli::symbol$cross}) hashes:")
cli::cli_alert_success(hash)
cli::cli_alert_danger(hash_found)
}
}

Expand Down
18 changes: 18 additions & 0 deletions tests/testthat/test-location-path.R
Original file line number Diff line number Diff line change
Expand Up @@ -350,3 +350,21 @@ test_that("Can read metadata files with a trailing newline", {
expected_hash <- packets[packets$packet == id]$hash
expect_no_error(hash_validate_data(data, expected_hash))
})


test_that("Fail to push sensibly if files have been changed", {
client <- create_temporary_root()
ids <- create_random_packet_chain(client, 4)

server <- create_temporary_root(use_file_store = TRUE, path_archive = NULL)
orderly_location_add("server", "path", list(path = server$path),
root = client)

## Corrupt one file:
path <- file.path(client$path, "archive", "b", ids[["b"]], "script.R")
append_lines(path, "# anything")

expect_error(
suppressMessages(orderly_location_push(ids[[4]], "server", client)),
"Did not find suitable file, can't push this packet")
})
Loading