Set User-Agent header for all clients (#480)

* Set User-Agent header for all clients

- Define a property with the format of the header
- Set the header on declarative clients
- Make the app version available in a property

* Remove unused import

* Workaround for Testcontainers incompatibility

* Format

Author: mmwinther

.github/workflows/run-tests.yml

@@ -11,12 +11,17 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 20
     steps:
-
       - name: Check out code
         uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
+      - name: Set up Docker
+        uses: docker/setup-docker-action@v4
+        with:
+          version: v28.0.0
+          set-host: 'true'
+
       - name: Set up Java
         uses: actions/setup-java@v5
         with:

README.md

@@ -16,6 +16,10 @@ Framework: Micronaut
 
 Data store: MongoDB Atlas
 
+## Docker
+
+:warning: For running tests Docker versions before v29 must be used due to incompatibility in the API version used by Testcontainers. This will be resolved once we upgrade to Micronaut Test Resources v3+.
+
 ## Contributing
 
 See the [contributing guide](./CONTRIBUTING.md).

build.gradle.kts

@@ -216,3 +216,16 @@ tasks.register<Copy>("copyPublicOpenApiSpec") {
     from(layout.buildDirectory.file("generated/ksp/main/resources/META-INF/swagger/variable-definitions-public.yml"))
     into(layout.projectDirectory.dir("openapi"))
 }
+
+val setVersionProperty by tasks.register<ProcessResources>("setVersionProperty") {
+    from(layout.projectDirectory.dir("src/main/resources")) {
+        include("**/application.yml")
+        filter {
+            it.replace("{{APP_VERSION}}", version.toString())
+        }
+    }
+    into(layout.buildDirectory.dir("resources/main"))
+}
+
+tasks.processResources { finalizedBy(setVersionProperty) }
+tasks.classes { mustRunAfter(setVersionProperty) }

src/main/kotlin/no/ssb/metadata/vardef/integrations/dapla/services/DaplaTeamApiClient.kt

@@ -6,7 +6,6 @@ import io.micronaut.http.HttpHeaders.USER_AGENT
 import io.micronaut.http.HttpResponse
 import io.micronaut.http.annotation.Get
 import io.micronaut.http.annotation.Header
-import io.micronaut.http.annotation.Headers
 import io.micronaut.http.annotation.PathVariable
 import io.micronaut.http.client.annotation.Client
 import no.ssb.metadata.vardef.integrations.dapla.models.Group
@@ -16,10 +15,8 @@ import no.ssb.metadata.vardef.integrations.dapla.models.Team
  * A declarative client for the Dapla Team API
  */
 @Client(id = "dapla-team-api")
-@Headers(
-    Header(name = USER_AGENT, value = "VarDef API"),
-    Header(name = ACCEPT, value = "application/hal+json"),
-)
+@Header(name = USER_AGENT, value = $$"${micronaut.http.request-headers.user-agent}")
+@Header(name = ACCEPT, value = "application/hal+json")
 interface DaplaTeamApiClient {
     @Get("/teams/{teamId}")
     @SingleResult

src/main/kotlin/no/ssb/metadata/vardef/integrations/klass/service/KlassApiClient.kt

@@ -14,10 +14,8 @@ import no.ssb.metadata.vardef.models.SupportedLanguages
  * A declarative client for the Klass API
  */
 @Client(id = "klass")
-@Headers(
-    Header(name = USER_AGENT, value = "VarDef API"),
-    Header(name = ACCEPT, value = "application/json"),
-)
+@Header(name = USER_AGENT, value = $$"${micronaut.http.request-headers.user-agent}")
+@Header(name = ACCEPT, value = "application/json")
 interface KlassApiClient {
     @Get("classifications/{classificationId}")
     @SingleResult

src/main/kotlin/no/ssb/metadata/vardef/integrations/vardok/client/VardokClient.kt

@@ -2,6 +2,7 @@ package no.ssb.metadata.vardef.integrations.vardok.client
 
 import io.micronaut.core.async.annotation.SingleResult
 import io.micronaut.http.HttpHeaders.ACCEPT
+import io.micronaut.http.HttpHeaders.USER_AGENT
 import io.micronaut.http.MediaType
 import io.micronaut.http.annotation.Get
 import io.micronaut.http.annotation.Header
@@ -10,6 +11,7 @@ import io.micronaut.http.client.annotation.Client
 
 @Client(id = "vardok")
 @Produces(MediaType.APPLICATION_XML)
+@Header(name = USER_AGENT, value = $$"${micronaut.http.request-headers.user-agent}")
 @Header(name = ACCEPT, value = "application/xml")
 interface VardokClient {
     @Produces(MediaType.APPLICATION_XML)

src/main/resources/application.yml

@@ -1,6 +1,7 @@
 micronaut:
   application:
     name: vardef
+    version: {{APP_VERSION}}  # Placeholder filled by the setVersionProperty task during the Gradle build
   auth:
     issuers:
       labid:
@@ -108,6 +109,8 @@ micronaut:
       expire-after-write: 9h
       enabled: false
   http:
+    request-headers:
+      user-agent: ${micronaut.application.name}/${micronaut.application.version} (metadata@ssb.no)
     services:
       klass:
         url: https://data.ssb.no/api/klass/v1/