Polishing.

Moves the ordering from the security access exception handler class to
the bean definition in the `SecurityAutoConfiguration`.

Adds an auto-configuration test to ensure user-defined exception
handlers can be ordered around the security exception handler.

Adds an auto-configuration test to ensure user-defined exception
handlers can be ordered in general.

Original Pull Request #371

Signed-off-by: onobc <chris.bono@gmail.com>

Author: onobc

spring-grpc-core/src/main/java/org/springframework/grpc/server/security/SecurityGrpcExceptionHandler.java

@@ -20,24 +20,22 @@
 import org.apache.commons.logging.LogFactory;
 import org.jspecify.annotations.Nullable;
 
-import org.springframework.core.Ordered;
 import org.springframework.grpc.server.exception.GrpcExceptionHandler;
 import org.springframework.security.access.AccessDeniedException;
 import org.springframework.security.core.AuthenticationException;
 
 import io.grpc.Status;
 import io.grpc.StatusException;
 
-public class SecurityGrpcExceptionHandler implements GrpcExceptionHandler, Ordered {
+/**
+ * Exception handler for server-side exceptions.
+ *
+ * @author Dave Syer
+ */
+public class SecurityGrpcExceptionHandler implements GrpcExceptionHandler {
 
 	private static final Log logger = LogFactory.getLog(SecurityGrpcExceptionHandler.class);
 
-	private final int order;
-
-	public SecurityGrpcExceptionHandler(int order) {
-		this.order = order;
-	}
-
 	@Override
 	public @Nullable StatusException handleException(Throwable exception) {
 		if (exception instanceof AuthenticationException) {
@@ -55,9 +53,4 @@ public SecurityGrpcExceptionHandler(int order) {
 		return null;
 	}
 
-	@Override
-	public int getOrder() {
-		return this.order;
-	}
-
 }

spring-grpc-server-spring-boot-autoconfigure/src/main/java/org/springframework/boot/grpc/server/autoconfigure/security/GrpcSecurityAutoConfiguration.java

@@ -34,6 +34,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.core.annotation.Order;
 import org.springframework.grpc.server.GlobalServerInterceptor;
 import org.springframework.grpc.server.exception.GrpcExceptionHandler;
 import org.springframework.grpc.server.security.CoroutineSecurityContextInterceptor;
@@ -55,6 +56,7 @@
  * @author Dave Syer
  * @author Chris Bono
  * @author Andrey Litvitski
+ * @author Thomas Skjolberg
  * @since 1.0.0
  */
 @AutoConfiguration(before = GrpcExceptionHandlerAutoConfiguration.class,
@@ -71,8 +73,9 @@ public final class GrpcSecurityAutoConfiguration {
 	static class ExceptionHandlerConfiguration {
 
 		@Bean
+		@Order(0)
 		GrpcExceptionHandler accessExceptionHandler() {
-			return new SecurityGrpcExceptionHandler(0);
+			return new SecurityGrpcExceptionHandler();
 		}
 
 	}

spring-grpc-server-spring-boot-autoconfigure/src/test/java/org/springframework/boot/grpc/server/autoconfigure/exception/GrpcExceptionHandlerAutoConfigurationTests.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.grpc.server.autoconfigure.exception;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
 
 import org.assertj.core.api.InstanceOfAssertFactories;
 import org.junit.jupiter.api.Test;
@@ -25,7 +26,11 @@
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.annotation.Order;
 import org.springframework.grpc.server.GrpcServerFactory;
+import org.springframework.grpc.server.exception.CompositeGrpcExceptionHandler;
 import org.springframework.grpc.server.exception.GrpcExceptionHandler;
 import org.springframework.grpc.server.exception.GrpcExceptionHandlerInterceptor;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
@@ -121,9 +126,43 @@ void whenHasUserDefinedGrpcExceptionHandlerInterceptorDoesNotAutoConfigureBean()
 	void exceptionHandlerInterceptorAutoConfiguredAsExpected() {
 		this.contextRunner()
 			.run((context) -> assertThat(context).getBean(GrpcExceptionHandlerInterceptor.class)
-				.extracting("exceptionHandler.exceptionHandlers",
-						InstanceOfAssertFactories.array(GrpcExceptionHandler[].class))
+				.extracting("exceptionHandler")
+				.isInstanceOf(CompositeGrpcExceptionHandler.class)
+				.extracting("exceptionHandlers")
+				.asInstanceOf(InstanceOfAssertFactories.array(GrpcExceptionHandler[].class))
 				.containsExactly(context.getBean(GrpcExceptionHandler.class)));
 	}
 
+	@Test
+	void userDefinedExceptionHandlersCanBeOrdered() {
+		this.contextRunner()
+			.withUserConfiguration(UserExceptionHandlerConfig.class)
+			.run((context) -> assertThat(context).getBean(GrpcExceptionHandlerInterceptor.class)
+				.extracting("exceptionHandler.exceptionHandlers")
+				.asInstanceOf(InstanceOfAssertFactories.array(GrpcExceptionHandler[].class))
+				.startsWith(UserExceptionHandlerConfig.USER_EXCEPTION_HANDLER_BAR,
+						UserExceptionHandlerConfig.USER_EXCEPTION_HANDLER_FOO));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class UserExceptionHandlerConfig {
+
+		static GrpcExceptionHandler USER_EXCEPTION_HANDLER_FOO = mock();
+
+		static GrpcExceptionHandler USER_EXCEPTION_HANDLER_BAR = mock();
+
+		@Bean
+		@Order(200)
+		GrpcExceptionHandler userExceptionHandlerFoo() {
+			return USER_EXCEPTION_HANDLER_FOO;
+		}
+
+		@Bean
+		@Order(100)
+		GrpcExceptionHandler userExceptionHandlerBar() {
+			return USER_EXCEPTION_HANDLER_BAR;
+		}
+
+	}
+
 }

spring-grpc-server-spring-boot-autoconfigure/src/test/java/org/springframework/boot/grpc/server/autoconfigure/security/GrpcSecurityAutoConfigurationTests.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.grpc.server.autoconfigure.security;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
 
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
@@ -27,7 +28,9 @@
 import org.springframework.boot.logging.LogLevel;
 import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.annotation.Order;
 import org.springframework.grpc.server.GrpcServerFactory;
 import org.springframework.grpc.server.exception.GrpcExceptionHandler;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
@@ -110,10 +113,42 @@ void grpcSecurityAutoConfiguredAsExpected() {
 		});
 	}
 
+	@Test
+	void userDefinedExceptionHandlerCanBeOrderedAroundSecurityExceptionHandler() {
+		this.contextRunner().withUserConfiguration(UserExceptionHandlerConfig.class).run((context) -> {
+			GrpcExceptionHandler securityExceptionHandler = context.getBean("accessExceptionHandler",
+					SecurityGrpcExceptionHandler.class);
+			assertThat(context.getBeanProvider(GrpcExceptionHandler.class).orderedStream()).containsExactly(
+					UserExceptionHandlerConfig.USER_HANDLER_PRE_SECURITY_HANDLER, securityExceptionHandler,
+					UserExceptionHandlerConfig.USER_HANDLER_POST_SECURITY_HANDLER);
+		});
+	}
+
 	@EnableMethodSecurity
 	@Configuration(proxyBeanMethods = false)
 	static class ExtraConfiguration {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	static class UserExceptionHandlerConfig {
+
+		static GrpcExceptionHandler USER_HANDLER_PRE_SECURITY_HANDLER = mock();
+
+		static GrpcExceptionHandler USER_HANDLER_POST_SECURITY_HANDLER = mock();
+
+		@Bean
+		@Order(-10)
+		GrpcExceptionHandler userHandlerPreSecurityHandler() {
+			return USER_HANDLER_PRE_SECURITY_HANDLER;
+		}
+
+		@Bean
+		@Order(10)
+		GrpcExceptionHandler userHandlerPostSecurityHandler() {
+			return USER_HANDLER_POST_SECURITY_HANDLER;
+		}
+
+	}
+
 }