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

gRPC dev UI: fix service names for service implementing the gRPC interface #19536

Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

import io.quarkus.builder.item.MultiBuildItem;

final class DelegatingGrpcBeanBuildItem extends MultiBuildItem {
final ClassInfo generatedBean;
final ClassInfo userDefinedBean;
public final class DelegatingGrpcBeanBuildItem extends MultiBuildItem {
public final ClassInfo generatedBean;
public final ClassInfo userDefinedBean;

DelegatingGrpcBeanBuildItem(ClassInfo generatedBean, ClassInfo userDefinedBean) {
this.generatedBean = generatedBean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import java.util.Map;
import java.util.Set;

import javax.inject.Singleton;

import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
import org.jboss.jandex.IndexView;
Expand All @@ -26,6 +28,10 @@
import io.grpc.MethodDescriptor.PrototypeMarshaller;
import io.grpc.ServiceDescriptor;
import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.arc.deployment.GeneratedBeanBuildItem;
import io.quarkus.arc.deployment.GeneratedBeanGizmoAdaptor;
import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
import io.quarkus.arc.profile.IfBuildProfile;
import io.quarkus.arc.runtime.BeanLookupSupplier;
import io.quarkus.deployment.IsDevelopment;
import io.quarkus.deployment.annotations.BuildProducer;
Expand All @@ -39,8 +45,12 @@
import io.quarkus.dev.console.DevConsoleManager;
import io.quarkus.dev.testing.GrpcWebSocketProxy;
import io.quarkus.devconsole.spi.DevConsoleRuntimeTemplateInfoBuildItem;
import io.quarkus.gizmo.ClassCreator;
import io.quarkus.gizmo.MethodCreator;
import io.quarkus.grpc.deployment.DelegatingGrpcBeanBuildItem;
import io.quarkus.grpc.deployment.GrpcDotNames;
import io.quarkus.grpc.protoc.plugin.MutinyGrpcGenerator;
import io.quarkus.grpc.runtime.devmode.DelegatingGrpcBeansStorage;
import io.quarkus.grpc.runtime.devmode.GrpcDevConsoleRecorder;
import io.quarkus.grpc.runtime.devmode.GrpcServices;
import io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem;
Expand All @@ -57,6 +67,39 @@ public void devConsoleInfo(BuildProducer<AdditionalBeanBuildItem> beans,
new BeanLookupSupplier(GrpcServices.class)));
}

@IfBuildProfile("dev")
@BuildStep
void prepareDelegatingBeanStorage(
List<DelegatingGrpcBeanBuildItem> delegatingBeans,
BuildProducer<UnremovableBeanBuildItem> unremovableBeans,
BuildProducer<GeneratedBeanBuildItem> generatedBeans) {
String className = "io.quarkus.grpc.internal.DelegatingGrpcBeansStorageImpl";
try (ClassCreator classCreator = ClassCreator.builder()
.className(className)
.classOutput(new GeneratedBeanGizmoAdaptor(generatedBeans))
.superClass(DelegatingGrpcBeansStorage.class)
.build()) {
classCreator.addAnnotation(Singleton.class.getName());
MethodCreator constructor = classCreator
.getMethodCreator(io.quarkus.gizmo.MethodDescriptor.ofConstructor(className));
constructor.invokeSpecialMethod(io.quarkus.gizmo.MethodDescriptor.ofConstructor(DelegatingGrpcBeansStorage.class),
constructor.getThis());

for (DelegatingGrpcBeanBuildItem delegatingBean : delegatingBeans) {
constructor.invokeVirtualMethod(
io.quarkus.gizmo.MethodDescriptor.ofMethod(DelegatingGrpcBeansStorage.class, "addDelegatingMapping",
void.class,
String.class, String.class),
constructor.getThis(),
constructor.load(delegatingBean.userDefinedBean.name().toString()),
constructor.load(delegatingBean.generatedBean.name().toString()));
}
constructor.returnValue(null);
}

unremovableBeans.produce(UnremovableBeanBuildItem.beanClassNames(className));
}

@BuildStep(onlyIf = IsDevelopment.class)
public void collectMessagePrototypes(CombinedIndexBuildItem index,
// Dummy producer to ensure the build step is executed
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package io.quarkus.grpc.runtime.devmode;

import java.util.HashMap;
import java.util.Map;

public abstract class DelegatingGrpcBeansStorage {

private final Map<String, String> userClassesByGeneratedBean = new HashMap<>();

@SuppressWarnings("unused") // used from generated code
public void addDelegatingMapping(String userClassName, String delegatingBeanName) {
userClassesByGeneratedBean.put(delegatingBeanName, userClassName);
}

public String getUserClassName(String delegatingBeanName) {
return userClassesByGeneratedBean.get(delegatingBeanName);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public class GrpcServices extends AbstractMap<String, ServiceDefinitionAndStatus
@Inject
GrpcHealthStorage healthStorage;

@Inject
DelegatingGrpcBeansStorage delegatingBeansMapping;

public List<ServiceDefinitionAndStatus> getInfos() {
List<GrpcServiceDefinition> services = GrpcServerRecorder.getServices();
List<ServiceDefinitionAndStatus> infos = new ArrayList<>(services.size());
Expand Down Expand Up @@ -70,7 +73,12 @@ public String getServiceClass() {
if (definition.service instanceof Subclass) {
instanceClass = instanceClass.getSuperclass();
}
return instanceClass.getName();

String grpcBeanClassName = instanceClass.getName();

String userClass = delegatingBeansMapping.getUserClassName(grpcBeanClassName);

return userClass != null ? userClass : grpcBeanClassName;
}

public Collection<ServerMethodDefinition<?, ?>> getMethods() {
Expand Down