-
Notifications
You must be signed in to change notification settings - Fork 578
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
Exposing GrpcResponse.grpcResponseToException #2814
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
* Copyright (C) 2024 Square, Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package com.squareup.wire | ||
|
||
import java.util.Base64 | ||
import okhttp3.Headers.Companion.headersOf | ||
import okio.IOException | ||
|
||
/** Returns an exception if the gRPC call didn't have a grpc-status of 0. */ | ||
fun GrpcResponse.grpcResponseToException(suppressed: IOException? = null): IOException? { | ||
var trailers = headersOf() | ||
var transportException = suppressed | ||
try { | ||
trailers = trailers() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This method is guaranteed to throw if the response hasn't been consumed yet. It would be good to document this behavior or ensure it doesn't happen by buffering the response body here via There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch. |
||
} catch (e: IOException) { | ||
if (transportException == null) transportException = e | ||
} | ||
|
||
val grpcStatus = trailers["grpc-status"] ?: header("grpc-status") | ||
val grpcMessage = trailers["grpc-message"] ?: header("grpc-message") | ||
var grpcStatusDetailsBin: ByteArray? = null | ||
|
||
grpcStatus?.toIntOrNull()?.takeIf { it != 0 }?.let { grpcStatusInt -> | ||
(trailers["grpc-status-details-bin"] ?: header("grpc-status-details-bin"))?.let { | ||
try { | ||
grpcStatusDetailsBin = Base64.getDecoder().decode(it) | ||
} catch (e: IllegalArgumentException) { | ||
throw IOException( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Isn't it a bit weird that |
||
"gRPC transport failure, invalid grpc-status-details-bin" + | ||
" (HTTP status=$code, grpc-status=$grpcStatus, grpc-message=$grpcMessage)", | ||
e, | ||
) | ||
} | ||
} | ||
|
||
return GrpcException(GrpcStatus.get(grpcStatusInt), grpcMessage, grpcStatusDetailsBin) | ||
} | ||
|
||
if (transportException != null || grpcStatus?.toIntOrNull() == null) { | ||
return IOException( | ||
"gRPC transport failure" + | ||
" (HTTP status=$code, grpc-status=$grpcStatus, grpc-message=$grpcMessage)", | ||
transportException, | ||
) | ||
} | ||
|
||
return null // Success. | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t think I like the signature of this function as a public API.
It’s job is to produce an exception if the response itself is malformed or bad.
Maybe this?