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

[swift5 client] fix filename for binary downloads #9989

Conversation

gretzki
Copy link
Contributor

@gretzki gretzki commented Jul 20, 2021

Problem:

When a file download is handled within URLSessionImplementations,
the filename is retrieved via the header Content-Disposition part of the response.
The header is looked for an entry starting with filename=.
But the search is skipped too early, since the loop is exited if the first iteration does not match.

Example:

Try to download a file with a swift5 client for a spec like this:

  /PublicDocument/Download:
    get:
      tags:
        - Public Area
      description: 'Document Download for Public Documents. Login not Required'
      parameters:
        - $ref: '#/components/parameters/queryId'
      responses:
        '200':
          description: 'OK'
          content:
            application/pdf:
              schema:
                type: string
                format: binary

When downloading from a server, the response header could have an answer like so:

Content-Disposition: attachment; filename=downloaded.pdf; filename*=UTF-8''downloaded.pdf

There, the server says to use downloaded.pdf as filename. But the actual implementation of the swift5 client will exit after checking attachment and won't find filename= in the next section (separated by semicolon).

Solution:

Simply replacing break with continue in the matching logic inside the loop fixes the algorithm.

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.3.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.
    @jgavris, @ehyche, @Edubits, @jaz-ah, @4brunu

@4brunu
Copy link
Contributor

4brunu commented Jul 20, 2021

@gretzki Thanks for your contribution.
Could you please also fix this in the AlamofireImplementations?

for contentItem in items {
let filenameKey = "filename="
guard let range = contentItem.range(of: filenameKey) else {
break
}
filename = contentItem
return filename?
.replacingCharacters(in: range, with: "")
.replacingOccurrences(of: "\"", with: "")
.trimmingCharacters(in: .whitespacesAndNewlines)
}

And to generate the sample projects, please run and commit the changes.

./mvnw clean package 
./bin/generate-samples.sh bin/configs/swift5-*

Thanks

@gretzki
Copy link
Contributor Author

gretzki commented Jul 20, 2021

@4brunu sure. Done and done.
I realised it's also a bug for the swift4 client codegen but didn't fix it, since it's not relevant for the above mentioned client swift5. If you think it should be handled here too, I'm happy to fix that part too.

@4brunu
Copy link
Contributor

4brunu commented Jul 20, 2021

Swift4 client is now deprecated, so I'm not sure if it's worth the effort.
I think for now I prefer to focus on the Swift5 client, unless there is still demand for the Swift4 client.

@4brunu
Copy link
Contributor

4brunu commented Jul 20, 2021

CI is failing, but it's not related to this PR.
Looks good to me this PR 🙂

@wing328 wing328 added this to the 5.2.1 milestone Jul 21, 2021
@wing328 wing328 merged commit d23915a into OpenAPITools:master Jul 21, 2021
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

3 participants