Also make it possible to supply the action manifest

Author: Vampire

action-binding-generator/api/action-binding-generator.api

@@ -88,8 +88,8 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/gen
 }
 
 public final class io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationKt {
-	public static final fun generateBinding (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;Ljava/lang/String;)Ljava/util/List;
-	public static synthetic fun generateBinding$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;Ljava/lang/String;ILjava/lang/Object;)Ljava/util/List;
+	public static final fun generateBinding (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;Ljava/lang/String;Ljava/lang/String;)Ljava/util/List;
+	public static synthetic fun generateBinding$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Ljava/util/List;
 }
 
 public final class io/github/typesafegithub/workflows/actionbindinggenerator/metadata/Input {
@@ -160,8 +160,8 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/met
 }
 
 public final class io/github/typesafegithub/workflows/actionbindinggenerator/metadata/MetadataReadingKt {
-	public static final fun fetchMetadata (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lkotlin/jvm/functions/Function1;)Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;
-	public static synthetic fun fetchMetadata$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;
+	public static final fun fetchMetadata (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Ljava/lang/String;Lkotlin/jvm/functions/Function1;)Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;
+	public static synthetic fun fetchMetadata$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Ljava/lang/String;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;
 }
 
 public final class io/github/typesafegithub/workflows/actionbindinggenerator/metadata/Output {

action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/Generation.kt

@@ -65,8 +65,9 @@ public fun ActionCoords.generateBinding(
     metadata: Metadata? = null,
     inputTypings: Pair<Map<String, Typing>, TypingActualSource?>? = null,
     types: String? = null,
+    explicitMetadata: String? = null,
 ): List<ActionBinding> {
-    val metadataResolved = metadata ?: this.fetchMetadata(metadataRevision) ?: return emptyList()
+    val metadataResolved = metadata ?: this.fetchMetadata(metadataRevision, explicitMetadata) ?: return emptyList()
     val metadataProcessed = metadataResolved.removeDeprecatedInputsIfNameClash()
 
     val (inputTypingsResolved, typingActualSource) =

action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/metadata/MetadataReading.kt

@@ -45,8 +45,13 @@ private fun ActionCoords.actionYamlUrl(gitRef: String) = "https://raw.githubuser
 
 public fun ActionCoords.fetchMetadata(
     metadataRevision: MetadataRevision,
+    explicitMetadata: String? = null,
     fetchUri: (URI) -> String = ::fetchUri,
 ): Metadata? {
+    if (explicitMetadata != null) {
+        return yaml.decodeFromString(explicitMetadata)
+    }
+
     val gitRef =
         when (metadataRevision) {
             is CommitHash -> metadataRevision.value

docs/user-guide/using-actions.md

@@ -78,14 +78,20 @@ While developing a typing manifest it might be a good idea to test the result wi
 release the action in question or merge a PR in the catalog. For this you can `POST` the typing manifest you have
 on disk to the binding server using any valid URL for the action in question, for example using
 ```bash
-curl --data-binary @action-types.yml https://bindings.krzeminski.it/pbrisbin/setup-tool-action/v2/setup-tool-action-v2.pom
+curl -F types=@action-types.yml https://bindings.krzeminski.it/pbrisbin/setup-tool-action/v2/setup-tool-action-v2.pom
 ```
 The binding server generates a binding with only the given type manifest and answer with some unique coordinates
 that you can use in a test workflow script. The binding will be available the normal cache time on the binding
 server and locally as long as you do not delete it from your local Maven repository where it is cached. After
 the cache period on the server ended requesting the same coordinates will return a binding as if no typing
 information is available at all.
 
+When writing typings for a new action that is not published yet or a new version with changed inputs / outputs,
+you should also provide the new action manifest, that the generation works with that state using
+```bash
+curl -F [email protected] -F [email protected] https://bindings.krzeminski.it/foo/bar/vX/bar-vX.pom
+```
+
 Once there are any typings in place for the action, the `_Untyped` suffixed class is marked `@Deprecated`, and a class
 without that suffix is created additionally. In that class for each input that does not have type information available
 there will still be only the property with `_Untyped` suffix and nullability according to required status. For each

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

@@ -11,8 +11,10 @@ import io.github.typesafegithub.workflows.mavenbinding.VersionArtifacts
 import io.github.typesafegithub.workflows.mavenbinding.buildVersionArtifacts
 import io.ktor.http.ContentType
 import io.ktor.http.HttpStatusCode
+import io.ktor.http.content.asFlow
 import io.ktor.server.application.ApplicationCall
 import io.ktor.server.request.httpMethod
+import io.ktor.server.request.receiveMultipart
 import io.ktor.server.request.receiveText
 import io.ktor.server.response.respondBytes
 import io.ktor.server.response.respondText
@@ -28,9 +30,14 @@ import io.micrometer.prometheusmetrics.PrometheusMeterRegistry
 import it.krzeminski.snakeyaml.engine.kmp.api.Load
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.launch
 import java.util.UUID.randomUUID
 
+private const val METADATA_PARAMETER = "actionYaml"
+private const val TYPES_PARAMETER = "types"
+
 private val logger = logger { }
 
 typealias CachedVersionArtifact = VersionArtifacts?
@@ -124,14 +131,45 @@ private fun Route.postArtifact(
         val owner = "${call.parameters["owner"]}__types__${randomUUID()}"
         val name = call.parameters["name"]!!
         val version = call.parameters["version"]!!
-        val types = call.receiveText()
-        runCatching {
-            Load().loadOne(types)
-        }.onFailure {
-            call.respondText(
-                text = "Exception while parsing supplied typings:\n${it.stackTraceToString()}",
-                status = HttpStatusCode.UnprocessableEntity,
-            )
+
+        val (metadata, types) =
+            runCatching {
+                val parts =
+                    call
+                        .receiveMultipart()
+                        .asFlow()
+                        .map { it.name to it.asString() }
+                        .toList()
+                        .map { (name, result) ->
+                            name to
+                                when {
+                                    result.isSuccess -> result.getOrThrow()
+                                    else -> {
+                                        call.respondText(
+                                            text = HttpStatusCode.InternalServerError.description,
+                                            status = HttpStatusCode.InternalServerError,
+                                        )
+                                        return@post
+                                    }
+                                }
+                        }.associate { it }
+
+                if (parts.keys.any { (it != METADATA_PARAMETER) && (it != TYPES_PARAMETER) }) {
+                    call.respondBadRequest(
+                        text = "Only '$METADATA_PARAMETER' and '$TYPES_PARAMETER' are allowed as form data fields",
+                    )
+                    return@post
+                }
+                if (!parts.containsKey(TYPES_PARAMETER)) {
+                    call.respondBadRequest(text = "'$TYPES_PARAMETER' field is mandatory")
+                    return@post
+                }
+                parts[METADATA_PARAMETER] to parts[TYPES_PARAMETER]!!
+            }.recover {
+                null to call.receiveText()
+            }.getOrThrow()
+
+        if (!call.validateMetadata(metadata) || !call.validateTypes(types)) {
             return@post
         }
         val typingActualSource =
@@ -141,18 +179,57 @@ private fun Route.postArtifact(
                     bindingsCache = bindingsCache,
                     owner = owner,
                     types = types,
+                    metadata = metadata,
                 )?.typingActualSource ?: TypingActualSource.CUSTOM
         call.respondText(text = "$owner:$name:$version")
 
         prometheusRegistry?.incrementArtifactCounter(call, typingActualSource)
     }
 }
 
+private suspend fun ApplicationCall.validateTypes(types: String): Boolean {
+    runCatching {
+        Load().loadOne(types)
+    }.onFailure {
+        respondText(
+            text = "Exception while parsing supplied $TYPES_PARAMETER:\n${it.stackTraceToString()}",
+            status = HttpStatusCode.UnprocessableEntity,
+        )
+        return false
+    }
+    return true
+}
+
+private suspend fun ApplicationCall.validateMetadata(metadata: String?): Boolean {
+    var result = true
+    if (metadata != null) {
+        if (metadata.isEmpty()) {
+            respondText(
+                text = "Supplied $METADATA_PARAMETER is empty",
+                status = HttpStatusCode.UnprocessableEntity,
+            )
+            result = false
+        }
+
+        runCatching {
+            Load().loadOne(metadata)
+        }.onFailure {
+            respondText(
+                text = "Exception while parsing supplied $METADATA_PARAMETER:\n${it.stackTraceToString()}",
+                status = HttpStatusCode.UnprocessableEntity,
+            )
+            result = false
+        }
+    }
+    return result
+}
+
 private suspend fun ApplicationCall.toBindingArtifacts(
     refresh: Boolean,
     bindingsCache: LoadingCache<ActionCoords, CachedVersionArtifact>,
     owner: String = parameters["owner"]!!,
     types: String? = null,
+    metadata: String? = null,
 ): VersionArtifacts? {
     val actionCoords = parameters.extractActionCoords(extractVersion = true, owner = owner)
 
@@ -162,7 +239,7 @@ private suspend fun ApplicationCall.toBindingArtifacts(
     }
     return (
         if (types != null) {
-            bindingsCache.get(actionCoords) { buildVersionArtifacts(actionCoords, types) }
+            bindingsCache.get(actionCoords) { buildVersionArtifacts(actionCoords, types, metadata) }
         } else {
             bindingsCache.get(actionCoords)
         }

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

@@ -105,3 +105,5 @@ private fun buildMetadataCache(
 val deliverOnRefreshRoute = System.getenv("GWKT_DELIVER_ON_REFRESH").toBoolean()
 
 suspend fun ApplicationCall.respondNotFound() = respondText(text = "Not found", status = HttpStatusCode.NotFound)
+
+suspend fun ApplicationCall.respondBadRequest(text: String) = respondText(text, status = HttpStatusCode.BadRequest)

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

@@ -0,0 +1,20 @@
+package io.github.typesafegithub.workflows.jitbindingserver
+
+import io.github.oshai.kotlinlogging.KotlinLogging.logger
+import io.ktor.http.content.PartData
+import io.ktor.utils.io.readRemaining
+import io.ktor.utils.io.readText
+
+private val logger = logger { }
+
+internal suspend fun PartData.asString() =
+    runCatching {
+        when (this) {
+            is PartData.FileItem -> provider().readRemaining().readText()
+            is PartData.FormItem -> value
+            else -> {
+                logger.error { "Unexpected part data ${this::class.simpleName}" }
+                error("Unexpected part data ${this::class.simpleName}")
+            }
+        }
+    }

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

@@ -28,9 +28,12 @@ internal data class Jars(
     val typingActualSource: TypingActualSource?,
 )
 
-internal fun ActionCoords.buildJars(types: String?): Jars? {
+internal fun ActionCoords.buildJars(
+    types: String?,
+    metadata: String?,
+): Jars? {
     val binding =
-        generateBinding(metadataRevision = NewestForVersion, types = types).also {
+        generateBinding(metadataRevision = NewestForVersion, types = types, explicitMetadata = metadata).also {
             if (it.isEmpty()) return null
         }
 

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

@@ -21,9 +21,10 @@ data class VersionArtifacts(
 fun buildVersionArtifacts(
     actionCoords: ActionCoords,
     types: String? = null,
+    metadata: String? = null,
 ): VersionArtifacts? {
     with(actionCoords) {
-        val jars = buildJars(types = types) ?: return null
+        val jars = buildJars(types = types, metadata = metadata) ?: return null
         val pom = buildPomFile()
         val mainJarSize by lazy { jars.mainJar().size }
         val mainJarMd5Checksum by lazy { jars.mainJar().md5Checksum() }