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

Exposing GrpcResponse.grpcResponseToException #2814

Closed
Closed
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
5 changes: 5 additions & 0 deletions wire-grpc-client/api/wire-grpc-client.api
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ public final class com/squareup/wire/GrpcHttpUrlKt {
public static final fun toHttpUrl (Ljava/lang/String;)Lokhttp3/HttpUrl;
}

public final class com/squareup/wire/GrpcKt {
public static final fun grpcResponseToException (Lokhttp3/Response;Ljava/io/IOException;)Ljava/io/IOException;
public static synthetic fun grpcResponseToException$default (Lokhttp3/Response;Ljava/io/IOException;ILjava/lang/Object;)Ljava/io/IOException;
}

public final class com/squareup/wire/GrpcMethod {
public fun <init> (Ljava/lang/String;Lcom/squareup/wire/ProtoAdapter;Lcom/squareup/wire/ProtoAdapter;)V
public final fun getPath ()Ljava/lang/String;
Expand Down
61 changes: 61 additions & 0 deletions wire-grpc-client/src/jvmMain/kotlin/com/squareup/wire/grpc.kt
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? {
Copy link
Collaborator

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?

fun GrpcResponse.toExceptionIfFailed(suppressed: IOException? = null): IOException? {
}

var trailers = headersOf()
var transportException = suppressed
try {
trailers = trailers()

Choose a reason for hiding this comment

The 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 response.peekBody()

Copy link
Collaborator

Choose a reason for hiding this comment

The 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(

Choose a reason for hiding this comment

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

Isn't it a bit weird that transportException is returned but this IllegarArgumentException is rethrown?
IMO it would be better to only return GrpcException from this method and throw anything else.

"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.
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package com.squareup.wire.internal
import com.squareup.wire.GrpcResponse
import com.squareup.wire.MessageSource
import com.squareup.wire.ProtoAdapter
import com.squareup.wire.grpcResponseToException
import com.squareup.wire.use
import java.util.concurrent.LinkedBlockingDeque
import okhttp3.Call
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.squareup.wire.GrpcCall
import com.squareup.wire.GrpcMethod
import com.squareup.wire.GrpcResponse
import com.squareup.wire.WireGrpcClient
import com.squareup.wire.grpcResponseToException
import com.squareup.wire.use
import java.util.concurrent.TimeUnit
import kotlin.coroutines.resume
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,18 @@
*/
package com.squareup.wire.internal

import com.squareup.wire.GrpcException
import com.squareup.wire.GrpcResponse
import com.squareup.wire.GrpcStatus
import com.squareup.wire.ProtoAdapter
import com.squareup.wire.grpcResponseToException
import com.squareup.wire.use
import java.io.Closeable
import java.util.Base64
import kotlinx.coroutines.CancellationException
import kotlinx.coroutines.channels.ReceiveChannel
import kotlinx.coroutines.channels.SendChannel
import kotlinx.coroutines.channels.consumeEach
import kotlinx.coroutines.runBlocking
import okhttp3.Call
import okhttp3.Callback
import okhttp3.Headers.Companion.headersOf
import okhttp3.MediaType
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody
Expand Down Expand Up @@ -198,44 +195,3 @@ private fun GrpcResponse.checkGrpcResponse() {
throw IOException("expected gRPC but was HTTP status=$code, content-type=$contentType")
}
}

/** Returns an exception if the gRPC call didn't have a grpc-status of 0. */
internal fun GrpcResponse.grpcResponseToException(suppressed: IOException? = null): IOException? {
var trailers = headersOf()
var transportException = suppressed
try {
trailers = trailers()
} 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(
"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.
}
Loading