Ktor のバグに遭遇した話

sya-ri

Souya Ichikawa (sya-ri)

• フルスタックエンジニア
  • YUMEMI Part of Accenture Song
  • Kotlin, TypeScript, React, AWS, ...
• コミュニティ活動
  • Kotlin愛好会
  • try! Swift Tokyo

• Kotlin 製の Web フレームワーク
• Spring Boot より薄くて、小さく始めやすい
• プラグインを組み合わせて機能を拡張できる

fun main() {
    embeddedServer(Netty, port = 8000) {
        routing {
            get("/") {
                call.respondText("Hello, world!") 
            }
        }
    }.start(wait = true)
}

例えばこんなプラグインがある

例えばこんなプラグインがある

OpenAPI の生成

@Serializable
data class User(val name: String)

get("/users") {
    call.respond(listOf(User("sya-ri")))
}.describe {
    summary = "Get users"
    description = "Retrieves a list of users."
    responses {
        HttpStatusCode.OK {
            description = "A list of users"
            schema = jsonSchema<List<User>>()
        }
    }
}

paths:
  /users:
    get:
      summary: Get users
      description: Retrieves a list of users.
      responses:
        "200":
          description: A list of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/User"
components:
  schemas:
    User:
      type: object
      properties:
        name:
          type: string
      required:
        - name

表現したいデータ

パーツとして考える

Heading(level = 1)
Text
TwoColumnRow(
  left  = [Image],
  right = [
    Heading(level = 2),
    List
  ]
)

ビルドエラー

Exception in thread "main" java.lang.StackOverflowError
  at io.ktor.openapi.JsonSchemaInferenceKt.jsonSchemaFromAnnotations(JsonSchemaInference.kt:483)
  at io.ktor.openapi.JsonSchemaInferenceKt.jsonSchemaFromAnnotations$default(JsonSchemaInference.kt:350)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:242)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema(JsonSchemaInference.kt:301)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema$default(JsonSchemaInference.kt:296)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:112)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema(JsonSchemaInference.kt:301)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema$default(JsonSchemaInference.kt:296)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:143)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema$default(JsonSchemaInference.kt:94)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:172)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema(JsonSchemaInference.kt:301)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema$default(JsonSchemaInference.kt:296)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:143)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema$default(JsonSchemaInference.kt:94)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:172)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema(JsonSchemaInference.kt:301)
  at io.ktor.openapi.JsonSchemaInferenceKt.buildJsonSchema$default(JsonSchemaInference.kt:296)
  at io.ktor.openapi.KotlinxSerializerJsonSchemaInference.buildSchemaFromDescriptor$ktor_openapi_schema(JsonSchemaInference.kt:206)

io.ktor.plugin で問題を再現してみた

class KotlinxJsonSchemaInferenceTest : AbstractSchemaInferenceTest(
    KotlinxSerializerJsonSchemaInference.Default,
    "kotlinx"
) {
    @Test
    fun `sealed child recursion`() {
        val schema = inference.jsonSchema<TreeElement>()
        assertEquals("io.ktor.openapi.reflect.TreeElement", schema.title)
        assertEquals(2, schema.oneOf?.size)
    }
}

@Serializable
sealed interface TreeElement {
    @Serializable
    data class Leaf(val value: String) : TreeElement

    @Serializable
    data class Branch(val child: TreeElement) : TreeElement
}

さあ、直そう

依存関係

調べてみたら報告されていた

https://youtrack.jetbrains.com/issue/KTOR-9463/OpenAPI-schema-inference-StackOverflow

もっと調べてみたら修正されていた

https://github.com/ktorio/ktor/pull/5505

早すぎる

• 4/4 : 報告・修正済み
• 4/10 : バグに遭遇・修正を試みる
• 4/10 : マージ済み
• 4月の最終週 : 3.4.3 でリリース予定

AIの活用ってどうなんだろう

おわり

Ktor 最高〜！