Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat(php-nextgen-client): add support for streaming #19192

Merged

Conversation

neilime
Copy link
Contributor

@neilime neilime commented Jul 17, 2024

php-nextgen client:

Add support for streaming file (https://spec.openapis.org/oas/latest.html#considerations-for-file-uploads)
Basically returning " Psr\Http\Message\StreamInterface" instead of "SplFileObject"

  • Adds a new option "supportStreaming" (false by default to do not add breaking change)

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.

  • @jebentier

  • @dkarlovi

  • @mandrean

  • @jfastnacht

  • @ybelenko

  • @renepardon

@neilime neilime force-pushed the feat/php-nextgen-client-streaming branch 2 times, most recently from 6e0186f to e4f61d1 Compare July 17, 2024 16:49
@neilime neilime marked this pull request as ready for review July 18, 2024 08:31
@neilime
Copy link
Contributor Author

neilime commented Jul 22, 2024

Hi,

@jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon

Are any of you available for a review?

Thanks

@neilime neilime force-pushed the feat/php-nextgen-client-streaming branch from e4f61d1 to 45d7a90 Compare July 22, 2024 14:34
@wing328
Copy link
Member

wing328 commented Jul 23, 2024

can you please review the test failures?

i could repeat the issue locally when testing the output

[INFO]
[INFO] Results:
[INFO]
[ERROR] Failures:
[ERROR] org.openapitools.codegen.php.PhpNextgenClientCodegenTest.testInitialConfigValues
[ERROR]   Run 1: PhpNextgenClientCodegenTest.testInitialConfigValues:31 expected [false] but found [null]
[ERROR]   Run 2: PhpNextgenClientCodegenTest.testInitialConfigValues:31 expected [false] but found [null]
[ERROR]   Run 3: PhpNextgenClientCodegenTest.testInitialConfigValues:31 expected [false] but found [null]
[INFO]
[ERROR] org.openapitools.codegen.php.PhpNextgenClientCodegenTest.testSettersForConfigValues
[ERROR]   Run 1: PhpNextgenClientCodegenTest.testSettersForConfigValues:41 expected [true] but found [null]
[ERROR]   Run 2: PhpNextgenClientCodegenTest.testSettersForConfigValues:41 expected [true] but found [null]
[ERROR]   Run 3: PhpNextgenClientCodegenTest.testSettersForConfigValues:41 expected [true] but found [null]
[INFO]
[INFO]
[ERROR] Tests run: 3096, Failures: 2, Errors: 0, Skipped: 0

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
@neilime neilime force-pushed the feat/php-nextgen-client-streaming branch from 45d7a90 to a4a53bb Compare July 23, 2024 16:16
@neilime neilime requested a review from wing328 July 23, 2024 16:34
@neilime
Copy link
Contributor Author

neilime commented Jul 23, 2024

@wing328 I've fixed you feedbacks, can you review it again please.

Thanks

@wing328
Copy link
Member

wing328 commented Jul 24, 2024

https://github.com/OpenAPITools/openapi-generator/actions/runs/10062528767/job/27842785278?pr=19192

please update the samples when you've time

…ming

Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>
@neilime neilime force-pushed the feat/php-nextgen-client-streaming branch from 2b73da0 to f71d439 Compare July 24, 2024 07:12
@neilime
Copy link
Contributor Author

neilime commented Jul 24, 2024

@wing328 it's done (I've updated the branch with master in the same time)

@wing328
Copy link
Member

wing328 commented Jul 31, 2024

looks good. let's give it a try.

thanks for the PR

@wing328 wing328 merged commit 7f551bb into OpenAPITools:master Jul 31, 2024
15 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants