Skip to content
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

[kotlin] fix Date types usages #8594

Merged
merged 3 commits into from
Feb 3, 2021

Conversation

4brunu
Copy link
Contributor

@4brunu 4brunu commented Feb 1, 2021

AbstractKotlinCodegen.java has some issues related to date types.

The first one is that in the typeMapping it defines Date as java.time.LocalDate which is correct.
But then in importMapping it defines Date as java.time.LocalDate which is incorrect and doesn't match with the typeMapping
It should define Date as java.time.LocalDate in the typeMapping.

The second one is that it defines DateTime as java.time.LocalDateTime in the typeMapping and in the importMapping, which is wrong, it should be java.time.OffsetDateTime.
This can cause bugs because the servers and the clients can (and most probably are) in different timezones.
This is already fixed in KotlinSpringServerCodegen and KotlinClientCodegen but not in AbstractKotlinCodegen.

Finally since java.util.Date is never used, it's not necessary in the Kotlin Client Serializer, so it's removed.

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03)

@auto-labeler
Copy link

auto-labeler bot commented Feb 1, 2021

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@4brunu
Copy link
Contributor Author

4brunu commented Feb 2, 2021

This PR has lots of changes, because I generate the samples server and openapi3, which were really outdated, because they are "hidden" in the directories bin/configs/other/openapi3/kotlin* and bin/configs/other/kotlin*.

@wing328 Maybe to avoid this problem of the samples server and openapi3 getting outdated, they should be moved to bin/configs/*?

@jimschubert
Copy link
Member

I was going to ask about the DateTime default from java.time.LocalDateTime to java.time.OffsetDateTime, but then I thought about it more and it's really the only type that fully supports the spec's date-time requirement to match rfc3339.

We'll need to consider this a bug fix in that case. Folks may need to pass type-mappings to override for backward compatibility with previously generated code.

Copy link
Member

@jimschubert jimschubert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jimschubert jimschubert added this to the 5.0.1 milestone Feb 3, 2021
@jimschubert jimschubert merged commit 45fc023 into OpenAPITools:master Feb 3, 2021
@4brunu 4brunu deleted the fix/date-types branch February 3, 2021 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants