Skip to content

ApiClient: support deserializing from InputStream instead of String to bypass 2GB Java String limit #4021

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

Conversation

klin1344
Copy link

Fixes issue #4020 .

Makes two changes:

  1. In ApiClient, if we are deserializing JSON, get the response body as an InputStream instead of String for deserialization.
  2. Adds a new deserialize() method in JSON.java which accepts InputStream.

These two changes enable the ApiClient to bypass the 2GB String length limit in Java and deserialize large responses greater than 2GB into Java objects.

Copy link

linux-foundation-easycla bot commented Apr 21, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: klin1344 / name: Kevin Lin (e7e0548)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: klin1344
Once this PR has been reviewed and has the lgtm label, please assign brendandburns for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 21, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @klin1344!

It looks like this is your first PR to kubernetes-client/java 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/java has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 21, 2025
@brendandburns
Copy link
Contributor

brendandburns commented Apr 21, 2025

Thanks for the PR. This code is generated. You need to make the changes here:

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

And then we will get the update next time that we regenerate the code.

@klin1344
Copy link
Author

Fixes issue #4020 .

Makes two changes:

  1. In ApiClient, if we are deserializing JSON, get the response body as an InputStream instead of String for deserialization.
  2. Adds a new deserialize() method in JSON.java which accepts InputStream.

These two changes enable the ApiClient to bypass the 2GB String length limit in Java and deserialize large responses greater than 2GB into Java objects.

Ah I see, thank you! Opened this PR for the openapi-generator repo and will close this one.

@klin1344 klin1344 closed this Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants