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

[Go] File Download Fix Return Type #14046

Merged
merged 8 commits into from
Dec 6, 2022

Conversation

icubbon
Copy link
Contributor

@icubbon icubbon commented Nov 16, 2022

Addresses #11965
The Go client.decode expected a **os.File but the return type is actually a *os.File.

This is almost a copy/pasta of #12685 but that PR has been sitting idle for 5 months without passing all of the checks to be merged in.

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 (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.
    @antihax @grokify @kemokemo @jirikuncar @ph4r5h4d @wing328

@wing328
Copy link
Member

wing328 commented Dec 6, 2022

@icubbon thanks for the fix. Let's give it a try.

@wing328 wing328 merged commit 63629ad into OpenAPITools:master Dec 6, 2022
}
_, err = f.Seek(0, io.SeekStart)
return
}
Copy link
Member

Choose a reason for hiding this comment

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

Some indentions in this files and others are using 4-space instead of tabs. I'll file another PR to update that.

Copy link
Member

Choose a reason for hiding this comment

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

UPDATE: filed #14189

@wing328 wing328 added Good First Issue An issue that could be fixed with a simple PR Breaking change (with fallback) Client: Go Issue: Bug Server: Go and removed Good First Issue An issue that could be fixed with a simple PR labels Dec 6, 2022
@wing328 wing328 added this to the 6.3.0 milestone Dec 6, 2022
typeMapping.put("binary", "*os.File");
typeMapping.put("File", "os.File");
typeMapping.put("file", "os.File");
typeMapping.put("binary", "os.File");
Copy link
Member

Choose a reason for hiding this comment

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

@icubbon shall we keep the mapping (pointer to os.File) and fix the code to properly return a pointer to os.File instead?

Copy link
Member

Choose a reason for hiding this comment

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

cc @DouglasDwyer (the author of #12685)

Copy link
Member

Choose a reason for hiding this comment

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

I'm afraid we need to revert this change and instead fix the endpoint to properly return a *os.File instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can take a stab at fixing the mapping to be a *os.File. It makes sense to have it be an *os.File as with the newer version of the generator, complex items are now pointers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@wing328 Please take a look at #14340. This reverts the mapping to *os.File and keeps us from having any goofy **os.File references.

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.

2 participants