Clear listeners when AddressResolverGroups close. (#10011) (#10012)

Motivation:

When an `AddressResolverGroup` closes, it can leave unwanted listeners attached to its `EventExecutor`'s termination future.

Modifications:

- Keep track of listeners attached to termination futures
- Clear listeners if the `AddressResolverGroup` closes before its associated executor(s)

Result:

Unwanted listeners no longer remain in memory after an `AddressResolverGroup` closes before its associated executor(s).
This commit is contained in:
Jon Chambers 2020-02-10 01:40:06 -05:00 committed by Norman Maurer
parent 8ab4adcc56
commit 48f56ff6af

View File

@ -19,7 +19,9 @@ package io.netty.resolver;
import static java.util.Objects.requireNonNull; import static java.util.Objects.requireNonNull;
import io.netty.util.concurrent.EventExecutor; import io.netty.util.concurrent.EventExecutor;
import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.FutureListener; import io.netty.util.concurrent.FutureListener;
import io.netty.util.concurrent.GenericFutureListener;
import io.netty.util.internal.logging.InternalLogger; import io.netty.util.internal.logging.InternalLogger;
import io.netty.util.internal.logging.InternalLoggerFactory; import io.netty.util.internal.logging.InternalLoggerFactory;
@ -41,13 +43,16 @@ public abstract class AddressResolverGroup<T extends SocketAddress> implements C
*/ */
private final Map<EventExecutor, AddressResolver<T>> resolvers = new IdentityHashMap<>(); private final Map<EventExecutor, AddressResolver<T>> resolvers = new IdentityHashMap<>();
private final Map<EventExecutor, GenericFutureListener<Future<Object>>> executorTerminationListeners =
new IdentityHashMap<>();
protected AddressResolverGroup() { } protected AddressResolverGroup() { }
/** /**
* Returns the {@link AddressResolver} associated with the specified {@link EventExecutor}. If there's no associated * Returns the {@link AddressResolver} associated with the specified {@link EventExecutor}. If there's no associated
* resolved found, this method creates and returns a new resolver instance created by * resolver found, this method creates and returns a new resolver instance created by
* {@link #newResolver(EventExecutor)} so that the new resolver is reused on another * {@link #newResolver(EventExecutor)} so that the new resolver is reused on another
* {@link #getResolver(EventExecutor)} call with the same {@link EventExecutor}. * {@code #getResolver(EventExecutor)} call with the same {@link EventExecutor}.
*/ */
public AddressResolver<T> getResolver(final EventExecutor executor) { public AddressResolver<T> getResolver(final EventExecutor executor) {
requireNonNull(executor, "executor"); requireNonNull(executor, "executor");
@ -68,12 +73,15 @@ public abstract class AddressResolverGroup<T extends SocketAddress> implements C
} }
resolvers.put(executor, newResolver); resolvers.put(executor, newResolver);
executor.terminationFuture().addListener((FutureListener<Object>) future -> { FutureListener<Object> terminationListener = future -> {
synchronized (resolvers) { synchronized (resolvers) {
resolvers.remove(executor); resolvers.remove(executor);
executorTerminationListeners.remove(executor);
} }
newResolver.close(); newResolver.close();
}); };
executorTerminationListeners.put(executor, terminationListener);
executor.terminationFuture().addListener(terminationListener);
r = newResolver; r = newResolver;
} }
@ -97,9 +105,17 @@ public abstract class AddressResolverGroup<T extends SocketAddress> implements C
synchronized (resolvers) { synchronized (resolvers) {
rArray = (AddressResolver<T>[]) resolvers.values().toArray(new AddressResolver[0]); rArray = (AddressResolver<T>[]) resolvers.values().toArray(new AddressResolver[0]);
resolvers.clear(); resolvers.clear();
for (final Map.Entry<EventExecutor, GenericFutureListener<Future<Object>>> entry :
executorTerminationListeners.entrySet()) {
entry.getKey().terminationFuture().removeListener(entry.getValue());
}
executorTerminationListeners.clear();
} }
for (AddressResolver<T> r: rArray) { for (final AddressResolver<T> r: rArray) {
try { try {
r.close(); r.close();
} catch (Throwable t) { } catch (Throwable t) {