feat: user-agent from build info

expose build info in actuator

pom.xml

@@ -105,6 +105,14 @@
             </env>
           </image>
         </configuration>
+
+        <executions>
+          <execution>
+            <goals>
+              <goal>build-info</goal>
+            </goals>
+          </execution>
+        </executions>
       </plugin>
 
       <plugin>

src/main/java/nu/peg/svmeal/SvmealApiApplication.java

@@ -1,14 +1,15 @@
 package nu.peg.svmeal;
 
 import nu.peg.svmeal.infrastructure.config.CacheProperties;
+import nu.peg.svmeal.infrastructure.config.SvmealProperties;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.cache.annotation.EnableCaching;
 
 @SpringBootApplication
 @EnableCaching
-@EnableConfigurationProperties(value = {CacheProperties.class})
+@EnableConfigurationProperties(value = {CacheProperties.class, SvmealProperties.class})
 public class SvmealApiApplication {
   public static void main(String[] args) {
     SpringApplication.run(SvmealApiApplication.class, args);

src/main/java/nu/peg/svmeal/infrastructure/config/SvmealProperties.java

@@ -0,0 +1,6 @@
+package nu.peg.svmeal.infrastructure.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties(prefix = "svmeal")
+public record SvmealProperties(String userAgentLink) {}

src/main/java/nu/peg/svmeal/infrastructure/http/SvmealUserAgentInterceptor.java

@@ -1,29 +1,46 @@
 package nu.peg.svmeal.infrastructure.http;
 
 import java.io.IOException;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.beans.factory.annotation.Value;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import nu.peg.svmeal.infrastructure.config.SvmealProperties;
+import org.springframework.boot.info.BuildProperties;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpRequest;
 import org.springframework.http.client.ClientHttpRequestExecution;
 import org.springframework.http.client.ClientHttpResponse;
 import org.springframework.stereotype.Component;
 
+@Slf4j
 @Component
+@RequiredArgsConstructor
 public class SvmealUserAgentInterceptor implements SvmealInterceptor {
-  private final String userAgent;
+  private final BuildProperties buildProperties;
+  private final SvmealProperties svmealProperties;
 
-  @Autowired
-  public SvmealUserAgentInterceptor(@Value("${svmeal.user-agent}") String userAgent) {
-    this.userAgent = userAgent;
+  @Getter(lazy = true)
+  private final String userAgent = userAgent();
+
+  private String userAgent() {
+    final var userAgent =
+        "%s/%s (%s)"
+            .formatted(
+                buildProperties.getArtifact(),
+                buildProperties.getVersion(),
+                svmealProperties.userAgentLink());
+
+    log.debug("User-Agent: {}", userAgent);
+
+    return userAgent;
   }
 
   @Override
   public ClientHttpResponse intercept(
       HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution)
       throws IOException {
     HttpHeaders headers = httpRequest.getHeaders();
-    headers.set("User-Agent", userAgent);
+    headers.set("User-Agent", getUserAgent());
 
     return clientHttpRequestExecution.execute(httpRequest, bytes);
   }

src/main/resources/application-dev.yml

@@ -5,4 +5,4 @@ svmeal:
     restaurant-dtos:
       expire-after-write: 5s
     meal-plan:
-      expire-after-write: 5s
+      expire-after-write: 5s

src/main/resources/application.yml

@@ -15,7 +15,7 @@ resilience4j:
         waitDurationInOpenState: 5m
 
 svmeal:
-  user-agent: sv-meal/4.1.1 github.com/jmesserli/svmeal-api
+  user-agent-link: github.com/jmesserli/svmeal-api
   cache:
     restaurants:
       max-size: 1
@@ -26,3 +26,20 @@ svmeal:
     meal-plan:
       max-size: 50
       expire-after-write: 15m
+
+management:
+  endpoints:
+    web:
+      exposure:
+        include: health,info
+  endpoint:
+    health:
+      show-details: always
+
+  health:
+    circuitbreakers:
+      enabled: true
+
+logging:
+  level:
+    nu.peg.svmeal: DEBUG