googleapis: Add RFC 3986 URI support.

jdcormie · jdcormie · commit e1d7c5fd7ef7 · 2026-03-17T16:43:17.000-07:00
diff --git a/googleapis/src/main/java/io/grpc/googleapis/GoogleCloudToProdExperimentalNameResolverProvider.java b/googleapis/src/main/java/io/grpc/googleapis/GoogleCloudToProdExperimentalNameResolverProvider.java
@@ -20,6 +20,7 @@
 import io.grpc.NameResolver;
 import io.grpc.NameResolver.Args;
 import io.grpc.NameResolverProvider;
+import io.grpc.Uri;
 import java.net.URI;
 
 /**
@@ -35,6 +36,11 @@ public NameResolver newNameResolver(URI targetUri, Args args) {
     return delegate.newNameResolver(targetUri, args);
   }
 
+  @Override
+  public NameResolver newNameResolver(Uri targetUri, Args args) {
+    return delegate.newNameResolver(targetUri, args);
+  }
+
   @Override
   public String getDefaultScheme() {
     return delegate.getDefaultScheme();
diff --git a/googleapis/src/main/java/io/grpc/googleapis/GoogleCloudToProdNameResolver.java b/googleapis/src/main/java/io/grpc/googleapis/GoogleCloudToProdNameResolver.java
@@ -29,6 +29,7 @@
 import io.grpc.NameResolverRegistry;
 import io.grpc.Status;
 import io.grpc.SynchronizationContext;
+import io.grpc.Uri;
 import io.grpc.alts.InternalCheckGcpEnvironment;
 import io.grpc.internal.GrpcUtil;
 import io.grpc.internal.SharedResourceHolder;
@@ -49,6 +50,7 @@
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.util.List;
 import java.util.Random;
 import java.util.concurrent.Executor;
 import java.util.logging.Level;
@@ -117,6 +119,7 @@ private static synchronized BootstrapInfo getBootstrapInfo()
   @VisibleForTesting
   GoogleCloudToProdNameResolver(URI targetUri, Args args, Resource<Executor> executorResource,
       NameResolver.Factory nameResolverFactory) {
+    // TODO(jdcormie): Remove after io.grpc.Uri migration.
     this.executorResource = checkNotNull(executorResource, "executorResource");
     String targetPath = checkNotNull(checkNotNull(targetUri, "targetUri").getPath(), "targetPath");
     Preconditions.checkArgument(
@@ -141,6 +144,45 @@ private static synchronized BootstrapInfo getBootstrapInfo()
     usingExecutorResource = executor == null;
   }
 
+  GoogleCloudToProdNameResolver(Uri targetUri, Args args, Resource<Executor> executorResource) {
+    this(targetUri, args, executorResource, NameResolverRegistry.getDefaultRegistry().asFactory());
+  }
+
+  @VisibleForTesting
+  GoogleCloudToProdNameResolver(
+      Uri targetUri,
+      Args args,
+      Resource<Executor> executorResource,
+      NameResolver.Factory nameResolverFactory) {
+    this.executorResource = checkNotNull(executorResource, "executorResource");
+    Preconditions.checkArgument(
+        targetUri.isPathAbsolute(),
+        "the path component of the target (%s) must start with '/'",
+        targetUri);
+    List<String> pathSegments = targetUri.getPathSegments();
+    Preconditions.checkArgument(
+        pathSegments.size() == 1,
+        "the path component of the target (%s) must have exactly one segment",
+        targetUri);
+    authority = GrpcUtil.checkAuthority(pathSegments.get(0));
+    syncContext = checkNotNull(args, "args").getSynchronizationContext();
+    Uri.Builder modifiedTargetBuilder = targetUri.toBuilder().setScheme(schemeOverride);
+    if (schemeOverride.equals("xds")) {
+      modifiedTargetBuilder.setRawAuthority(C2P_AUTHORITY).build();
+      args =
+          args.toBuilder()
+              .setArg(XdsNameResolverProvider.XDS_CLIENT_SUPPLIER, () -> xdsClient)
+              .build();
+    }
+    targetUri = modifiedTargetBuilder.build();
+    target = targetUri.toString();
+    metricRecorder = args.getMetricRecorder();
+    delegate =
+        checkNotNull(nameResolverFactory, "nameResolverFactory").newNameResolver(targetUri, args);
+    executor = args.getOffloadExecutor();
+    usingExecutorResource = executor == null;
+  }
+
   @Override
   public String getServiceAuthority() {
     return authority;
diff --git a/googleapis/src/main/java/io/grpc/googleapis/GoogleCloudToProdNameResolverProvider.java b/googleapis/src/main/java/io/grpc/googleapis/GoogleCloudToProdNameResolverProvider.java
@@ -21,6 +21,7 @@
 import io.grpc.NameResolver;
 import io.grpc.NameResolver.Args;
 import io.grpc.NameResolverProvider;
+import io.grpc.Uri;
 import io.grpc.internal.GrpcUtil;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
@@ -48,6 +49,16 @@ public GoogleCloudToProdNameResolverProvider() {
 
   @Override
   public NameResolver newNameResolver(URI targetUri, Args args) {
+    // TODO(jdcormie): Remove after io.grpc.Uri migration is complete.
+    if (scheme.equals(targetUri.getScheme())) {
+      return new GoogleCloudToProdNameResolver(
+          targetUri, args, GrpcUtil.SHARED_CHANNEL_EXECUTOR);
+    }
+    return null;
+  }
+
+  @Override
+  public NameResolver newNameResolver(Uri targetUri, Args args) {
     if (scheme.equals(targetUri.getScheme())) {
       return new GoogleCloudToProdNameResolver(
           targetUri, args, GrpcUtil.SHARED_CHANNEL_EXECUTOR);
diff --git a/googleapis/src/test/java/io/grpc/googleapis/GoogleCloudToProdNameResolverProviderTest.java b/googleapis/src/test/java/io/grpc/googleapis/GoogleCloudToProdNameResolverProviderTest.java
@@ -23,20 +23,23 @@
 import io.grpc.ChannelLogger;
 import io.grpc.InternalServiceProviders;
 import io.grpc.NameResolver;
+import io.grpc.NameResolver.Args;
 import io.grpc.NameResolver.ServiceConfigParser;
 import io.grpc.NameResolverProvider;
 import io.grpc.SynchronizationContext;
+import io.grpc.Uri;
 import io.grpc.internal.FakeClock;
 import io.grpc.internal.GrpcUtil;
 import java.net.URI;
+import java.util.Arrays;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameter;
+import org.junit.runners.Parameterized.Parameters;
 
-/**
- * Unit tests for {@link GoogleCloudToProdNameResolverProvider}.
- */
-@RunWith(JUnit4.class)
+/** Unit tests for {@link GoogleCloudToProdNameResolverProvider}. */
+@RunWith(Parameterized.class)
 public class GoogleCloudToProdNameResolverProviderTest {
   private final SynchronizationContext syncContext = new SynchronizationContext(
       new Thread.UncaughtExceptionHandler() {
@@ -59,6 +62,13 @@ public void uncaughtException(Thread t, Throwable e) {
   private GoogleCloudToProdNameResolverProvider provider =
       new GoogleCloudToProdNameResolverProvider();
 
+  @Parameters(name = "enableRfc3986UrisParam={0}")
+  public static Iterable<Object[]> data() {
+    return Arrays.asList(new Object[][] {{true}, {false}});
+  }
+
+  @Parameter public boolean enableRfc3986UrisParam;
+
   @Test
   public void provided() {
     for (NameResolverProvider current
@@ -84,16 +94,24 @@ NameResolverProvider.class, getClass().getClassLoader())) {
   }
 
   @Test
-  public void newNameResolver() {
-    assertThat(provider
-        .newNameResolver(URI.create("google-c2p:///foo.googleapis.com"), args))
+  public void shouldProvideNameResolverOfExpectedType() {
+    assertThat(newNameResolver(provider, "google-c2p:///foo.googleapis.com", args))
         .isInstanceOf(GoogleCloudToProdNameResolver.class);
   }
 
   @Test
-  public void experimentalNewNameResolver() {
-    assertThat(new GoogleCloudToProdExperimentalNameResolverProvider()
-        .newNameResolver(URI.create("google-c2p-experimental:///foo.googleapis.com"), args))
+  public void shouldProvideExperimentalNameResolverOfExpectedType() {
+    assertThat(
+            newNameResolver(
+                new GoogleCloudToProdExperimentalNameResolverProvider(),
+                "google-c2p-experimental:///foo.googleapis.com",
+                args))
         .isInstanceOf(GoogleCloudToProdNameResolver.class);
   }
+
+  private NameResolver newNameResolver(NameResolverProvider provider, String uri, Args args) {
+    return enableRfc3986UrisParam
+        ? provider.newNameResolver(Uri.create(uri), args)
+        : provider.newNameResolver(URI.create(uri), args);
+  }
 }
diff --git a/googleapis/src/test/java/io/grpc/googleapis/GoogleCloudToProdNameResolverTest.java b/googleapis/src/test/java/io/grpc/googleapis/GoogleCloudToProdNameResolverTest.java
@@ -34,6 +34,7 @@
 import io.grpc.Status;
 import io.grpc.Status.Code;
 import io.grpc.SynchronizationContext;
+import io.grpc.Uri;
 import io.grpc.googleapis.GoogleCloudToProdNameResolver.HttpConnectionProvider;
 import io.grpc.internal.FakeClock;
 import io.grpc.internal.GrpcUtil;
@@ -43,6 +44,7 @@
 import java.net.HttpURLConnection;
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -53,20 +55,22 @@
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.junit.runners.JUnit4;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameter;
+import org.junit.runners.Parameterized.Parameters;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Captor;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnit;
 import org.mockito.junit.MockitoRule;
 
-@RunWith(JUnit4.class)
+@RunWith(Parameterized.class)
 public class GoogleCloudToProdNameResolverTest {
 
   @Rule
   public final MockitoRule mocks = MockitoJUnit.rule();
 
-  private static final URI TARGET_URI = URI.create("google-c2p:///googleapis.com");
+  private static final String TARGET_URI = "google-c2p:///googleapis.com";
   private static final String ZONE = "us-central1-a";
   private static final int DEFAULT_PORT = 887;
 
@@ -108,6 +112,13 @@ public void close(Executor instance) {}
   private GoogleCloudToProdNameResolver resolver;
   private String responseToIpV6 = "1:1:1";
 
+  @Parameters(name = "enableRfc3986UrisParam={0}")
+  public static Iterable<Object[]> data() {
+    return Arrays.asList(new Object[][] {{true}, {false}});
+  }
+
+  @Parameter public boolean enableRfc3986UrisParam;
+
   @Before
   public void setUp() {
     nsRegistry.register(new FakeNsProvider("dns"));
@@ -149,8 +160,12 @@ public void tearDown() {
   }
 
   private void createResolver() {
-    resolver = new GoogleCloudToProdNameResolver(
-        TARGET_URI, args, fakeExecutorResource, nsRegistry.asFactory());
+    resolver =
+        enableRfc3986UrisParam
+            ? new GoogleCloudToProdNameResolver(
+                Uri.create(TARGET_URI), args, fakeExecutorResource, nsRegistry.asFactory())
+            : new GoogleCloudToProdNameResolver(
+                URI.create(TARGET_URI), args, fakeExecutorResource, nsRegistry.asFactory());
   }
 
   @Test
