[FLINK-36876] Support external eventLoopGroup for RestClient #25788
+70
−20
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -59,6 +59,7 @@ | |
| import org.apache.flink.shaded.netty4.io.netty.channel.ChannelInitializer; | ||
| import org.apache.flink.shaded.netty4.io.netty.channel.ChannelOption; | ||
| import org.apache.flink.shaded.netty4.io.netty.channel.DefaultSelectStrategyFactory; | ||
| import org.apache.flink.shaded.netty4.io.netty.channel.EventLoopGroup; | ||
| import org.apache.flink.shaded.netty4.io.netty.channel.SelectStrategyFactory; | ||
| import org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler; | ||
| import org.apache.flink.shaded.netty4.io.netty.channel.nio.NioEventLoopGroup; | ||
|
|
@@ -143,30 +144,42 @@ public class RestClient implements AutoCloseableAsync { | |
| ConcurrentHashMap.newKeySet(); | ||
|
|
||
| private final List<OutboundChannelHandlerFactory> outboundChannelHandlerFactories; | ||
| private final Boolean useInternalEventLoopGroup; | ||
|
There was a problem hiding this comment. nit: why not boolean, I assume we do not want this ever to be null |
||
|
|
||
| /** | ||
| * Creates a new RestClient for the provided root URL. If the protocol of the URL is "https", | ||
| * then SSL is automatically enabled for the REST client. | ||
| */ | ||
| public static RestClient forUrl(Configuration configuration, Executor executor, URL rootUrl) | ||
| throws ConfigurationException { | ||
| return forUrl(configuration, executor, rootUrl, null); | ||
| } | ||
|
|
||
| public static RestClient forUrl( | ||
| Configuration configuration, Executor executor, URL rootUrl, EventLoopGroup group) | ||
| throws ConfigurationException { | ||
| Preconditions.checkNotNull(configuration); | ||
| Preconditions.checkNotNull(rootUrl); | ||
| if ("https".equals(rootUrl.getProtocol())) { | ||
| configuration = configuration.clone(); | ||
| configuration.set(SSL_REST_ENABLED, true); | ||
| } | ||
| return new RestClient(configuration, executor, rootUrl.getHost(), rootUrl.getPort(), group); | ||
| } | ||
|
|
||
| public RestClient(Configuration configuration, Executor executor) | ||
| throws ConfigurationException { | ||
| this(configuration, executor, null, -1, null); | ||
| } | ||
|
|
||
| public RestClient( | ||
| Configuration configuration, | ||
| Executor executor, | ||
| String host, | ||
| int port, | ||
| EventLoopGroup group) | ||
| throws ConfigurationException { | ||
| this(configuration, executor, host, port, DefaultSelectStrategyFactory.INSTANCE, group); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
|
|
@@ -175,15 +188,16 @@ public RestClient(Configuration configuration, Executor executor, String host, i | |
| Executor executor, | ||
| SelectStrategyFactory selectStrategyFactory) | ||
| throws ConfigurationException { | ||
| this(configuration, executor, null, -1, selectStrategyFactory, null); | ||
| } | ||
|
|
||
| private RestClient( | ||
| Configuration configuration, | ||
| Executor executor, | ||
| String host, | ||
| int port, | ||
| SelectStrategyFactory selectStrategyFactory, | ||
| EventLoopGroup group) | ||
| throws ConfigurationException { | ||
| Preconditions.checkNotNull(configuration); | ||
| this.executor = Preconditions.checkNotNull(executor); | ||
|
|
@@ -264,15 +278,21 @@ protected void initChannel(SocketChannel socketChannel) { | |
| } | ||
| }; | ||
|
|
||
| if (group == null) { | ||
| // No NioEventLoopGroup constructor available that allows passing nThreads, | ||
| // threadFactory, | ||
| // and selectStrategyFactory without also passing a SelectorProvider, so mimicking its | ||
| // default value seen in other constructors | ||
| group = | ||
| new NioEventLoopGroup( | ||
| 1, | ||
| new ExecutorThreadFactory("flink-rest-client-netty"), | ||
| SelectorProvider.provider(), | ||
| selectStrategyFactory); | ||
| useInternalEventLoopGroup = true; | ||
| } else { | ||
| useInternalEventLoopGroup = false; | ||
|
There was a problem hiding this comment. should we check that the supplied group is not shutting down or shutdown There was a problem hiding this comment. I see the channel is There was a problem hiding this comment. I think the extenal service doesn't care the type of SocketChannel. As the jira says, it just pass a shared event group to avoid heap memory leak. Maybe it's a better choice to specify the contruct param |
||
| } | ||
|
|
||
| bootstrap = new Bootstrap(); | ||
| bootstrap | ||
|
|
@@ -317,7 +337,7 @@ private CompletableFuture<Void> shutdownInternally(Duration timeout) { | |
| LOG.debug("Shutting down rest endpoint."); | ||
|
|
||
| if (bootstrap != null) { | ||
| if (bootstrap.config().group() != null && useInternalEventLoopGroup) { | ||
| bootstrap | ||
| .config() | ||
| .group() | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we tag with @nullable?