Skip to content

xds: Fix Java 8 compilation failure; add ldsResourceNameResolver and forAddress() to XdsServerBuilder #12926

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

Draft
Copilot wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

xds: Fix Java 8 compilation failure; add ldsResourceNameResolver and forAddress() to XdsServerBuilder #12926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
872b0cc
Initial plan
Copilot Jul 23, 2026
106e03d
Fix Java 8 compatibility: replace pattern matching instanceof in XdsS…
Copilot Jul 23, 2026
ca681bf
Address code review: rename test and improve exception comment
Copilot Jul 23, 2026
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
43 changes: 41 additions & 2 deletions xds/src/main/java/io/grpc/xds/XdsServerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,14 @@
import io.grpc.netty.InternalProtocolNegotiator;
import io.grpc.netty.NettyServerBuilder;
import io.grpc.xds.FilterChainMatchingProtocolNegotiators.FilterChainMatchingNegotiatorServerFactory;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Function;
import java.util.logging.Logger;
import javax.annotation.Nullable;

/**
* A version of {@link ServerBuilder} to create xDS managed servers.
Expand All @@ -57,6 +61,7 @@ public final class XdsServerBuilder extends ForwardingServerBuilder<XdsServerBui
private XdsClientPoolFactory xdsClientPoolFactory =
SharedXdsClientPoolProvider.getDefaultProvider();
private Map<String, ?> bootstrapOverride;
@Nullable private Function<String, String> ldsResourceNameResolver;
private long drainGraceTime = 10;
private TimeUnit drainGraceTimeUnit = TimeUnit.MINUTES;
private ChannelConfigurator channelConfigurator = builder -> { };
Expand Down Expand Up @@ -134,6 +139,23 @@ public static XdsServerBuilder forPort(int port, ServerCredentials serverCredent
return new XdsServerBuilder(nettyDelegate, port);
}

/** Creates a gRPC server builder for the given address. */
public static XdsServerBuilder forAddress(
SocketAddress address, ServerCredentials serverCredentials) {
checkNotNull(serverCredentials, "serverCredentials");
InternalProtocolNegotiator.ServerFactory originalNegotiatorFactory =
InternalNettyServerCredentials.toNegotiator(serverCredentials);
ServerCredentials wrappedCredentials =
InternalNettyServerCredentials.create(
new FilterChainMatchingNegotiatorServerFactory(originalNegotiatorFactory));
NettyServerBuilder nettyDelegate = NettyServerBuilder.forAddress(address, wrappedCredentials);
int port = 0;
if (address instanceof InetSocketAddress) {
port = ((InetSocketAddress) address).getPort();
}
return new XdsServerBuilder(nettyDelegate, port);
}

