Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
70 changes: 70 additions & 0 deletions api/src/main/java/io/grpc/ChildChannelConfigurer.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* Copyright 2025 The gRPC Authors
Comment thread
AgraVator marked this conversation as resolved.
Outdated
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package io.grpc;

import java.util.function.Consumer;

/**
* A configurer for child channels created by gRPC's internal infrastructure.
*
* <p>This interface allows users to inject configuration (such as credentials, interceptors,
* or flow control settings) into channels created automatically by gRPC for control plane
* operations. Common use cases include:
* <ul>
* <li>xDS control plane connections</li>
* <li>Load Balancing helper channels (OOB channels)</li>
* </ul>
*
* <p><strong>Usage Example:</strong>
* <pre>{@code
* // 1. Define the configurer
* ChildChannelConfigurer configurer = builder -> {
* builder.intercept(new MyAuthInterceptor());
* builder.maxInboundMessageSize(4 * 1024 * 1024);
* };
*
* // 2. Apply to parent channel - automatically used for ALL child channels
* ManagedChannel channel = ManagedChannelBuilder
* .forTarget("xds:///my-service")
* .childChannelConfigurer(configurer)
* .build();
* }</pre>
*
* <p>Implementations must be thread-safe as {@link #accept} may be invoked concurrently
* by multiple internal components.
*
* @since 1.79.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
@FunctionalInterface
public interface ChildChannelConfigurer extends Consumer<ManagedChannelBuilder<?>> {

/**
* Configures a builder for a new child channel.
*
* <p>This method is invoked synchronously during the creation of the child channel,
* before {@link ManagedChannelBuilder#build()} is called.
*
* <p>Note: The provided {@code builder} is generic (`?`). Implementations should use
* universal configuration methods (like {@code intercept()}, {@code userAgent()}) rather
* than casting to specific implementation types.
Comment thread
AgraVator marked this conversation as resolved.
Outdated
*
* @param builder the mutable channel builder for the new child channel
*/
@Override
void accept(ManagedChannelBuilder<?> builder);
}
99 changes: 99 additions & 0 deletions api/src/main/java/io/grpc/ChildChannelConfigurers.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* Copyright 2025 The gRPC Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package io.grpc;

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.logging.Level;
import java.util.logging.Logger;

/**
* Utilities for working with {@link ChildChannelConfigurer}.
*
* @since 1.79.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
public final class ChildChannelConfigurers {
private static final Logger logger = Logger.getLogger(ChildChannelConfigurers.class.getName());

// Singleton no-op instance to avoid object churn
private static final ChildChannelConfigurer NO_OP = builder -> {
};

private ChildChannelConfigurers() { // Prevent instantiation
}

/**
* Returns a configurer that does nothing.
* Useful as a default value to avoid null checks in internal code.
*/
public static ChildChannelConfigurer noOp() {
return NO_OP;
}

/**
* Returns a configurer that applies all the given configurers in sequence.
*
* <p>If any configurer in the chain throws an exception, the remaining ones are skipped
* (unless wrapped in {@link #safe(ChildChannelConfigurer)}).
*
* @param configurers the configurers to apply in order. Null elements are ignored.
*/
public static ChildChannelConfigurer compose(ChildChannelConfigurer... configurers) {
checkNotNull(configurers, "configurers");
return builder -> {
for (ChildChannelConfigurer configurer : configurers) {
if (configurer != null) {
configurer.accept(builder);
}
}
};
}

/**
* Returns a configurer that applies the delegate but catches and logs any exceptions.
*
* <p>This prevents a buggy configurer (e.g., one that fails metric setup) from crashing
* the critical path of channel creation.
*
* @param delegate the configurer to wrap.
*/
public static ChildChannelConfigurer safe(ChildChannelConfigurer delegate) {
Comment thread
AgraVator marked this conversation as resolved.
Outdated
checkNotNull(delegate, "delegate");
return builder -> {
try {
delegate.accept(builder);
} catch (Exception e) {
logger.log(Level.WARNING, "Failed to apply child channel configuration", e);
}
};
}

