Skip to content

add gRPC exception advice support for factory beans #266

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

add gRPC exception advice support for factory beans #266

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9d0ed77
add gRPC exception advice support for factory beans
Nov 24, 2021
c4b40eb
cleanup code
Nov 24, 2021
a4bf9eb
address NPE
Nov 24, 2021
c69b193
fix formatting
Nov 24, 2021
01f6d42
more formatting fixes
Nov 24, 2021
fc47852
add tests
Nov 29, 2021
860950d
more fixes
Nov 29, 2021
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
72 changes: 40 additions & 32 deletions ...boot-starter-demo/src/test/java/org/lognet/springboot/grpc/recovery/GRpcRecoveryTest.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
package org.lognet.springboot.grpc.recovery;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.isA;
import static org.hamcrest.Matchers.notNullValue;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
@@ -15,25 +30,11 @@
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.test.mock.mockito.SpyBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.isA;
import static org.hamcrest.Matchers.notNullValue;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = {DemoApp.class}, webEnvironment = NONE)
@ActiveProfiles({"disable-security"})
@@ -43,6 +44,7 @@ public class GRpcRecoveryTest extends GrpcServerTestBase {
static class CheckedException extends Exception {

}

static class CheckedException1 extends Exception {

}
@@ -59,16 +61,25 @@ static class Exception1 extends RuntimeException {

}

@GRpcServiceAdvice
static class BeanCustomErrorHandler {

@GRpcExceptionHandler
public Status handleA(ExceptionA e, GRpcExceptionScope scope) {
return Status.NOT_FOUND;
}
}

@TestConfiguration
static class Cfg {

@Bean
public BeanCustomErrorHandler otherErrorHandler() {
return new BeanCustomErrorHandler();
}

@GRpcServiceAdvice
static class CustomErrorHandler {
@GRpcExceptionHandler
public Status handleA(ExceptionA e, GRpcExceptionScope scope) {
return Status.NOT_FOUND;
}

@GRpcExceptionHandler
public Status handleB(ExceptionB e, GRpcExceptionScope scope) {
@@ -87,7 +98,6 @@ public Status handle(Exception e, GRpcExceptionScope scope) {
}
}


@GRpcService
static class CustomService extends CustomServiceGrpc.CustomServiceImplBase {

@@ -150,12 +160,14 @@ public Status handleB(ExceptionB e, GRpcExceptionScope scope) {
@SpyBean
private Cfg.CustomErrorHandler handler;

@SpyBean
private BeanCustomErrorHandler beanErrorHandler;


@Test
public void streamingServiceErrorHandlerTest() throws ExecutionException, InterruptedException, TimeoutException {



final CompletableFuture<Throwable> errorFuture = new CompletableFuture<>();
final StreamObserver<Custom.CustomReply> reply = new StreamObserver<Custom.CustomReply>() {

@@ -180,15 +192,12 @@ public void onCompleted() {
requests.onCompleted();





final Throwable actual = errorFuture.get(20, TimeUnit.SECONDS);
assertThat(actual, notNullValue());
assertThat(actual, isA(StatusRuntimeException.class));
assertThat(((StatusRuntimeException)actual).getStatus(), is(Status.RESOURCE_EXHAUSTED));
assertThat(((StatusRuntimeException) actual).getStatus(), is(Status.RESOURCE_EXHAUSTED));

Mockito.verify(srv,times(1)).handle(any(CheckedException1.class),any());
Mockito.verify(srv, times(1)).handle(any(CheckedException1.class), any());

}

@@ -205,9 +214,8 @@ public void checkedExceptionHandlerTest() {

Mockito.verify(srv, never()).handleB(any(), any());


Mockito.verify(beanErrorHandler, never()).handleA(any(), any());
Mockito.verify(handler, never()).handle(any(), any());
Mockito.verify(handler, never()).handleA(any(), any());
Mockito.verify(handler, times(1)).handleCheckedException(any(CheckedException.class), any());
Mockito.verify(handler, never()).handleB(any(), any());

@@ -229,7 +237,7 @@ public void globalHandlerTest() {


Mockito.verify(handler, never()).handle(any(), any());
Mockito.verify(handler, times(1)).handleA(any(), any());
Mockito.verify(beanErrorHandler, times(1)).handleA(any(), any());
Mockito.verify(handler, never()).handleB(any(), any());


@@ -249,7 +257,7 @@ public void globalHandlerWithExceptionHierarchyTest() {
Mockito.verify(srv, never()).handleB(any(), any());


Mockito.verify(handler, never()).handleA(any(), any());
Mockito.verify(beanErrorHandler, never()).handleA(any(), any());
Mockito.verify(handler, never()).handleB(any(), any());
Mockito.verify(handler, times(1)).handle(any(), any());

@@ -272,9 +280,9 @@ public void privateHandlerHasHigherPrecedence() {
final String testTrailer = statusRuntimeException.getTrailers().get(Metadata.Key.of("test", Metadata.ASCII_STRING_MARSHALLER));
assertThat(testTrailer, is("5"));



Mockito.verify(beanErrorHandler, never()).handleA(any(), any());
Mockito.verify(handler, never()).handle(any(), any());
Mockito.verify(handler, never()).handleA(any(), any());
Mockito.verify(handler, never()).handleB(any(), any());

}
16 changes: 14 additions & 2 deletions grpc-spring-boot-starter-gradle-plugin/src/main/resources/grpc-spring-boot.gradle
View file
Original file line number Diff line number Diff line change
@@ -40,11 +40,23 @@ sourceSets.configureEach{s->

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:${grpcSpringBoot.protocVersion.get()}"

// for apple m1, please add protoc_platform=osx-x86_64 in $HOME/.gradle/gradle.properties
Copy link
Author

Choose a reason for hiding this comment

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

On Apple M1 this project currently does not build due to missing artifacts. This is a recommended workaround. I can remove this again if you want.

Copy link
Collaborator

Choose a reason for hiding this comment

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

If the platform can't be inferred dynamically, please add it as configuration option here+ readme

Copy link
Author

Choose a reason for hiding this comment

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

This is just a workaround and should not be needed as a property of this Spring boot starter. In case we still want to have it I'd suggest to make it as part of another pull request.

In the meantime, I will revert these changes to the grpc-spring-boot.gradle file.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, this is not starter's feature, but gradle plugin's one. You can have this logic in extension class and grpc-spring-boot.gradle in separate PR.

if (project.hasProperty('protoc_platform')) {
artifact = "com.google.protobuf:protoc:${grpcSpringBoot.protocVersion.get()}:${protoc_platform}"
} else {
artifact = "com.google.protobuf:protoc:${grpcSpringBoot.protocVersion.get()}"
}
}

plugins {
grpc {
artifact = "io.grpc:protoc-gen-grpc-java:${grpcSpringBoot.grpcVersion.get()}"
// for apple m1, please add protoc_platform=osx-x86_64 in $HOME/.gradle/gradle.properties
if (project.hasProperty('protoc_platform')) {
artifact = "io.grpc:protoc-gen-grpc-java:${grpcSpringBoot.grpcVersion.get()}:${protoc_platform}"
} else {
artifact = "io.grpc:protoc-gen-grpc-java:${grpcSpringBoot.grpcVersion.get()}"
}
}
}

22 changes: 17 additions & 5 deletions ...rc/main/java/org/lognet/springboot/grpc/autoconfigure/OnMissingErrorHandlerCondition.java
View file
Original file line number Diff line number Diff line change
@@ -3,12 +3,15 @@
import org.lognet.springboot.grpc.recovery.GRpcExceptionHandler;
import org.lognet.springboot.grpc.recovery.GRpcServiceAdvice;
import org.lognet.springboot.grpc.recovery.HandlerMethod;
import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.MethodIntrospector;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.core.type.MethodMetadata;
import org.springframework.util.ReflectionUtils;

import java.lang.reflect.Method;
@@ -24,10 +27,9 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM
.get("value");

ReflectionUtils.MethodFilter f = method -> AnnotatedElementUtils.hasAnnotation(method, GRpcExceptionHandler.class);
for(String adviceBeanName:context.getBeanFactory().getBeanNamesForAnnotation(GRpcServiceAdvice.class)){
final String beanClassName = context.getBeanFactory().getBeanDefinition(adviceBeanName)
.getBeanClassName();

for(String adviceBeanName : context.getBeanFactory().getBeanNamesForAnnotation(GRpcServiceAdvice.class)){
BeanDefinition beanDefinition = context.getBeanFactory().getBeanDefinition(adviceBeanName);
String beanClassName = getBeanClassName(beanDefinition);
try {
for (Method method : MethodIntrospector.selectMethods(Class.forName(beanClassName), f)) {
final Optional<Class<? extends Throwable>> handledException = HandlerMethod.getHandledException(method, false);
@@ -40,10 +42,20 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM
}
}
} catch (ClassNotFoundException e) {
throw new IllegalStateException(e);
throw new IllegalStateException(e);
}
};

return ConditionOutcome.match();
}

private String getBeanClassName(BeanDefinition beanDefinition) {
if(beanDefinition instanceof AnnotatedBeanDefinition){
MethodMetadata factoryMethodMetadata = ((AnnotatedBeanDefinition) beanDefinition).getFactoryMethodMetadata();
if(factoryMethodMetadata != null){
return factoryMethodMetadata.getReturnTypeName();
}
}
return beanDefinition.getBeanClassName();
}
}