Refactor ClientInterceptorFilter usage to isolate in factories

Author: dsyer

spring-grpc-core/src/main/java/org/springframework/grpc/client/ClientInterceptorsConfigurer.java

@@ -21,10 +21,7 @@
 import java.util.List;
 
 import org.springframework.beans.factory.InitializingBean;
-import org.springframework.beans.factory.NoSuchBeanDefinitionException;
-import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
 import org.springframework.context.ApplicationContext;
-import org.springframework.core.log.LogAccessor;
 import org.springframework.grpc.internal.ApplicationContextBeanLookupUtils;
 
 import io.grpc.ClientInterceptor;
@@ -38,14 +35,10 @@
  */
 public class ClientInterceptorsConfigurer implements InitializingBean {
 
-	private final LogAccessor log = new LogAccessor(getClass());
-
 	private final ApplicationContext applicationContext;
 
 	private List<ClientInterceptor> globalInterceptors;
 
-	private ClientInterceptorFilter interceptorFilter;
-
 	public ClientInterceptorsConfigurer(ApplicationContext applicationContext) {
 		this.applicationContext = applicationContext;
 	}
@@ -65,9 +58,7 @@ protected void configureInterceptors(ManagedChannelBuilder<?> builder, List<Clie
 		// Add specific interceptors
 		allInterceptors.addAll(interceptors);
 		// Filter all interceptors
-		if (this.interceptorFilter != null) {
-			allInterceptors.removeIf(interceptor -> !this.interceptorFilter.filter(interceptor, factory));
-		}
+		allInterceptors.removeIf(interceptor -> !factory.supports(interceptor));
 		if (mergeWithGlobalInterceptors) {
 			ApplicationContextBeanLookupUtils.sortBeansIncludingOrderAnnotation(this.applicationContext,
 					ClientInterceptor.class, allInterceptors);
@@ -79,28 +70,11 @@ protected void configureInterceptors(ManagedChannelBuilder<?> builder, List<Clie
 	@Override
 	public void afterPropertiesSet() {
 		this.globalInterceptors = findGlobalInterceptors();
-		this.interceptorFilter = findInterceptorFilter();
 	}
 
 	private List<ClientInterceptor> findGlobalInterceptors() {
 		return ApplicationContextBeanLookupUtils.getBeansWithAnnotation(this.applicationContext,
 				ClientInterceptor.class, GlobalClientInterceptor.class);
 	}
 
-	private ClientInterceptorFilter findInterceptorFilter() {
-		try {
-			return this.applicationContext.getBean(ClientInterceptorFilter.class);
-		}
-		catch (NoUniqueBeanDefinitionException noUniqueBeanEx) {
-			this.log.warn(noUniqueBeanEx,
-					() -> "No unique ClientInterceptorFilter bean found. Consider defining a single bean or marking one as @Primary");
-			return null;
-		}
-		catch (NoSuchBeanDefinitionException ignored) {
-			this.log.debug(
-					() -> "No ClientInterceptorFilter bean found - filtering will not be applied to client interceptors.");
-			return null;
-		}
-	}
-
 }

spring-grpc-core/src/main/java/org/springframework/grpc/client/CompositeGrpcChannelFactory.java

@@ -21,6 +21,7 @@
 
 import org.springframework.util.Assert;
 
+import io.grpc.ClientInterceptor;
 import io.grpc.ManagedChannel;
 
 /**
@@ -49,6 +50,11 @@ public boolean supports(String target) {
 		return this.channelFactories.stream().anyMatch((cf) -> cf.supports(target));
 	}
 
+	@Override
+	public boolean supports(ClientInterceptor interceptor) {
+		return this.channelFactories.stream().anyMatch((cf) -> cf.supports(interceptor));
+	}
+
 	@Override
 	public ManagedChannel createChannel(final String target, ChannelBuilderOptions options) {
 		return this.channelFactories.stream()

spring-grpc-core/src/main/java/org/springframework/grpc/client/DefaultGrpcChannelFactory.java

@@ -24,9 +24,11 @@
 
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.core.log.LogAccessor;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 import io.grpc.ChannelCredentials;
+import io.grpc.ClientInterceptor;
 import io.grpc.Grpc;
 import io.grpc.ManagedChannel;
 import io.grpc.ManagedChannelBuilder;
@@ -52,10 +54,16 @@ public class DefaultGrpcChannelFactory<T extends ManagedChannelBuilder<T>>
 
 	private final ClientInterceptorsConfigurer interceptorsConfigurer;
 
+	private ClientInterceptorFilter interceptorFilter;
+
 	private ChannelCredentialsProvider credentials = ChannelCredentialsProvider.INSECURE;
 
 	private VirtualTargets targets = VirtualTargets.DEFAULT;
 
+	public void setInterceptorFilter(@Nullable ClientInterceptorFilter interceptorFilter) {
+		this.interceptorFilter = interceptorFilter;
+	}
+
 	/**
 	 * Construct a channel factory instance.
 	 * @param globalCustomizers the global customizers to apply to all created channels
@@ -82,6 +90,11 @@ public boolean supports(String target) {
 		return !target.startsWith("in-process:");
 	}
 
+	@Override
+	public boolean supports(ClientInterceptor interceptor) {
+		return this.interceptorFilter == null || this.interceptorFilter.filter(interceptor, this);
+	}
+
 	public void setVirtualTargets(VirtualTargets targets) {
 		this.targets = targets;
 	}

spring-grpc-core/src/main/java/org/springframework/grpc/client/GrpcChannelFactory.java

@@ -38,6 +38,15 @@ public interface GrpcChannelFactory {
 	 */
 	boolean supports(String target);
 
+	/**
+	 * Whether this factory supports the given global {@link ClientInterceptor}.
+	 * @param interceptor the client interceptor to check support for
+	 * @return whether this factory supports the given interceptor
+	 */
+	default boolean supports(ClientInterceptor interceptor) {
+		return true;
+	}
+
 	/**
 	 * Creates a {@link ManagedChannel} for the given target string. The target can be
 	 * either a valid nameresolver-compliant URI, an authority string as described in

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

@@ -68,8 +68,8 @@ private void customizeContextAndRunConfigurer(
 			List<ClientInterceptor> clientSpecificInterceptors, List<ClientInterceptor> expectedInterceptors) {
 		ManagedChannelBuilder<?> builder = Mockito.mock();
 		this.contextRunner().with(contextCustomizer).run((context) -> {
-			var factory = Mockito.mock(GrpcChannelFactory.class);
 			var configurer = context.getBean(ClientInterceptorsConfigurer.class);
+			var factory = new DefaultGrpcChannelFactory<>(List.of(), configurer);
 			configurer.configureInterceptors(builder, clientSpecificInterceptors, true, factory);
 			// NOTE: the interceptors are called in reverse order per builder contract
 			var expectedInterceptorsReversed = new ArrayList<>(expectedInterceptors);
@@ -131,13 +131,13 @@ void whenBlendInterceptorsFalseThenGlobalInterceptorsAddedFirst() {
 			ClientInterceptorsConfigurerTests.this.contextRunner()
 				.withUserConfiguration(GlobalClientInterceptorsConfig.class, ClientSpecificInterceptorsConfig.class)
 				.run((context) -> {
-					var factory = Mockito.mock(GrpcChannelFactory.class);
 					var interceptorA = context.getBean("interceptorA", ClientInterceptor.class);
 					var interceptorB = context.getBean("interceptorB", ClientInterceptor.class);
 					var clientSpecificInterceptors = List.of(interceptorB, interceptorA);
 					var expectedInterceptors = List.of(GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_BAR,
 							GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_FOO, interceptorB, interceptorA);
 					var configurer = context.getBean(ClientInterceptorsConfigurer.class);
+					var factory = new DefaultGrpcChannelFactory<>(List.of(), configurer);
 					configurer.configureInterceptors(builder, clientSpecificInterceptors, false, factory);
 					// NOTE: the interceptors are called in reverse order per builder
 					// contract
@@ -147,20 +147,19 @@ void whenBlendInterceptorsFalseThenGlobalInterceptorsAddedFirst() {
 				});
 		}
 
-		@SuppressWarnings("unchecked")
 		@Test
 		void whenBlendInterceptorsTrueThenGlobalInterceptorsBlended() {
 			ManagedChannelBuilder<?> builder = Mockito.mock();
 			ClientInterceptorsConfigurerTests.this.contextRunner()
 				.withUserConfiguration(GlobalClientInterceptorsConfig.class, ClientSpecificInterceptorsConfig.class)
 				.run((context) -> {
-					var factory = Mockito.mock(GrpcChannelFactory.class);
 					var interceptorA = context.getBean("interceptorA", ClientInterceptor.class);
 					var interceptorB = context.getBean("interceptorB", ClientInterceptor.class);
 					var clientSpecificInterceptors = List.of(interceptorB, interceptorA);
 					var expectedInterceptors = List.of(GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_BAR,
 							interceptorB, GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_FOO, interceptorA);
 					var configurer = context.getBean(ClientInterceptorsConfigurer.class);
+					var factory = new DefaultGrpcChannelFactory<>(List.of(), configurer);
 					configurer.configureInterceptors(builder, clientSpecificInterceptors, true, factory);
 					// NOTE: the interceptors are called in reverse order per builder
 					// contract
@@ -178,13 +177,14 @@ class WithInterceptorFilter {
 		@Test
 		void whenFilterExcludesOneGlobalInterceptor_thenBuilderGetsOnlyAllowedOnes() {
 			ManagedChannelBuilder<?> builder = Mockito.mock();
+			ClientInterceptorFilter filter = (interceptor,
+					__) -> interceptor == GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_BAR;
 			ClientInterceptorsConfigurerTests.this.contextRunner()
 				.withUserConfiguration(GlobalClientInterceptorsConfig.class)
-				.withBean(ClientInterceptorFilter.class,
-						() -> (interceptor, __) -> interceptor == GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_BAR)
 				.run(context -> {
-					var factory = Mockito.mock(GrpcChannelFactory.class);
 					var configurer = context.getBean(ClientInterceptorsConfigurer.class);
+					var factory = new InProcessGrpcChannelFactory(List.of(), configurer);
+					factory.setInterceptorFilter(filter);
 					configurer.configureInterceptors(builder, List.of(), true, factory);
 					var expectedInterceptors = List.of(GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_BAR);
 					verify(builder).intercept(expectedInterceptors);
@@ -194,12 +194,13 @@ void whenFilterExcludesOneGlobalInterceptor_thenBuilderGetsOnlyAllowedOnes() {
 		@Test
 		void whenFilterIncludesAllGlobalInterceptors_thenBuilderGetsOnlyAllowedOnes() {
 			ManagedChannelBuilder<?> builder = Mockito.mock();
+			ClientInterceptorFilter filter = (interceptor, __) -> true;
 			ClientInterceptorsConfigurerTests.this.contextRunner()
 				.withUserConfiguration(GlobalClientInterceptorsConfig.class)
-				.withBean(ClientInterceptorFilter.class, () -> (__, ___) -> true)
 				.run(context -> {
-					var factory = Mockito.mock(GrpcChannelFactory.class);
 					var configurer = context.getBean(ClientInterceptorsConfigurer.class);
+					var factory = new InProcessGrpcChannelFactory(List.of(), configurer);
+					factory.setInterceptorFilter(filter);
 					configurer.configureInterceptors(builder, List.of(), true, factory);
 					var expectedInterceptors = List.of(GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_BAR,
 							GlobalClientInterceptorsConfig.GLOBAL_INTERCEPTOR_FOO);

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

@@ -30,7 +30,6 @@
 /**
  * Unit tests for the {@link CompositeGrpcChannelFactory}.
  */
-@SuppressWarnings({ "unchecked", "rawtypes" })
 class CompositeGrpcChannelFactoryTests {
 
 	private TestChannelFactory fooChannelFactory;

spring-grpc-docs/src/main/antora/modules/ROOT/pages/client.adoc

@@ -247,7 +247,7 @@ In the preceding example, the `globalLoggingInterceptor` is applied prior to the
 [[global-client-interceptor-filtering]]
 ==== Filtering
 All global interceptors are applied to all created channels by default.
-However, you can register a `ClientInterceptorFilter` bean to decide which interceptors are applied to which channel factories.
+However, you can register a `ClientInterceptorFilter` to decide which interceptors are applied to which channel factories.
 
 The following example prevents the `ExtraThingsInterceptor` interceptor from being applied to any channels created by the `InProcessGrpcChannelFactory` channel factory.
 
@@ -260,6 +260,9 @@ ClientInterceptorFilter myInterceptorFilter() {
 }
 ----
 
+The `InProcessGrpcChannelFactory` picks up the `ClientInterceptorFilter` bean automatically and applies it to the global interceptors.
+For other channel factories, you can set the `interceptorFilter` property on the `GrpcChannelFactory` bean to the filter bean using a `GrpcChannelFactoryCustomizer`.
+
 === Per-Channel
 To add one or more client interceptors to be applied to a single client channel you can simply set the interceptor instance(s) on the options passed to the channel factory when creating the channel.
 

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/client/GrpcChannelFactoryConfigurations.java

@@ -18,13 +18,15 @@
 
 import java.util.List;
 
+import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.grpc.client.ChannelCredentialsProvider;
+import org.springframework.grpc.client.ClientInterceptorFilter;
 import org.springframework.grpc.client.ClientInterceptorsConfigurer;
 import org.springframework.grpc.client.GrpcChannelBuilderCustomizer;
 import org.springframework.grpc.client.GrpcChannelFactory;
@@ -55,12 +57,15 @@ static class ShadedNettyChannelFactoryConfiguration {
 		@Bean
 		ShadedNettyGrpcChannelFactory shadedNettyGrpcChannelFactory(GrpcClientProperties properties,
 				ChannelBuilderCustomizers channelBuilderCustomizers,
-				ClientInterceptorsConfigurer interceptorsConfigurer, ChannelCredentialsProvider credentials) {
+				ClientInterceptorsConfigurer interceptorsConfigurer,
+				ObjectProvider<GrpcChannelFactoryCustomizer> channelFactoryCustomizers,
+				ChannelCredentialsProvider credentials) {
 			List<GrpcChannelBuilderCustomizer<io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder>> builderCustomizers = List
 				.of(channelBuilderCustomizers::customize);
 			var factory = new ShadedNettyGrpcChannelFactory(builderCustomizers, interceptorsConfigurer);
 			factory.setCredentialsProvider(credentials);
 			factory.setVirtualTargets(properties);
+			channelFactoryCustomizers.orderedStream().forEach(customizer -> customizer.customize(factory));
 			return factory;
 		}
 
@@ -77,12 +82,15 @@ static class NettyChannelFactoryConfiguration {
 		@Bean
 		NettyGrpcChannelFactory nettyGrpcChannelFactory(GrpcClientProperties properties,
 				ChannelBuilderCustomizers channelBuilderCustomizers,
-				ClientInterceptorsConfigurer interceptorsConfigurer, ChannelCredentialsProvider credentials) {
+				ClientInterceptorsConfigurer interceptorsConfigurer,
+				ObjectProvider<GrpcChannelFactoryCustomizer> channelFactoryCustomizers,
+				ChannelCredentialsProvider credentials) {
 			List<GrpcChannelBuilderCustomizer<NettyChannelBuilder>> builderCustomizers = List
 				.of(channelBuilderCustomizers::customize);
 			var factory = new NettyGrpcChannelFactory(builderCustomizers, interceptorsConfigurer);
 			factory.setCredentialsProvider(credentials);
 			factory.setVirtualTargets(properties);
+			channelFactoryCustomizers.orderedStream().forEach(customizer -> customizer.customize(factory));
 			return factory;
 		}
 
@@ -97,10 +105,18 @@ static class InProcessChannelFactoryConfiguration {
 
 		@Bean
 		InProcessGrpcChannelFactory inProcessGrpcChannelFactory(ChannelBuilderCustomizers channelBuilderCustomizers,
-				ClientInterceptorsConfigurer interceptorsConfigurer) {
+				ClientInterceptorsConfigurer interceptorsConfigurer,
+				ObjectProvider<ClientInterceptorFilter> interceptorFilter,
+				ObjectProvider<GrpcChannelFactoryCustomizer> channelFactoryCustomizers) {
 			List<GrpcChannelBuilderCustomizer<InProcessChannelBuilder>> inProcessBuilderCustomizers = List
 				.of(channelBuilderCustomizers::customize);
-			return new InProcessGrpcChannelFactory(inProcessBuilderCustomizers, interceptorsConfigurer);
+			InProcessGrpcChannelFactory factory = new InProcessGrpcChannelFactory(inProcessBuilderCustomizers,
+					interceptorsConfigurer);
+			if (interceptorFilter != null) {
+				factory.setInterceptorFilter(interceptorFilter.getIfAvailable(() -> null));
+			}
+			channelFactoryCustomizers.orderedStream().forEach(customizer -> customizer.customize(factory));
+			return factory;
 		}
 
 	}

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/client/GrpcChannelFactoryCustomizer.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.client;
+
+import org.springframework.grpc.client.GrpcChannelFactory;
+
+public interface GrpcChannelFactoryCustomizer {
+
+	/**
+	 * Customize the given {@link GrpcChannelFactory}.
+	 * @param factory the factory to customize
+	 */
+	void customize(GrpcChannelFactory factory);
+
+}