Skip to content

Expose function to extract safe error message #41

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

Merged
merged 1 commit into from
Sep 4, 2024
Merged

Expose function to extract safe error message #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 57 additions & 12 deletions src/RustyObjectStore.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,13 @@ struct TimeoutError <: ErrorReason end
struct ParseURLError <: ErrorReason end
struct UnknownError <: ErrorReason end

reason_description(::ConnectionError) = "Connection"
reason_description(r::StatusError) = "StatusCode($(r.code))"
reason_description(::EarlyEOF) = "EarlyEOF"
reason_description(::TimeoutError) = "Timeout"
reason_description(::ParseURLError) = "ParseURL"
reason_description(::UnknownError) = "Unknown"

abstract type RequestException <: Exception end
struct GetException <: RequestException
msg::String
Expand All @@ -590,21 +597,20 @@ struct DeleteException <: RequestException
end


function reason(e::GetException)
return e.reason::ErrorReason
end
message(e::GetException) = e.msg::String
message(e::PutException) = e.msg::String
message(e::DeleteException) = e.msg::String

function reason(e::PutException)
return e.reason::ErrorReason
function message(e::Exception)
iobuf = IOBuffer()
Base.showerror(iobuf, e)
return String(take!(iobuf))
end

function reason(e::DeleteException)
return e.reason::ErrorReason
end

function reason(e::Exception)
return UnknownError()
end
reason(e::GetException) = e.reason::ErrorReason
reason(e::PutException) = e.reason::ErrorReason
reason(e::DeleteException) = e.reason::ErrorReason
reason(e::Exception) = UnknownError()

function status_code(e::Exception)
return reason(e) isa StatusError ? reason(e).code : nothing
Expand All @@ -630,6 +636,28 @@ function is_unknown(e::Exception)
return reason(e) isa UnknownError
end

function safe_message(e::Exception)
if e isa RequestException
msg = message(e)
r = reason(e)
if contains(msg, "<Error>") || contains(msg, "http")
# Contains unreadacted payload from backend or urls, try extracting safe information
code, backend_msg, report = extract_safe_parts(message(e))
reason_str = reason_description(r)

code = isnothing(code) ? "Unknown" : code
backend_msg = isnothing(backend_msg) ? "Error without safe message" : backend_msg
retry_report = isnothing(report) ? "" : "\n\n$(report)"

return "$(backend_msg) (code: $(code), reason: $(reason_str))$(retry_report)"
else
# Assuming it safe as it does not come from backend or has url, return message directly
return msg
end
else
return nothing
end
end

function rust_message_to_reason(msg::AbstractString)
if (
Expand Down Expand Up @@ -682,6 +710,23 @@ function rust_message_to_reason(msg::AbstractString)
end
end

function extract_safe_parts(msg::AbstractString)
code = nothing
backend_message = nothing
retry_report = nothing
codemsg = match(r"<Error>[\s\S]*?<Code>([\s\S]*?)</Code>[\s\S]*?<Message>([\s\S]*?)(?:</Message>|\n)", msg)
if !isnothing(codemsg)
code = codemsg.captures[1]
backend_message = codemsg.captures[2]
end
retry_match = match(r"Recent attempts \([\s\S]*", msg)
if !isnothing(retry_match)
retry_report = retry_match.match
end

return (code, backend_message, retry_report)
end

"""
get_object!(buffer, path, conf) -> Int

Expand Down