Skip to content

Commit

Permalink
Merge pull request #33162 from cescoffier/grpc-reflection-1.0.alpha
Browse files Browse the repository at this point in the history 
Expose gRPC Reflection service v1 and v1.alpha
  • Loading branch information
@cescoffier
cescoffier authored May 11, 2023
2 parents 50be8db + fd1dec1 commit 3a10b2e
Show file tree
Hide file tree
Showing 11 changed files with 663 additions and 18 deletions.
2 changes: 2 additions & 0 deletions docs/src/main/asciidoc/grpc-service-implementation.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,8 @@ This service allows tools like https://github.com/fullstorydev/grpcurl[grpcurl]
The reflection service is enabled by default in _dev_ mode.
In test or production mode, you need to enable it explicitly by setting `quarkus.grpc.server.enable-reflection-service` to `true`.

NOTE: Quarkus exposes both the reflection service `v1` and `v1alpha`.

== Scaling
By default, quarkus-grpc starts a single gRPC server running on a single event loop.

Expand Down
14 changes: 12 additions & 2 deletions ...ions/grpc/deployment/src/test/java/io/quarkus/grpc/client/MultipleStubsInjectionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,18 @@
import org.junit.jupiter.api.extension.RegisterExtension;

import io.grpc.Channel;
import io.grpc.examples.goodbyeworld.*;
import io.grpc.examples.helloworld.*;
import io.grpc.examples.goodbyeworld.FarewellGrpc;
import io.grpc.examples.goodbyeworld.GoodbyeReply;
import io.grpc.examples.goodbyeworld.GoodbyeReplyOrBuilder;
import io.grpc.examples.goodbyeworld.GoodbyeRequest;
import io.grpc.examples.goodbyeworld.GoodbyeRequestOrBuilder;
import io.grpc.examples.goodbyeworld.MutinyFarewellGrpc;
import io.grpc.examples.helloworld.GreeterGrpc;
import io.grpc.examples.helloworld.HelloReply;
import io.grpc.examples.helloworld.HelloReplyOrBuilder;
import io.grpc.examples.helloworld.HelloRequest;
import io.grpc.examples.helloworld.HelloRequestOrBuilder;
import io.grpc.examples.helloworld.MutinyGreeterGrpc;
import io.quarkus.grpc.GrpcClient;
import io.quarkus.grpc.server.services.GoodbyeService;
import io.quarkus.grpc.server.services.HelloService;
Expand Down
296 changes: 296 additions & 0 deletions extensions/grpc/deployment/src/test/java/io/quarkus/grpc/server/GrpcReflectionAlphaTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,296 @@
package io.quarkus.grpc.server;

import static org.assertj.core.api.Assertions.assertThat;
import static org.awaitility.Awaitility.await;

import java.util.Arrays;
import java.util.List;
import java.util.concurrent.Flow;

import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import com.google.protobuf.ByteString;

import grpc.health.v1.HealthGrpc;
import grpc.reflection.v1alpha.MutinyServerReflectionGrpc;
import grpc.reflection.v1alpha.Reflection;
import io.grpc.Status;
import io.grpc.reflection.testing.MutinyReflectableServiceGrpc;
import io.grpc.reflection.testing.ReflectionTestDepthThreeProto;
import io.grpc.reflection.testing.ReflectionTestDepthTwoProto;
import io.grpc.reflection.testing.ReflectionTestProto;
import io.grpc.reflection.testing.Reply;
import io.grpc.reflection.testing.Request;
import io.quarkus.grpc.GrpcClient;
import io.quarkus.grpc.GrpcService;
import io.quarkus.test.QuarkusUnitTest;
import io.smallrye.mutiny.Multi;
import io.smallrye.mutiny.Uni;
import io.smallrye.mutiny.operators.multi.processors.UnicastProcessor;

