refactor(server): allow injecting logic for building package artifacts (#1941)

krzema12 · web-flow · commit bce8663de907 · 2025-05-03T14:12:43.000+02:00
Part of #1938. To be able to mock it in tests.
diff --git a/jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/Main.kt b/jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/Main.kt
@@ -7,7 +7,9 @@ import com.sksamuel.aedile.core.refreshAfterWrite
 import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.mavenbinding.Artifact
+import io.github.typesafegithub.workflows.mavenbinding.buildPackageArtifacts
 import io.github.typesafegithub.workflows.mavenbinding.buildVersionArtifacts
+import io.github.typesafegithub.workflows.shared.internal.getGithubAuthToken
 import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.Application
 import io.ktor.server.application.ApplicationCall
@@ -48,19 +50,26 @@ fun main() {
         logger.error(throwable) { "Uncaught exception in thread $thread" }
     }
     embeddedServer(Netty, port = 8080) {
-        appModule(buildVersionArtifacts = ::buildVersionArtifacts)
+        appModule(
+            buildVersionArtifacts = ::buildVersionArtifacts,
+            buildPackageArtifacts = ::buildPackageArtifacts,
+        )
     }.start(wait = true)
 }
 
-fun Application.appModule(buildVersionArtifacts: (ActionCoords) -> Map<String, Artifact>?) {
+fun Application.appModule(
+    buildVersionArtifacts: (ActionCoords) -> Map<String, Artifact>?,
+    buildPackageArtifacts: suspend (ActionCoords, String, (Collection<ActionCoords>) -> Unit) -> Map<String, String>,
+) {
     val bindingsCache = buildBindingsCache(buildVersionArtifacts)
+    val metadataCache = buildMetadataCache(bindingsCache, buildPackageArtifacts)
     installPlugins(prometheusRegistry)
 
     routing {
         internalRoutes(prometheusRegistry)
 
         artifactRoutes(bindingsCache, prometheusRegistry)
-        metadataRoutes(bindingsCache, prometheusRegistry)
+        metadataRoutes(metadataCache, prometheusRegistry)
     }
 }
 
@@ -73,6 +82,25 @@ private fun buildBindingsCache(
         .recordStats()
         .asLoadingCache<ActionCoords, ArtifactResult> { runCatching { buildVersionArtifacts(it) } }
 
+@Suppress("ktlint:standard:function-signature") // Conflict with detekt.
+private fun buildMetadataCache(
+    bindingsCache: LoadingCache<ActionCoords, ArtifactResult>,
+    buildPackageArtifacts: suspend (ActionCoords, String, (Collection<ActionCoords>) -> Unit) -> Map<String, String>,
+): LoadingCache<ActionCoords, MetadataResult> =
+    Caffeine
+        .newBuilder()
+        .refreshAfterWrite(1.hours)
+        .recordStats()
+        .asLoadingCache<ActionCoords, MetadataResult> {
+            runCatching {
+                buildPackageArtifacts(
+                    it,
+                    getGithubAuthToken(),
+                    { coords -> prefetchBindingArtifacts(coords, bindingsCache) },
+                )
+            }
+        }
+
 val deliverOnRefreshRoute = System.getenv("GWKT_DELIVER_ON_REFRESH").toBoolean()
 
 suspend fun ApplicationCall.respondNotFound() = respondText(text = "Not found", status = HttpStatusCode.NotFound)
diff --git a/jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/MetadataRoutes.kt b/jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/MetadataRoutes.kt
@@ -1,49 +1,25 @@
 package io.github.typesafegithub.workflows.jitbindingserver
 
-import com.github.benmanes.caffeine.cache.Caffeine
 import com.sksamuel.aedile.core.LoadingCache
-import com.sksamuel.aedile.core.asLoadingCache
-import com.sksamuel.aedile.core.refreshAfterWrite
 import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.prettyPrintWithoutVersion
-import io.github.typesafegithub.workflows.mavenbinding.buildPackageArtifacts
-import io.github.typesafegithub.workflows.shared.internal.getGithubAuthToken
 import io.ktor.server.response.respondText
 import io.ktor.server.routing.Route
 import io.ktor.server.routing.Routing
 import io.ktor.server.routing.get
 import io.ktor.server.routing.route
 import io.micrometer.core.instrument.binder.cache.CaffeineCacheMetrics
 import io.micrometer.prometheusmetrics.PrometheusMeterRegistry
-import kotlin.time.Duration.Companion.hours
 
 private val logger = logger { }
 
 typealias MetadataResult = Result<Map<String, String>>
 
-@Suppress("ktlint:standard:function-signature") // Conflict with detekt.
-private fun buildMetadataCache(
-    bindingsCache: LoadingCache<ActionCoords, ArtifactResult>,
-): LoadingCache<ActionCoords, MetadataResult> =
-    Caffeine
-        .newBuilder()
-        .refreshAfterWrite(1.hours)
-        .recordStats()
-        .asLoadingCache<ActionCoords, MetadataResult> {
-            runCatching {
-                it.buildPackageArtifacts(
-                    githubAuthToken = getGithubAuthToken(),
-                    { coords -> prefetchBindingArtifacts(coords, bindingsCache) },
-                )
-            }
-        }
-
 fun Routing.metadataRoutes(
-    bindingsCache: LoadingCache<ActionCoords, ArtifactResult>,
+    metadataCache: LoadingCache<ActionCoords, MetadataResult>,
     prometheusRegistry: PrometheusMeterRegistry? = null,
 ) {
-    val metadataCache = buildMetadataCache(bindingsCache)
     prometheusRegistry?.let {
         CaffeineCacheMetrics.monitor(it, metadataCache.underlying(), "metadata_cache")
     }
diff --git a/jit-binding-server/src/test/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ArtifactRoutesTest.kt b/jit-binding-server/src/test/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ArtifactRoutesTest.kt
@@ -23,6 +23,8 @@ class ArtifactRoutesTest :
                             buildVersionArtifacts = {
                                 mapOf("some-action-v4.pom" to TextArtifact { "Some POM contents" })
                             },
+                            // Irrelevant for these tests.
+                            buildPackageArtifacts = { _, _, _ -> emptyMap() },
                         )
                     }
 
@@ -41,6 +43,8 @@ class ArtifactRoutesTest :
                     application {
                         appModule(
                             buildVersionArtifacts = { null },
+                            // Irrelevant for these tests.
+                            buildPackageArtifacts = { _, _, _ -> emptyMap() },
                         )
                     }
 
@@ -58,6 +62,8 @@ class ArtifactRoutesTest :
                     application {
                         appModule(
                             buildVersionArtifacts = { error("An internal error occurred!") },
+                            // Irrelevant for these tests.
+                            buildPackageArtifacts = { _, _, _ -> emptyMap() },
                         )
                     }
 
@@ -79,6 +85,8 @@ class ArtifactRoutesTest :
                     application {
                         appModule(
                             buildVersionArtifacts = mockBuildVersionArtifacts,
+                            // Irrelevant for these tests.
+                            buildPackageArtifacts = { _, _, _ -> emptyMap() },
                         )
                     }
 
diff --git a/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/PackageArtifactsBuilding.kt b/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/PackageArtifactsBuilding.kt
@@ -2,12 +2,13 @@ package io.github.typesafegithub.workflows.mavenbinding
 
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 
-suspend fun ActionCoords.buildPackageArtifacts(
+suspend fun buildPackageArtifacts(
+    actionCoords: ActionCoords,
     githubAuthToken: String,
     prefetchBindingArtifacts: (Collection<ActionCoords>) -> Unit,
 ): Map<String, String> {
     val mavenMetadata =
-        buildMavenMetadataFile(
+        actionCoords.buildMavenMetadataFile(
             githubAuthToken = githubAuthToken,
             prefetchBindingArtifacts = prefetchBindingArtifacts,
         ) ?: return emptyMap()

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ class ArtifactRoutesTest :`
`23`	`23`	`buildVersionArtifacts = {`
`24`	`24`	`mapOf("some-action-v4.pom" to TextArtifact { "Some POM contents" })`
`25`	`25`	`},`
	`26`	`+ // Irrelevant for these tests.`
	`27`	`+ buildPackageArtifacts = { _, _, _ -> emptyMap() },`
`26`	`28`	`)`
`27`	`29`	`}`
`28`	`30`
`@@ -41,6 +43,8 @@ class ArtifactRoutesTest :`
`41`	`43`	`application {`
`42`	`44`	`appModule(`
`43`	`45`	`buildVersionArtifacts = { null },`
	`46`	`+ // Irrelevant for these tests.`
	`47`	`+ buildPackageArtifacts = { _, _, _ -> emptyMap() },`
`44`	`48`	`)`
`45`	`49`	`}`
`46`	`50`
`@@ -58,6 +62,8 @@ class ArtifactRoutesTest :`
`58`	`62`	`application {`
`59`	`63`	`appModule(`
`60`	`64`	`buildVersionArtifacts = { error("An internal error occurred!") },`
	`65`	`+ // Irrelevant for these tests.`
	`66`	`+ buildPackageArtifacts = { _, _, _ -> emptyMap() },`
`61`	`67`	`)`
`62`	`68`	`}`
`63`	`69`
`@@ -79,6 +85,8 @@ class ArtifactRoutesTest :`
`79`	`85`	`application {`
`80`	`86`	`appModule(`
`81`	`87`	`buildVersionArtifacts = mockBuildVersionArtifacts,`
	`88`	`+ // Irrelevant for these tests.`
	`89`	`+ buildPackageArtifacts = { _, _, _ -> emptyMap() },`
`82`	`90`	`)`
`83`	`91`	`}`
`84`	`92`