[ruby] Make File Downloads Threadsafe

[dawson-conway]

#16796

This makes the ApiClient threadsafe in ruby. I definitely need help testing this and following the process.

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/configs/*.yaml
  ./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 (upcoming 7.1.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.

[dawson-conway]

@cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)

[wing328]

please update the samples so that the CI can verify the change:

https://github.com/OpenAPITools/openapi-generator/actions/runs/6577707103/job/17937746453?pr=16876

let me know if you need any help.

[wing328]

the change looks good.

about testing the file download, can you please PM me via Slack when you've time?

[wing328]

circleci failure not related to this change

[lumpidu]

Since this MR, file downloading doesn't work anymore without patching the generated api_client.rb. I have tested this for Faraday, but also I couldn't download with Typheus.

The problem is an exception because of missing parameters, e.g.:

...
      if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
        data = deserialize_file(stream)
      elsif opts[:return_type]
...

Which should be

...
      if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
        data = deserialize_file(response, stream)
      elsif opts[:return_type]
...

and

def call_api(http_method, path, opts = {})
      stream = nil
      begin
        response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
          build_request(http_method, path, req, opts)
          stream = download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
        end
...

Where the call to build_request() misses an assignment to a local request variable that is then used in the download_file() method.

Obviously, file downloading hasn't been tested at all.

[wing328]

can you please file a PR with the suggested fix?

we can add a test in the echo API client to ensure the file download works as expected.

PM me via Slack if you need the details.

[wing328]

FYI https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/echo_api/python/test/test_manual.py#L110 is how we test it in the Python Echo API client.

We need to add a similar test for the Ruby client.

[lumpidu]

FYI https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/echo_api/python/test/test_manual.py#L110 is how we test it in the Python Echo API client.

We need to add a similar test for the Ruby client.

Well, in fact we would need to add 3 such tests for each of the supported clients (Faraday, Typhoeus, httpx). There is a httpx client, but it misses the manual tests you mentioned.