Merge branch 'master' into pr/548

Author: ST-DDT

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

@@ -37,7 +37,6 @@
 import io.grpc.NameResolverProvider;
 import io.grpc.internal.GrpcUtil;
 import io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder;
-import io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder;
 import io.grpc.netty.shaded.io.netty.handler.ssl.SslContextBuilder;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
@@ -182,7 +181,7 @@ public void setEnableKeepAlive(final Boolean enableKeepAlive) {
 
     @DurationUnit(ChronoUnit.SECONDS)
     private Duration keepAliveTime;
-    private static final Duration DEFAULT_KEEP_ALIVE_TIME = Duration.of(60, ChronoUnit.SECONDS);
+    private static final Duration DEFAULT_KEEP_ALIVE_TIME = Duration.of(5, ChronoUnit.MINUTES);
 
     /**
      * Gets the default delay before we send a keepAlive.
@@ -196,13 +195,14 @@ public Duration getKeepAliveTime() {
     }
 
     /**
-     * The default delay before we send a keepAlives. Defaults to {@code 60s}. Default unit {@link ChronoUnit#SECONDS
-     * SECONDS}. Please note that shorter intervals increase the network burden for the server.
+     * The default delay before we send a keepAlives. Defaults to {@code 5min}. Default unit {@link ChronoUnit#SECONDS
+     * SECONDS}. Please note that shorter intervals increase the network burden for the server. Cannot be lower than
+     * permitKeepAliveTime on server (default 5min).
      *
      * @param keepAliveTime The new default delay before sending keepAlives, or null to use the fallback.
      *
      * @see #setEnableKeepAlive(Boolean)
-     * @see NettyServerBuilder#keepAliveTime(long, TimeUnit)
+     * @see NettyChannelBuilder#keepAliveTime(long, TimeUnit)
      */
     public void setKeepAliveTime(final Duration keepAliveTime) {
         this.keepAliveTime = keepAliveTime;
@@ -232,7 +232,7 @@ public Duration getKeepAliveTimeout() {
      * @param keepAliveTimeout The default timeout for a keepAlives ping request.
      *
      * @see #setEnableKeepAlive(Boolean)
-     * @see NettyServerBuilder#keepAliveTimeout(long, TimeUnit)
+     * @see NettyChannelBuilder#keepAliveTimeout(long, TimeUnit)
      */
     public void setKeepAliveTimeout(final Duration keepAliveTimeout) {
         this.keepAliveTimeout = keepAliveTimeout;

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

@@ -118,7 +118,7 @@ public class GrpcServerProperties {
     private boolean enableKeepAlive = false;
 
     /**
-     * The default delay before we send a keepAlives. Defaults to {@code 60s}. Default unit {@link ChronoUnit#SECONDS
+     * The default delay before we send a keepAlives. Defaults to {@code 2h}. Default unit {@link ChronoUnit#SECONDS
      * SECONDS}.
      *
      * @see #setEnableKeepAlive(boolean)
@@ -128,7 +128,7 @@ public class GrpcServerProperties {
      * @return The default delay before sending keepAlives.
      */
     @DurationUnit(ChronoUnit.SECONDS)
-    private Duration keepAliveTime = Duration.of(60, ChronoUnit.SECONDS);
+    private Duration keepAliveTime = Duration.of(2, ChronoUnit.HOURS);
 
     /**
      * The default timeout for a keepAlives ping request. Defaults to {@code 20s}. Default unit
@@ -167,6 +167,40 @@ public class GrpcServerProperties {
     @DurationUnit(ChronoUnit.SECONDS)
     private boolean permitKeepAliveWithoutCalls = false;
 
+    /**
+     * Specify a max connection idle time. Defaults to disabled. Default unit {@link ChronoUnit#SECONDS SECONDS}.
+     *
+     * @see NettyServerBuilder#maxConnectionIdle(long, TimeUnit)
+     *
+     * @param maxConnectionIdle The max connection idle time.
+     * @return The max connection idle time.
+     */
+    @DurationUnit(ChronoUnit.SECONDS)
+    private Duration maxConnectionIdle = null;
+
+    /**
+     * Specify a max connection age. Defaults to disabled. Default unit {@link ChronoUnit#SECONDS SECONDS}.
+     *
+     * @see NettyServerBuilder#maxConnectionAge(long, TimeUnit)
+     *
+     * @param maxConnectionAge The max connection age.
+     * @return The max connection age.
+     */
+    @DurationUnit(ChronoUnit.SECONDS)
+    private Duration maxConnectionAge = null;
+
+    /**
+     * Specify a grace time for the graceful max connection age termination. Defaults to disabled. Default unit
+     * {@link ChronoUnit#SECONDS SECONDS}.
+     *
+     * @see NettyServerBuilder#maxConnectionAgeGrace(long, TimeUnit)
+     *
+     * @param maxConnectionAgeGrace The max connection age grace time.
+     * @return The max connection age grace time.
+     */
+    @DurationUnit(ChronoUnit.SECONDS)
+    private Duration maxConnectionAgeGrace = null;
+
     /**
      * The maximum message size allowed to be received by the server. If not set ({@code null}) then
      * {@link GrpcUtil#DEFAULT_MAX_MESSAGE_SIZE gRPC's default} should be used.

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

@@ -84,6 +84,7 @@ public Server createServer() {
     protected void configure(final T builder) {
         configureServices(builder);
         configureKeepAlive(builder);
+        configureConnectionLimits(builder);
         configureSecurity(builder);
         configureLimits(builder);
         for (final GrpcServerConfigurer serverConfigurer : this.serverConfigurers) {
@@ -121,6 +122,26 @@ protected void configureKeepAlive(final T builder) {
         }
     }
 
+    /**
+     * Configures the keep alive options that should be used by the server.
+     *
+     * @param builder The server builder to configure.
+     */
+    protected void configureConnectionLimits(final T builder) {
+        if (this.properties.getMaxConnectionIdle() != null) {
+            throw new IllegalStateException(
+                    "MaxConnectionIdle is set but this implementation does not support maxConnectionIdle!");
+        }
+        if (this.properties.getMaxConnectionAge() != null) {
+            throw new IllegalStateException(
+                    "MaxConnectionAge is set but this implementation does not support maxConnectionAge!");
+        }
+        if (this.properties.getMaxConnectionAgeGrace() != null) {
+            throw new IllegalStateException(
+                    "MaxConnectionAgeGrace is set but this implementation does not support maxConnectionAgeGrace!");
+        }
+    }
+
     /**
      * Configures the security options that should be used by the server.
      *

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

@@ -88,6 +88,20 @@ protected void configureKeepAlive(final NettyServerBuilder builder) {
                 .permitKeepAliveWithoutCalls(this.properties.isPermitKeepAliveWithoutCalls());
     }
 
+    @Override
+    // Keep this in sync with ShadedNettyGrpcServerFactory#configureConnectionLimits
+    protected void configureConnectionLimits(final NettyServerBuilder builder) {
+        if (this.properties.getMaxConnectionIdle() != null) {
+            builder.maxConnectionIdle(this.properties.getMaxConnectionIdle().toNanos(), TimeUnit.NANOSECONDS);
+        }
+        if (this.properties.getMaxConnectionAge() != null) {
+            builder.maxConnectionAge(this.properties.getMaxConnectionAge().toNanos(), TimeUnit.NANOSECONDS);
+        }
+        if (this.properties.getMaxConnectionAgeGrace() != null) {
+            builder.maxConnectionAgeGrace(this.properties.getMaxConnectionAgeGrace().toNanos(), TimeUnit.NANOSECONDS);
+        }
+    }
+
     @Override
     // Keep this in sync with ShadedNettyGrpcServerFactory#configureSecurity
     protected void configureSecurity(final NettyServerBuilder builder) {

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

@@ -78,6 +78,20 @@ protected NettyServerBuilder newServerBuilder() {
         }
     }
 
+    @Override
+    // Keep this in sync with NettyGrpcServerFactory#configureConnectionLimits
+    protected void configureConnectionLimits(final NettyServerBuilder builder) {
+        if (this.properties.getMaxConnectionIdle() != null) {
+            builder.maxConnectionIdle(this.properties.getMaxConnectionIdle().toNanos(), TimeUnit.NANOSECONDS);
+        }
+        if (this.properties.getMaxConnectionAge() != null) {
+            builder.maxConnectionAge(this.properties.getMaxConnectionAge().toNanos(), TimeUnit.NANOSECONDS);
+        }
+        if (this.properties.getMaxConnectionAgeGrace() != null) {
+            builder.maxConnectionAgeGrace(this.properties.getMaxConnectionAgeGrace().toNanos(), TimeUnit.NANOSECONDS);
+        }
+    }
+
     @Override
     // Keep this in sync with NettyGrpcServerFactory#configureKeepAlive
     protected void configureKeepAlive(final NettyServerBuilder builder) {