Merge branch 'master' into support-AuthenticationManagerResolver

.github/workflows/build-master.yml

@@ -30,13 +30,13 @@ jobs:
         run: openssl aes-256-cbc -K ${{ secrets.ENCRYPTED_KEY }} -iv ${{ secrets.ENCRYPTED_IV }} -in private.key.enc -out ./private.key -d && gpg --batch --import ./private.key || echo
 
       - name: Build with Gradle
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/actions/setup-gradle@v3
         with:
           arguments: --scan --stacktrace --warning-mode=all build
 
       - name: Deploy with Gradle
         if: ${{ matrix.java == '17' }}
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/actions/setup-gradle@v3
         with:
           arguments: --scan publish -x check -Psigning.gnupg.executable=gpg -Psigning.gnupg.keyName=${{ secrets.GPG_NAME }} -Psigning.gnupg.passphrase=${{ secrets.GPG_PASSWORD }}
         env:

.github/workflows/pull-request.yml

@@ -24,12 +24,12 @@ jobs:
           check-latest: true
 
       - name: Build with Gradle
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/actions/setup-gradle@v3
         with:
           arguments: --scan --stacktrace --warning-mode=all build
 
       # Avoid publish errors when upgrading gradle version and dependencyManager plugin
       - name: Try publishToMavenLocal
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/actions/setup-gradle@v3
         with:
           arguments: publishToMavenLocal

build.gradle