/**
* Check the behavior of the reflection service (v1alpha)
*/
public class GrpcReflectionAlphaTest {

@RegisterExtension
static final QuarkusUnitTest config = new QuarkusUnitTest().setArchiveProducer(
() -> ShrinkWrap.create(JavaArchive.class)
.addPackage(HealthGrpc.class.getPackage())
.addPackage(MutinyReflectableServiceGrpc.class.getPackage())
.addClass(MyReflectionService.class))
.setFlatClassPath(true)
.withConfigurationResource("reflection-config.properties");

@GrpcClient("reflection-service")
MutinyServerReflectionGrpc.MutinyServerReflectionStub reflection;

private UnicastProcessor<Reflection.ServerReflectionRequest> processor;
private ResettableSubscriber<Reflection.ServerReflectionResponse> subscriber;

@BeforeEach
public void setUp() {
processor = UnicastProcessor.create();
subscriber = new ResettableSubscriber<>();
}

@AfterEach
public void cleanUp() {
processor.onComplete();
subscriber.cancel();
}

@Test
public void testRetrievingListOfServices() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder().setHost("localhost")
.setListServices("").build();

Reflection.ServerReflectionResponse response = invoke(request);
List<Reflection.ServiceResponse> list = response.getListServicesResponse().getServiceList();
assertThat(list).hasSize(2)
.anySatisfy(r -> assertThat(r.getName()).isEqualTo("grpc.reflection.testing.ReflectableService"))
.anySatisfy(r -> assertThat(r.getName()).isEqualTo("grpc.health.v1.Health"));
}

@Test
public void testRetrievingFilesByFileName() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileByFilename("reflection/reflection_test_depth_three.proto")
.build();

Reflection.ServerReflectionResponse expected = Reflection.ServerReflectionResponse.newBuilder()
.setValidHost("localhost")
.setOriginalRequest(request)
.setFileDescriptorResponse(
Reflection.FileDescriptorResponse.newBuilder()
.addFileDescriptorProto(
ReflectionTestDepthThreeProto.getDescriptor().toProto().toByteString())
.build())
.build();

Reflection.ServerReflectionResponse response = invoke(request);
assertThat(response).isEqualTo(expected);
}

@Test
public void testRetrievingFilesByFileNameWithUnknownFileName() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileByFilename("reflection/unknown.proto")
.build();

Reflection.ServerReflectionResponse response = invoke(request);
assertThat(response.getErrorResponse().getErrorCode()).isEqualTo(Status.Code.NOT_FOUND.value());
}

private Reflection.ServerReflectionResponse invoke(Reflection.ServerReflectionRequest request) {
subscriber.reset();
Multi<Reflection.ServerReflectionResponse> multi = reflection.serverReflectionInfo(processor);
multi.subscribe().withSubscriber(subscriber);
subscriber.awaitForSubscription();
processor.onNext(request);
return subscriber.awaitAndGetLast();
}

@Test
public void testRetrievingFilesContainingSymbol() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileContainingSymbol("grpc.reflection.testing.ReflectableService.Method")
.build();

List<ByteString> responses = Arrays.asList(
ReflectionTestProto.getDescriptor().toProto().toByteString(),
ReflectionTestDepthTwoProto.getDescriptor().toProto().toByteString(),
ReflectionTestDepthThreeProto.getDescriptor().toProto().toByteString());

Reflection.ServerReflectionResponse response = invoke(request);
List<ByteString> list = response.getFileDescriptorResponse().getFileDescriptorProtoList();
assertThat(list).containsExactlyInAnyOrderElementsOf(responses);
}

@Test
public void testRetrievingFilesContainingUnknownSymbol() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileContainingSymbol("grpc.reflection.testing.ReflectableService.UnknownMethod")
.build();

Reflection.ServerReflectionResponse response = invoke(request);
List<ByteString> list = response.getFileDescriptorResponse().getFileDescriptorProtoList();
assertThat(list).isEmpty();
assertThat(response.getErrorResponse().getErrorMessage()).contains("UnknownMethod");
assertThat(response.getErrorResponse().getErrorCode()).isEqualTo(Status.Code.NOT_FOUND.value());
}

