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

fix(golang): make sure xml.Encoder is closed #16141

Merged
merged 1 commit into from
Jul 26, 2023

Conversation

adamdecaf
Copy link
Contributor

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.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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.

/cc @lwj5

@adamdecaf
Copy link
Contributor Author

The .Close() method was added in Go 1.20, so OpenAPI probably needs to support older versions? Do you go back to Go 1.18?

@wing328
Copy link
Member

wing328 commented Jul 21, 2023

thanks for the PR. CI failed with errors: https://app.circleci.com/pipelines/github/OpenAPITools/openapi-generator/24812/workflows/5e1fba49-7f46-4b8e-83f7-723066699134/jobs/73874

please take a look when you've time.

@adamdecaf
Copy link
Contributor Author

That CI job runs on go version go1.18 linux/amd64 and .Close() was added in Go 1.20

go-petstore/client.go:561:36: enc.Close undefined (type *xml.Encoder has no field or method Close)

How long does OpenAPI support older versions of Go?

@lwj5
Copy link
Contributor

lwj5 commented Jul 21, 2023

My opinion is that it should be supported until the version is EOL

@wing328
Copy link
Member

wing328 commented Jul 22, 2023

https://endoflife.date/go

let's target Go 1.19

@wing328 wing328 added this to the 7.0.0 milestone Jul 22, 2023
@adamdecaf
Copy link
Contributor Author

adamdecaf commented Jul 24, 2023

I've pushed a fix for older versions of Go. When a newer version of Go is used to compile code after generation it will call Encoder.Close(), which is announced and the default for Go 1.20+

@adamdecaf adamdecaf changed the title fix(golang): close xml.Encoder and check errors fix(golang): make sure xml.Encoder is closed Jul 24, 2023
@wing328 wing328 merged commit 90eacb6 into OpenAPITools:master Jul 26, 2023
10 checks passed
@adamdecaf adamdecaf deleted the close-xml-encoder branch July 26, 2023 13:20
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.

3 participants