feat: allow configuring user agent (#1009)

Co-authored-by: Onyn <[email protected]>

Author: onyn

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

@@ -182,6 +182,7 @@ protected void configure(final T builder, final String name) {
         configureSecurity(builder, name);
         configureLimits(builder, name);
         configureCompression(builder, name);
+        configureUserAgent(builder, name);
         for (final GrpcChannelConfigurer channelConfigurer : this.channelConfigurers) {
             channelConfigurer.accept(builder, name);
         }
@@ -259,6 +260,20 @@ protected void configureCompression(final T builder, final String name) {
         }
     }
 
+    /**
+     * Configures custom User-Agent for the channel.
+     *
+     * @param builder The channel builder to configure.
+     * @param name The name of the client to configure.
+     */
+    protected void configureUserAgent(final T builder, final String name) {
+        final GrpcChannelProperties properties = getPropertiesFor(name);
+        final String userAgent = properties.getUserAgent();
+        if (userAgent != null) {
+            builder.userAgent(userAgent);
+        }
+    }
+
     @Override
     public Map<String, ConnectivityState> getConnectivityState() {
         return Collections.unmodifiableMap(this.channelStates);

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

@@ -422,6 +422,32 @@ public void setImmediateConnectTimeout(final Duration immediateConnectTimeout) {
 
     // --------------------------------------------------
 
+    private String userAgent = null;
+
+    /**
+     * Get custom User-Agent for the channel.
+     *
+     * @return custom User-Agent for the channel.
+     *
+     * @see #setUserAgent(String)
+     */
+    public String getUserAgent() {
+        return this.userAgent;
+    }
+
+    /**
+     * Sets custom User-Agent HTTP header.
+     *
+     * @param userAgent Custom User-Agent.
+     *
+     * @see ManagedChannelBuilder#userAgent(String)
+     */
+    public void setUserAgent(final String userAgent) {
+        this.userAgent = userAgent;
+    }
+
+    // --------------------------------------------------
+
     private final Security security = new Security();
 
     /**
@@ -476,6 +502,9 @@ public void copyDefaultsFrom(final GrpcChannelProperties config) {
         if (this.immediateConnectTimeout == null) {
             this.immediateConnectTimeout = config.immediateConnectTimeout;
         }
+        if (this.userAgent == null) {
+            this.userAgent = config.userAgent;
+        }
         this.security.copyDefaultsFrom(config.security);
     }