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

AWS S3 cache miss should not issue warning #1404

Merged
merged 3 commits into from
Jun 7, 2024
Merged

AWS S3 cache miss should not issue warning #1404

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f3b762
Enable differentiating cache misses from errors
petamas May 9, 2024
80dcf3f
AWS S3 binary cache miss should not issue warning
petamas May 9, 2024
9353f16
empty nitpick
BillyONeal Jun 7, 2024
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
108 changes: 85 additions & 23 deletions src/vcpkg/binarycaching.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -951,14 +951,37 @@ namespace
static constexpr StringLiteral m_accept_header = "Accept: application/json;api-version=6.0-preview.1";
};

template<class ResultOnSuccessType>
static ExpectedL<ResultOnSuccessType> flatten_generic(const ExpectedL<ExitCodeAndOutput>& maybe_exit,
StringView tool_name,
ResultOnSuccessType result_on_success)
{
if (auto exit = maybe_exit.get())
{
if (exit->exit_code == 0)
{
return {result_on_success};
}

return {msg::format_error(
msgProgramReturnedNonzeroExitCode, msg::tool_name = tool_name, msg::exit_code = exit->exit_code)
.append_raw('\n')
.append_raw(exit->output)};
}

return {msg::format_error(msgLaunchingProgramFailed, msg::tool_name = tool_name)
.append_raw(' ')
.append_raw(maybe_exit.error().to_string())};
}

struct IObjectStorageTool
{
virtual ~IObjectStorageTool() = default;

virtual LocalizedString restored_message(size_t count,
std::chrono::high_resolution_clock::duration elapsed) const = 0;
virtual ExpectedL<Unit> stat(StringView url) const = 0;
virtual ExpectedL<Unit> download_file(StringView object, const Path& archive) const = 0;
virtual ExpectedL<CacheAvailability> stat(StringView url) const = 0;
virtual ExpectedL<RestoreResult> download_file(StringView object, const Path& archive) const = 0;
virtual ExpectedL<Unit> upload_file(StringView object, const Path& archive) const = 0;
};

