flasn4nt
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

core: Replace inappropriate picker result status codes (#9530) 

Certain status codes are inappropriate for a control plane to be
returning and indicate a bug in the control plane. These status codes
will be replaced by INTERNAL, to make it clearer to see that the control
plane is misbehaving.
This commit is contained in:
Terry Wilson 2022-09-09 15:46:28 -07:00 committed by GitHub
parent eac4178eaa
commit 84d0b0474f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 107 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
core/src/main/java/io/grpc/internal/GrpcUtil.java
View File

@ -56,7 +56,10 @@ import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
@ -75,6 +78,17 @@ public final class GrpcUtil {
private static final Logger log = Logger.getLogger(GrpcUtil.class.getName());
private static final Set<Status.Code> INAPPROPRIATE_CONTROL_PLANE_STATUS
= Collections.unmodifiableSet(EnumSet.of(
Status.Code.OK,
Status.Code.INVALID_ARGUMENT,
Status.Code.NOT_FOUND,
Status.Code.ALREADY_EXISTS,
Status.Code.FAILED_PRECONDITION,
Status.Code.ABORTED,
Status.Code.OUT_OF_RANGE,
Status.Code.DATA_LOSS));
public static final Charset US_ASCII = Charset.forName("US-ASCII");
/**
@ -747,10 +761,12 @@ public final class GrpcUtil {
}
if (!result.getStatus().isOk()) {
if (result.isDrop()) {
return new FailingClientTransport(result.getStatus(), RpcProgress.DROPPED);
return new FailingClientTransport(
replaceInappropriateControlPlaneStatus(result.getStatus()), RpcProgress.DROPPED);
}
if (!isWaitForReady) {
return new FailingClientTransport(result.getStatus(), RpcProgress.PROCESSED);
return new FailingClientTransport(
replaceInappropriateControlPlaneStatus(result.getStatus()), RpcProgress.PROCESSED);
}
}
return null;
@ -805,6 +821,19 @@ public final class GrpcUtil {
while (in.read(buf) != -1) {}
}
/**
* Some status codes from the control plane are not appropritate to use in the data plane. If one
* is given it will be replaced with INTERNAL, indicating a bug in the control plane
* implementation.
*/
public static Status replaceInappropriateControlPlaneStatus(Status status) {
checkArgument(status != null);
return INAPPROPRIATE_CONTROL_PLANE_STATUS.contains(status.getCode())
? Status.INTERNAL.withDescription(
"Inappropriate status code from control plane: " + status.getCode() + " "
+ status.getDescription()).withCause(status.getCause()) : status;
}
/**
* Checks whether the given item exists in the iterable. This is copied from Guava Collect's
* {@code Iterables.contains()} because Guava Collect is not Android-friendly thus core can't

76
core/src/test/java/io/grpc/internal/GrpcUtilTest.java
View File

@ -16,6 +16,7 @@
package io.grpc.internal;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
@ -27,19 +28,26 @@ import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import com.google.common.collect.Lists;
import io.grpc.CallOptions;
import io.grpc.ClientStreamTracer;
import io.grpc.LoadBalancer.PickResult;
import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.Status.Code;
import io.grpc.internal.ClientStreamListener.RpcProgress;
import io.grpc.internal.GrpcUtil.Http2Error;
import io.grpc.testing.TestMethodDescriptors;
import java.util.ArrayList;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
/** Unit tests for {@link GrpcUtil}. */
@RunWith(JUnit4.class)
@ -51,6 +59,11 @@ public class GrpcUtilTest {
@SuppressWarnings("deprecation") // https://github.com/grpc/grpc-java/issues/7467
@Rule public final ExpectedException thrown = ExpectedException.none();
@Rule public final MockitoRule mocks = MockitoJUnit.rule();
@Captor
private ArgumentCaptor<Status> statusCaptor;
@Test
public void http2ErrorForCode() {
@ -258,6 +271,69 @@ public class GrpcUtilTest {
verify(listener).closed(eq(status), eq(RpcProgress.PROCESSED), any(Metadata.class));
}
/* Status codes that a control plane should not be returned get replaced by INTERNAL. */
@Test
public void getTransportFromPickResult_errorPickResult_noInappropriateControlPlaneStatus() {
// These are NOT appropriate for a control plane to return.
ArrayList<Status> inappropriateStatus = Lists.newArrayList(
Status.INVALID_ARGUMENT.withDescription("bad one").withCause(new RuntimeException()),
Status.NOT_FOUND.withDescription("not here").withCause(new RuntimeException()),
Status.ALREADY_EXISTS.withDescription("not again").withCause(new RuntimeException()),
Status.FAILED_PRECONDITION.withDescription("naah").withCause(new RuntimeException()),
Status.ABORTED.withDescription("nope").withCause(new RuntimeException()),
Status.OUT_OF_RANGE.withDescription("outta range").withCause(new RuntimeException()),
Status.DATA_LOSS.withDescription("lost").withCause(new RuntimeException()));
for (Status status : inappropriateStatus) {
PickResult pickResult = PickResult.withError(status);
ClientTransport transport = GrpcUtil.getTransportFromPickResult(pickResult, false);
ClientStream stream = transport.newStream(
TestMethodDescriptors.voidMethod(), new Metadata(), CallOptions.DEFAULT,
tracers);
ClientStreamListener listener = mock(ClientStreamListener.class);
stream.start(listener);
verify(listener).closed(statusCaptor.capture(), eq(RpcProgress.PROCESSED),
any(Metadata.class));
Status usedStatus = statusCaptor.getValue();
assertThat(usedStatus.getCode()).isEqualTo(Code.INTERNAL);
assertThat(usedStatus.getDescription()).contains("Inappropriate status");
assertThat(usedStatus.getCause()).isInstanceOf(RuntimeException.class);
}
}
/* Status codes a control plane can return are not replaced. */
@Test
public void getTransportFromPickResult_errorPickResult_appropriateControlPlaneStatus() {
// These ARE appropriate for a control plane to return.
ArrayList<Status> inappropriateStatus = Lists.newArrayList(
Status.CANCELLED,
Status.UNKNOWN,
Status.DEADLINE_EXCEEDED,
Status.PERMISSION_DENIED,
Status.RESOURCE_EXHAUSTED,
Status.UNIMPLEMENTED,
Status.INTERNAL,
Status.UNAVAILABLE,
Status.UNAUTHENTICATED);
for (Status status : inappropriateStatus) {
PickResult pickResult = PickResult.withError(status);
ClientTransport transport = GrpcUtil.getTransportFromPickResult(pickResult, false);
ClientStream stream = transport.newStream(
TestMethodDescriptors.voidMethod(), new Metadata(), CallOptions.DEFAULT,
tracers);
ClientStreamListener listener = mock(ClientStreamListener.class);
stream.start(listener);
verify(listener).closed(eq(status), eq(RpcProgress.PROCESSED), any(Metadata.class));
}
}
@Test
public void getTransportFromPickResult_dropPickResult_waitForReady() {
Status status = Status.UNAVAILABLE;