/**
* Returns a configurer that applies the delegate only if the given condition is true.
*
* <p>Useful for applying interceptors only in specific environments (e.g., Debug/Test).
*
* @param condition true to apply the delegate, false to do nothing.
* @param delegate the configurer to apply if condition is true.
*/
public static ChildChannelConfigurer conditional(boolean condition,
Comment thread
AgraVator marked this conversation as resolved.
Outdated
ChildChannelConfigurer delegate) {
checkNotNull(delegate, "delegate");
return condition ? delegate : NO_OP;
}
}
18 changes: 18 additions & 0 deletions api/src/main/java/io/grpc/ForwardingChannelBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,24 @@ public T disableServiceConfigLookUp() {
return thisT();
}

@Override
public T configureChannel(ManagedChannel parentChannel) {
delegate().configureChannel(parentChannel);
return thisT();
}

@Override
public T configureChannel(Server parentServer) {
delegate().configureChannel(parentServer);
return thisT();
}

@Override
public T childChannelConfigurer(ChildChannelConfigurer childChannelConfigurer) {
delegate().childChannelConfigurer(childChannelConfigurer);
return thisT();
}

/**
* Returns the correctly typed version of the builder.
*/
Expand Down
22 changes: 20 additions & 2 deletions api/src/main/java/io/grpc/ForwardingChannelBuilder2.java
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public T intercept(ClientInterceptor... interceptors) {
}

