Add Formatter::formatResponseForRequest()

[ro0NL]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Related tickets	fixes #145
Documentation	-
License	MIT

During 1.x lifecycle:

deprecation.INFO: User Deprecated: Class "Http\HttplugBundle\Collector\Formatter" should implement method "Http\Message\Formatter::formatResponseForRequest(ResponseInterface $response, RequestInterface $request): string": Formats a response in context of its request.

Next major release should add the method for real.

[dbu]

looks good to me.

@Nyholm wdyt?

there is some code rot going on with php 8 and phpstan, but thats not related to the PR.

[Nyholm]

Im happy with this.

But this will only have a "real" effect in v2. Currently v2 is not planned.

Introducing a new interface would make more sense and would make this change "real" now. I see that it was discussed in #145

[ro0NL]

i will update at least logger plugin as such, using method_exsists trick till v2.

im still not convinced we need moar interfaces :')

[dbu]

But this will only have a "real" effect in v2. Currently v2 is not planned.

aparently this is the symfony way of "adding" methods to interfaces without breaking BC. the consumer would have to use method_exists as i understood

[ro0NL]

@method is phpdoc standard, yet symfony triggers the deprecation for implementors.

this is my personal preference though, as it's more easy to discover than a new contract IMHO.

for consumers methods_exists+@method vs instanceof+NewFormatter is irrelevant IMHO :)

which raises the question, what new contract would we add? AdvancedFormatter? Do we want it? (knowing there's a way to stick with just Formatter).

[dbu]

i agree with @ro0NL's reasoning. ok for you @Nyholm or do you have a strong feeling that that would be wrong?

[Nyholm]

I dont have any strong feelings.

I do like the "symfony way". But that only works well because Symfony always has a next major version planned.

Im happy with the PR in the current state if @ro0NL is happy. (Given the fact that it might never be a version 2 coming up)

[ro0NL]

[ro0NL]

Given the fact that it might never be a version 2 coming up

no worries, im playing chess on 2 boards ;) symfony/symfony#45358

[ro0NL]

about deprecating formatResponse(): #145 (comment)

i think it makes sense 👍 ideally there's 1 responsible method for response formatting. Let me know if should be part of this PR.

[dbu]

if we do the new method on the same interface, i would indeed deprecate the old formatResponse method. and best to this in the same MR.

[dbu]

thanks! i will see if we can get the build to green again, that would be good to see before tagging the release.

[dbu]

and released https://github.com/php-http/message/releases/tag/1.13.0