Expand Down Expand Up @@ -990,9 +1013,12 @@ namespace
const auto& abi = action.package_abi().value_or_exit(VCPKG_LINE_INFO);
auto tmp = make_temp_archive_path(m_buildtrees, action.spec);
auto res = m_tool->download_file(make_object_path(m_prefix, abi), tmp);
if (res)
if (auto cache_result = res.get())
{
out_zip_paths[idx].emplace(std::move(tmp), RemoveWhen::always);
if (*cache_result == RestoreResult::restored)
{
out_zip_paths[idx].emplace(std::move(tmp), RemoveWhen::always);
}
}
else
{
Expand All @@ -1007,9 +1033,10 @@ namespace
{
auto&& action = *actions[idx];
const auto& abi = action.package_abi().value_or_exit(VCPKG_LINE_INFO);
if (m_tool->stat(make_object_path(m_prefix, abi)))
auto maybe_res = m_tool->stat(make_object_path(m_prefix, abi));
if (auto res = maybe_res.get())
{
cache_status[idx] = CacheAvailability::available;
cache_status[idx] = *res;
}
else
{
Expand Down Expand Up @@ -1077,19 +1104,21 @@ namespace
return msg::format(msgRestoredPackagesFromGCS, msg::count = count, msg::elapsed = ElapsedTime(elapsed));
}

ExpectedL<Unit> stat(StringView url) const override
ExpectedL<CacheAvailability> stat(StringView url) const override
{
return flatten(
return flatten_generic(
cmd_execute_and_capture_output(Command{m_tool}.string_arg("-q").string_arg("stat").string_arg(url)),
Tools::GSUTIL);
Tools::GSUTIL,
CacheAvailability::available);
}

ExpectedL<Unit> download_file(StringView object, const Path& archive) const override
ExpectedL<RestoreResult> download_file(StringView object, const Path& archive) const override
{
return flatten(
return flatten_generic(
cmd_execute_and_capture_output(
Command{m_tool}.string_arg("-q").string_arg("cp").string_arg(object).string_arg(archive)),
Tools::GSUTIL);
Tools::GSUTIL,
RestoreResult::restored);
}

ExpectedL<Unit> upload_file(StringView object, const Path& archive) const override
Expand All @@ -1116,29 +1145,60 @@ namespace
return msg::format(msgRestoredPackagesFromAWS, msg::count = count, msg::elapsed = ElapsedTime(elapsed));
}

ExpectedL<Unit> stat(StringView url) const override
ExpectedL<CacheAvailability> stat(StringView url) const override
{
auto cmd = Command{m_tool}.string_arg("s3").string_arg("ls").string_arg(url);
if (m_no_sign_request)
{
cmd.string_arg("--no-sign-request");
}

return flatten(cmd_execute_and_capture_output(cmd), Tools::AWSCLI);
auto maybe_exit = cmd_execute_and_capture_output(cmd);

// When the file is not found, "aws s3 ls" prints nothing, and returns exit code 1.
// flatten_generic() would treat this as an error, but we want to treat it as a (silent) cache miss instead,
// so we handle this special case before calling flatten_generic().
// See https://github.com/aws/aws-cli/issues/5544 for the related aws-cli bug report.
if (auto exit = maybe_exit.get())
{
// We want to return CacheAvailability::unavailable even if aws-cli starts to return exit code 0 with an
// empty output when the file is missing. This way, both the current and possible future behavior of
// aws-cli is covered.
if (exit->exit_code == 0 || exit->exit_code == 1)
{
if (Strings::trim(exit->output).empty())
{
return CacheAvailability::unavailable;
}
}
}

// In the non-special case, simply let flatten_generic() do its job.
return flatten_generic(maybe_exit, Tools::AWSCLI, CacheAvailability::available);
}

ExpectedL<Unit> download_file(StringView object, const Path& archive) const override
ExpectedL<RestoreResult> download_file(StringView object, const Path& archive) const override
{
auto r = stat(object);
if (!r) return r;
if (auto stat_result = r.get())
{
if (*stat_result != CacheAvailability::available)
{
return RestoreResult::unavailable;
}
}
else
{
return r.error();
}

auto cmd = Command{m_tool}.string_arg("s3").string_arg("cp").string_arg(object).string_arg(archive);
if (m_no_sign_request)
{
cmd.string_arg("--no-sign-request");
}

return flatten(cmd_execute_and_capture_output(cmd), Tools::AWSCLI);
return flatten_generic(cmd_execute_and_capture_output(cmd), Tools::AWSCLI, RestoreResult::restored);
}

ExpectedL<Unit> upload_file(StringView object, const Path& archive) const override
Expand All @@ -1165,17 +1225,19 @@ namespace
return msg::format(msgRestoredPackagesFromCOS, msg::count = count, msg::elapsed = ElapsedTime(elapsed));
}

ExpectedL<Unit> stat(StringView url) const override
ExpectedL<CacheAvailability> stat(StringView url) const override
{
return flatten(cmd_execute_and_capture_output(Command{m_tool}.string_arg("ls").string_arg(url)),
Tools::COSCLI);
return flatten_generic(cmd_execute_and_capture_output(Command{m_tool}.string_arg("ls").string_arg(url)),
Tools::COSCLI,
CacheAvailability::available);
}

ExpectedL<Unit> download_file(StringView object, const Path& archive) const override
ExpectedL<RestoreResult> download_file(StringView object, const Path& archive) const override
{
return flatten(
return flatten_generic(
cmd_execute_and_capture_output(Command{m_tool}.string_arg("cp").string_arg(object).string_arg(archive)),
Tools::COSCLI);
Tools::COSCLI,
RestoreResult::restored);
}

ExpectedL<Unit> upload_file(StringView object, const Path& archive) const override
Expand Down
Loading