Add new abstraction for GrpcServerExecutorProvider

Author: dsyer

spring-grpc-core/src/test/java/org/springframework/grpc/client/GrpcClientFactoryTests.java

@@ -46,7 +46,7 @@ public class GrpcClientFactoryTests {
 
 	GrpcClientFactoryTests() {
 		Mockito.when(channelFactory.createChannel(Mockito.anyString(), Mockito.any()))
-				.thenReturn(Mockito.mock(ManagedChannel.class));
+			.thenReturn(Mockito.mock(ManagedChannel.class));
 		context.registerBean(GrpcChannelFactory.class, () -> channelFactory);
 		factory = new GrpcClientFactory();
 		factory.setApplicationContext(context);
@@ -75,7 +75,7 @@ void testCustomStubFactory() {
 	void testWithExplicitStubFactory() {
 		context.registerBean(OtherStubFactory.class, () -> new OtherStubFactory());
 		GrpcClientFactory.register(context, new GrpcClientRegistrationSpec("local", new Class[] { OtherStub.class })
-				.factory(OtherStubFactory.class));
+			.factory(OtherStubFactory.class));
 		assertThat(factory.getClient("local", OtherStub.class, null)).isNotNull();
 	}
 
@@ -96,21 +96,19 @@ void testCoroutineStubFactory() {
 		context.registerBean(CoroutineStubFactory.class, CoroutineStubFactory::new);
 		GrpcClientFactory.register(context,
 				GrpcClientRegistrationSpec.of("local")
-						.factory(CoroutineStubFactory.class)
-						.types(MyCoroutineStub.class));
+					.factory(CoroutineStubFactory.class)
+					.types(MyCoroutineStub.class));
 		assertThat(factory.getClient("local", MyCoroutineStub.class, null)).isNotNull();
 	}
 
 	@Test
 	void testCoroutineStubFactoryAfterDefault() {
 		context.registerBean(CoroutineStubFactory.class, CoroutineStubFactory::new);
+		GrpcClientFactory.register(context, GrpcClientRegistrationSpec.of("local").types(MyStub.class));
 		GrpcClientFactory.register(context,
 				GrpcClientRegistrationSpec.of("local")
-						.types(MyStub.class));
-		GrpcClientFactory.register(context,
-				GrpcClientRegistrationSpec.of("local")
-						.factory(CoroutineStubFactory.class)
-						.types(MyCoroutineStub.class));
+					.factory(CoroutineStubFactory.class)
+					.types(MyCoroutineStub.class));
 		assertThat(factory.getClient("local", MyCoroutineStub.class, null)).isNotNull();
 		assertThat(factory.getClient("local", MyStub.class, null)).isNotNull();
 	}

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

@@ -26,6 +26,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.core.Ordered;
 import org.springframework.grpc.autoconfigure.common.codec.GrpcCodecConfiguration;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
 import org.springframework.grpc.server.exception.ReactiveStubBeanDefinitionRegistrar;
@@ -88,6 +89,34 @@ <T extends ServerBuilder<T>> ServerBuilderCustomizer<T> decompressionServerConfi
 		return builder -> builder.decompressorRegistry(registry);
 	}
 
+	@ConditionalOnBean(GrpcServerExecutorProvider.class)
+	@Bean
+	<T extends ServerBuilder<T>> ServerBuilderCustomizer<T> executorServerConfigurer(
+			GrpcServerExecutorProvider provider) {
+		return new ServerBuilderCustomizerImplementation<T>(provider);
+	}
+
+	private final class ServerBuilderCustomizerImplementation<T extends ServerBuilder<T>>
+			implements ServerBuilderCustomizer<T>, Ordered {
+
+		private final GrpcServerExecutorProvider provider;
+
+		private ServerBuilderCustomizerImplementation(GrpcServerExecutorProvider provider) {
+			this.provider = provider;
+		}
+
+		@Override
+		public int getOrder() {
+			return 0;
+		}
+
+		@Override
+		public void customize(T builder) {
+			builder.executor(provider.getExecutor());
+		}
+
+	}
+
 	@ConditionalOnClass(name = "com.salesforce.reactivegrpc.common.Function")
 	@Configuration
 	@Import(ReactiveStubBeanDefinitionRegistrar.class)

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

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2024-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.grpc.autoconfigure.server;
+
+import java.util.concurrent.Executor;
+
+public interface GrpcServerExecutorProvider {
+
+	/**
+	 * Returns a {@link Executor} for the gRPC server, if it needs tio be customized.
+	 * @return the executor to use for the gRPC server
+	 */
+	Executor getExecutor();
+
+}

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

@@ -18,17 +18,18 @@
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.grpc.autoconfigure.server.ConditionalOnGrpcServerEnabled;
+import org.springframework.grpc.autoconfigure.server.GrpcServerExecutorProvider;
 import org.springframework.grpc.autoconfigure.server.GrpcServerFactoryAutoConfiguration;
 import org.springframework.grpc.autoconfigure.server.exception.GrpcExceptionHandlerAutoConfiguration;
 import org.springframework.grpc.server.GlobalServerInterceptor;
-import org.springframework.grpc.server.ServerBuilderCustomizer;
 import org.springframework.grpc.server.exception.GrpcExceptionHandler;
 import org.springframework.grpc.server.security.GrpcSecurity;
 import org.springframework.grpc.server.security.SecurityContextServerInterceptor;
@@ -39,7 +40,6 @@
 import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration;
 import org.springframework.security.web.SecurityFilterChain;
 
-import io.grpc.ServerBuilder;
 import io.grpc.internal.GrpcUtil;
 
 @ConditionalOnClass(ObjectPostProcessor.class)
@@ -91,9 +91,9 @@ public SecurityContextServerInterceptor securityContextInterceptor() {
 	}
 
 	@Bean
-	public <T extends ServerBuilder<T>> ServerBuilderCustomizer<T> securityContextExecutorCustomizer() {
-		return (serverBuilder) -> serverBuilder
-			.executor(new DelegatingSecurityContextExecutor(GrpcUtil.SHARED_CHANNEL_EXECUTOR.create()));
+	@ConditionalOnMissingBean(GrpcServerExecutorProvider.class)
+	public GrpcServerExecutorProvider grpcServerExecutorProvider() {
+		return () -> new DelegatingSecurityContextExecutor(GrpcUtil.SHARED_CHANNEL_EXECUTOR.create());
 	}
 
 }