Skip to content

core: do not call LoadBalancer callbacks after it's shut down. #3573

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

Merged
merged 1 commit into from
Oct 11, 2017
Merged

core: do not call LoadBalancer callbacks after it's shut down. #3573

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
11 changes: 8 additions & 3 deletions core/src/main/java/io/grpc/internal/ManagedChannelImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,10 @@ void onStateChange(InternalSubchannel is, ConnectivityStateInfo newState) {
if ((newState.getState() == TRANSIENT_FAILURE || newState.getState() == IDLE)) {
nr.refresh();
}
lb.handleSubchannelState(subchannel, newState);
// Call LB only if it's not shutdown. If LB is shutdown, lbHelper won't match.
if (LbHelperImpl.this == ManagedChannelImpl.this.lbHelper) {
lb.handleSubchannelState(subchannel, newState);
}
}

@Override
Expand Down Expand Up @@ -846,7 +849,8 @@ public void onAddresses(final List<EquivalentAddressGroup> servers, final Attrib
helper.runSerialized(new Runnable() {
@Override
public void run() {
if (terminated) {
// Call LB only if it's not shutdown. If LB is shutdown, lbHelper won't match.
if (NameResolverListenerImpl.this.helper != ManagedChannelImpl.this.lbHelper) {
return;
}
try {
Expand All @@ -871,7 +875,8 @@ public void onError(final Status error) {
channelExecutor.executeLater(new Runnable() {
@Override
public void run() {
if (terminated) {
// Call LB only if it's not shutdown. If LB is shutdown, lbHelper won't match.
if (NameResolverListenerImpl.this.helper != ManagedChannelImpl.this.lbHelper) {
return;
}
balancer.handleNameResolutionError(error);
Expand Down
46 changes: 46 additions & 0 deletions core/src/test/java/io/grpc/internal/ManagedChannelImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,52 @@ private void subtestCallsAndShutdown(boolean shutdownNow, boolean shutdownNowAft
verifyNoMoreInteractions(mockTransport);
}

@Test
public void noMoreCallbackAfterLoadBalancerShutdown() {
FakeNameResolverFactory nameResolverFactory = new FakeNameResolverFactory(true);
Status resolutionError = Status.UNAVAILABLE.withDescription("Resolution failed");
createChannel(nameResolverFactory, NO_INTERCEPTOR);

FakeNameResolverFactory.FakeNameResolver resolver = nameResolverFactory.resolvers.get(0);
verify(mockLoadBalancerFactory).newLoadBalancer(any(Helper.class));
verify(mockLoadBalancer).handleResolvedAddressGroups(
eq(Arrays.asList(addressGroup)), eq(Attributes.EMPTY));

Subchannel subchannel1 = helper.createSubchannel(addressGroup, Attributes.EMPTY);
Subchannel subchannel2 = helper.createSubchannel(addressGroup, Attributes.EMPTY);
subchannel1.requestConnection();
subchannel2.requestConnection();
verify(mockTransportFactory, times(2)).newClientTransport(
any(SocketAddress.class), any(String.class), any(String.class));
MockClientTransportInfo transportInfo1 = transports.poll();
MockClientTransportInfo transportInfo2 = transports.poll();

// LoadBalancer receives all sorts of callbacks
transportInfo1.listener.transportReady();
verify(mockLoadBalancer, times(2))
.handleSubchannelState(same(subchannel1), stateInfoCaptor.capture());
assertSame(CONNECTING, stateInfoCaptor.getAllValues().get(0).getState());
assertSame(READY, stateInfoCaptor.getAllValues().get(1).getState());

verify(mockLoadBalancer)
.handleSubchannelState(same(subchannel2), stateInfoCaptor.capture());
assertSame(CONNECTING, stateInfoCaptor.getValue().getState());

resolver.listener.onError(resolutionError);
verify(mockLoadBalancer).handleNameResolutionError(resolutionError);

verifyNoMoreInteractions(mockLoadBalancer);

channel.shutdown();
verify(mockLoadBalancer).shutdown();

// No more callback should be delivered to LoadBalancer after it's shut down
transportInfo2.listener.transportReady();
resolver.listener.onError(resolutionError);
resolver.resolved();
verifyNoMoreInteractions(mockLoadBalancer);
}

@Test
public void interceptor() throws Exception {
final AtomicLong atomic = new AtomicLong();
Expand Down