@Override
public Server build() {
checkState(isServerBuilt.compareAndSet(false, true), "Server already built!");
Expand All @@ -144,11 +166,28 @@ public Server build() {
builder.set(ATTR_DRAIN_GRACE_NANOS, drainGraceTimeUnit.toNanos(drainGraceTime));
}
InternalNettyServerBuilder.eagAttributes(delegate, builder.build());
return new XdsServerWrapper("0.0.0.0:" + port, delegate, xdsServingStatusListener,
filterChainSelectorManager, xdsClientPoolFactory, bootstrapOverride, filterRegistry,
return new XdsServerWrapper(
"0.0.0.0:" + port,
delegate,
xdsServingStatusListener,
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
ldsResourceNameResolver,
filterRegistry,
this.channelConfigurator);
}

/**
* Provides a function that takes the listening address and returns the LDS resource name. When
* provided, this overrides the server_listener_resource_name_template in the bootstrap.
*/
public XdsServerBuilder ldsResourceNameResolver(
Function<String, String> ldsResourceNameResolver) {
this.ldsResourceNameResolver = checkNotNull(ldsResourceNameResolver, "ldsResourceNameResolver");
return this;
}

@VisibleForTesting
XdsServerBuilder xdsClientPoolFactory(XdsClientPoolFactory xdsClientPoolFactory) {
this.xdsClientPoolFactory = checkNotNull(xdsClientPoolFactory, "xdsClientPoolFactory");
Expand Down
172 changes: 141 additions & 31 deletions xds/src/main/java/io/grpc/xds/XdsServerWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -108,6 +109,7 @@ public void uncaughtException(Thread t, Throwable e) {
private final ThreadSafeRandom random = ThreadSafeRandomImpl.instance;
private final XdsClientPoolFactory xdsClientPoolFactory;
private final @Nullable Map<String, ?> bootstrapOverride;
private final @Nullable Function<String, String> ldsResourceNameResolver;
private final XdsServingStatusListener listener;
private final FilterChainSelectorManager filterChainSelectorManager;
private final AtomicBoolean started = new AtomicBoolean(false);
Expand Down Expand Up @@ -139,6 +141,7 @@ public void uncaughtException(Thread t, Throwable e) {
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
@Nullable Function<String, String> ldsResourceNameResolver,
FilterRegistry filterRegistry,
ChannelConfigurator channelConfigurator) {
this(
Expand All @@ -148,12 +151,59 @@ public void uncaughtException(Thread t, Throwable e) {
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
ldsResourceNameResolver,
filterRegistry,
SharedResourceHolder.get(GrpcUtil.TIMER_SERVICE),
channelConfigurator);
sharedTimeService = true;
}

XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
FilterRegistry filterRegistry,
ChannelConfigurator channelConfigurator) {
this(
listenerAddress,
delegateBuilder,
listener,
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
null,
filterRegistry,
SharedResourceHolder.get(GrpcUtil.TIMER_SERVICE),
channelConfigurator);
sharedTimeService = true;
}

XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
@Nullable Function<String, String> ldsResourceNameResolver,
FilterRegistry filterRegistry) {
this(
listenerAddress,
delegateBuilder,
listener,
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
ldsResourceNameResolver,
filterRegistry,
SharedResourceHolder.get(GrpcUtil.TIMER_SERVICE),
builder -> { });
sharedTimeService = true;
}

XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
Expand All @@ -169,43 +219,96 @@ public void uncaughtException(Thread t, Throwable e) {
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
null,
filterRegistry,
SharedResourceHolder.get(GrpcUtil.TIMER_SERVICE),
builder -> { });
sharedTimeService = true;
}

@VisibleForTesting
XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
FilterRegistry filterRegistry,
ScheduledExecutorService timeService) {
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
@Nullable Function<String, String> ldsResourceNameResolver,
FilterRegistry filterRegistry,
ScheduledExecutorService timeService) {
this(
listenerAddress,
delegateBuilder,
listener,
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
ldsResourceNameResolver,
filterRegistry,
timeService,
builder -> { });
}

@VisibleForTesting
XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
FilterRegistry filterRegistry,
ScheduledExecutorService timeService,
ChannelConfigurator channelConfigurator) {
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
FilterRegistry filterRegistry,
ScheduledExecutorService timeService) {
this(
listenerAddress,
delegateBuilder,
listener,
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
null,
filterRegistry,
timeService,
builder -> { });
}

@VisibleForTesting
XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
FilterRegistry filterRegistry,
ScheduledExecutorService timeService,
ChannelConfigurator channelConfigurator) {
this(
listenerAddress,
delegateBuilder,
listener,
filterChainSelectorManager,
xdsClientPoolFactory,
bootstrapOverride,
null,
filterRegistry,
timeService,
channelConfigurator);
}

