refactor(server): pass name and version from request to artifact generation (#2186)

This is a preliminary change making it easier to implement
#1691.

Even without the above project, it makes things more straightforward. In
particular, the artifact names happen to match what comes in the
request, but in general it doesn't have to be the case. We need to
encode certain extra information in Maven artifact's names and owners,
which leads to a mismatch where the GitHub action's name isn't equal to
the requested Maven artifact's name. This change recognizes it by using
different fields in these two circumstances.

Author: krzema12

jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ArtifactRoutes.kt

@@ -5,6 +5,7 @@ import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.prettyPrint
+import io.github.typesafegithub.workflows.mavenbinding.BindingsServerRequest
 import io.github.typesafegithub.workflows.mavenbinding.JarArtifact
 import io.github.typesafegithub.workflows.mavenbinding.TextArtifact
 import io.github.typesafegithub.workflows.mavenbinding.VersionArtifacts
@@ -35,7 +36,7 @@ typealias CachedVersionArtifact = Optional<VersionArtifacts>
 private val prefetchScope = CoroutineScope(Dispatchers.IO)
 
 fun Routing.artifactRoutes(
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
     prometheusRegistry: PrometheusMeterRegistry? = null,
 ) {
     prometheusRegistry?.let {
@@ -53,15 +54,15 @@ fun Routing.artifactRoutes(
 
 private fun Route.artifact(
     prometheusRegistry: PrometheusMeterRegistry?,
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
     refresh: Boolean = false,
 ) {
     headArtifact(bindingsCache, prometheusRegistry, refresh)
     getArtifact(bindingsCache, prometheusRegistry, refresh)
 }
 
 private fun Route.headArtifact(
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
     prometheusRegistry: PrometheusMeterRegistry?,
     refresh: Boolean,
 ) {
@@ -81,7 +82,7 @@ private fun Route.headArtifact(
 }
 
 private fun Route.getArtifact(
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
     prometheusRegistry: PrometheusMeterRegistry?,
     refresh: Boolean,
 ) {
@@ -105,24 +106,32 @@ private fun Route.getArtifact(
 
 internal fun prefetchBindingArtifacts(
     coords: Collection<ActionCoords>,
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
 ) {
     prefetchScope.launch {
-        bindingsCache.getAll(coords)
+        bindingsCache.getAll(
+            coords.map {
+                BindingsServerRequest(
+                    rawName = it.name,
+                    rawVersion = it.version,
+                    actionCoords = it,
+                )
+            },
+        )
     }
 }
 
 private suspend fun ApplicationCall.toBindingArtifacts(
     refresh: Boolean,
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
 ): VersionArtifacts? {
-    val actionCoords = parameters.extractActionCoords(extractVersion = true)
+    val parsedRequest = parameters.parseRequest(extractVersion = true)
 
-    logger.info { "➡️ Requesting ${actionCoords.prettyPrint}" }
+    logger.info { "➡️ Requesting ${parsedRequest.actionCoords.prettyPrint}" }
     if (refresh) {
-        bindingsCache.invalidate(actionCoords)
+        bindingsCache.invalidate(parsedRequest)
     }
-    return bindingsCache.get(actionCoords).getOrNull()
+    return bindingsCache.get(parsedRequest).getOrNull()
 }
 
 private fun PrometheusMeterRegistry.incrementArtifactCounter(

jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/Main.kt

@@ -6,6 +6,7 @@ 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.mavenbinding.BindingsServerRequest
 import io.github.typesafegithub.workflows.mavenbinding.VersionArtifacts
 import io.github.typesafegithub.workflows.mavenbinding.buildPackageArtifacts
 import io.github.typesafegithub.workflows.mavenbinding.buildVersionArtifacts
@@ -67,9 +68,9 @@ fun main() {
 }
 
 fun Application.appModule(
-    buildVersionArtifacts: suspend (ActionCoords, HttpClient) -> VersionArtifacts?,
+    buildVersionArtifacts: suspend (BindingsServerRequest, HttpClient) -> VersionArtifacts?,
     buildPackageArtifacts: suspend (
-        ActionCoords,
+        BindingsServerRequest,
         String,
         (Collection<ActionCoords>) -> Unit,
         MeterRegistry,
@@ -103,9 +104,9 @@ fun Application.appModule(
 }
 
 private fun buildBindingsCache(
-    buildVersionArtifacts: suspend (ActionCoords, HttpClient) -> VersionArtifacts?,
+    buildVersionArtifacts: suspend (BindingsServerRequest, HttpClient) -> VersionArtifacts?,
     httpClient: HttpClient,
-): LoadingCache<ActionCoords, CachedVersionArtifact> =
+): LoadingCache<BindingsServerRequest, CachedVersionArtifact> =
     Caffeine
         .newBuilder()
         .refreshAfterWrite(1.hours)
@@ -114,20 +115,20 @@ private fun buildBindingsCache(
 
 @Suppress("ktlint:standard:function-signature") // Conflict with detekt.
 private fun buildMetadataCache(
-    bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
+    bindingsCache: LoadingCache<BindingsServerRequest, CachedVersionArtifact>,
     buildPackageArtifacts: suspend (
-        ActionCoords,
+        BindingsServerRequest,
         String,
         (Collection<ActionCoords>) -> Unit,
         MeterRegistry,
     ) -> Map<String, String>,
     getGithubAuthToken: () -> String,
-): LoadingCache<ActionCoords, CachedMetadataArtifact> =
+): LoadingCache<BindingsServerRequest, CachedMetadataArtifact> =
     Caffeine
         .newBuilder()
         .refreshAfterWrite(1.hours)
         .recordStats()
-        .asLoadingCache<ActionCoords, CachedMetadataArtifact> {
+        .asLoadingCache<BindingsServerRequest, CachedMetadataArtifact> {
             buildPackageArtifacts(
                 it,
                 getGithubAuthToken(),

jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/MetadataRoutes.kt

@@ -2,8 +2,8 @@ package io.github.typesafegithub.workflows.jitbindingserver
 
 import com.sksamuel.aedile.core.LoadingCache
 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.BindingsServerRequest
 import io.ktor.http.HttpStatusCode
 import io.ktor.server.response.respondText
 import io.ktor.server.routing.Route
@@ -19,7 +19,7 @@ private val logger = logger { }
 typealias CachedMetadataArtifact = Map<String, String>
 
 fun Routing.metadataRoutes(
-    metadataCache: LoadingCache<ActionCoords, CachedMetadataArtifact>,
+    metadataCache: LoadingCache<BindingsServerRequest, CachedMetadataArtifact>,
     prometheusRegistry: PrometheusMeterRegistry? = null,
 ) {
     prometheusRegistry?.let {
@@ -38,16 +38,16 @@ fun Routing.metadataRoutes(
 }
 
 private fun Route.headMetadata(
-    metadataCache: LoadingCache<ActionCoords, CachedMetadataArtifact>,
+    metadataCache: LoadingCache<BindingsServerRequest, CachedMetadataArtifact>,
     refresh: Boolean = false,
 ) {
     head {
-        val actionCoords = call.parameters.extractActionCoords(extractVersion = false)
+        val request = call.parameters.parseRequest(extractVersion = false)
 
         if (refresh) {
-            metadataCache.invalidate(actionCoords)
+            metadataCache.invalidate(request)
         }
-        val metadataArtifacts = metadataCache.get(actionCoords)
+        val metadataArtifacts = metadataCache.get(request)
 
         if (refresh && !deliverOnRefreshRoute) return@head call.respondText(text = "OK")
 
@@ -62,18 +62,18 @@ private fun Route.headMetadata(
 }
 
 private fun Route.getMetadata(
-    metadataCache: LoadingCache<ActionCoords, CachedMetadataArtifact>,
+    metadataCache: LoadingCache<BindingsServerRequest, CachedMetadataArtifact>,
     refresh: Boolean = false,
 ) {
     get {
-        val actionCoords = call.parameters.extractActionCoords(extractVersion = false)
+        val request = call.parameters.parseRequest(extractVersion = false)
 
-        logger.info { "➡️ Requesting metadata for ${actionCoords.prettyPrintWithoutVersion}" }
+        logger.info { "➡️ Requesting metadata for ${request.actionCoords.prettyPrintWithoutVersion}" }
 
         if (refresh) {
-            metadataCache.invalidate(actionCoords)
+            metadataCache.invalidate(request)
         }
-        val metadataArtifacts = metadataCache.get(actionCoords)
+        val metadataArtifacts = metadataCache.get(request)
 
         if (refresh && !deliverOnRefreshRoute) return@get call.respondText(text = "OK")
 

…rkflows/jitbindingserver/ActionCoords.kt …flows/jitbindingserver/RequestParsing.ktjit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ActionCoords.kt renamed to jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/RequestParsing.kt jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ActionCoords.kt renamed to jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/RequestParsing.kt

@@ -3,9 +3,10 @@ package io.github.typesafegithub.workflows.jitbindingserver
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.SignificantVersion
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.SignificantVersion.FULL
+import io.github.typesafegithub.workflows.mavenbinding.BindingsServerRequest
 import io.ktor.http.Parameters
 
-fun Parameters.extractActionCoords(extractVersion: Boolean): ActionCoords {
+fun Parameters.parseRequest(extractVersion: Boolean): BindingsServerRequest {
     val owner = this["owner"]!!
     val nameAndPathAndSignificantVersionParts = this["name"]!!.split("___", limit = 2)
     val nameAndPath = nameAndPathAndSignificantVersionParts.first()
@@ -28,5 +29,9 @@ fun Parameters.extractActionCoords(extractVersion: Boolean): ActionCoords {
             .takeUnless { it.isBlank() }
     val version = if (extractVersion) this["version"]!! else "irrelevant"
 
-    return ActionCoords(owner, name, version, significantVersion, path)
+    return BindingsServerRequest(
+        rawName = this["name"]!!,
+        rawVersion = this["version"],
+        actionCoords = ActionCoords(owner, name, version, significantVersion, path),
+    )
 }

jit-binding-server/src/test/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ActionCoordsTest.kt

@@ -2,6 +2,7 @@ package io.github.typesafegithub.workflows.jitbindingserver
 
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
+import io.github.typesafegithub.workflows.mavenbinding.BindingsServerRequest
 import io.github.typesafegithub.workflows.mavenbinding.TextArtifact
 import io.github.typesafegithub.workflows.mavenbinding.VersionArtifacts
 import io.kotest.core.spec.style.FunSpec
@@ -67,7 +68,7 @@ class ArtifactRoutesTest :
             test("when artifacts is not available, two requests in a row") {
                 testApplication {
                     // Given
-                    val mockBuildVersionArtifacts = mockk<(ActionCoords, HttpClient) -> VersionArtifacts?>()
+                    val mockBuildVersionArtifacts = mockk<(BindingsServerRequest, HttpClient) -> VersionArtifacts?>()
                     every { mockBuildVersionArtifacts(any(), any()) } returns null
                     application {
                         appModule(
@@ -117,7 +118,7 @@ class ArtifactRoutesTest :
             test("when binding generation fails and then succeeds, and two requests are made") {
                 testApplication {
                     // Given
-                    val mockBuildVersionArtifacts = mockk<(ActionCoords, HttpClient) -> VersionArtifacts?>()
+                    val mockBuildVersionArtifacts = mockk<(BindingsServerRequest, HttpClient) -> VersionArtifacts?>()
                     every { mockBuildVersionArtifacts(any(), any()) } throws
                         Exception("An internal error occurred!") andThen
                         VersionArtifacts(

jit-binding-server/src/test/kotlin/io/github/typesafegithub/workflows/jitbindingserver/ArtifactRoutesTest.kt

@@ -1,6 +1,7 @@
 package io.github.typesafegithub.workflows.jitbindingserver
 
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
+import io.github.typesafegithub.workflows.mavenbinding.BindingsServerRequest
 import io.github.typesafegithub.workflows.mavenbinding.VersionArtifacts
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
@@ -104,7 +105,7 @@ class MetadataRoutesTest :
                     val mockBuildPackageArtifacts =
                         mockk<
                             (
-                                ActionCoords,
+                                BindingsServerRequest,
                                 String,
                                 (Collection<ActionCoords>) -> Unit,
                                 MeterRegistry?,