feat(server): add info about typing's source to metrics (#1952)

Thanks to this, we'll be able to monitor the source of typings, and also
proactively add typings for untyped actions.

Author: krzema12

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

@@ -3,6 +3,7 @@ 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.TypingActualSource
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.prettyPrint
 import io.github.typesafegithub.workflows.mavenbinding.JarArtifact
 import io.github.typesafegithub.workflows.mavenbinding.TextArtifact
@@ -73,7 +74,7 @@ private fun Route.headArtifact(
             call.respondNotFound()
         }
 
-        prometheusRegistry?.incrementArtifactCounter(call)
+        prometheusRegistry?.incrementArtifactCounter(call, bindingArtifacts.typingActualSource)
     }
 }
 
@@ -96,7 +97,7 @@ private fun Route.getArtifact(
             is JarArtifact -> call.respondBytes(artifact.data(), ContentType.parse("application/java-archive"))
         }
 
-        prometheusRegistry?.incrementArtifactCounter(call)
+        prometheusRegistry?.incrementArtifactCounter(call, bindingArtifacts.typingActualSource)
     }
 }
 
@@ -122,7 +123,10 @@ private suspend fun ApplicationCall.toBindingArtifacts(
     return bindingsCache.get(actionCoords)
 }
 
-private fun PrometheusMeterRegistry.incrementArtifactCounter(call: ApplicationCall) {
+private fun PrometheusMeterRegistry.incrementArtifactCounter(
+    call: ApplicationCall,
+    typingActualSource: TypingActualSource?,
+) {
     val owner = call.parameters["owner"] ?: "unknown"
     val name = call.parameters["name"] ?: "unknown"
     val version = call.parameters["version"] ?: "unknown"
@@ -133,6 +137,12 @@ private fun PrometheusMeterRegistry.incrementArtifactCounter(call: ApplicationCa
             .status()
             ?.value
             ?.toString() ?: "unknown"
+    val typingActualSourceString =
+        when (typingActualSource) {
+            TypingActualSource.ACTION -> "action"
+            TypingActualSource.TYPING_CATALOG -> "typing_catalog"
+            null -> "no_typing"
+        }
 
     val counter =
         this.counter(
@@ -144,6 +154,7 @@ private fun PrometheusMeterRegistry.incrementArtifactCounter(call: ApplicationCa
                 Tag.of("file", file),
                 Tag.of("method", method),
                 Tag.of("status", status),
+                Tag.of("typing_actual_source", typingActualSourceString),
             ),
         )
     counter.increment()

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.actionbindinggenerator.domain.TypingActualSource
 import io.github.typesafegithub.workflows.mavenbinding.TextArtifact
 import io.github.typesafegithub.workflows.mavenbinding.VersionArtifacts
 import io.kotest.core.spec.style.FunSpec
@@ -24,6 +25,7 @@ class ArtifactRoutesTest :
                             buildVersionArtifacts = {
                                 VersionArtifacts(
                                     files = mapOf("some-action-v4.pom" to TextArtifact { "Some POM contents" }),
+                                    typingActualSource = TypingActualSource.TYPING_CATALOG,
                                 )
                             },
                             // Irrelevant for these tests.
@@ -89,6 +91,7 @@ class ArtifactRoutesTest :
                         Exception("An internal error occurred!") andThen
                         VersionArtifacts(
                             files = mapOf("some-action-v4.pom" to TextArtifact { "Some POM contents" }),
+                            typingActualSource = TypingActualSource.TYPING_CATALOG,
                         )
                     application {
                         appModule(

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

@@ -28,6 +28,7 @@ class MetadataRoutesTest :
                             buildVersionArtifacts = {
                                 VersionArtifacts(
                                     files = emptyMap(),
+                                    typingActualSource = null,
                                 )
                             },
                         )
@@ -55,6 +56,7 @@ class MetadataRoutesTest :
                             buildVersionArtifacts = {
                                 VersionArtifacts(
                                     files = emptyMap(),
+                                    typingActualSource = null,
                                 )
                             },
                         )
@@ -81,6 +83,7 @@ class MetadataRoutesTest :
                             buildVersionArtifacts = {
                                 VersionArtifacts(
                                     files = emptyMap(),
+                                    typingActualSource = null,
                                 )
                             },
                         )
@@ -116,6 +119,7 @@ class MetadataRoutesTest :
                             buildVersionArtifacts = {
                                 VersionArtifacts(
                                     files = emptyMap(),
+                                    typingActualSource = null,
                                 )
                             },
                         )

maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/JarBuilding.kt

@@ -4,6 +4,7 @@ package io.github.typesafegithub.workflows.mavenbinding
 
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.NewestForVersion
+import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
 import io.github.typesafegithub.workflows.actionbindinggenerator.generation.ActionBinding
 import io.github.typesafegithub.workflows.actionbindinggenerator.generation.generateBinding
 import org.jetbrains.kotlin.cli.common.ExitCode
@@ -24,6 +25,7 @@ import kotlin.io.path.writeText
 internal data class Jars(
     val mainJar: () -> ByteArray,
     val sourcesJar: () -> ByteArray,
+    val typingActualSource: TypingActualSource?,
 )
 
 internal fun ActionCoords.buildJars(): Jars? {
@@ -53,6 +55,7 @@ internal fun ActionCoords.buildJars(): Jars? {
     return Jars(
         mainJar = { mainJar },
         sourcesJar = { sourcesJar },
+        typingActualSource = binding.firstNotNullOfOrNull { it.typingActualSource },
     )
 }
 

maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/VersionArtifactsBuilding.kt

@@ -1,6 +1,7 @@
 package io.github.typesafegithub.workflows.mavenbinding
 
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
+import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
 
 sealed interface Artifact
 
@@ -14,6 +15,7 @@ data class JarArtifact(
 
 data class VersionArtifacts(
     val files: Map<String, Artifact>,
+    val typingActualSource: TypingActualSource?,
 )
 
 fun buildVersionArtifacts(actionCoords: ActionCoords): VersionArtifacts? {
@@ -68,6 +70,7 @@ fun buildVersionArtifacts(actionCoords: ActionCoords): VersionArtifacts? {
                     "$mavenName-$version.module.sha256" to TextArtifact { module.sha256Checksum() },
                     "$mavenName-$version.module.sha512" to TextArtifact { module.sha512Checksum() },
                 ),
+            typingActualSource = jars.typingActualSource,
         )
     }
 }