Skip to content

When MongoReactiveAutoConfiguration creates a MongoClient that uses Netty, EventLoopGroup threads prevent the JVM from exiting #16087

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

Closed
wants to merge 1 commit into from
Closed

When MongoReactiveAutoConfiguration creates a MongoClient that uses Netty, EventLoopGroup threads prevent the JVM from exiting #16087

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
50 changes: 41 additions & 9 deletions ...ain/java/org/springframework/boot/autoconfigure/mongo/MongoReactiveAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@
import java.util.stream.Collectors;

import com.mongodb.MongoClientSettings;
import com.mongodb.MongoClientSettings.Builder;
import com.mongodb.connection.netty.NettyStreamFactoryFactory;
import com.mongodb.reactivestreams.client.MongoClient;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import reactor.core.publisher.Flux;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
Expand Down Expand Up @@ -60,23 +64,51 @@ public MongoClient reactiveStreamsMongoClient(MongoProperties properties,
}

@Configuration
@ConditionalOnClass(SocketChannel.class)
@ConditionalOnClass({ SocketChannel.class, NioEventLoopGroup.class })
static class NettyDriverConfiguration {

@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
public MongoClientSettingsBuilderCustomizer nettyDriverCustomizer(
ObjectProvider<MongoClientSettings> settings) {
return (builder) -> {
if (!isStreamFactoryFactoryDefined(settings.getIfAvailable())) {
builder.streamFactoryFactory(
NettyStreamFactoryFactory.builder().build());
}
};
return new EventLoopGroupMongoClientSettingsBuilderCustomizer(settings);
}

private boolean isStreamFactoryFactoryDefined(MongoClientSettings settings) {
return settings != null && settings.getStreamFactoryFactory() != null;
private static final class EventLoopGroupMongoClientSettingsBuilderCustomizer
implements MongoClientSettingsBuilderCustomizer, DisposableBean {

private final ObjectProvider<MongoClientSettings> settings;

private EventLoopGroup eventLoopGroup;

private EventLoopGroupMongoClientSettingsBuilderCustomizer(
ObjectProvider<MongoClientSettings> settings) {
this.settings = settings;
}

@Override
public void customize(Builder builder) {
if (!isStreamFactoryFactoryDefined(this.settings.getIfAvailable())) {
NioEventLoopGroup eventLoopGroup = new NioEventLoopGroup();
this.eventLoopGroup = eventLoopGroup;
builder.streamFactoryFactory(NettyStreamFactoryFactory.builder()
.eventLoopGroup(eventLoopGroup).build());
}
}

@Override
public void destroy() {
EventLoopGroup eventLoopGroup = this.eventLoopGroup;
if (eventLoopGroup != null) {
eventLoopGroup.shutdownGracefully().awaitUninterruptibly();
this.eventLoopGroup = null;
}
}

private boolean isStreamFactoryFactoryDefined(MongoClientSettings settings) {
return settings != null && settings.getStreamFactoryFactory() != null;
}

}

}
Expand Down
14 changes: 11 additions & 3 deletions ...ava/org/springframework/boot/autoconfigure/mongo/MongoReactiveAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2018 the original author or authors.
* Copyright 2012-2019 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.
Expand All @@ -17,6 +17,7 @@
package org.springframework.boot.autoconfigure.mongo;

import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;

import com.mongodb.MongoClientSettings;
import com.mongodb.ReadPreference;
Expand All @@ -25,6 +26,7 @@
import com.mongodb.connection.StreamFactoryFactory;
import com.mongodb.connection.netty.NettyStreamFactoryFactory;
import com.mongodb.reactivestreams.client.MongoClient;
import io.netty.channel.EventLoopGroup;
import org.junit.Test;

import org.springframework.boot.autoconfigure.AutoConfigurations;
Expand Down Expand Up @@ -89,11 +91,17 @@ public void optionsSslConfig() {

@Test
public void nettyStreamFactoryFactoryIsConfiguredAutomatically() {
AtomicReference<EventLoopGroup> capture = new AtomicReference<>();
this.contextRunner.run((context) -> {
assertThat(context).hasSingleBean(MongoClient.class);
assertThat(getSettings(context).getStreamFactoryFactory())
.isInstanceOf(NettyStreamFactoryFactory.class);
StreamFactoryFactory factory = getSettings(context).getStreamFactoryFactory();
assertThat(factory).isInstanceOf(NettyStreamFactoryFactory.class);
capture.set((EventLoopGroup) ReflectionTestUtils.getField(factory,
"eventLoopGroup"));
assertThat(capture.get()).isNotNull();
assertThat(capture.get().isShutdown()).isFalse();
});
assertThat(capture.get().isShutdown()).isTrue();
}

@Test
Expand Down