feat(jit): build and cache all artifacts for version (#1351)

krzema12 · web-flow · commit f2f7fc8ddff3 · 2024-04-08T09:22:14.000+02:00
Part of #1318.
diff --git a/.github/workflows/end-to-end-tests.main.kts b/.github/workflows/end-to-end-tests.main.kts
@@ -2,7 +2,6 @@
 @file:DependsOn("io.github.typesafegithub:github-workflows-kt:1.13.0")
 
 import io.github.typesafegithub.workflows.actions.actions.CheckoutV4
-import io.github.typesafegithub.workflows.actions.actions.SetupJavaV4
 import io.github.typesafegithub.workflows.actions.gradle.ActionsSetupGradleV3
 import io.github.typesafegithub.workflows.annotations.ExperimentalKotlinLogicStep
 import io.github.typesafegithub.workflows.domain.RunnerType.UbuntuLatest
@@ -37,13 +36,6 @@ workflow(
     ) {
         // Using bundled bindings to avoid generating them here.
         uses(action = CheckoutV4())
-        uses(
-            name = "Set up JDK",
-            action = SetupJavaV4(
-                javaVersion = "11",
-                distribution = SetupJavaV4.Distribution.Zulu,
-            )
-        )
         uses(action = ActionsSetupGradleV3())
 
         run(
@@ -54,7 +46,7 @@ workflow(
         run(name = "Wait for the server to respond") {
             val timeSource = TimeSource.Monotonic
             val waitStart = timeSource.markNow()
-            val timeout = 1.minutes
+            val timeout = 3.minutes
 
             while (timeSource.markNow() - waitStart < timeout) {
                 try {
diff --git a/.github/workflows/end-to-end-tests.yaml b/.github/workflows/end-to-end-tests.yaml
@@ -31,20 +31,14 @@ jobs:
     - id: 'step-0'
       uses: 'actions/checkout@v4'
     - id: 'step-1'
-      name: 'Set up JDK'
-      uses: 'actions/setup-java@v4'
-      with:
-        java-version: '11'
-        distribution: 'zulu'
-    - id: 'step-2'
       uses: 'gradle/actions/setup-gradle@v3'
-    - id: 'step-3'
+    - id: 'step-2'
       name: 'Start the server'
       run: './gradlew :jit-binding-server:run &'
-    - id: 'step-4'
+    - id: 'step-3'
       name: 'Wait for the server to respond'
-      run: 'GHWKT_RUN_STEP=''test-jit-server:step-4'' ''.github/workflows/end-to-end-tests.main.kts'''
-    - id: 'step-5'
+      run: 'GHWKT_RUN_STEP=''test-jit-server:step-3'' ''.github/workflows/end-to-end-tests.main.kts'''
+    - id: 'step-4'
       name: 'Execute the script using the bindings from the server'
       run: |-
         mv .github/workflows/test-script-consuming-jit-bindings.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings.main.kts
diff --git a/buildSrc/src/main/kotlin/buildsrc/convention/kotlin-jvm-server.gradle.kts b/buildSrc/src/main/kotlin/buildsrc/convention/kotlin-jvm-server.gradle.kts
@@ -0,0 +1,55 @@
+package buildsrc.convention
+
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    kotlin("jvm")
+    `java-library`
+
+    // Code quality.
+    id("org.jmailen.kotlinter")
+}
+
+dependencies {
+    testImplementation(platform("io.kotest:kotest-bom:5.8.1"))
+    testImplementation("io.kotest:kotest-assertions-core")
+    testImplementation("io.kotest:kotest-runner-junit5")
+}
+
+java {
+    withJavadocJar()
+    withSourcesJar()
+
+    toolchain {
+        requiredJdkVersion()
+    }
+}
+
+kotlin {
+    jvmToolchain {
+        requiredJdkVersion()
+    }
+}
+
+fun JavaToolchainSpec.requiredJdkVersion() {
+    languageVersion.set(JavaLanguageVersion.of(17))
+}
+
+tasks.withType<KotlinCompile> {
+    kotlinOptions {
+        jvmTarget = "17"
+
+        allWarningsAsErrors = true
+    }
+
+    compilerOptions {
+        freeCompilerArgs.addAll(
+            "-opt-in=kotlin.ExperimentalStdlibApi",
+            "-opt-in=kotlin.time.ExperimentalTime",
+        )
+    }
+}
+
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
diff --git a/jit-binding-server/build.gradle.kts b/jit-binding-server/build.gradle.kts
@@ -1,7 +1,7 @@
 import io.ktor.plugin.features.*
 
 plugins {
-    buildsrc.convention.`kotlin-jvm`
+    buildsrc.convention.`kotlin-jvm-server`
     application
     id("io.ktor.plugin") version "2.3.9"
 }
@@ -10,6 +10,7 @@ dependencies {
     implementation(platform("io.ktor:ktor-bom:2.3.9"))
     implementation("io.ktor:ktor-server-core")
     implementation("io.ktor:ktor-server-netty")
+    implementation("io.github.reactivecircus.cache4k:cache4k:0.13.0")
     implementation("ch.qos.logback:logback-classic:1.5.3")
 
     implementation(projects.mavenBindingBuilder)
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
@@ -1,8 +1,11 @@
 package io.github.typesafegithub.workflows.jitbindingserver
 
-import io.github.typesafegithub.workflows.mavenbinding.buildJar
-import io.github.typesafegithub.workflows.mavenbinding.buildModuleFile
-import io.github.typesafegithub.workflows.mavenbinding.buildPomFile
+import io.github.reactivecircus.cache4k.Cache
+import io.github.typesafegithub.workflows.mavenbinding.ActionCoords
+import io.github.typesafegithub.workflows.mavenbinding.Artifact
+import io.github.typesafegithub.workflows.mavenbinding.JarArtifact
+import io.github.typesafegithub.workflows.mavenbinding.TextArtifact
+import io.github.typesafegithub.workflows.mavenbinding.buildVersionArtifacts
 import io.ktor.http.ContentType
 import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.call
@@ -12,39 +15,69 @@ import io.ktor.server.response.respondBytes
 import io.ktor.server.response.respondText
 import io.ktor.server.routing.get
 import io.ktor.server.routing.head
+import io.ktor.server.routing.route
 import io.ktor.server.routing.routing
+import kotlin.time.Duration.Companion.hours
 
 fun main() {
+    val bindingsCache =
+        Cache.Builder<ActionCoords, Map<String, Artifact>>()
+            .expireAfterAccess(1.hours)
+            .build()
+
     embeddedServer(Netty, port = 8080) {
         routing {
-            get("/binding/{owner}/{name}/{version}/{file}") {
-                val owner = call.parameters["owner"]!!
-                val name = call.parameters["name"]!!
-                val version = call.parameters["version"]!!
-                val file = call.parameters["file"]!!
-                when (file) {
-                    "$name-$version.jar" -> {
-                        val jarByteArray = buildJar(owner = owner, name = name, version = version)
-                        call.respondBytes(
-                            bytes = jarByteArray,
-                            contentType = ContentType.parse("application/java-archive"),
+            route("/binding/{owner}/{name}/{version}/{file}") {
+                get {
+                    val owner = call.parameters["owner"]!!
+                    val name = call.parameters["name"]!!
+                    val version = call.parameters["version"]!!
+                    val actionCoords =
+                        ActionCoords(
+                            owner = owner,
+                            name = name,
+                            version = version,
                         )
+                    val bindingArtifacts =
+                        bindingsCache.get(actionCoords) {
+                            actionCoords.buildVersionArtifacts()
+                        }
+                    val file = call.parameters["file"]!!
+                    if (file in bindingArtifacts) {
+                        when (val artifact = bindingArtifacts[file]) {
+                            is TextArtifact -> call.respondText(artifact.data)
+                            is JarArtifact ->
+                                call.respondBytes(
+                                    bytes = artifact.data,
+                                    contentType = ContentType.parse("application/java-archive"),
+                                )
+                            else -> call.respondText(text = "Not found", status = HttpStatusCode.NotFound)
+                        }
+                    } else {
+                        call.respondText(text = "Not found", status = HttpStatusCode.NotFound)
                     }
-                    "$name-$version.pom" -> call.respondText(buildPomFile(owner = owner, name = name, version = version))
-                    "$name-$version.module" -> call.respondText(buildModuleFile(owner = owner, name = name, version = version))
-                    else -> call.respondText(text = "Not found", status = HttpStatusCode.NotFound)
                 }
-            }
 
-            head("/binding/{owner}/{name}/{version}/{file}") {
-                val name = call.parameters["name"]!!
-                val version = call.parameters["version"]!!
-                val file = call.parameters["file"]!!
-                when (file) {
-                    "$name-$version.jar" -> call.respondText("ok", status = HttpStatusCode.OK)
-                    "$name-$version.pom" -> call.respondText("ok", status = HttpStatusCode.OK)
-                    "$name-$version.module" -> call.respondText("ok", status = HttpStatusCode.OK)
-                    else -> call.respondText(text = "Not found", status = HttpStatusCode.NotFound)
+                head {
+                    val owner = call.parameters["owner"]!!
+                    val name = call.parameters["name"]!!
+                    val version = call.parameters["version"]!!
+                    val file = call.parameters["file"]!!
+                    val actionCoords =
+                        ActionCoords(
+                            owner = owner,
+                            name = name,
+                            version = version,
+                        )
+                    val bindingArtifacts =
+                        bindingsCache.get(actionCoords) {
+                            actionCoords.buildVersionArtifacts()
+                        }
+                    if (file in bindingArtifacts) {
+                        call.respondText("Exists", status = HttpStatusCode.OK)
+                    } else {
+                        call.respondText(text = "Not found", status = HttpStatusCode.NotFound)
+                    }
                 }
             }
 
diff --git a/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/ActionCoords.kt b/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/ActionCoords.kt
@@ -0,0 +1,7 @@
+package io.github.typesafegithub.workflows.mavenbinding
+
+data class ActionCoords(
+    val owner: String,
+    val name: String,
+    val version: String,
+)
diff --git a/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/JarBuilding.kt b/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/JarBuilding.kt
@@ -20,7 +20,7 @@ import kotlin.io.path.createTempDirectory
 import kotlin.io.path.div
 import kotlin.io.path.writeText
 
-fun buildJar(
+internal fun buildJar(
     owner: String,
     name: String,
     version: String,
diff --git a/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/ModuleBuilding.kt b/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/ModuleBuilding.kt
@@ -1,6 +1,6 @@
 package io.github.typesafegithub.workflows.mavenbinding
 
-fun buildModuleFile(
+internal fun buildModuleFile(
     owner: String,
     name: String,
     version: String,
diff --git a/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/PomBuilding.kt b/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/PomBuilding.kt
@@ -1,6 +1,6 @@
 package io.github.typesafegithub.workflows.mavenbinding
 
-fun buildPomFile(
+internal fun buildPomFile(
     owner: String,
     name: String,
     version: String,
diff --git a/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/VersionArtifactsBuilding.kt b/maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/VersionArtifactsBuilding.kt
@@ -0,0 +1,27 @@
+package io.github.typesafegithub.workflows.mavenbinding
+
+sealed interface Artifact
+
+data class TextArtifact(val data: String) : Artifact
+
+data class JarArtifact(val data: ByteArray) : Artifact {
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as JarArtifact
+
+        return data.contentEquals(other.data)
+    }
+
+    override fun hashCode(): Int {
+        return data.contentHashCode()
+    }
+}
+
+fun ActionCoords.buildVersionArtifacts(): Map<String, Artifact> =
+    mapOf(
+        "$name-$version.jar" to JarArtifact(buildJar(owner = owner, name = name, version = version)),
+        "$name-$version.pom" to TextArtifact(buildPomFile(owner = owner, name = name, version = version)),
+        "$name-$version.module" to TextArtifact(buildModuleFile(owner = owner, name = name, version = version)),
+    )
