Release 3.3.3

DanielLiu1123 · Sep 21, 2024 · 4deee56 · 4deee56
1 parent 4afd3d2
commit 4deee56
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 36 deletions.
diff --git a/gradle.properties b/gradle.properties
@@ -1,8 +1,9 @@
 group=io.github.danielliu1123
-version=3.3.3-RC1-SNAPSHOT
+version=3.3.3-SNAPSHOT
 
 # Spring related
-springBootVersion=3.3.2
+# https://github.com/spring-projects/spring-boot
+springBootVersion=3.3.3
 # https://docs.spring.io/spring-cloud-release/reference/index.html
 # https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies
 #springCloudVersion=2023.0.3
@@ -16,23 +17,26 @@ springConfigurationPropertyDocumenterVersion=0.7.1
 # gRPC related
 # https://github.com/google/protobuf-gradle-plugin
 protobufGradlePluginVersion=0.9.4
-grpcVersion=1.66.0
+# https://central.sonatype.com/artifact/io.grpc/grpc-protobuf/dependencies
+grpcVersion=1.68.0
 # https://central.sonatype.com/artifact/com.google.api/api-common
-googleApiCommonVersion=2.34.0
+googleApiCommonVersion=2.36.0
 # https://central.sonatype.com/artifact/io.grpc/grpc-protobuf/dependencies
 protobufVersion=3.25.3
 # https://central.sonatype.com/artifact/io.grpc/grpc-protobuf/dependencies
 protoGoogleCommonProtosVersion=2.41.0
 # https://github.com/bufbuild/protoc-gen-validate
 pgvVersion=1.1.0
 # https://github.com/bufbuild/protovalidate-java
+# Do NOT upgrade, until protobuf for grpc upgrade to protobuf 4.x
+# https://github.com/bufbuild/protovalidate-java/releases/tag/v0.3.0
 protovalidateVersion=0.2.1
 
 # Code quality
 # https://plugins.gradle.org/plugin/com.diffplug.gradle.spotless
 spotlessVersion=6.25.0
 # https://plugins.gradle.org/plugin/com.github.spotbugs
-spotbugsVersion=6.0.20
+spotbugsVersion=6.0.22
 # https://github.com/spotbugs/spotbugs-gradle-plugin/blob/master/build.gradle.kts
 spotbugsAnnotationsVersion=4.8.6
 

diff --git a/grpc-extensions/grpc-metrics/src/test/java/grpcstarter/extensions/metrics/Deps.java b/grpc-extensions/grpc-metrics/src/test/java/grpcstarter/extensions/metrics/Deps.java
@@ -7,5 +7,5 @@ public final class Deps {
 
     private Deps() {}
 
-    public static final String SPRING_BOOT_VERSION = "3.3.2";
+    public static final String SPRING_BOOT_VERSION = "3.3.3";
 }
diff --git a/website/docs/40-configuration-properties.md b/website/docs/40-configuration-properties.md
@@ -139,80 +139,80 @@ This page was generated by [spring-configuration-property-documenter](https://gi
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| cert-chain| org.springframework.core.io.Resource| | | | 
-| private-key| org.springframework.core.io.Resource| | | | 
-| private-key-password| java.lang.String| | | | 
+| cert-chain| org.springframework.core.io.Resource| @see TlsServerCredentials.Builder#getCertificateChain()| | | 
+| private-key| org.springframework.core.io.Resource| @see TlsServerCredentials.Builder#getPrivateKey()| | | 
+| private-key-password| java.lang.String| @see TlsServerCredentials.Builder#getPrivateKeyPassword()| | | 
 ### grpc.server.tls.trust-manager
 **Class:** `grpcstarter.server.GrpcServerProperties$Tls$TrustManager`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| root-certs| org.springframework.core.io.Resource| | | | 
+| root-certs| org.springframework.core.io.Resource| @see TlsServerCredentials.Builder#getRootCertificates()| | | 
 ### grpc.server.health.datasource
 **Class:** `grpcstarter.server.GrpcServerProperties$Health$DataSource`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| | | | 
-| service| java.lang.String| | | | 
-| timeout| java.lang.Integer| | | | 
-| validation-query| java.lang.String| | | | 
+| enabled| java.lang.Boolean| Whether to enable datasource health check, default true.| true| | 
+| service| java.lang.String| The service name that will be used for datasource health check, default value is &#x27;datasource&#x27;.| datasource| | 
+| timeout| java.lang.Integer| \{@link #validationQuery} timeout, unit seconds.| | | 
+| validation-query| java.lang.String| The SQL query that will be used to validate datasource connection, default value is &#x27;SELECT 1&#x27;.| SELECT 1| | 
 ### grpc.server.health.redis
 **Class:** `grpcstarter.server.GrpcServerProperties$Health$Redis`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| | | | 
-| service| java.lang.String| | | | 
+| enabled| java.lang.Boolean| Whether to enable redis health check, default true.| true| | 
+| service| java.lang.String| The service name that will be used for redis health check, default value is &#x27;redis&#x27;.| redis| | 
 ### grpc.server
 **Class:** `grpcstarter.server.GrpcServerProperties`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enable-empty-server| java.lang.Boolean| | | | 
-| enabled| java.lang.Boolean| | | | 
-| max-inbound-message-size| org.springframework.util.unit.DataSize| | | | 
-| max-inbound-metadata-size| org.springframework.util.unit.DataSize| | | | 
-| port| java.lang.Integer| | | | 
-| shutdown-timeout| java.lang.Long| | | | 
+| enable-empty-server| java.lang.Boolean| Whether to start a gRPC server when no service found, default true.| true| | 
+| enabled| java.lang.Boolean| Whether to enable gRPC server autoconfiguration, default true.| true| | 
+| max-inbound-message-size| org.springframework.util.unit.DataSize| The maximum message size allowed to be received on the server, default 4MB. @see GrpcUtil#DEFAULT_MAX_MESSAGE_SIZE| | | 
+| max-inbound-metadata-size| org.springframework.util.unit.DataSize| The maximum size of metadata allowed to be received, default 8KB. @see GrpcUtil#DEFAULT_MAX_HEADER_LIST_SIZE| | | 
+| port| java.lang.Integer| gRPC server port, default 9090, 0 or negative numbers will use random port.| 9090| | 
+| shutdown-timeout| java.lang.Long| Graceful shutdown timeout, default 30s, if 0 will wait forever util all active calls finished.| 30000| | 
 ### grpc.server.channelz
 **Class:** `grpcstarter.server.GrpcServerProperties$Channelz`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| | | | 
-| max-page-size| java.lang.Integer| | | | 
+| enabled| java.lang.Boolean| Whether to register \{@link ChannelzService}, default false.| false| | 
+| max-page-size| java.lang.Integer| The maximum page size to return, default 100. @see AdminInterface| 100| | 
 ### grpc.server.exception-handling
 **Class:** `grpcstarter.server.GrpcServerProperties$ExceptionHandling`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| default-exception-advice-enabled| java.lang.Boolean| | | | 
-| enabled| java.lang.Boolean| | | | 
+| default-exception-advice-enabled| java.lang.Boolean| Whether to enable \{@link DefaultGrpcExceptionAdvice}, default true. &lt;p&gt; \{@link DefaultGrpcExceptionAdvice} will handle exceptions recognized by gRPC, including: &lt;/p&gt; &lt;ul&gt; &lt;li&gt;\{@link StatusRuntimeException}&lt;/li&gt; &lt;li&gt;\{@link StatusException}&lt;/li&gt; &lt;/ul&gt; &lt;p&gt; When enabled, you can directly throw \{@link StatusRuntimeException} or \{@link StatusException} in service implementation, and the exception will be handled by \{@link DefaultGrpcExceptionAdvice}. &lt;/p&gt; &lt;pre&gt;\{@code @GrpcService public class SimpleService extends SimpleServiceGrpc.SimpleServiceImplBase \{ @Override public void unaryRpc(SimpleRequest request, StreamObserver&lt;SimpleResponse&gt; responseObserver) \{ throw new StatusRuntimeException(Status.INVALID_ARGUMENT.withDescription(&quot;Invalid request&quot;)); } } }&lt;/pre&gt; @see DefaultGrpcExceptionAdvice @since 3.2.3| true| | 
+| enabled| java.lang.Boolean| Whether to enable exception handling, default true.| true| | 
 ### grpc.server.health
 **Class:** `grpcstarter.server.GrpcServerProperties$Health`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| | | | 
+| enabled| java.lang.Boolean| Whether to enable health check, default false.| true| | 
 ### grpc.server.in-process
 **Class:** `grpcstarter.server.GrpcServerProperties$InProcess`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| name| java.lang.String| | | | 
+| name| java.lang.String| In-process server name, if configured, will create an in-process server, usually for testing.| | | 
 ### grpc.server.reflection
 **Class:** `grpcstarter.server.GrpcServerProperties$Reflection`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| | | | 
+| enabled| java.lang.Boolean| Whether to register reflection service, default false.| false| | 
 ### grpc.server.response
 **Class:** `grpcstarter.server.GrpcServerProperties$Response`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| max-description-length| java.lang.Integer| | | | 
+| max-description-length| java.lang.Integer| The maximum length of response description. &lt;p&gt; When the length of the description exceeds this value, it will be truncated. &lt;/p&gt; @since 3.2.3| 2048| | 
 ### grpc.server.tls
 **Class:** `grpcstarter.server.GrpcServerProperties$Tls`
 
@@ -284,16 +284,16 @@ This page was generated by [spring-configuration-property-documenter](https://gi
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| auto-mapping| java.lang.Boolean| | | | 
-| enabled| java.lang.Boolean| | | | 
-| endpoint| java.lang.String| | | | 
+| auto-mapping| java.lang.Boolean| Whether to route methods without the &#x60;google.api.http&#x60; option, default true. &lt;p&gt; Example: &lt;pre&gt;\{@code package bookstore; service Bookstore \{ rpc GetShelf(GetShelfRequest) returns (Shelf) \{} } message GetShelfRequest \{ int64 shelf &#x3D; 1; } message Shelf \{} }&lt;/pre&gt; &lt;p&gt; The client could &#x60;post&#x60; a json body &#x60;\{&quot;shelf&quot;: 1234}&#x60; with the path of &#x60;/bookstore.Bookstore/GetShelfRequest&#x60; to call &#x60;GetShelfRequest&#x60;.| true| | 
+| enabled| java.lang.Boolean| Whether to enable transcoding autoconfiguration, default \{@code true}.| true| | 
+| endpoint| java.lang.String| gRPC server endpoint, if not set, will use \{@code localhost:$\{grpc.server.port}}. &lt;p&gt; In most cases, do not need to set this property explicitly.| | | 
 ### grpc.transcoding.print-options
 **Class:** `grpcstarter.extensions.transcoding.GrpcTranscodingProperties$PrintOptions`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| add-whitespace| java.lang.Boolean| | | | 
-| always-print-enums-as-ints| java.lang.Boolean| | | | 
+| add-whitespace| java.lang.Boolean| Whether to add spaces, line breaks and indentation to make the JSON output easy to read. Defaults to false.| false| | 
+| always-print-enums-as-ints| java.lang.Boolean| Whether to always print enums as ints. By default they are rendered as strings. Defaults to false.| false| | 
 
 ## grpc-validation
 ### grpc.validation
@@ -318,4 +318,4 @@ This page was generated by [spring-configuration-property-documenter](https://gi
 | enabled| java.lang.Boolean| Whether to enable validation, default is \{@code true}.| true| | 
 | order| java.lang.Integer| Validating interceptor order, default is \{@code 0}.| 0| | 
 
-This is a generated file, generated at: **2024-08-20T22:49:57.226256**
+This is a generated file, generated at: **2024-09-21T14:46:24.020459**