Move constants and path extraction to a central location

Author: ST-DDT

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/channelfactory/NettyChannelFactory.java

@@ -18,6 +18,7 @@
 package net.devh.boot.grpc.client.channelfactory;
 
 import static java.util.Objects.requireNonNull;
+import static net.devh.boot.grpc.common.util.GrpcUtils.DOMAIN_SOCKET_ADDRESS_SCHEME;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -39,6 +40,7 @@
 import net.devh.boot.grpc.client.config.GrpcChannelsProperties;
 import net.devh.boot.grpc.client.config.NegotiationType;
 import net.devh.boot.grpc.client.interceptor.GlobalClientInterceptorRegistry;
+import net.devh.boot.grpc.common.util.GrpcUtils;
 
 /**
  * This channel factory creates and manages netty based {@link GrpcChannelFactory}s.
@@ -74,8 +76,8 @@ protected NettyChannelBuilder newChannelBuilder(final String name) {
         if (address == null) {
             address = URI.create(name);
         }
-        if (GrpcChannelProperties.DOMAIN_SOCKET_ADDRESS_SCHEME.equals(address.getScheme())) {
-            String path = address.getSchemeSpecificPart();
+        if (DOMAIN_SOCKET_ADDRESS_SCHEME.equals(address.getScheme())) {
+            final String path = GrpcUtils.extractDomainSocketAddressPath(address.toString());
             return NettyChannelBuilder.forAddress(new DomainSocketAddress(path))
                     .channelType(EpollDomainSocketChannel.class)
                     .eventLoopGroup(new EpollEventLoopGroup());

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/channelfactory/ShadedNettyChannelFactory.java

@@ -18,6 +18,7 @@
 package net.devh.boot.grpc.client.channelfactory;
 
 import static java.util.Objects.requireNonNull;
+import static net.devh.boot.grpc.common.util.GrpcUtils.DOMAIN_SOCKET_ADDRESS_SCHEME;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -39,6 +40,7 @@
 import net.devh.boot.grpc.client.config.GrpcChannelsProperties;
 import net.devh.boot.grpc.client.config.NegotiationType;
 import net.devh.boot.grpc.client.interceptor.GlobalClientInterceptorRegistry;
+import net.devh.boot.grpc.common.util.GrpcUtils;
 
 /**
  * This channel factory creates and manages shaded netty based {@link GrpcChannelFactory}s.
@@ -72,8 +74,8 @@ protected NettyChannelBuilder newChannelBuilder(final String name) {
         if (address == null) {
             address = URI.create(name);
         }
-        if (GrpcChannelProperties.DOMAIN_SOCKET_ADDRESS_SCHEME.equals(address.getScheme())) {
-            final String path = address.getSchemeSpecificPart();
+        if (DOMAIN_SOCKET_ADDRESS_SCHEME.equals(address.getScheme())) {
+            final String path = GrpcUtils.extractDomainSocketAddressPath(address.toString());
             return NettyChannelBuilder.forAddress(new DomainSocketAddress(path))
                     .channelType(EpollDomainSocketChannel.class)
                     .eventLoopGroup(new EpollEventLoopGroup());

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/config/GrpcChannelProperties.java

@@ -52,11 +52,6 @@
 @EqualsAndHashCode
 public class GrpcChannelProperties {
 
-    /**
-     * A constant that defines, the scheme of a Unix domain socket address.
-     */
-    public static final String DOMAIN_SOCKET_ADDRESS_SCHEME = "unix";
-
     // --------------------------------------------------
     // Target Address
     // --------------------------------------------------

grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/GrpcUtils.java

