#8: resolve comments || tests for grpc codec configuration

Author: andreilisa

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

@@ -27,13 +27,14 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.grpc.autoconfigure.client.GrpcClientProperties.NamedChannel;
+import org.springframework.grpc.autoconfigure.common.codec.GrpcCodecConfiguration;
 import org.springframework.grpc.client.GrpcChannelConfigurer;
 
 @Configuration(proxyBeanMethods = false)
 @EnableConfigurationProperties(GrpcClientProperties.class)
 @Import({ GrpcChannelFactoryConfigurations.ShadedNettyChannelFactoryConfiguration.class,
 		GrpcChannelFactoryConfigurations.NettyChannelFactoryConfiguration.class,
-		GrpcChannelFactoryConfigurations.DefaultChannelFactoryConfiguration.class })
+		GrpcChannelFactoryConfigurations.DefaultChannelFactoryConfiguration.class, GrpcCodecConfiguration.class })
 public class GrpcClientAutoConfiguration {
 
 	@Bean
@@ -86,13 +87,13 @@ else if (ShadedNettyChannelFactoryHelper.isAvailable()) {
 
 	@ConditionalOnBean(CompressorRegistry.class)
 	@Bean
-	public GrpcChannelConfigurer compressionServerConfigurer(final CompressorRegistry registry) {
+	GrpcChannelConfigurer compressionClientConfigurer(CompressorRegistry registry) {
 		return (name, builder) -> builder.compressorRegistry(registry);
 	}
 
 	@ConditionalOnBean(DecompressorRegistry.class)
 	@Bean
-	public GrpcChannelConfigurer decompressionServerConfigurer(final DecompressorRegistry registry) {
+	GrpcChannelConfigurer decompressionClientConfigurer(DecompressorRegistry registry) {
 		return (name, builder) -> builder.decompressorRegistry(registry);
 	}
 

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/common/codec/GrpcCodecAutoConfiguration.java

@@ -0,0 +1,52 @@
+/*
+ * 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.common.codec;
+
+import io.grpc.Codec;
+import io.grpc.Compressor;
+import io.grpc.Decompressor;
+import io.grpc.DecompressorRegistry;
+import io.grpc.CompressorRegistry;
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * The autoconfiguration that contains all codec related beans for clients/servers.
+ *
+ * @author Andrei Lisa
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(Codec.class)
+public class GrpcCodecConfiguration {
+
+	@Bean
+	public CompressorRegistry compressorRegistry(ObjectProvider<Compressor> compressors) {
+		CompressorRegistry registry = CompressorRegistry.getDefaultInstance();
+		compressors.forEach(registry::register);
+		return registry;
+	}
+
+	@Bean
+	public DecompressorRegistry decompressorRegistry(ObjectProvider<Decompressor> decompressors) {
+		DecompressorRegistry registry = DecompressorRegistry.getDefaultInstance();
+		decompressors.forEach(decompressor -> registry.with(decompressor, false));
+		return registry;
+	}
+
+}

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/common/codec/GrpcCodecConfiguration.java

@@ -32,6 +32,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 import org.springframework.core.Ordered;
+import org.springframework.grpc.autoconfigure.common.codec.GrpcCodecConfiguration;
 import org.springframework.grpc.server.GrpcServerFactory;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
@@ -52,7 +53,7 @@
 @EnableConfigurationProperties(GrpcServerProperties.class)
 @Import({ GrpcServerFactoryConfigurations.ShadedNettyServerFactoryConfiguration.class,
 		GrpcServerFactoryConfigurations.NettyServerFactoryConfiguration.class,
-		GrpcServerFactoryConfigurations.ServiceProviderServerFactoryConfiguration.class })
+		GrpcServerFactoryConfigurations.ServiceProviderServerFactoryConfiguration.class, GrpcCodecConfiguration.class })
 public class GrpcServerAutoConfiguration {
 
 	private final GrpcServerProperties properties;
@@ -75,14 +76,13 @@ ServerBuilderCustomizers serverBuilderCustomizers(ObjectProvider<ServerBuilderCu
 
 	@ConditionalOnBean(CompressorRegistry.class)
 	@Bean
-	public ServerBuilderCustomizer<NettyServerBuilder> compressionServerConfigurer(final CompressorRegistry registry) {
+	ServerBuilderCustomizer<NettyServerBuilder> compressionServerConfigurer(CompressorRegistry registry) {
 		return builder -> builder.compressorRegistry(registry);
 	}
 
 	@ConditionalOnBean(DecompressorRegistry.class)
 	@Bean
-	public ServerBuilderCustomizer<NettyServerBuilder> decompressionServerConfigurer(
-			final DecompressorRegistry registry) {
+	ServerBuilderCustomizer<NettyServerBuilder> decompressionServerConfigurer(DecompressorRegistry registry) {
 		return builder -> builder.decompressorRegistry(registry);
 	}
 

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

@@ -0,0 +1,82 @@
+package org.springframework.grpc.autoconfigure.common;
+
+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.TestConfiguration;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.grpc.autoconfigure.common.codec.GrpcCodecConfiguration;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link GrpcCodecConfiguration}.
+ *
+ * @author Andrei Lisa
+ */
+public class GrpcCodecConfigurationTest {
+
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+		.withConfiguration(AutoConfigurations.of(GrpcCodecConfiguration.class));
+
+	@Test
+	void testCompressorRegistryBean() {
+		contextRunner.run(context -> {
+			assertThat(context).hasSingleBean(CompressorRegistry.class);
+			CompressorRegistry registry = context.getBean(CompressorRegistry.class);
+			assertThat(registry).isNotNull();
+		});
+	}
+
+	@Test
+	void testDecompressorRegistryBean() {
+		contextRunner.run(context -> {
+			assertThat(context).hasSingleBean(DecompressorRegistry.class);
+			DecompressorRegistry registry = context.getBean(DecompressorRegistry.class);
+			assertThat(registry).isNotNull();
+		});
+	}
+
+	@TestConfiguration
+	static class TestConfig {
+
+		@Bean
+		public Compressor testCompressor() {
+			return new Compressor() {
+				@Override
+				public String getMessageEncoding() {
+					return "testCompressor";
+				}
+
+				@Override
+				public OutputStream compress(OutputStream os) {
+					return null;
+				}
+			};
+		}
+
+		@Bean
+		public Decompressor testDecompressor() {
+			return new Decompressor() {
+				@Override
+				public String getMessageEncoding() {
+					return "testDecompressor";
+				}
+
+				@Override
+				public InputStream decompress(InputStream is) {
+					return null;
+				}
+			};
+		}
+
+	}
+
+}