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

protobuf: StatusProto#fromStatusAndTrailers fall-back use status #6278

Merged
merged 3 commits into from Oct 15, 2019
Merged

protobuf: StatusProto#fromStatusAndTrailers fall-back use status #6278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc089b0
protobuf: StatusProto#fromStatusAndTrailers fall-back use status
creamsoup Oct 14, 2019
b339684
apply review
creamsoup Oct 14, 2019
dd356ea
statusproto: status now cannot be null
creamsoup Oct 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 14 additions & 6 deletions protobuf/src/main/java/io/grpc/protobuf/StatusProto.java
View file
Open in desktop
Expand Up @@ -147,14 +147,16 @@ public static com.google.rpc.Status fromThrowable(Throwable t) {
}

/**
* Extracts the google.rpc.Status from trailers, and makes sure they match the gRPC
* {@code status}.
* Extracts the {@code google.rpc.Status} from trailers, and makes sure they match the gRPC
* {@code status}. If the trailers do not contain a {@code google.rpc.Status}, it uses
* {@code status} param to generate a {@code google.rpc.Status}.
*
* @return the embedded google.rpc.Status or {@code null} if it is not present.
* @return the embedded google.rpc.Status
* @since 1.11.0
*/
@Nullable
public static com.google.rpc.Status fromStatusAndTrailers(Status status, Metadata trailers) {
public static com.google.rpc.Status fromStatusAndTrailers(
Status status, @Nullable Metadata trailers) {
checkNotNull(status, "status");
if (trailers != null) {
com.google.rpc.Status statusProto = trailers.get(STATUS_DETAILS_KEY);
if (statusProto != null) {
Expand All @@ -164,6 +166,12 @@ public static com.google.rpc.Status fromStatusAndTrailers(Status status, Metadat
return statusProto;
}
}
return null;
// fall-back to status, this is useful if the error is local. e.g. Server is unavailable.
com.google.rpc.Status.Builder statusBuilder = com.google.rpc.Status.newBuilder()
.setCode(status.getCode().value());
if (status.getDescription() != null) {
statusBuilder.setMessage(status.getDescription());
}
return statusBuilder.build();
}
}
23 changes: 14 additions & 9 deletions protobuf/src/test/java/io/grpc/protobuf/StatusProtoTest.java
View file
Open in desktop
Expand Up @@ -126,20 +126,25 @@ public void toStatusException_shouldThrowIfStatusCodeInvalid() throws Exception
}

@Test
public void fromThrowable_shouldReturnNullIfTrailersAreNull() {
Status status = Status.fromCodeValue(0);
public void fromThrowable_runtimeException_shouldReturnDerivedStatusIfTrailersAreNull() {
Status status = Status.UNAVAILABLE.withDescription("not available");

assertNull(StatusProto.fromThrowable(status.asRuntimeException()));
assertNull(StatusProto.fromThrowable(status.asException()));
com.google.rpc.Status statusFromThrowable =
StatusProto.fromThrowable(status.asRuntimeException());

assertEquals(statusFromThrowable.getCode(), status.getCode().value());
assertEquals(statusFromThrowable.getMessage(), status.getDescription());
}

@Test
public void fromThrowable_shouldReturnNullIfStatusDetailsKeyIsMissing() {
Status status = Status.fromCodeValue(0);
Metadata emptyMetadata = new Metadata();
public void fromThrowable_exception_shouldReturnDerivedStatusIfTrailersAreNull() {
Status status = Status.UNAVAILABLE.withDescription("not available");

com.google.rpc.Status statusFromThrowable =
StatusProto.fromThrowable(status.asException());

assertNull(StatusProto.fromThrowable(status.asRuntimeException(emptyMetadata)));
assertNull(StatusProto.fromThrowable(status.asException(emptyMetadata)));
assertEquals(statusFromThrowable.getCode(), status.getCode().value());
assertEquals(statusFromThrowable.getMessage(), status.getDescription());
}

@Test
Expand Down