@Test
public void testRetrievingFilesContainingNestedSymbol() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileContainingSymbol("grpc.reflection.testing.NestedTypeOuter.Middle.Inner")
.build();
Reflection.ServerReflectionResponse expected = Reflection.ServerReflectionResponse.newBuilder()
.setValidHost("localhost")
.setOriginalRequest(request)
.setFileDescriptorResponse(
Reflection.FileDescriptorResponse.newBuilder()
.addFileDescriptorProto(
ReflectionTestDepthThreeProto.getDescriptor().toProto().toByteString())
.build())
.build();
Reflection.ServerReflectionResponse resp = invoke(request);
assertThat(resp).isEqualTo(expected);
}

@Test
public void testRetrievingFilesContainingExtension() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileContainingExtension(
Reflection.ExtensionRequest.newBuilder()
.setContainingType("grpc.reflection.testing.ThirdLevelType")
.setExtensionNumber(100)
.build())
.build();

List<ByteString> expected = Arrays.asList(
ReflectionTestProto.getDescriptor().toProto().toByteString(),
ReflectionTestDepthTwoProto.getDescriptor().toProto().toByteString(),
ReflectionTestDepthThreeProto.getDescriptor().toProto().toByteString());

Reflection.ServerReflectionResponse response = invoke(request);
assertThat(response.getFileDescriptorResponse().getFileDescriptorProtoList())
.containsExactlyInAnyOrderElementsOf(expected);
}

@Test
public void testRetrievingFilesContainingNestedExtension() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setFileContainingExtension(
Reflection.ExtensionRequest.newBuilder()
.setContainingType("grpc.reflection.testing.ThirdLevelType")
.setExtensionNumber(101)
.build())
.build();

Reflection.ServerReflectionResponse expected = Reflection.ServerReflectionResponse.newBuilder()
.setValidHost("localhost")
.setOriginalRequest(request)
.setFileDescriptorResponse(
Reflection.FileDescriptorResponse.newBuilder()
.addFileDescriptorProto(
ReflectionTestDepthTwoProto.getDescriptor().toProto().toByteString())
.addFileDescriptorProto(
ReflectionTestDepthThreeProto.getDescriptor().toProto().toByteString())
.build())
.build();

Reflection.ServerReflectionResponse response = invoke(request);
assertThat(response).isEqualTo(expected);
}

@Test
public void testRetrievingAllExtensionNumbersOfType() {
Reflection.ServerReflectionRequest request = Reflection.ServerReflectionRequest.newBuilder()
.setHost("localhost")
.setAllExtensionNumbersOfType("grpc.reflection.testing.ThirdLevelType")
.build();

List<Integer> expected = Arrays.asList(100, 101);

Reflection.ServerReflectionResponse response = invoke(request);
List<Integer> list = response.getAllExtensionNumbersResponse().getExtensionNumberList();
assertThat(list).containsExactlyInAnyOrderElementsOf(expected);
}

private static class ResettableSubscriber<T> implements Flow.Subscriber<T> {

private Flow.Subscription subscription;
private volatile T last;
private boolean completed;
private Throwable failure;

@Override
public void onSubscribe(Flow.Subscription subscription) {
this.subscription = subscription;
}

public void reset() {
this.subscription = null;
}

public void awaitForSubscription() {
await().until(() -> subscription != null);
}

public T awaitAndGetLast() {
validate();
last = null;
subscription.request(1);
await().until(() -> last != null);
return last;
}

@Override
public void onNext(T t) {
last = t;
}

@Override
public void onError(Throwable throwable) {
this.failure = throwable;
}

@Override
public void onComplete() {
this.completed = true;
}

private void validate() {
if (this.failure != null || this.completed) {
throw new IllegalStateException("Subscriber already in a terminal state");
}
}

public void cancel() {
this.subscription.cancel();
}
}

@GrpcService
public static class MyReflectionService extends MutinyReflectableServiceGrpc.ReflectableServiceImplBase {
@Override
public Uni<Reply> method(Request request) {
String message = request.getMessage();
return Uni.createFrom().item(Reply.newBuilder().setMessage(message).build());
}
}

}
6 changes: 5 additions & 1 deletion ...eployment/src/test/java/io/quarkus/grpc/server/interceptors/FailingInInterceptorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@
import io.grpc.ServerInterceptor;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import io.grpc.examples.helloworld.*;
import io.grpc.examples.helloworld.Greeter;
import io.grpc.examples.helloworld.GreeterBean;
import io.grpc.examples.helloworld.GreeterGrpc;
import io.grpc.examples.helloworld.HelloReply;
import io.grpc.examples.helloworld.HelloRequest;
import io.quarkus.grpc.GlobalInterceptor;
import io.quarkus.grpc.GrpcClient;
import io.quarkus.grpc.server.services.HelloService;
Expand Down
6 changes: 5 additions & 1 deletion extensions/grpc/deployment/src/test/resources/reflection-config.properties
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
quarkus.grpc.server.enable-reflection-service=true

