Skip to content

Fix explicit KSerializer's name & generation when used in container #20093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 14, 2024

Conversation

hrach
Copy link
Contributor

@hrach hrach commented Nov 12, 2024

This PR fixes two issues for explicit generation of KSerializer for enums (with auto unknown case):

  • KSerializer's name - the referencing side was ok, but the referenced side was using the wrong variable (output shows the change)
  • When the enum was a part of the container, the KSerializer was generated incorrectly (non-compiling). I copied the pattern from line 123 and it works flawlessly now. I am unable to show it in the generated code without changing pets schema.

@e5l

THIS IS FOLLOW UP FOR #20092

Example of the second issue:

Before:

@Serializable
data class CreatorFanclubPutRequestBodyDto (
    @SerialName(value = "creator_fanclub_types")
    val creatorFanclubTypes: kotlin.collections.List<CreatorFanclubPutRequestBodyDto.CreatorFanclubTypes>

) {
    @Serializable(with = CreatorFanclubTypesSerializer::class)
    enum class CreatorFanclubTypes(val value: kotlin.String) {
        @SerialName(value = "actors") ACTORS("actors"),
        @SerialName(value = "actresses") ACTRESSES("actresses"),
        @SerialName(value = "unknown_default_open_api") UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");
    }

    internal object CreatorFanclubTypesSerializer : KSerializer<CreatorFanclubTypes> {
        override val descriptor = kotlin.collections.List&lt;kotlin.String&gt;.serializer().descriptor

        override fun deserialize(decoder: Decoder): CreatorFanclubTypes {
            val value = decoder.decodeSerializableValue(kotlin.collections.List&lt;kotlin.String&gt;.serializer())
            return CreatorFanclubTypes.values().firstOrNull { it.value == value }
                ?: CreatorFanclubTypes.UNKNOWN_DEFAULT_OPEN_API
        }

        override fun serialize(encoder: Encoder, value: CreatorFanclubTypes) {
            encoder.encodeSerializableValue(kotlin.collections.List&lt;kotlin.String&gt;.serializer(), value.value)
        }
    }
}

After:

@Serializable
data class CreatorFanclubPutRequestBodyDto (
    @SerialName(value = "creator_fanclub_types")
    val creatorFanclubTypes: kotlin.collections.List<CreatorFanclubPutRequestBodyDto.CreatorFanclubTypes>
) {
    @Serializable(with = CreatorFanclubTypesSerializer::class)
    enum class CreatorFanclubTypes(val value: kotlin.String) {
        @SerialName(value = "actors") ACTORS("actors"),
        @SerialName(value = "actresses") ACTRESSES("actresses"),
        @SerialName(value = "unknown_default_open_api") UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");
    }

    internal object CreatorFanclubTypesSerializer : KSerializer<CreatorFanclubTypes> {
        override val descriptor = kotlin.String.serializer().descriptor

        override fun deserialize(decoder: Decoder): CreatorFanclubTypes {
            val value = decoder.decodeSerializableValue(kotlin.String.serializer())
            return CreatorFanclubTypes.values().firstOrNull { it.value == value }
                ?: CreatorFanclubTypes.UNKNOWN_DEFAULT_OPEN_API
        }

        override fun serialize(encoder: Encoder, value: CreatorFanclubTypes) {
            encoder.encodeSerializableValue(kotlin.String.serializer(), value.value)
        }
    }
}

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@hrach hrach force-pushed the kotlin-client-explicit-kserializer branch from cec1f62 to 60be9fe Compare November 12, 2024 21:42
@hrach hrach force-pushed the kotlin-client-explicit-kserializer branch from 60be9fe to 6ca974c Compare November 12, 2024 21:45
@e5l
Copy link
Contributor

e5l commented Nov 13, 2024

Hey @hrach, thank you for the PR. Looks good

@4brunu
Copy link
Contributor

4brunu commented Nov 14, 2024

Looks good 👍

@4brunu 4brunu merged commit 96adf2f into OpenAPITools:master Nov 14, 2024
60 checks passed
@hrach hrach deleted the kotlin-client-explicit-kserializer branch November 14, 2024 14:11
@wing328 wing328 added this to the 7.10.0 milestone Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants