api: Turn on RFC 3986 parsing by default and update javadoc.

Author: jdcormie

api/src/main/java/io/grpc/FeatureFlags.java

@@ -20,7 +20,7 @@
 import com.google.common.base.Strings;
 
 class FeatureFlags {
-  private static boolean enableRfc3986Uris = getFlag("GRPC_ENABLE_RFC3986_URIS", false);
+  private static boolean enableRfc3986Uris = getFlag("GRPC_ENABLE_RFC3986_URIS", true);
 
   /** Whether to parse targets as RFC 3986 URIs (true), or use {@link java.net.URI} (false). */
   @VisibleForTesting

api/src/main/java/io/grpc/Grpc.java

@@ -73,25 +73,25 @@ private Grpc() {
   public @interface TransportAttr {}
 
   /**
-   * Creates a channel builder with a target string and credentials. The target can be either a
-   * valid {@link NameResolver}-compliant URI, or an authority string.
+   * Creates a channel builder with a target string and credentials. The target can be either an RFC
+   * 3986 URI, or an authority string.
+   *
+   * <p>Example URIs:
    *
-   * <p>A {@code NameResolver}-compliant URI is an absolute hierarchical URI as defined by {@link
-   * java.net.URI}. Example URIs:
    * <ul>
    *   <li>{@code "dns:///foo.googleapis.com:8080"}</li>
    *   <li>{@code "dns:///foo.googleapis.com"}</li>
    *   <li>{@code "dns:///%5B2001:db8:85a3:8d3:1319:8a2e:370:7348%5D:443"}</li>
    *   <li>{@code "dns://8.8.8.8/foo.googleapis.com:8080"}</li>
    *   <li>{@code "dns://8.8.8.8/foo.googleapis.com"}</li>
    *   <li>{@code "zookeeper://zk.example.com:9900/example_service"}</li>
+   *   <li>{@code "intent:#Intent;package=com.some.app;action=a;category=c;end;"}</li>
    * </ul>
    *
-   * <p>An authority string will be converted to a {@code NameResolver}-compliant URI, which has
-   * the scheme from the name resolver with the highest priority (e.g. {@code "dns"}),
-   * no authority, and the original authority string as its path after properly escaped.
-   * We recommend libraries to specify the schema explicitly if it is known, since libraries cannot
-   * know which NameResolver will be default during runtime.
+   * <p>An authority string will be converted to a URI having the scheme of the name resolver with
+   * the highest priority (e.g. {@code "dns"}), the empty string as the authority, and 'target' as
+   * its path. We recommend libraries specify the scheme explicitly if it is known, since libraries
+   * cannot know which NameResolver will be default at runtime.
    * Example authority strings:
    * <ul>
    *   <li>{@code "localhost"}</li>
@@ -102,6 +102,14 @@ private Grpc() {
    *   <li>{@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]"}</li>
    *   <li>{@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"}</li>
    * </ul>
+   *
+   * <p>We also recommend the URI form of `target` because the alternative is ambiguous. For
+   * example, the target string `foo:8080` is a valid authority string with host `foo` and port
+   * `8080` but it is also a valid RFC 3986 URI with scheme `foo` and path `8080`. {@code
+   * NameResolver}s are discovered dynamically from your classpath using SPI, so it's hard to be
+   * sure in advance how such a target will be resolved. A {@code NameResolver} for scheme `foo`
+   * might someday make a host named `foo` unreachable! On the other hand, the 'dns:///foo:8080'
+   * target will always behave the same.
    */
   public static ManagedChannelBuilder<?> newChannelBuilder(
       String target, ChannelCredentials creds) {
@@ -118,9 +126,7 @@ public static ManagedChannelBuilder<?> newChannelBuilderForAddress(
     return newChannelBuilder(authorityFromHostAndPort(host, port), creds);
   }
 
-  /**
-   * Combine a host and port into an authority string.
-   */
+  /** Combine a host and port into an authority string. */
   // A copy of GrpcUtil.authorityFromHostAndPort
   private static String authorityFromHostAndPort(String host, int port) {
     try {

api/src/main/java/io/grpc/ManagedChannelBuilder.java

@@ -45,25 +45,24 @@ public static ManagedChannelBuilder<?> forAddress(String name, int port) {
   }
 
   /**
-   * Creates a channel with a target string, which can be either a valid {@link
-   * NameResolver}-compliant URI, or an authority string.
+   * Creates a channel with a target string, which can be either an RFC 3986 URI, or an authority
+   * string.
    *
-   * <p>A {@code NameResolver}-compliant URI is an absolute hierarchical URI as defined by {@link
-   * java.net.URI}. Example URIs:
+   * <p>Example URIs:
    * <ul>
    *   <li>{@code "dns:///foo.googleapis.com:8080"}</li>
    *   <li>{@code "dns:///foo.googleapis.com"}</li>
    *   <li>{@code "dns:///%5B2001:db8:85a3:8d3:1319:8a2e:370:7348%5D:443"}</li>
    *   <li>{@code "dns://8.8.8.8/foo.googleapis.com:8080"}</li>
    *   <li>{@code "dns://8.8.8.8/foo.googleapis.com"}</li>
    *   <li>{@code "zookeeper://zk.example.com:9900/example_service"}</li>
+   *   <li>{@code "intent:#Intent;package=com.some.app;action=a;category=c;end;"}</li>
    * </ul>
    *
-   * <p>An authority string will be converted to a {@code NameResolver}-compliant URI, which has
-   * the scheme from the name resolver with the highest priority (e.g. {@code "dns"}),
-   * no authority, and the original authority string as its path after properly escaped.
-   * We recommend libraries to specify the schema explicitly if it is known, since libraries cannot
-   * know which NameResolver will be default during runtime.
+   * <p>An authority string will be converted to a URI having the scheme of the name resolver with
+   * the highest priority (e.g. {@code "dns"}), the empty string as the authority, and 'target' as
+   * its path. We recommend libraries specify the scheme explicitly if it is known, since libraries
+   * cannot know which NameResolver will be default at runtime.
    * Example authority strings:
    * <ul>
    *   <li>{@code "localhost"}</li>
@@ -75,11 +74,14 @@ public static ManagedChannelBuilder<?> forAddress(String name, int port) {
    *   <li>{@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"}</li>
    * </ul>
    *
-   * <p>Note that there is an open JDK bug on {@link java.net.URI} class parsing an ipv6 scope ID:
-   * bugs.openjdk.org/browse/JDK-8199396. This method is exposed to this bug. If you experience an
-   * issue, a work-around is to convert the scope ID to its numeric form (e.g. by using
-   * Inet6Address.getScopeId()) before calling this method.
-   * 
+   * <p>We strongly recommend the URI form of `target` because the alternative is ambiguous. For
+   * example, the target string `foo:8080` is a valid authority string with host `foo` and port
+   * `8080` but it is also a valid RFC 3986 URI with scheme `foo` and path `8080`. {@code
+   * NameResolver}s are discovered dynamically from your classpath using SPI, so it's hard to be
+   * sure in advance how such a target will be resolved. A {@code NameResolver} for scheme `foo`
+   * might someday make a host named `foo` unreachable! On the other hand, the 'dns:///foo:8080'
+   * target will always behave the same.
+   *
    * @since 1.0.0
    */
   public static ManagedChannelBuilder<?> forTarget(String target) {