quarkus.grpc.clients.reflection-service.host=localhost
quarkus.grpc.clients.reflection-service.port=9001
quarkus.grpc.server.enable-reflection-service=true

quarkus.grpc.clients.reflection-service-alpha.host=localhost
quarkus.grpc.clients.reflection-service-alpha.port=9001
17 changes: 12 additions & 5 deletions extensions/grpc/runtime/src/main/java/io/quarkus/grpc/runtime/GrpcServerRecorder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
import io.quarkus.grpc.runtime.devmode.GrpcHotReplacementInterceptor;
import io.quarkus.grpc.runtime.devmode.GrpcServerReloader;
import io.quarkus.grpc.runtime.health.GrpcHealthStorage;
import io.quarkus.grpc.runtime.reflection.ReflectionService;
import io.quarkus.grpc.runtime.reflection.ReflectionServiceV1;
import io.quarkus.grpc.runtime.reflection.ReflectionServiceV1alpha;
import io.quarkus.grpc.runtime.supports.CompressionInterceptor;
import io.quarkus.grpc.runtime.supports.blocking.BlockingServerInterceptor;
import io.quarkus.grpc.spi.GrpcBuilderProvider;
Expand Down Expand Up @@ -162,10 +163,15 @@ private void buildGrpcServer(Vertx vertx, GrpcServerConfiguration configuration,

if (reflectionServiceEnabled) {
LOGGER.info("Registering gRPC reflection service");
ReflectionService reflectionService = new ReflectionService(definitions);
ServerServiceDefinition serviceDefinition = ServerInterceptors.intercept(reflectionService, globalInterceptors);
ReflectionServiceV1 reflectionServiceV1 = new ReflectionServiceV1(definitions);
ReflectionServiceV1alpha reflectionServiceV1alpha = new ReflectionServiceV1alpha(definitions);
ServerServiceDefinition serviceDefinition = ServerInterceptors.intercept(reflectionServiceV1, globalInterceptors);
GrpcServiceBridge bridge = GrpcServiceBridge.bridge(serviceDefinition);
bridge.bind(server);
ServerServiceDefinition serviceDefinitionAlpha = ServerInterceptors.intercept(reflectionServiceV1alpha,
globalInterceptors);
GrpcServiceBridge bridgeAlpha = GrpcServiceBridge.bridge(serviceDefinitionAlpha);
bridgeAlpha.bind(server);
}

initHealthStorage();
Expand Down Expand Up @@ -386,7 +392,7 @@ private void devModeReload(GrpcContainer grpcContainer, Vertx vertx, GrpcServerC
definitions.add(service.definition);
}

ServerServiceDefinition reflectionService = new ReflectionService(definitions).bindService();
ServerServiceDefinition reflectionService = new ReflectionServiceV1(definitions).bindService();

for (ServerMethodDefinition<?, ?> method : reflectionService.getMethods()) {
methods.put(method.getMethodDescriptor().getFullMethodName(), method);
Expand Down Expand Up @@ -491,7 +497,8 @@ private Map.Entry<Integer, Server> buildServer(Vertx vertx, GrpcServerConfigurat

if (reflectionServiceEnabled) {
LOGGER.info("Registering gRPC reflection service");
builder.addService(new ReflectionService(definitions));
builder.addService(new ReflectionServiceV1(definitions));
builder.addService(new ReflectionServiceV1alpha(definitions));
}

for (ServerInterceptor serverInterceptor : grpcContainer.getSortedGlobalInterceptors()) {
Expand Down
Loading

0 comments on commit 3a10b2e

Please sign in to comment.