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

[PHP-Client] Allow Content-Type merge-match+json for encoding #19479

Merged
merged 6 commits into from
Oct 3, 2024

Conversation

frickelbruder
Copy link
Contributor

Some APIs offer a PATCH-Request method for Entities and use "application/merge-patch+json" as Content-Type. This was not detected as json_encode and ObjectSerializer target and thus resultet in an Exception,

Nyholm\Psr7\Request::withBody(): Argument #1 ($body) must be of type Psr\Http\Message\StreamInterface, _XXX__ given, called in XXX

This PR fixes this.

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

@frickelbruder frickelbruder changed the title Allow Content-Type merge-match+json for encoding [PHP-Client] Allow Content-Type merge-match+json for encoding Aug 28, 2024
private function bodyShouldBeEncoded(string $contentType): bool
{
return preg_match('~^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)~', $contentType) === 1;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about adding this function in the api client class instead?

can we name this method as isJsonMime?

minor suggestion: add a docstring explaining what this function does

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure, what you mean by "what about adding this function in the api client class instead?"
As this is a method used throughout the code and if not working properly results in Exceptions being thrown, I think it is quite important.
What I could think of, is implementing a separate Class "JsonDetector" or anything with a single method, which could be injected via consturctor DI. Would this be a good solution or are you thinking of anything else?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for the confusion, api client class (ApiClient.php) is in client generated by php-dt generator but not php client generator.

shall we put the function in HeaderSelector class instead which has something similar already?

$headersWithJson = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you have something like this in mind?

@wing328
Copy link
Member

wing328 commented Oct 3, 2024

all tests passed locally:

[INFO]
[INFO] --- exec:1.2.1:exec (bundle-test) @ PhpPetstoreOAS3Tests ---
PHPUnit 9.6.19 by Sebastian Bergmann and contributors.

...............................................................  63 / 222 ( 28%)
............................................................... 126 / 222 ( 56%)
............................................................... 189 / 222 ( 85%)
.................................                               222 / 222 (100%)

Time: 00:01.709, Memory: 12.00 MB

OK (222 tests, 384 assertions)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  10.721 s
[INFO] Finished at: 2024-10-03T20:52:32+08:00
[INFO] ------------------------------------------------------------------------
[INFO] 3 goals, 3 executed

thanks again for the PR

@wing328 wing328 merged commit 2437d7f into OpenAPITools:master Oct 3, 2024
15 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