Skip to content

Commit 72c6e5f

Browse files
core: reference-count shared transport factory for OOB channels (grpc#12985)
When a main channel enters IDLE mode (e.g. after 30 minutes of inactivity), it shuts down its Load Balancer (such as RLS). This in turn shuts down any Out-of-Band child channels created by the LB. Previously, when an OOB channel finished terminating, it called `transportFactory.close()`, which prematurely closed the parent channel's shared `ClientTransportFactory` (`NettyTransportFactory`). As a result, when the main channel later attempted to exit IDLE mode or reconnect, `transportFactory.newClientTransport()` threw `IllegalStateException: The transport factory is closed`, causing an uncaught exception panic in the SynchronizationContext. This change introduces `RefCountedClientTransportFactory` to track active references to the underlying `ClientTransportFactory`. When OOB channels inherit `originalTransportFactory` via `createResolvingOobChannelBuilder()`, `retain()` is invoked. Calling `close()` on the transport factory now decrements the reference count, ensuring the underlying delegate factory is only closed when all parent and child channel references have been released. b/545260270
1 parent 6966536 commit 72c6e5f

4 files changed

Lines changed: 207 additions & 4 deletions

File tree

‎core/src/main/java/io/grpc/internal/ManagedChannelImpl.java‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ public Result selectConfig(PickSubchannelArgs args) {
173173
private final NameResolverProvider nameResolverProvider;
174174
private final NameResolver.Args nameResolverArgs;
175175
private final LoadBalancerProvider loadBalancerFactory;
176-
private final ClientTransportFactory originalTransportFactory;
176+
private final RefCountedClientTransportFactory originalTransportFactory;
177177
@Nullable
178178
private final ChannelCredentials originalChannelCreds;
179179
private final ClientTransportFactory transportFactory;
@@ -562,11 +562,15 @@ ClientStream newSubstream(
562562
this.executorPool = checkNotNull(builder.executorPool, "executorPool");
563563
this.executor = checkNotNull(executorPool.getObject(), "executor");
564564
this.originalChannelCreds = builder.channelCredentials;
565-
this.originalTransportFactory = clientTransportFactory;
565+
if (clientTransportFactory instanceof RefCountedClientTransportFactory) {
566+
this.originalTransportFactory = (RefCountedClientTransportFactory) clientTransportFactory;
567+
} else {
568+
this.originalTransportFactory = new RefCountedClientTransportFactory(clientTransportFactory);
569+
}
566570
this.offloadExecutorHolder =
567571
new ExecutorHolder(checkNotNull(builder.offloadExecutorPool, "offloadExecutorPool"));
568572
this.transportFactory = new CallCredentialsApplyingTransportFactory(
569-
clientTransportFactory, builder.callCredentials, this.offloadExecutorHolder);
573+
originalTransportFactory, builder.callCredentials, this.offloadExecutorHolder);
570574
this.scheduledExecutor =
571575
new RestrictedScheduledExecutor(transportFactory.getScheduledExecutorService());
572576
maxTraceEvents = builder.maxTraceEvents;
@@ -1462,7 +1466,10 @@ final class ResolvingOobChannelBuilder
14621466
final ClientTransportFactory transportFactory;
14631467
CallCredentials callCredentials;
14641468
if (channelCreds instanceof DefaultChannelCreds) {
1465-
transportFactory = originalTransportFactory;
1469+
// TODO(kannanjgithub) We should eventually refactor ManagedChannelImplBuilder so
1470+
// callCredentials can be resolved lazily at build() time, allowing transport factory
1471+
// retention to happen strictly inside buildClientTransportFactory().
1472+
transportFactory = originalTransportFactory.retain();
14661473
callCredentials = null;
14671474
} else {
14681475
SwapChannelCredentialsResult swapResult =
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
/*
2+
* Copyright 2026 The gRPC Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.grpc.internal;
18+
19+
import static com.google.common.base.Preconditions.checkNotNull;
20+
import static com.google.common.base.Preconditions.checkState;
21+
22+
import io.grpc.ChannelCredentials;
23+
import io.grpc.ChannelLogger;
24+
import java.net.SocketAddress;
25+
import java.util.Collection;
26+
import java.util.concurrent.ScheduledExecutorService;
27+
import java.util.concurrent.atomic.AtomicInteger;
28+
29+
/**
30+
* A wrapper for {@link ClientTransportFactory} that reference-counts calls to {@link #retain()} and
31+
* {@link #close()}, ensuring the delegate factory is closed only when all references are released.
32+
*/
33+
final class RefCountedClientTransportFactory implements ClientTransportFactory {
34+
private final ClientTransportFactory delegate;
35+
private final AtomicInteger refCount = new AtomicInteger(1);
36+
37+
public RefCountedClientTransportFactory(ClientTransportFactory delegate) {
38+
this.delegate = checkNotNull(delegate, "delegate");
39+
}
40+
41+
public RefCountedClientTransportFactory retain() {
42+
refCount.incrementAndGet();
43+
return this;
44+
}
45+
46+
@Override
47+
public ConnectionClientTransport newClientTransport(
48+
SocketAddress serverAddress, ClientTransportOptions options, ChannelLogger channelLogger) {
49+
return delegate.newClientTransport(serverAddress, options, channelLogger);
50+
}
51+
52+
@Override
53+
public ScheduledExecutorService getScheduledExecutorService() {
54+
return delegate.getScheduledExecutorService();
55+
}
56+
57+
@Override
58+
public Collection<Class<? extends SocketAddress>> getSupportedSocketAddressTypes() {
59+
return delegate.getSupportedSocketAddressTypes();
60+
}
61+
62+
@Override
63+
public SwapChannelCredentialsResult swapChannelCredentials(ChannelCredentials channelCreds) {
64+
return delegate.swapChannelCredentials(channelCreds);
65+
}
66+
67+
@Override
68+
public void close() {
69+
int count = refCount.decrementAndGet();
70+
checkState(count >= 0, "Reference count has gone negative: %s", count);
71+
if (count == 0) {
72+
delegate.close();
73+
}
74+
}
75+
}

‎core/src/test/java/io/grpc/internal/ManagedChannelImplTest.java‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4824,6 +4824,46 @@ public void run() {
48244824
});
48254825
}
48264826

4827+
@Test
4828+
public void oobChannelTermination_doesNotCloseSharedTransportFactory() {
4829+
channelBuilder.nameResolverRegistry.register(new NameResolverProvider() {
4830+
@Override
4831+
public NameResolver newNameResolver(URI targetUri, NameResolver.Args args) {
4832+
NameResolver resolver = mock(NameResolver.class);
4833+
when(resolver.getServiceAuthority()).thenReturn(
4834+
targetUri.getAuthority() != null ? targetUri.getAuthority() : targetUri.getPath());
4835+
return resolver;
4836+
}
4837+
4838+
@Override
4839+
public String getDefaultScheme() {
4840+
return expectedUri.getScheme();
4841+
}
4842+
4843+
@Override
4844+
protected boolean isAvailable() {
4845+
return true;
4846+
}
4847+
4848+
@Override
4849+
protected int priority() {
4850+
return 10;
4851+
}
4852+
});
4853+
createChannel();
4854+
ManagedChannel oob = helper.createResolvingOobChannelBuilder("oobauthority").build();
4855+
4856+
// Shutting down OOB channel should release its reference but not close the
4857+
// shared transport factory
4858+
oob.shutdownNow();
4859+
verify(mockTransportFactory, never()).close();
4860+
4861+
// Terminating the main channel releases the final reference and closes the
4862+
// transport factory
4863+
channel.shutdownNow();
4864+
verify(mockTransportFactory).close();
4865+
}
4866+
48274867
@SuppressWarnings("unchecked")
48284868
private static Map<String, Object> parseConfig(String json) throws Exception {
48294869
return (Map<String, Object>) JsonParser.parse(json);
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/*
2+
* Copyright 2026 The gRPC Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.grpc.internal;
18+
19+
import static org.junit.Assert.assertThrows;
20+
import static org.mockito.Mockito.never;
21+
import static org.mockito.Mockito.verify;
22+
23+
import org.junit.Rule;
24+
import org.junit.Test;
25+
import org.junit.runner.RunWith;
26+
import org.junit.runners.JUnit4;
27+
import org.mockito.Mock;
28+
import org.mockito.junit.MockitoJUnit;
29+
import org.mockito.junit.MockitoRule;
30+
31+
/** Unit tests for {@link RefCountedClientTransportFactory}. */
32+
@RunWith(JUnit4.class)
33+
public class RefCountedClientTransportFactoryTest {
34+
@Rule public final MockitoRule mocks = MockitoJUnit.rule();
35+
36+
@Mock private ClientTransportFactory mockDelegate;
37+
38+
@Test
39+
public void singleClose_closesDelegate() {
40+
RefCountedClientTransportFactory factory = new RefCountedClientTransportFactory(mockDelegate);
41+
factory.close();
42+
verify(mockDelegate).close();
43+
}
44+
45+
@Test
46+
public void retainAndClose_closesDelegateOnlyWhenCountReachesZero() {
47+
RefCountedClientTransportFactory factory = new RefCountedClientTransportFactory(mockDelegate);
48+
RefCountedClientTransportFactory retained = factory.retain();
49+
50+
factory.close();
51+
verify(mockDelegate, never()).close();
52+
53+
retained.close();
54+
verify(mockDelegate).close();
55+
}
56+
57+
@Test
58+
public void multipleRetains_requiresEqualClosesToCloseDelegate() {
59+
RefCountedClientTransportFactory factory = new RefCountedClientTransportFactory(mockDelegate);
60+
factory.retain();
61+
factory.retain();
62+
63+
factory.close();
64+
verify(mockDelegate, never()).close();
65+
66+
factory.close();
67+
verify(mockDelegate, never()).close();
68+
69+
factory.close();
70+
verify(mockDelegate).close();
71+
}
72+
73+
@Test
74+
public void closeMoreThanRetain_throwsIllegalStateException() {
75+
RefCountedClientTransportFactory factory = new RefCountedClientTransportFactory(mockDelegate);
76+
factory.close();
77+
verify(mockDelegate).close();
78+
79+
assertThrows(IllegalStateException.class, factory::close);
80+
}
81+
}

0 commit comments

Comments
 (0)