Skip to content

Guard gRPC beans on grpc-netty instead of grpc-api #4190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seonwooj0810 wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −3
Open

Guard gRPC beans on grpc-netty instead of grpc-api #4190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...java/org/springframework/cloud/gateway/config/ConfigurableHintsRegistrationProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class ConfigurableHintsRegistrationProcessor implements BeanFactoryInitializatio
Set.of("org.springframework.security.oauth2.client.OAuth2AuthorizedClient",
"org.springframework.security.web.server.SecurityWebFilterChain",
"org.springframework.boot.security.autoconfigure.SecurityProperties"),
JsonToGrpcGatewayFilterFactory.class, Set.of("io.grpc.Channel"), RedisRateLimiter.class,
JsonToGrpcGatewayFilterFactory.class, Set.of("io.grpc.netty.NettyChannelBuilder"), RedisRateLimiter.class,
Set.of("org.springframework.data.redis.core.RedisTemplate",
"org.springframework.web.reactive.DispatcherHandler"),
SpringCloudCircuitBreakerResilience4JFilterFactory.class, circuitBreakerConditionalClasses,
Expand Down
4 changes: 2 additions & 2 deletions ...flux/src/main/java/org/springframework/cloud/gateway/config/GatewayAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ public GRPCResponseHeadersFilter gRPCResponseHeadersFilter() {
@Bean
@ConditionalOnEnabledFilter
@ConditionalOnProperty(name = "server.http2.enabled", matchIfMissing = true)
@ConditionalOnClass(name = "io.grpc.Channel")
@ConditionalOnClass(name = "io.grpc.netty.NettyChannelBuilder")
public JsonToGrpcGatewayFilterFactory jsonToGRPCFilterFactory(GrpcSslConfigurer gRPCSSLContext,
ResourceLoader resourceLoader) {
return new JsonToGrpcGatewayFilterFactory(gRPCSSLContext, resourceLoader);
Expand All @@ -379,7 +379,7 @@ public JsonToGrpcGatewayFilterFactory jsonToGRPCFilterFactory(GrpcSslConfigurer
@Bean
@ConditionalOnEnabledFilter(JsonToGrpcGatewayFilterFactory.class)
@ConditionalOnMissingBean(GrpcSslConfigurer.class)
@ConditionalOnClass(name = "io.grpc.Channel")
@ConditionalOnClass(name = "io.grpc.netty.NettyChannelBuilder")
public GrpcSslConfigurer grpcSslConfigurer(HttpClientProperties properties, SslBundles bundles)
throws KeyStoreException, NoSuchAlgorithmException, CertificateException, IOException {
TrustManagerFactory trustManagerFactory = TrustManagerFactory
Expand Down
21 changes: 21 additions & 0 deletions ...src/test/java/org/springframework/cloud/gateway/config/GatewayAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
import org.springframework.cloud.gateway.actuate.GatewayLegacyControllerEndpoint;
import org.springframework.cloud.gateway.config.GatewayAutoConfigurationTests.CustomHttpClientFactory.CustomSslConfigurer;
import org.springframework.cloud.gateway.config.HttpClientProperties.Pool.LeasingStrategy;
import org.springframework.cloud.gateway.filter.factory.JsonToGrpcGatewayFilterFactory;
import org.springframework.cloud.gateway.filter.factory.TokenRelayGatewayFilterFactory;
import org.springframework.cloud.gateway.filter.headers.ForwardedHeadersFilter;
import org.springframework.cloud.gateway.filter.headers.GRPCRequestHeadersFilter;
Expand Down Expand Up @@ -315,6 +316,26 @@ public void gRPCFiltersNotConfiguredWhenHTTP2Disabled() {
});
}

@Test // gh-4169
public void grpcBeansNotConfiguredWhenGrpcNettyAbsent() {
// io.grpc.Channel comes from grpc-api, but the gRPC beans require grpc-netty
// (io.grpc.netty.NettyChannelBuilder). When grpc-api is present without
// grpc-netty the beans must back off rather than fail the context with
// NoClassDefFoundError: io/grpc/netty/NettyChannelBuilder.
new ReactiveWebApplicationContextRunner()
.withClassLoader(
new org.springframework.boot.test.context.FilteredClassLoader("io.grpc.netty.NettyChannelBuilder"))
.withConfiguration(AutoConfigurations.of(WebFluxAutoConfiguration.class, MetricsAutoConfiguration.class,
SimpleMetricsExportAutoConfiguration.class, GatewayAutoConfiguration.class,
HttpClientCustomizedConfig.class, ServerPropertiesConfig.class))
.withPropertyValues("server.http2.enabled=true")
.run(context -> {
assertThat(context).hasNotFailed();
assertThat(context).doesNotHaveBean(JsonToGrpcGatewayFilterFactory.class);
assertThat(context).doesNotHaveBean(GrpcSslConfigurer.class);
});
}

@Test
public void insecureTrustManagerNotEnabledByDefaultWhenHTTP2Enabled() {
new ReactiveWebApplicationContextRunner()
Expand Down