Still array fields in the custom annotations don't appear in the output

[IvanPizhenko]

Full story is here: #93
I can't reopen that issue, so creating this one to keep track of it.

[IvanPizhenko]

Maybe you can add some debug output to the annotation processor, that can be optionally enabled, so we will see what's going on and why it loses array field in my case?

[dzikoysk]

Does it happen only when there's a fallback to default value or it happens also when you'll directly provide new values to the array?

[IvanPizhenko]

I observe it when I directly provide values, but I have default value empty array, which should not appear. I did not try non-empty default value because I don't need that in my code.

[dzikoysk]

Annotation processor should be configurable if I'll extend #127 with a decent API, so for sure we can try to add some kind of a debug mode on request.

[IvanPizhenko]

hmm... and why exactly groovy, why not kotlin script like in gradle?

[dzikoysk]

Groovy is quite compact, it provides all features bundled as library and just works at this point. I don't know much about scripting capabilities of Kotlin, it might be bootstraped in build system like Gradle, but I'm not sure how could I use it as library-only. Another thing is that as long as Kotlin devs would prefer Kotlin, Java devs are more familiar with Groovy anyway.

If you'd like to work on Kotlin support, feel free to submit issue & PR, it'd be quite nice enhancement. Both those scripts should return OpenApiAnnotationProcessorConfigurer interface implementation, so it doesn't really matter from the API perspective which language we use. In the end it's still workaround for limited capabilities of annotation processor API and I never seen such approach, so it's literally experimental adjustment.

[dzikoysk]

I've quickly checked kotlin-script-jsr223 and some related approaches, but it won't work out-of-the-box in the annotation processor environment. It probably requires some kind of a custom layer to properly link classloaders & classpath with compiler & runtime as it doesn't work the same way in annotation processor as in regular Java app. Also, Groovy has way better support in IntelliJ than Kotlin Script, it wouldn't work as good as gradle.kts files.

[dzikoysk]

This is what I get in debug logging using debug mode defined here:

• https://github.com/javalin/javalin-openapi/blob/main/openapi-annotation-processor/src/test/compile/openapi.groovy

For this code:

javalin-openapi/openapi-annotation-processor/src/test/kotlin/io/javalin/openapi/processor/UserCasesTest.kt

Lines 12 to 45 in 4716f14

	/*
	* GH-125 Array fields in the custom annotations don't appear in the output
	* ~ https://github.com/javalin/javalin-openapi/issues/125
	*/
	@Target(AnnotationTarget.PROPERTY_GETTER)
	@CustomAnnotation
	annotation class Schema(
	val allowableValues: Array<String> = [],
	val description: String = "",
	val example: String = "",
	val format: String = "",
	val pattern: String = ""
	)
	data class KeypairCreateResponse(
	@get:Schema(
	allowableValues = ["valid", "expired", "revoked"],
	format = "fingerprint",
	pattern = "^(valid|expired|revoked)$",
	description = "status of the key like valid|expired|revoked",
	)
	val fingerprint: String
	)
	@OpenApi(
	path = "gh-125",
	versions = ["gh-125"],
	responses = [OpenApiResponse(status = "200", content = [OpenApiContent(from = KeypairCreateResponse::class)])]
	)
	@Test
	fun gh_125() = withOpenApi("gh-125") {
	println(it)
	}

Logging:

