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

[Ruby] Fix Content-Transfer-Encoding binary unpacking #19132

Merged
merged 1 commit into from
Jul 11, 2024

Conversation

sirwolfgang
Copy link
Contributor

@sirwolfgang sirwolfgang commented Jul 10, 2024

Based on my findings attempting to download PDFs with a downstream gem, I discovered that binary transferred data is never being unpacked into it's native format. This renders the results malformed. mxenabled/mx-platform-ruby#90

This PR adds a patch that simplifies the flow control of the deserialize method, while updating it to properly deserialize content from binary transfer encoding.

I have a patch of this running downstream in production.

Ruby Committee: @cliffano @zlx @autopp

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
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.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.

@wing328
Copy link
Member

wing328 commented Jul 10, 2024

please update the samples (step 3) so that CI can verify the fix

@sirwolfgang
Copy link
Contributor Author

sirwolfgang commented Jul 10, 2024

@wing328 I've gone through this a few times, and nothing changes; but it could be because some of the threads crash out on the second command:

[pool-1-thread-6] Finished generating java…
[pool-1-thread-8] Generation failed for java-helidon-client: (NullPointerException) null
[pool-1-thread-9] Generation failed for java-helidon-server: (NullPointerException) null
[pool-1-thread-22] Generation failed for java-helidon-server: (NullPointerException) null
java.lang.NullPointerException
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen$VersionUtil.majorVersion(JavaHelidonCommonCodegen.java:427)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.setHelidonVersion(JavaHelidonCommonCodegen.java:242)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.processOpts(JavaHelidonCommonCodegen.java:164)
	at org.openapitools.codegen.languages.JavaHelidonServerCodegen.processOpts(JavaHelidonServerCodegen.java:131)
	at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:259)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1283)
	at org.openapitools.codegen.cmd.GenerateBatch$GenerationRunner.run(GenerateBatch.java:228)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	at java.base/java.lang.Thread.run(Thread.java:829)
[pool-1-thread-7] Generation failed for java-helidon-server: (NullPointerException) null
[pool-1-thread-1] Generation failed for java-helidon-client: (NullPointerException) null
java.lang.NullPointerException
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen$VersionUtil.majorVersion(JavaHelidonCommonCodegen.java:427)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.setHelidonVersion(JavaHelidonCommonCodegen.java:242)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.processOpts(JavaHelidonCommonCodegen.java:164)
	at org.openapitools.codegen.languages.JavaHelidonClientCodegen.processOpts(JavaHelidonClientCodegen.java:174)
	at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:259)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1283)
	at org.openapitools.codegen.cmd.GenerateBatch$GenerationRunner.run(GenerateBatch.java:228)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	at java.base/java.lang.Thread.run(Thread.java:829)
[pool-1-thread-13] Generation failed for java-helidon-client: (NullPointerException) null
java.lang.NullPointerException
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen$VersionUtil.majorVersion(JavaHelidonCommonCodegen.java:427)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.setHelidonVersion(JavaHelidonCommonCodegen.java:242)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.processOpts(JavaHelidonCommonCodegen.java:164)
	at org.openapitools.codegen.languages.JavaHelidonClientCodegen.processOpts(JavaHelidonClientCodegen.java:174)
	at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:259)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1283)
	at org.openapitools.codegen.cmd.GenerateBatch$GenerationRunner.run(GenerateBatch.java:228)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	at java.base/java.lang.Thread.run(Thread.java:829)
java.lang.NullPointerException
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen$VersionUtil.majorVersion(JavaHelidonCommonCodegen.java:427)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.setHelidonVersion(JavaHelidonCommonCodegen.java:242)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.processOpts(JavaHelidonCommonCodegen.java:164)
	at org.openapitools.codegen.languages.JavaHelidonServerCodegen.processOpts(JavaHelidonServerCodegen.java:131)
	at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:259)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1283)
	at org.openapitools.codegen.cmd.GenerateBatch$GenerationRunner.run(GenerateBatch.java:228)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	at java.base/java.lang.Thread.run(Thread.java:829)
java.lang.NullPointerException
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen$VersionUtil.majorVersion(JavaHelidonCommonCodegen.java:427)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.setHelidonVersion(JavaHelidonCommonCodegen.java:242)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.processOpts(JavaHelidonCommonCodegen.java:164)
	at org.openapitools.codegen.languages.JavaHelidonServerCodegen.processOpts(JavaHelidonServerCodegen.java:131)
	at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:259)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1283)
	at org.openapitools.codegen.cmd.GenerateBatch$GenerationRunner.run(GenerateBatch.java:228)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	at java.base/java.lang.Thread.run(Thread.java:829)
java.lang.NullPointerException
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen$VersionUtil.majorVersion(JavaHelidonCommonCodegen.java:427)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.setHelidonVersion(JavaHelidonCommonCodegen.java:242)
	at org.openapitools.codegen.languages.JavaHelidonCommonCodegen.processOpts(JavaHelidonCommonCodegen.java:164)
	at org.openapitools.codegen.languages.JavaHelidonClientCodegen.processOpts(JavaHelidonClientCodegen.java:174)
	at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:259)
	at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1283)
	at org.openapitools.codegen.cmd.GenerateBatch$GenerationRunner.run(GenerateBatch.java:228)
	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
	at java.base/java.lang.Thread.run(Thread.java:829)

@sirwolfgang
Copy link
Contributor Author

Oh, looks like I can run just the ruby ones.

@wing328
Copy link
Member

wing328 commented Jul 11, 2024

lgtm. let's give it a try

thanks for the fix

@wing328 wing328 merged commit 8938f9d into OpenAPITools:master Jul 11, 2024
18 checks passed
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