@@ -11,7 +11,7 @@ buildscript {
         projectVersion = '3.0.0.RELEASE'
 
         // https://github.com/grpc/grpc-java/releases
-        grpcVersion = '1.60.1'
+        grpcVersion = '1.63.0'
 
         // https://github.com/google/guava/releases
         guavaVersion = '33.1.0-jre'
@@ -61,7 +61,7 @@ if (hasProperty('buildScan')) {
 wrapper {
     // Update using:
     // ./gradlew wrapper --gradle-version=8.4 --distribution-type=bin
-    gradleVersion = '8.6'
+    gradleVersion = '8.7'
 }
 
 def buildTimeAndDate = OffsetDateTime.now()

docs/en/client/configuration.md

@@ -69,7 +69,7 @@ There are a number of supported schemes, that you can use to determine the targe
 - `discovery` (Prio 6): \
   (Optional) Uses spring-cloud's `DiscoveryClient` to lookup appropriate targets. The connections will be refreshed
   automatically during `HeartbeatEvent`s. Uses the `gRPC_port` metadata to determine the port, otherwise uses the
-  service port. \
+  service port. Uses the `gRPC_service_config` metadata to determine [service config](https://grpc.github.io/grpc/core/md_doc_service_config.html). \
   Example: `discovery:///service-name`
 - `self` (Prio 0): \
   The self address or scheme is a keyword that is available, if you also use `grpc-server-spring-boot-starter` and

docs/en/client/getting-started.md

@@ -26,7 +26,7 @@ This section deals with how to get Spring to connect to a grpc server and manage
 
 Before we start adding the dependencies lets start with some of our recommendation for your project setup.
 
-![project setup](/grpc-spring-boot-starter/assets/images/client-project-setup.svg)
+![project setup](/grpc-spring/assets/images/client-project-setup.svg)
 
 We recommend splitting your project into 2-3 separate modules.
 

docs/en/server/getting-started.md

@@ -28,7 +28,7 @@ This section describes the steps necessary to convert your application into a gr
 
 Before we start adding the dependencies lets start with some of our recommendation for your project setup.
 
-![project setup](/grpc-spring-boot-starter/assets/images/server-project-setup.svg)
+![project setup](/grpc-spring/assets/images/server-project-setup.svg)
 
 We recommend splitting your project into 2-3 separate modules.
 

docs/zh-CN/client/getting-started.md

@@ -26,7 +26,7 @@
 
 在我们开始添加依赖关系之前，让我们项目的一些设置建议开始。
 
-![项目创建](/grpc-spring-boot-starter/assets/images/client-project-setup.svg)
+![项目创建](/grpc-spring/assets/images/client-project-setup.svg)
 
 我们建议将您的项目分为2至3个不同的模块。
 

docs/zh-CN/server/getting-started.md

@@ -28,7 +28,7 @@
 
 在我们开始添加依赖关系之前，让我们项目的一些设置建议开始。
 
-![项目创建](/grpc-spring-boot-starter/assets/images/server-project-setup.svg)
+![项目创建](/grpc-spring/assets/images/server-project-setup.svg)
 
 我们建议将您的项目分为2至3个不同的模块。
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

grpc-client-spring-boot-starter/src/main/java/net/devh/boot/grpc/client/channelfactory/AbstractChannelFactory.java

@@ -181,7 +181,6 @@ protected void configure(final T builder, final String name) {
         configureKeepAlive(builder, name);
         configureSecurity(builder, name);
         configureLimits(builder, name);
-        configureCompression(builder, name);
         configureUserAgent(builder, name);
         for (final GrpcChannelConfigurer channelConfigurer : this.channelConfigurers) {
             channelConfigurer.accept(builder, name);
@@ -251,19 +250,6 @@ protected void configureLimits(final T builder, final String name) {
         }
     }
 
-    /**
-     * Configures the compression options that should be used by the channel.
-     *
-     * @param builder The channel builder to configure.
-     * @param name The name of the client to configure.
-     */
-    protected void configureCompression(final T builder, final String name) {
-        final GrpcChannelProperties properties = getPropertiesFor(name);
-        if (properties.isFullStreamDecompression()) {
-            builder.enableFullStreamDecompression();
-        }
-    }
-
     /**
      * Configures custom User-Agent for the channel.
      *

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

@@ -372,35 +372,6 @@ public void setMaxInboundMetadataSize(DataSize maxInboundMetadataSize) {
     }
     // --------------------------------------------------
 
-    private Boolean fullStreamDecompression;
-    private static final boolean DEFAULT_FULL_STREAM_DECOMPRESSION = false;
-
-    /**
-     * Gets whether full-stream decompression of inbound streams should be enabled.
-     *
-     * @return True, if full-stream decompression of inbound streams should be enabled. False otherwise.
-     *
-     * @see #setFullStreamDecompression(Boolean)
-     */
-    public boolean isFullStreamDecompression() {
-        return this.fullStreamDecompression == null ? DEFAULT_FULL_STREAM_DECOMPRESSION : this.fullStreamDecompression;
-    }
-
-    /**
-     * Sets whether full-stream decompression of inbound streams should be enabled. This will cause the channel's
-     * outbound headers to advertise support for GZIP compressed streams, and gRPC servers which support the feature may
-     * respond with a GZIP compressed stream.
-     *
-     * @param fullStreamDecompression Whether full stream decompression should be enabled or null to use the fallback.
-     *
-     * @see ManagedChannelBuilder#enableFullStreamDecompression()
-     */
-    public void setFullStreamDecompression(final Boolean fullStreamDecompression) {
-        this.fullStreamDecompression = fullStreamDecompression;
-    }
-
-    // --------------------------------------------------
-
     private NegotiationType negotiationType;
     private static final NegotiationType DEFAULT_NEGOTIATION_TYPE = NegotiationType.TLS;
 
@@ -530,9 +501,6 @@ public void copyDefaultsFrom(final GrpcChannelProperties config) {
         if (this.maxInboundMessageSize == null) {
             this.maxInboundMessageSize = config.maxInboundMessageSize;
         }
-        if (this.fullStreamDecompression == null) {
-            this.fullStreamDecompression = config.fullStreamDecompression;
-        }
         if (this.negotiationType == null) {
             this.negotiationType = config.negotiationType;
         }

grpc-client-spring-boot-starter/src/main/java/net/devh/boot/grpc/client/metrics/MetricsClientStreamTracers.java

@@ -35,6 +35,7 @@
 import io.grpc.Status;
 import io.grpc.Status.Code;
 import io.micrometer.core.instrument.Tags;
+import net.devh.boot.grpc.common.util.Constants;
 
 /**
  * Provides factories for {@link io.grpc.StreamTracer} that records metrics.
@@ -47,6 +48,8 @@
 final class MetricsClientStreamTracers {
     private static final Supplier<Stopwatch> STOPWATCH_SUPPLIER = Stopwatch::createUnstarted;
     private final Supplier<Stopwatch> stopwatchSupplier;
+    private static final String INSTRUMENTATION_SOURCE_TAG_KEY = "instrumentation_source";
+    private static final String INSTRUMENTATION_VERSION_TAG_KEY = "instrumentation_version";
 
     MetricsClientStreamTracers() {
         this(STOPWATCH_SUPPLIER);
@@ -127,7 +130,10 @@ public void streamClosed(Status status) {
 
         void recordFinishedAttempt() {
             Tags attemptMetricTags =
-                    Tags.of("grpc.method", fullMethodName, "grpc.status", statusCode.toString());
+                    Tags.of("grpc.method", fullMethodName,
+                            "grpc.status", statusCode.toString(),
+                            INSTRUMENTATION_SOURCE_TAG_KEY, Constants.LIBRARY_NAME,
+                            INSTRUMENTATION_VERSION_TAG_KEY, Constants.VERSION);
             this.metricsClientMeters.getClientAttemptDuration()
                     .withTags(attemptMetricTags)
                     .record(attemptNanos, TimeUnit.NANOSECONDS);
@@ -168,7 +174,9 @@ static final class CallAttemptsTracerFactory extends ClientStreamTracer.Factory
 
             // Record here in case newClientStreamTracer() would never be called.
             this.metricsClientMeters.getAttemptCounter()
-                    .withTags(Tags.of("grpc.method", fullMethodName))
+                    .withTags(Tags.of("grpc.method", fullMethodName,
+                            INSTRUMENTATION_SOURCE_TAG_KEY, Constants.LIBRARY_NAME,
+                            INSTRUMENTATION_VERSION_TAG_KEY, Constants.VERSION))
                     .increment();
         }
 
@@ -188,7 +196,9 @@ public ClientStreamTracer newClientStreamTracer(StreamInfo info, Metadata metada
             // attempt, as first attempt cannot be a transparent retry.
             if (attemptsPerCall.get() > 0) {
                 this.metricsClientMeters.getAttemptCounter()
-                        .withTags((Tags.of("grpc.method", fullMethodName)))
+                        .withTags((Tags.of("grpc.method", fullMethodName,
+                                INSTRUMENTATION_SOURCE_TAG_KEY, Constants.LIBRARY_NAME,
+                                INSTRUMENTATION_VERSION_TAG_KEY, Constants.VERSION)))
                         .increment();
             }
             if (!info.isTransparentRetry()) {
@@ -248,7 +258,10 @@ void recordFinishedCall() {
             }
             callLatencyNanos = clientCallStopWatch.elapsed(TimeUnit.NANOSECONDS);
             Tags clientCallMetricTags =
-                    Tags.of("grpc.method", this.fullMethodName, "grpc.status", status.getCode().toString());
+                    Tags.of("grpc.method", this.fullMethodName,
+                            "grpc.status", status.getCode().toString(),
+                            INSTRUMENTATION_SOURCE_TAG_KEY, Constants.LIBRARY_NAME,
+                            INSTRUMENTATION_VERSION_TAG_KEY, Constants.VERSION);
             this.metricsClientMeters.getClientCallDuration()
                     .withTags(clientCallMetricTags)
                     .record(callLatencyNanos, TimeUnit.NANOSECONDS);

grpc-client-spring-boot-starter/src/main/java/net/devh/boot/grpc/client/nameresolver/DiscoveryClientNameResolver.java

@@ -22,6 +22,7 @@
 import static net.devh.boot.grpc.client.nameresolver.DiscoveryClientResolverFactory.DISCOVERY_INSTANCE_ID_KEY;
 import static net.devh.boot.grpc.client.nameresolver.DiscoveryClientResolverFactory.DISCOVERY_SERVICE_NAME_KEY;
 import static net.devh.boot.grpc.common.util.GrpcUtils.CLOUD_DISCOVERY_METADATA_PORT;
+import static net.devh.boot.grpc.common.util.GrpcUtils.CLOUD_DISCOVERY_METADATA_SERVICE_CONFIG;
 
 import java.net.InetSocketAddress;
 import java.util.List;
@@ -35,6 +36,8 @@
 import org.springframework.util.CollectionUtils;
 
 import com.google.common.collect.Lists;
+import com.google.gson.Gson;
+import com.google.gson.JsonSyntaxException;
 
 import io.grpc.Attributes;
 import io.grpc.Attributes.Builder;
@@ -58,13 +61,15 @@ public class DiscoveryClientNameResolver extends NameResolver {
     @Deprecated
     private static final String LEGACY_CLOUD_DISCOVERY_METADATA_PORT = "gRPC.port";
     private static final List<ServiceInstance> KEEP_PREVIOUS = null;
+    private static final Gson GSON = new Gson();
 
     private final String name;
     private final DiscoveryClient client;
     private final SynchronizationContext syncContext;
     private final Consumer<DiscoveryClientNameResolver> shutdownHook;
     private final SharedResourceHolder.Resource<Executor> executorResource;
     private final boolean usingExecutorResource;
+    private final ServiceConfigParser serviceConfigParser;
 
     // The field must be accessed from syncContext, although the methods on an Listener2 can be called
     // from any thread.
@@ -93,6 +98,7 @@ public DiscoveryClientNameResolver(final String name, final DiscoveryClient clie
         this.executor = args.getOffloadExecutor();
         this.usingExecutorResource = this.executor == null;
         this.executorResource = executorResource;
+        this.serviceConfigParser = args.getServiceConfigParser();
     }
 
     /**
@@ -187,6 +193,55 @@ protected int getGrpcPort(final ServiceInstance instance) {
         }
     }
 
+    /**
+     * Extracts and parse gRPC service config from the given service instances.
+     *
+     * @param instances The list of instances to extract the service config from.
+     * @return Parsed gRPC service config or null.
+     */
+    private ConfigOrError resolveServiceConfig(List<ServiceInstance> instances) {
+        final String serviceConfig = getServiceConfig(instances);
+        if (serviceConfig == null) {
+            return null;
+        }
+        log.debug("Found service config for {}", getName());
+        if (log.isTraceEnabled()) {
+            // This is to avoid blowing log into several lines if newlines present in service config string.
+            final String logStr = serviceConfig.replace("\r", "\\r").replace("\n", "\\n");
+            log.trace("Service config for {}: {}", getName(), logStr);
+        }
+        try {
+            @SuppressWarnings("unchecked")
+            Map<String, ?> parsedServiceConfig = GSON.fromJson(serviceConfig, Map.class);
+            return serviceConfigParser.parseServiceConfig(parsedServiceConfig);
+        } catch (JsonSyntaxException e) {
+            return ConfigOrError.fromError(
+                    Status.UNKNOWN
+                            .withDescription("Failed to parse grpc service config")
+                            .withCause(e));
+        }
+    }
+
+    /**
+     * Extracts the gRPC service config string from the given service instances.
+     *
+     * @param instances The list of instances to extract the service config from.
+     * @return The gRPC service config or null.
+     */
+    protected String getServiceConfig(final List<ServiceInstance> instances) {
+        for (final ServiceInstance inst : instances) {
+            final Map<String, String> metadata = inst.getMetadata();
+            if (metadata == null || metadata.isEmpty()) {
+                continue;
+            }
+            final String metaValue = metadata.get(CLOUD_DISCOVERY_METADATA_SERVICE_CONFIG);
+            if (metaValue != null && !metaValue.isEmpty()) {
+                return metaValue;
+            }
+        }
+        return null;
+    }
+
     /**
      * Gets the attributes from the service instance for later use in a load balancer. Can be overwritten to convert
      * custom attributes.
@@ -318,6 +373,7 @@ private List<ServiceInstance> resolveInternal() {
             log.debug("Ready to update server list for {}", getName());
             this.savedListener.onResult(ResolutionResult.newBuilder()
                     .setAddresses(toTargets(newInstanceList))
+                    .setServiceConfig(resolveServiceConfig(newInstanceList))
                     .build());
             log.info("Done updating server list for {}", getName());
             return newInstanceList;

grpc-client-spring-boot-starter/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -53,13 +53,6 @@
 			"description": "Whether keepAlive should be enabled.",
 			"defaultValue": false
 		},
-		{
-			"name": "grpc.client.GLOBAL.full-stream-decompression",
-			"type": "java.lang.Boolean",
-			"sourceType": "net.devh.boot.grpc.client.config.GrpcChannelProperties",
-			"description": "Whether full-stream decompression of inbound streams should be enabled.",
-			"defaultValue": false
-		},
 		{
 			"name": "grpc.client.GLOBAL.keep-alive-time",
 			"type": "java.time.Duration",