Invalid Generated code (conflicting declaration)

[nlescure-pictet]

Hi,

Let me start by thanking you for the good work !!

Now, I have a use case where the generated code does not compile.
Given the schema:

{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Commodities.Forward.Forward.InstRefDataReporting.V1", "LastModifyDateTime": "2020-08-05T10:37:37", "type": "object", "properties": { "Header": { "title": "Header", "type": "object", "properties": { "AssetClass": { "title": "Asset Class", "description": "As defined by CFI code: ISO 10962 (2015); Character #2", "type": "string", "enum": [ "Commodities" ] } }, }, }, }

The generated code looks like:
`
data class CommoditiesForwardForwardInstRefDataReportingV1(
val Header: Header,
) {

data class Header(
    val AssetClass: AssetClass
)

enum class AssetClass {
Commodities
}
}
`

which does not compile with error "conflicting declaration" because the field name == class name

[pwall567]

Hi @nlescure-pictet , very sorry I haven't responded before now.

I'm surprised this problem hasn't arisen before now. The creation of a class name for the enum (and other nested classes) by capitalising the property name works fine when the property name starts with a lower case letter, and in almost all examples I have seen that is the case.

I am trying to think of a solution to this problem. One possibility would be to offer different strategies for generating names, selected by an option in the config file, but this would then apply to all code produced in the same run of the code generator.

Let me think about it, but I should warn you that there are a couple of other issues ahead of this in my backlog 😄

Regards,
Peter

[rudolfv]

I am seeing the same issue where the object name starts with an underscore, for example _meta.

Conflicting declarations: public final data class _meta, public final val _meta: MySchema_v01._meta?

Other than that the code generator works like a charm!

In the meantime I am using the following search and replace workaround to fix the generated code. Replace the ellipses with whatever makes sense for your schema.

val generatedSourceDir = File(rootDir.absolutePath + "/build/generated-sources/kotlin")

tasks.register("jsonSchemaGeneratedCodeFix") {
    doFirst {
        jsonSchemaGeneratedCodeFix()
    }
}

tasks.named("compileKotlin") {
    dependsOn("jsonSchemaGeneratedCodeFix")
}

fun jsonSchemaGeneratedCodeFix() {
    generatedSourceDir.walk().filter { it.isFile }.forEach {
        it.writeText(
            it.readText().replace(..., ...)
        )
    }
}

[wiiitek]

Hello @nlescure-pictet, If I understand correctly the invalid output you get is because properties start with capital letter:

• Header
• AssetClass

As long as this is valid for TypeScript and Java, for Kotlin I would expect following input:

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "title": "Commodities.Forward.Forward.InstRefDataReporting.V1",
  "LastModifyDateTime": "2020-08-05T10:37:37",
  "type": "object",
  "properties": {
    "header": {
      "title": "Header",
      "type": "object",
      "properties": {
        "assetClass": {
          "title": "Asset Class",
          "description": "As defined by CFI code: ISO 10962 (2015); Character #2",
          "type": "string",
          "enum": [ "Commodities" ]
        }
      }
    }
  }
}

I agree, that currently generated Kotlin is bad. What is our idea of expected behaviour for such cases?

1. throw an exception?
2. generate types that are not nested (like for TypeScript)?
3. something else?

[nlescure-pictet]

Hi @wiiitek
Thanks for the answer.
Maybe generate a class name using the parent class name as a prefix or not using nested classes indeed like for TypeScript.
I would attempt to find a solution which doesn't crash as the schema is valid so the generator should manage to, well, generate the code :)