@Override
protected T interceptWithTarget(InterceptorFactory factory) {
public T interceptWithTarget(InterceptorFactory factory) {
delegate().interceptWithTarget(factory);
return thisT();
}
Expand Down Expand Up @@ -258,7 +258,7 @@ public T disableServiceConfigLookUp() {
}

@Override
protected T addMetricSink(MetricSink metricSink) {
public T addMetricSink(MetricSink metricSink) {
delegate().addMetricSink(metricSink);
return thisT();
}
Expand All @@ -269,6 +269,24 @@ public <X> T setNameResolverArg(NameResolver.Args.Key<X> key, X value) {
return thisT();
}

@Override
public T configureChannel(ManagedChannel parentChannel) {
delegate().configureChannel(parentChannel);
return thisT();
}

@Override
public T configureChannel(Server parentServer) {
delegate().configureChannel(parentServer);
return thisT();
}

@Override
public T childChannelConfigurer(ChildChannelConfigurer childChannelConfigurer) {
delegate().childChannelConfigurer(childChannelConfigurer);
return thisT();
}

/**
* Returns the {@link ManagedChannel} built by the delegate by default. Overriding method can
* return different value.
Expand Down
12 changes: 12 additions & 0 deletions api/src/main/java/io/grpc/ForwardingServerBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,18 @@ public T setBinaryLog(BinaryLog binaryLog) {
return thisT();
}

@Override
public T configureChannel(Server parentServer) {
delegate().configureChannel(parentServer);
return thisT();
}

@Override
public T childChannelConfigurer(ChildChannelConfigurer childChannelConfigurer) {
delegate().childChannelConfigurer(childChannelConfigurer);
return thisT();
}

/**
* Returns the {@link Server} built by the delegate by default. Overriding method can return
* different value.
Expand Down
17 changes: 17 additions & 0 deletions api/src/main/java/io/grpc/ManagedChannel.java
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,23 @@ public ConnectivityState getState(boolean requestConnection) {
throw new UnsupportedOperationException("Not implemented");
}

/**
* Returns the configurer for child channels.
*
* <p>This method is intended for use by the internal gRPC infrastructure (specifically
* load balancers and the channel builder) to propagate configuration to child channels.
* Application code should not call this method.
*
* @return the configurer, or {@code noOp()} if none is set.
* @since 1.79.0
*/
@Internal
public ChildChannelConfigurer getChildChannelConfigurer() {
Comment thread
AgraVator marked this conversation as resolved.
Outdated
// Return noOP() by default so we don't break existing custom ManagedChannel implementations
// (like wrappers or mocks) that don't override this method.
return ChildChannelConfigurers.noOp();
}

/**
* Registers a one-off callback that will be run if the connectivity state of the channel diverges
* from the given {@code source}, which is typically what has just been returned by {@link
Expand Down
59 changes: 51 additions & 8 deletions api/src/main/java/io/grpc/ManagedChannelBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,14 @@ public T offloadExecutor(Executor executor) {
public abstract T intercept(ClientInterceptor... interceptors);

/**
* Internal-only: Adds a factory that will construct an interceptor based on the channel's target.
* Adds a factory that will construct an interceptor based on the channel's target.
* This can be used to work around nameResolverFactory() changing the target string.
*/
@Internal
protected T interceptWithTarget(InterceptorFactory factory) {
public T interceptWithTarget(InterceptorFactory factory) {
throw new UnsupportedOperationException();
}

/** Internal-only. */
@Internal
Comment thread
AgraVator marked this conversation as resolved.
protected interface InterceptorFactory {
public interface InterceptorFactory {
Comment thread
AgraVator marked this conversation as resolved.
Outdated
ClientInterceptor newInterceptor(String target);
}

Expand Down Expand Up @@ -638,8 +635,7 @@ public T disableServiceConfigLookUp() {
* @return this
* @since 1.64.0
*/
@Internal
protected T addMetricSink(MetricSink metricSink) {
public T addMetricSink(MetricSink metricSink) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's happening here? Why will this no longer be internal? Even if we were going to make it public, we wouldn't have it go immediately stable; it'd be experimental first.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When an application or test implements ChannelConfigurator, it receives a reference to the child channel's ManagedChannelBuilder.
If addMetricSink were protected (or package-private), then class implementations of ChannelConfigurator outside of the io.grpc package (such as user applications or test suites like FakeControlPlaneXdsIntegrationTest.java) would not be able to call builder.addMetricSink(sink) to register their metric sinks.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the problem with that? What new thing do they need to do because of ChannelConfigurator? If addMetricSink() being hidden was a problem, wouldn't that be a pre-existing problem?

GrpcOpenTelemetry.configureChannelBuilder() still works fine with ChannelConfigurator, and it calls addMetricSink() on the user's behalf.

throw new UnsupportedOperationException();
}

Expand All @@ -661,6 +657,53 @@ public <X> T setNameResolverArg(NameResolver.Args.Key<X> key, X value) {
throw new UnsupportedOperationException();
}

/**
* Configures this builder using settings derived from an existing parent channel.
*
* <p>This method is typically used by internal components (like LoadBalancers) when creating
* child channels to ensure they inherit relevant configuration (like the
* {@link ChildChannelConfigurer}) from the parent.
*
* @param parentChannel the channel to inherit configuration from
* @return this
* @since 1.79.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
public T configureChannel(ManagedChannel parentChannel) {
throw new UnsupportedOperationException();
}

/**
* Configures this builder using settings derived from an existing parent server.
*
* <p>This method is typically used by internal components (like LoadBalancers) when creating
* child channels to ensure they inherit relevant configuration (like the
* {@link ChildChannelConfigurer}) from the parent.
*
* @param parentServer the server to inherit configuration from
* @return this
* @since 1.79.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
public T configureChannel(Server parentServer) {
throw new UnsupportedOperationException();
}

/**
* Sets a configurer that will be applied to all internal child channels created by this channel.
*
* <p>This allows injecting configuration (like credentials, interceptors, or flow control)
* into auxiliary channels created by gRPC infrastructure, such as xDS control plane connections.
*
* @param childChannelConfigurer the configurer to apply.
* @return this
* @since 1.79.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/12574")
public T childChannelConfigurer(ChildChannelConfigurer childChannelConfigurer) {
throw new UnsupportedOperationException("Not implemented");
}

/**
* Builds a channel using the given parameters.
*
Expand Down
Loading