Note: TypeSchemaGenerator#findExtra | Custom annotation: @io.javalin.openapi.processor.UserCasesTest.Schema(allowableValues={"valid", "expired", "revoked"}, format="fingerprint", pattern="^(valid|expired|revoked)$", description="status of the key like valid|expired|revoked")
Note: TypeSchemaGenerator#findExtra | Element values with defaults: {allowableValues()={"valid", "expired", "revoked"}, format()="fingerprint", pattern()="^(valid|expired|revoked)$", description()="status of the key like valid|expired|revoked", example()=""}
Note: TypeSchemaGenerator#findExtra | Visited entry (allowableValues(), {"valid", "expired", "revoked"}) mapped to ["valid","expired","revoked"]
Note: TypeSchemaGenerator#findExtra | Visited entry (format(), "fingerprint") mapped to fingerprint
Note: TypeSchemaGenerator#findExtra | Visited entry (pattern(), "^(valid|expired|revoked)$") mapped to ^(valid|expired|revoked)$
Note: TypeSchemaGenerator#findExtra | Visited entry (description(), "status of the key like valid|expired|revoked") mapped to status of the key like valid|expired|revoked
Note: TypeSchemaGenerator#findExtra | Visited entry (example(), "") mapped to 

Result:

{
  "openapi": "3.0.3",
  "info": {
    "title": "",
    "version": ""
  },
  "paths": {
    "/gh-125": {
      "get": {
        "tags": [],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/KeypairCreateResponse"
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "components": {
    "schemas": {
      "KeypairCreateResponse": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "fingerprint": {
            "type": "string",
            "example": "",
            "allowableValues": [
              "valid",
              "expired",
              "revoked"
            ],
            "format": "fingerprint",
            "pattern": "^(valid|expired|revoked)$",
            "description": "status of the key like valid|expired|revoked"
          }
        },
        "required": [
          "fingerprint"
        ]
      }
    }
  }
}

Could you try to use latest snapshot to check what's the output? Also, if you're using Gradle, you should be able to debug annotation processor as regular lib. Just add annotation processor library as implementation(), so IntelliJ will be able to link sources with Gradle debug execution process.

[dzikoysk]

Quick update: Imports have been slightly changed in experimental scripting API:

javalin-openapi/openapi-annotation-processor/src/test/compile/openapi.groovy

Lines 1 to 18 in 9ca6b29

	import groovy.transform.CompileStatic
	import io.javalin.openapi.experimental.AnnotationProcessorContext
	import io.javalin.openapi.experimental.ClassDefinition
	import io.javalin.openapi.experimental.ExperimentalCompileOpenApiConfiguration
	import io.javalin.openapi.experimental.OpenApiAnnotationProcessorConfiguration
	import io.javalin.openapi.experimental.OpenApiAnnotationProcessorConfigurer
	import org.jetbrains.annotations.Nullable
	import javax.lang.model.element.Element
	import javax.lang.model.element.TypeElement
	@CompileStatic
	@ExperimentalCompileOpenApiConfiguration
	class OpenApiConfiguration implements OpenApiAnnotationProcessorConfigurer {
	@Override
	void configure(OpenApiAnnotationProcessorConfiguration configuration) {
	configuration.debug = true

[IvanPizhenko]

So I have the following class:

data class KeyHistoryListItem(
  @get:Schema(
    allowableValues = ["add", "mod", "del"],
    description = "type of revision - add, mod (modify) or del (delete)"
  )
  val revisionType: String,

  @get:Schema(description = "row id of the particular history record")
  val id: Long,

  val keypair: KeyListItem
)

I get following debug output from the annotation processor regarding it:

Note: TypeSchemaGenerator#findAllProperties | Enclosed elements of com.mypackage.KeyHistoryListItem: revisionType,id,keypair,copy(java.lang.String,long,com.mypackage.KeyListItem),equals(java.lang.Object),hashCode(),toString(),KeyHistoryListItem(java.lang.String,long,com.mypackage.KeyListItem),component1(),getRevisionType(),component2(),getId(),component3(),getKeypair()

Nothing else.
No log entries from "TypeSchemaGenerator#findExtra".

[dzikoysk]

It sounds pretty strange, because it'd indicate those @get:Schema annotations are not processed at all... but you said you have some of those properties in the scheme 🤔 Sounds like caching issue, I guess you're using clean task, but could you also disable incremental compilation in Kapt: https://kotlinlang.org/docs/kapt.html#incremental-annotation-processing

Also, could you extract this code at some point to standalone project, so I can try to launch that on my own and debug some stuff?