Fix codec configuration (server side)

- only use default de/compressor registry when user provides no custom de/compressor
- update tests accordingly

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

Author: onobc

module/spring-boot-grpc-client/src/test/java/org/springframework/boot/grpc/client/autoconfigure/GrpcClientAutoConfigurationTests.java

@@ -201,7 +201,7 @@ void decompressionCustomizerAutoConfiguredAsExpected() {
 	}
 
 	@Test
-	void whenNoDecompressorRegistryAutoConfigurationIsSkipped() {
+	void whenNoDecompressorRegistryThenDecompressionCustomizerIsNotConfigured() {
 		// Codec class guards the imported GrpcCodecConfiguration which provides the
 		// registry
 		this.contextRunner()

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

@@ -21,6 +21,7 @@
 import io.grpc.CompressorRegistry;
 import io.grpc.Decompressor;
 import io.grpc.DecompressorRegistry;
+import io.grpc.ServerBuilder;
 
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -37,19 +38,44 @@
 @ConditionalOnClass(Codec.class)
 class GrpcCodecConfiguration {
 
+	/**
+	 * The compressor registry that is set on the
+	 * {@link ServerBuilder#compressorRegistry(CompressorRegistry) server builder} .
+	 * @param compressors the compressors to use on the registry
+	 * @return a new {@link CompressorRegistry#newEmptyInstance() registry} with the
+	 * specified compressors or the {@link CompressorRegistry#getDefaultInstance() default
+	 * registry} if no custom compressors are available in the application context.
+	 */
 	@Bean
 	@ConditionalOnMissingBean
 	CompressorRegistry compressorRegistry(ObjectProvider<Compressor> compressors) {
-		CompressorRegistry registry = CompressorRegistry.getDefaultInstance();
+		if (compressors.stream().count() == 0) {
+			return CompressorRegistry.getDefaultInstance();
+		}
+		CompressorRegistry registry = CompressorRegistry.newEmptyInstance();
 		compressors.orderedStream().forEachOrdered(registry::register);
 		return registry;
 	}
 
+	/**
+	 * The decompressor registry that is set on the
+	 * {@link ServerBuilder#decompressorRegistry(DecompressorRegistry) server builder}.
+	 * @param decompressors the decompressors to use on the registry
+	 * @return a new {@link DecompressorRegistry#emptyInstance() registry} with the
+	 * specified decompressors or the {@link DecompressorRegistry#getDefaultInstance()
+	 * default registry} if no custom decompressors are available in the application
+	 * context.
+	 */
 	@Bean
 	@ConditionalOnMissingBean
 	DecompressorRegistry decompressorRegistry(ObjectProvider<Decompressor> decompressors) {
-		DecompressorRegistry registry = DecompressorRegistry.getDefaultInstance();
-		decompressors.orderedStream().forEachOrdered((decompressor) -> registry.with(decompressor, false));
+		if (decompressors.stream().count() == 0) {
+			return DecompressorRegistry.getDefaultInstance();
+		}
+		DecompressorRegistry registry = DecompressorRegistry.emptyInstance();
+		for (Decompressor decompressor : decompressors.orderedStream().toList()) {
+			registry = registry.with(decompressor, false);
+		}
 		return registry;
 	}
 

module/spring-boot-grpc-server/src/test/java/org/springframework/boot/grpc/server/autoconfigure/GrpcCodecConfigurationTests.java

@@ -16,14 +16,20 @@
 
 package org.springframework.boot.grpc.server.autoconfigure;
 
+import io.grpc.Codec;
+import io.grpc.Compressor;
 import io.grpc.CompressorRegistry;
+import io.grpc.Decompressor;
 import io.grpc.DecompressorRegistry;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
 
 /**
  * Tests for {@link GrpcCodecConfiguration}.
@@ -36,13 +42,59 @@ class GrpcCodecConfigurationTests {
 		.withConfiguration(AutoConfigurations.of(GrpcCodecConfiguration.class));
 
 	@Test
-	void testCompressorRegistryBean() {
-		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(CompressorRegistry.class));
+	void whenCodecNotOnClasspathThenAutoconfigurationSkipped() {
+		this.contextRunner.withClassLoader(new FilteredClassLoader(Codec.class))
+			.run((context) -> assertThat(context).doesNotHaveBean(GrpcCodecConfiguration.class));
 	}
 
 	@Test
-	void testDecompressorRegistryBean() {
-		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(DecompressorRegistry.class));
+	void whenHasCustomCompressorRegistryDoesNotAutoConfigureBean() {
+		CompressorRegistry customRegistry = mock();
+		this.contextRunner.withBean("customCompressorRegistry", CompressorRegistry.class, () -> customRegistry)
+			.run((context) -> assertThat(context).getBean(CompressorRegistry.class).isSameAs(customRegistry));
+	}
+
+	@Test
+	void compressorRegistryAutoConfiguredAsExpected() {
+		this.contextRunner.run((context) -> assertThat(context).getBean(CompressorRegistry.class)
+			.isSameAs(CompressorRegistry.getDefaultInstance()));
+	}
+
+	@Test
+	void whenCustomCompressorsThenCompressorRegistryIsNewInstance() {
+		Compressor compressor = mock();
+		given(compressor.getMessageEncoding()).willReturn("foo");
+		this.contextRunner.withBean(Compressor.class, () -> compressor).run((context) -> {
+			assertThat(context).hasSingleBean(CompressorRegistry.class);
+			CompressorRegistry registry = context.getBean(CompressorRegistry.class);
+			assertThat(registry).isNotSameAs(CompressorRegistry.getDefaultInstance());
+			assertThat(registry.lookupCompressor("foo")).isSameAs(compressor);
+		});
+	}
+
+	@Test
+	void whenHasCustomDecompressorRegistryDoesNotAutoConfigureBean() {
+		DecompressorRegistry customRegistry = mock();
+		this.contextRunner.withBean("customDecompressorRegistry", DecompressorRegistry.class, () -> customRegistry)
+			.run((context) -> assertThat(context).getBean(DecompressorRegistry.class).isSameAs(customRegistry));
+	}
+
+	@Test
+	void decompressorRegistryAutoConfiguredAsExpected() {
+		this.contextRunner.run((context) -> assertThat(context).getBean(DecompressorRegistry.class)
+			.isSameAs(DecompressorRegistry.getDefaultInstance()));
+	}
+
+	@Test
+	void whenCustomDecompressorsThenDecompressorRegistryIsNewInstance() {
+		Decompressor decompressor = mock();
+		given(decompressor.getMessageEncoding()).willReturn("foo");
+		this.contextRunner.withBean(Decompressor.class, () -> decompressor).run((context) -> {
+			assertThat(context).hasSingleBean(DecompressorRegistry.class);
+			DecompressorRegistry registry = context.getBean(DecompressorRegistry.class);
+			assertThat(registry).isNotSameAs(DecompressorRegistry.getDefaultInstance());
+			assertThat(registry.lookupDecompressor("foo")).isSameAs(decompressor);
+		});
 	}
 
 }

module/spring-boot-grpc-server/src/test/java/org/springframework/boot/grpc/server/autoconfigure/GrpcServerAutoConfigurationTests.java

@@ -21,6 +21,9 @@
 import java.util.concurrent.TimeUnit;
 
 import io.grpc.BindableService;
+import io.grpc.Codec;
+import io.grpc.CompressorRegistry;
+import io.grpc.DecompressorRegistry;
 import io.grpc.Grpc;
 import io.grpc.ServerBuilder;
 import io.grpc.ServerServiceDefinition;
@@ -61,6 +64,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyInt;
 import static org.mockito.BDDMockito.given;
+import static org.mockito.BDDMockito.then;
 import static org.mockito.Mockito.inOrder;
 import static org.mockito.Mockito.mock;
 
@@ -409,6 +413,59 @@ void nettyServerFactoryAutoConfiguredWithSsl() {
 				NettyGrpcServerFactory.class, "myhost:6160", "nettyGrpcServerLifecycle");
 	}
 
+	@Nested
+	class WithCodecConfiguration {
+
+		@SuppressWarnings("unchecked")
+		@Test
+		void compressionCustomizerAutoConfiguredAsExpected() {
+			GrpcServerAutoConfigurationTests.this.contextRunner().run((context) -> {
+				assertThat(context).getBean("compressionServerConfigurer", ServerBuilderCustomizer.class).isNotNull();
+				var customizer = context.getBean("compressionServerConfigurer", ServerBuilderCustomizer.class);
+				var compressorRegistry = context.getBean(CompressorRegistry.class);
+				ServerBuilder<?> builder = mock();
+				customizer.customize(builder);
+				then(builder).should().compressorRegistry(compressorRegistry);
+			});
+		}
+
+		@Test
+		void whenNoCompressorRegistryThenCompressionCustomizerIsNotConfigured() {
+			// Codec class guards the imported GrpcCodecConfiguration which provides the
+			// registry
+			GrpcServerAutoConfigurationTests.this.contextRunner()
+				.withClassLoader(new FilteredClassLoader(Codec.class))
+				.run((context) -> assertThat(context)
+					.getBean("compressionServerConfigurer", ServerBuilderCustomizer.class)
+					.isNull());
+		}
+
+		@SuppressWarnings("unchecked")
+		@Test
+		void decompressionCustomizerAutoConfiguredAsExpected() {
+			GrpcServerAutoConfigurationTests.this.contextRunner().run((context) -> {
+				assertThat(context).getBean("decompressionServerConfigurer", ServerBuilderCustomizer.class).isNotNull();
+				var customizer = context.getBean("decompressionServerConfigurer", ServerBuilderCustomizer.class);
+				var decompressorRegistry = context.getBean(DecompressorRegistry.class);
+				ServerBuilder<?> builder = mock();
+				customizer.customize(builder);
+				then(builder).should().decompressorRegistry(decompressorRegistry);
+			});
+		}
+
+		@Test
+		void whenNoDecompressorRegistryThenDecompressionCustomizerIsNotConfigured() {
+			// Codec class guards the imported GrpcCodecConfiguration which provides the
+			// registry
+			GrpcServerAutoConfigurationTests.this.contextRunner()
+				.withClassLoader(new FilteredClassLoader(Codec.class))
+				.run((context) -> assertThat(context)
+					.getBean("decompressionClientCustomizer", ServerBuilderCustomizer.class)
+					.isNull());
+		}
+
+	}
+
 	@Nested
 	class WithAllFactoriesServiceFilterAutoConfig {