[HttpClient] Add a Record & Replay callback to the MockHttpClient.

[GaryPEGEOT]

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	partially #30502
License	MIT
Doc PR	TODO

Allow to record & replay responses for test / dev purpose:

<?php

/* @var Psr\Cache\CacheItemPoolInterface $cache */
$cache = new ArrayAdapter();
$callback = new RecordReplayCallback(RecordReplayCallback::MODE_REPLAY_OR_RECORD, $cache)

$mockClient = new MockHttpClient($callback);

// Will make an actual HTTP request
$client->request('POST', 'https://example.org/whatever');

// Will replay the previous response
$client->request('POST', 'https://example.org/whatever');

TODO:

• Create the PR for the documentation
• Integrate with Framework bundle for easy config

[fabpot]

@GaryPEGEOT Do you have time to finish this PR?

[GaryPEGEOT]

Hi @fabpot! I would need some feedback on the callback before creating the Framework integration. PR #35893 gives the ability to integrate the callback easily.

[nicolas-grekas]

What about making this way simpler, by just recording + replaying the req/resp in order?

Right now, the hashing logic makes me think of this as a special cache layer, not a record-replay tape.

I feel like we might prefer implementing a real HTTP cache and make it able to force-store+serve requests, and have this one specialized on in-order serving.

WDYT?

[nicolas-grekas]

Shouldn't we make the mode optional, defaulting to MODE_REPLAY_OR_RECORD?
That would ease integration with tests I believe: one wants to re-record? => bin/console cache:pool:clear some_pool_for_some_reqs then run the tests again.
WDYT?

[nicolas-grekas]

better not use md5 for this.
we could use hash_init() instead of the $parts array

[nicolas-grekas]

For inspiration btw: https://github.com/ikwattro/guzzle-stereo/

[fabpot]

#35893 has been merged now.

[nicolas-grekas]

Thanks this moves forward nicely.
One thing that doesn't work right now is async: the way this is currently implemented break async and streaming when recording.
It should be possible to record without breaking async by leveraging AsyncDecorator.
Up to continue this way?

[nicolas-grekas]

we should clean up the temporary files created when running the tests

[nicolas-grekas]

please remove all : void from all test cases

[nicolas-grekas]

let's remove all @var that duplicate the constructor, they're useless

[nicolas-grekas]

Closing as we discussed on Slack: we should try another approach based on AsyncDecoratorTrait, that would share some logic/classes between this use case and the "client-side http-cache" use case.

[rrajkomar]

@nicolas-grekas Has there been any progress or new leads on this feature ?
It would be awesome if we could get a working record/replay system for the HttpClient as currently there does not seem to be any viable alternative (aside from configuring a custom callback which would have to be duplicated accross projets, not ideal).
Thanks.