@VisibleForTesting
XdsServerWrapper(
String listenerAddress,
ServerBuilder<?> delegateBuilder,
XdsServingStatusListener listener,
FilterChainSelectorManager filterChainSelectorManager,
XdsClientPoolFactory xdsClientPoolFactory,
@Nullable Map<String, ?> bootstrapOverride,
@Nullable Function<String, String> ldsResourceNameResolver,
FilterRegistry filterRegistry,
ScheduledExecutorService timeService,
ChannelConfigurator channelConfigurator) {
this.listenerAddress = checkNotNull(listenerAddress, "listenerAddress");
this.delegateBuilder = checkNotNull(delegateBuilder, "delegateBuilder");
this.delegateBuilder.intercept(new ConfigApplyingInterceptor());
Expand All @@ -214,6 +317,7 @@ public void uncaughtException(Thread t, Throwable e) {
= checkNotNull(filterChainSelectorManager, "filterChainSelectorManager");
this.xdsClientPoolFactory = checkNotNull(xdsClientPoolFactory, "xdsClientPoolFactory");
this.bootstrapOverride = bootstrapOverride;
this.ldsResourceNameResolver = ldsResourceNameResolver;
this.timeService = checkNotNull(timeService, "timeService");
this.filterRegistry = checkNotNull(filterRegistry,"filterRegistry");
this.delegate = delegateBuilder.build();
Expand Down Expand Up @@ -261,21 +365,27 @@ private void internalStart() {
return;
}
xdsClient = xdsClientPool.getObject();
String listenerTemplate = xdsClient.getBootstrapInfo().serverListenerResourceNameTemplate();
if (listenerTemplate == null) {
StatusException statusException =
Status.UNAVAILABLE.withDescription(
"Can only support xDS v3 with listener resource name template").asException();
listener.onNotServing(statusException);
initialStartFuture.set(statusException);
xdsClient = xdsClientPool.returnObject(xdsClient);
return;
}
String replacement = listenerAddress;
if (listenerTemplate.startsWith(XDSTP_SCHEME)) {
replacement = XdsClient.percentEncodePath(replacement);
String resourceName;
if (ldsResourceNameResolver != null) {
resourceName = ldsResourceNameResolver.apply(listenerAddress);
} else {
String listenerTemplate = xdsClient.getBootstrapInfo().serverListenerResourceNameTemplate();
if (listenerTemplate == null) {
StatusException statusException =
Status.UNAVAILABLE.withDescription(
"Can only support xDS v3 with listener resource name template").asException();
listener.onNotServing(statusException);
initialStartFuture.set(statusException);
xdsClient = xdsClientPool.returnObject(xdsClient);
return;
}
String replacement = listenerAddress;
if (listenerTemplate.startsWith(XDSTP_SCHEME)) {
replacement = XdsClient.percentEncodePath(replacement);
}
resourceName = listenerTemplate.replaceAll("%s", replacement);
}
discoveryState = new DiscoveryState(listenerTemplate.replaceAll("%s", replacement));
discoveryState = new DiscoveryState(resourceName);
}

@Override
Expand Down
45 changes: 44 additions & 1 deletion xds/src/test/java/io/grpc/xds/XdsServerWrapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,50 @@ public void run() {
}

@Test
public void shutdown() throws Exception {
@SuppressWarnings("unchecked")
public void testLdsResourceNameResolver_overridesBootstrapTemplate() throws Exception {
Bootstrapper.BootstrapInfo b =
Bootstrapper.BootstrapInfo.builder()
.servers(
Arrays.asList(
Bootstrapper.ServerInfo.create("uri", InsecureChannelCredentials.create())))
.node(EnvoyProtoData.Node.newBuilder().setId("id").build())
.serverListenerResourceNameTemplate("grpc/server?udpa.resource.listening_address=%s")
.build();
XdsClient xdsClient = mock(XdsClient.class);
XdsListenerResource listenerResource = XdsListenerResource.getInstance();
when(xdsClient.getBootstrapInfo()).thenReturn(b);
xdsServerWrapper =
new XdsServerWrapper(
"[::FFFF:129.144.52.38]:80",
mockBuilder,
listener,
selectorManager,
new FakeXdsClientPoolFactory(xdsClient),
XdsServerTestHelper.RAW_BOOTSTRAP,
addr -> "xdstp://resolved_name/" + addr,
filterRegistry);
Executors.newSingleThreadExecutor()
.execute(
new Runnable() {
@Override
public void run() {
try {
xdsServerWrapper.start();
} catch (IOException ex) {
// Ignored: test only asserts on the watchXdsResource call, not start() result.
}
}
});
verify(xdsClient, timeout(5000))
.watchXdsResource(
eq(listenerResource),
eq("xdstp://resolved_name/[::FFFF:129.144.52.38]:80"),
any(ResourceWatcher.class),
any(SynchronizationContext.class));
}

@Test
final SettableFuture<Server> start = SettableFuture.create();
Executors.newSingleThreadExecutor().execute(new Runnable() {
@Override
Expand Down
Loading