Merge pull request #380 from jbf154/feat/add_http_header_size_config

feat: add metadata size config for server

Author: yidongnan

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

@@ -160,6 +160,15 @@ public class GrpcServerProperties {
     @DataSizeUnit(DataUnit.BYTES)
     private DataSize maxInboundMessageSize = null;
 
+    /**
+     * The maximum size of metadata allowed to be received. If not set ({@code null}) then
+     * {@link GrpcUtil#DEFAULT_MAX_HEADER_LIST_SIZE gRPC's default} should be used.
+     * 
+     * @return The maximum metadata size allowed.
+     */
+    @DataSizeUnit(DataUnit.BYTES)
+    private DataSize maxInboundMetadataSize = null;
+
     /**
      * Whether gRPC health service is enabled or not. Defaults to {@code true}.
      *
@@ -313,4 +322,24 @@ public void setMaxInboundMessageSize(final DataSize maxInboundMessageSize) {
         }
     }
 
+    /**
+     * Sets the maximum metadata size allowed to be received by the server. If not set ({@code null}) then it will
+     * default to {@link GrpcUtil#DEFAULT_MAX_HEADER_LIST_SIZE gRPC's default}. If set to {@code -1} then it will use
+     * the highest possible limit (not recommended).
+     *
+     * @param maxInboundMetadataSize The new maximum size allowed for incoming metadata. {@code -1} for max possible.
+     *        Null to use the gRPC's default.
+     *
+     * @see ServerBuilder#maxInboundMetadataSize(int)
+     */
+    public void setMaxInboundMetadataSize(final DataSize maxInboundMetadataSize) {
+        if (maxInboundMetadataSize == null || maxInboundMetadataSize.toBytes() >= 0) {
+            this.maxInboundMetadataSize = maxInboundMetadataSize;
+        } else if (maxInboundMetadataSize.toBytes() == -1) {
+            this.maxInboundMetadataSize = DataSize.ofBytes(Integer.MAX_VALUE);
+        } else {
+            throw new IllegalArgumentException("Unsupported maxInboundMetadataSize: " + maxInboundMetadataSize);
+        }
+    }
+
 }

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

@@ -151,6 +151,10 @@ protected void configureLimits(final T builder) {
         if (maxInboundMessageSize != null) {
             builder.maxInboundMessageSize((int) maxInboundMessageSize.toBytes());
         }
+        final DataSize maxInboundMetadataSize = this.properties.getMaxInboundMetadataSize();
+        if (maxInboundMetadataSize != null) {
+            builder.maxInboundMetadataSize((int) maxInboundMetadataSize.toBytes());
+        }
     }
 
     @Override

grpc-server-spring-boot-autoconfigure/src/test/java/net/devh/boot/grpc/server/config/GrpcServerPropertiesGivenUnitTest.java

@@ -34,7 +34,8 @@
 @ExtendWith(SpringExtension.class)
 @SpringBootTest(properties = {
         "grpc.server.keepAliveTime=42m",
-        "grpc.server.maxInboundMessageSize=5MB"
+        "grpc.server.maxInboundMessageSize=5MB",
+        "grpc.server.maxInboundMetadataSize=10KB"
 })
 class GrpcServerPropertiesGivenUnitTest {
 
@@ -45,6 +46,7 @@ class GrpcServerPropertiesGivenUnitTest {
     void test() {
         assertEquals(Duration.ofMinutes(42), this.grpcServerProperties.getKeepAliveTime());
         assertEquals(DataSize.ofMegabytes(5), this.grpcServerProperties.getMaxInboundMessageSize());
+        assertEquals(DataSize.ofKilobytes(10), this.grpcServerProperties.getMaxInboundMetadataSize());
     }
 
 }