@@ -26,6 +26,16 @@
  */
 public final class GrpcUtils {
 
+    /**
+     * A constant that defines, the scheme of a Unix domain socket address.
+     */
+    public static final String DOMAIN_SOCKET_ADDRESS_SCHEME = "unix";
+
+    /**
+     * A constant that defines, the scheme prefix of a Unix domain socket address.
+     */
+    public static final String DOMAIN_SOCKET_ADDRESS_PREFIX = DOMAIN_SOCKET_ADDRESS_SCHEME + ":";
+
     /**
      * The cloud discovery metadata key used to identify the grpc port.
      */
@@ -36,6 +46,30 @@ public final class GrpcUtils {
      */
     public static final int INTER_PROCESS_DISABLE = -1;
 
+    /**
+     * Extracts the domain socket address specific path from the given full address. The address must fulfill the
+     * requirements as specified by <a href="https://grpc.github.io/grpc/cpp/md_doc_naming.html">grpc</a>.
+     *
+     * @param address The address to extract it from.
+     * @return The extracted domain socket address specific path.
+     * @throws IllegalArgumentException If the given address is not a valid address.
+     */
+    public static String extractDomainSocketAddressPath(final String address) {
+        if (!address.startsWith(DOMAIN_SOCKET_ADDRESS_PREFIX)) {
+            throw new IllegalArgumentException(address + " is not a valid domain socket address.");
+        }
+        String path = address.substring(DOMAIN_SOCKET_ADDRESS_PREFIX.length());
+        if (path.startsWith("//")) {
+            path = path.substring(2);
+            // We don't check this as there is no reliable way to check that it's an absolute path,
+            // especially when Windows adds support for these in the future
+            // if (!path.startsWith("/")) {
+            // throw new IllegalArgumentException("If the path is prefixed with '//', then the path must be absolute");
+            // }
+        }
+        return path;
+    }
+
     /**
      * Extracts the service name from the given method.
      *

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/config/GrpcServerProperties.java

@@ -66,11 +66,6 @@ public class GrpcServerProperties {
      */
     public static final String ANY_IPv6_ADDRESS = "::";
 
-    /**
-     * A constant that defines, the prefix of a Unix domain socket address.
-     */
-    public static final String DOMAIN_SOCKET_ADDRESS_PREFIX = "unix:";
-
     /**
      * Bind address for the server. Defaults to {@link #ANY_IP_ADDRESS "*"}. Alternatively you can restrict this to
      * {@link #ANY_IPv4_ADDRESS "0.0.0.0"} or {@link #ANY_IPv6_ADDRESS "::"}. Or restrict it to exactly one IP address.

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/serverfactory/NettyGrpcServerFactory.java

@@ -18,6 +18,8 @@
 package net.devh.boot.grpc.server.serverfactory;
 
 import static java.util.Objects.requireNonNull;
+import static net.devh.boot.grpc.common.util.GrpcUtils.DOMAIN_SOCKET_ADDRESS_PREFIX;
+import static net.devh.boot.grpc.server.config.GrpcServerProperties.ANY_IP_ADDRESS;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -37,6 +39,7 @@
 import io.netty.channel.epoll.EpollServerDomainSocketChannel;
 import io.netty.channel.unix.DomainSocketAddress;
 import io.netty.handler.ssl.SslContextBuilder;
+import net.devh.boot.grpc.common.util.GrpcUtils;
 import net.devh.boot.grpc.server.config.ClientAuth;
 import net.devh.boot.grpc.server.config.GrpcServerProperties;
 import net.devh.boot.grpc.server.config.GrpcServerProperties.Security;
@@ -64,13 +67,13 @@ public NettyGrpcServerFactory(final GrpcServerProperties properties,
     protected NettyServerBuilder newServerBuilder() {
         final String address = getAddress();
         final int port = getPort();
-        if (address.startsWith(GrpcServerProperties.DOMAIN_SOCKET_ADDRESS_PREFIX)) {
-            String path = address.substring(GrpcServerProperties.DOMAIN_SOCKET_ADDRESS_PREFIX.length());
+        if (address.startsWith(DOMAIN_SOCKET_ADDRESS_PREFIX)) {
+            final String path = GrpcUtils.extractDomainSocketAddressPath(address);
             return NettyServerBuilder.forAddress(new DomainSocketAddress(path))
                     .channelType(EpollServerDomainSocketChannel.class)
                     .bossEventLoopGroup(new EpollEventLoopGroup(1))
                     .workerEventLoopGroup(new EpollEventLoopGroup());
-        } else if (GrpcServerProperties.ANY_IP_ADDRESS.equals(address)) {
+        } else if (ANY_IP_ADDRESS.equals(address)) {
             return NettyServerBuilder.forPort(port);
         } else {
             return NettyServerBuilder.forAddress(new InetSocketAddress(InetAddresses.forString(address), port));

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/serverfactory/ShadedNettyGrpcServerFactory.java

@@ -18,6 +18,8 @@
 package net.devh.boot.grpc.server.serverfactory;
 
 import static java.util.Objects.requireNonNull;
+import static net.devh.boot.grpc.common.util.GrpcUtils.DOMAIN_SOCKET_ADDRESS_PREFIX;
+import static net.devh.boot.grpc.server.config.GrpcServerProperties.ANY_IP_ADDRESS;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -37,6 +39,7 @@
 import io.grpc.netty.shaded.io.netty.channel.epoll.EpollServerDomainSocketChannel;
 import io.grpc.netty.shaded.io.netty.channel.unix.DomainSocketAddress;
 import io.grpc.netty.shaded.io.netty.handler.ssl.SslContextBuilder;
+import net.devh.boot.grpc.common.util.GrpcUtils;
 import net.devh.boot.grpc.server.config.ClientAuth;
 import net.devh.boot.grpc.server.config.GrpcServerProperties;
 import net.devh.boot.grpc.server.config.GrpcServerProperties.Security;
@@ -65,13 +68,13 @@ public ShadedNettyGrpcServerFactory(final GrpcServerProperties properties,
     protected NettyServerBuilder newServerBuilder() {
         final String address = getAddress();
         final int port = getPort();
-        if (address.startsWith(GrpcServerProperties.DOMAIN_SOCKET_ADDRESS_PREFIX)) {
-            final String path = address.substring(GrpcServerProperties.DOMAIN_SOCKET_ADDRESS_PREFIX.length());
+        if (address.startsWith(DOMAIN_SOCKET_ADDRESS_PREFIX)) {
+            final String path = GrpcUtils.extractDomainSocketAddressPath(address);
             return NettyServerBuilder.forAddress(new DomainSocketAddress(path))
                     .channelType(EpollServerDomainSocketChannel.class)
                     .bossEventLoopGroup(new EpollEventLoopGroup(1))
                     .workerEventLoopGroup(new EpollEventLoopGroup());
-        } else if (GrpcServerProperties.ANY_IP_ADDRESS.equals(address)) {
+        } else if (ANY_IP_ADDRESS.equals(address)) {
             return NettyServerBuilder.forPort(port);
         } else {
             return NettyServerBuilder.forAddress(new InetSocketAddress(InetAddresses.forString(address), port));