[HttpClient] Make `CachingHttpClient` compatible with RFC 9111 #59576

Lctrs · 2025-01-21T23:53:32Z

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	yes
Issues	Fix #36858 Fix #49937 Fix #41843 Fix #61588
License	MIT

https://www.rfc-editor.org/rfc/rfc9111.html

src/Symfony/Component/HttpClient/Rfc9111HttpClient.php

stof · 2025-01-22T13:26:45Z

Can we bring this to CachingHttpClient (with a BC layer) instead of introducing a new class that is the good implementation of caching but with a name that is much less clear ?
Also, having the RFC id in the class name is a bad idea to me, as it would be a pain if a new RFC gets released to replace the current one (which happened multiple times for RFCs related to HTTP)

src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd

src/Symfony/Component/HttpClient/Rfc9111HttpClient.php

src/Symfony/Component/HttpClient/Tests/LegacyCachingHttpClientTest.php

Lctrs · 2025-02-19T11:35:49Z

UPDATE:

CI failure on PHP 8.5 is unrelated
Psalm failure seems to be a false positive to me
Tests pass locally on low deps, but not on github actions. I need to look at it.
I don't know how to please fabbot. Should I not make any change to the upgrade file ?

Otherwise, PR is ready on my side. Ready for another reviews.

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

src/Symfony/Component/HttpClient/CHANGELOG.md

src/Symfony/Component/HttpClient/CachingHttpClient.php

UPGRADE-7.3.md

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

src/Symfony/Component/HttpClient/CHANGELOG.md

src/Symfony/Component/HttpClient/CachingHttpClient.php

Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

stof

Looks good to me, but I'd like a review from @nicolas-grekas as he is the one knowing symfony/http-client best.

nicolas-grekas

I didn't get into all details but still LGTM thanks!

nicolas-grekas · 2025-09-05T12:13:27Z

src/Symfony/Component/HttpClient/CachingHttpClient.php

-            throw new \LogicException(\sprintf('Using "%s" requires the HttpKernel component, try running "composer require symfony/http-kernel".', __CLASS__));
-        }
+        if ($cache instanceof StoreInterface) {
+            trigger_deprecation('symfony/http-client', '7.3', 'Passing a "%s" as constructor\'s 2nd argument of "%s" is deprecated, "%s" expected.', StoreInterface::class, __CLASS__, TagAwareCacheInterface::class);


Suggested change

trigger_deprecation('symfony/http-client', '7.3', 'Passing a "%s" as constructor\'s 2nd argument of "%s" is deprecated, "%s" expected.', StoreInterface::class, __CLASS__, TagAwareCacheInterface::class);

trigger_deprecation('symfony/http-client', '7.4', 'Passing a "%s" as constructor\'s 2nd argument of "%s" is deprecated, "%s" expected.', StoreInterface::class, __CLASS__, TagAwareCacheInterface::class);

nicolas-grekas · 2025-09-05T12:13:41Z

src/Symfony/Component/HttpClient/CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---

 * Deprecate using amphp/http-client < 5
+ * Add RFC 9111–based caching support to `CachingHttpClient`


let's mention the deprecation also

* Deprecate passing an instance of `StoreInterface` as `$cache` argument to `CachingHttpClient` constructor

nicolas-grekas · 2025-09-05T12:20:04Z

src/Symfony/Component/HttpClient/CachingHttpClient.php

+            return new AsyncResponse($this->client, $method, $url, $options);
+        }
+
+        $requestHash = self::hash($method.$fullUrl.json_encode(array_intersect_key($options['normalized_headers'], self::RESPONSE_INFLUENCING_HEADERS), \JSON_THROW_ON_ERROR));


serialize instead of json_encode to work with non-utf8 chars?

nicolas-grekas · 2025-09-05T12:27:47Z

Can you please maybe expand in the PR description? Think about a blog post we could derive from it :)

Lctrs · 2025-09-05T12:43:34Z

I'm currently on holiday. I'll get back to it next week. Including my thoughts on possible race conditions discussed earlier.

Can you please maybe expand in the PR description? Think about a blog post we could derive from it :)

May you be more specific ? You want me to explain the code ?

nicolas-grekas · 2025-09-05T12:45:23Z

What we could put in the doc about it yes (thus not internal details of course)

This comment has been minimized.

Sign in to view

Lctrs marked this pull request as ready for review January 21, 2025 23:54

carsonbot added Status: Needs Review Feature HttpClient labels Jan 21, 2025

carsonbot added this to the 7.3 milestone Jan 21, 2025

OskarStark reviewed Jan 22, 2025

View reviewed changes

src/Symfony/Component/HttpClient/Rfc9111HttpClient.php Outdated Show resolved Hide resolved

OskarStark reviewed Jan 22, 2025

View reviewed changes

src/Symfony/Component/HttpClient/Rfc9111HttpClient.php Outdated Show resolved Hide resolved

OskarStark reviewed Jan 22, 2025

View reviewed changes

src/Symfony/Component/HttpClient/Rfc9111HttpClient.php Outdated Show resolved Hide resolved

OskarStark reviewed Jan 22, 2025

View reviewed changes

src/Symfony/Component/HttpClient/Rfc9111HttpClient.php Outdated Show resolved Hide resolved

stof reviewed Jan 22, 2025

View reviewed changes

alexandre-daubois reviewed Feb 7, 2025

View reviewed changes

src/Symfony/Component/HttpClient/Tests/LegacyCachingHttpClientTest.php Outdated Show resolved Hide resolved

Lctrs force-pushed the rfc9111-http-client branch from 62db76a to 5b52dd2 Compare February 18, 2025 20:59

Lctrs changed the title ~~[HttpClient] Add an RFC 9111 compliant client~~ [HttpClient] Make CachingHttpClientCompatible with RFC 9111 Feb 18, 2025

Lctrs changed the title ~~[HttpClient] Make CachingHttpClientCompatible with RFC 9111~~ [HttpClient] Make CachingHttpClient compatible with RFC 9111 Feb 18, 2025

Lctrs requested review from alexandre-daubois, OskarStark and stof February 19, 2025 11:37

stof reviewed Feb 19, 2025

View reviewed changes

Lctrs force-pushed the rfc9111-http-client branch 2 times, most recently from b7a0bb4 to 12bf66f Compare February 20, 2025 16:16

Lctrs requested a review from stof February 21, 2025 08:45

Lctrs force-pushed the rfc9111-http-client branch from e93f3b2 to d0be468 Compare February 22, 2025 23:19

OskarStark changed the title ~~[HttpClient] Make CachingHttpClient compatible with RFC 9111~~ [HttpClient] Make CachingHttpClient compatible with RFC 9111 Feb 24, 2025

Lctrs force-pushed the rfc9111-http-client branch 3 times, most recently from b9df14d to 0405dc5 Compare February 28, 2025 10:51

alexandre-daubois reviewed Feb 28, 2025

View reviewed changes

Lctrs and others added 18 commits August 27, 2025 23:48

evaluateCachedFreshness -> evaluateCacheFreshness

a6420e8

remove dev deps on symfony/filesystem

51336d4

add more tests

9127d42

vary asterisk prevents caching

77948df

exclude non cacheable headers from cache

dc41840

remove wrongly cacheable status codes

726ae8c

implement heuristic caching

a837bb6

Update src/Symfony/Component/HttpClient/CachingHttpClient.php

ec7bc12

Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

Update src/Symfony/Component/HttpClient/CachingHttpClient.php

fc7daa9

Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

Update src/Symfony/Component/HttpClient/CachingHttpClient.php

220302c

Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

Update src/Symfony/Component/HttpClient/CachingHttpClient.php

cb7294d

Co-authored-by: Nicolas Grekas <nicolas.grekas@gmail.com>

switch to a sha256 based hash

cdf3662

turn some vars by ref to static ones

d53fbc3

cs

f335d96

more static methods

d52a271

switch to TagAwareCacheInterface

acb6135

support for range and content nego headers

9ccf332

rebase to branch 7.4

17d0fdc

Lctrs force-pushed the rfc9111-http-client branch from 7c66ffd to 17d0fdc Compare August 27, 2025 23:38

Lctrs added 3 commits August 28, 2025 01:50

add back no cache support through options

08826f9

migrate to phpunit's attributes

190743c

migrate legacy tests

0668a9f

GromNaN mentioned this pull request Sep 2, 2025

[HttpClient] Allow use Redis storage on CachingHttpClient #61588

Open

stof approved these changes Sep 5, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 5, 2025

nicolas-grekas approved these changes Sep 5, 2025

View reviewed changes

	trigger_deprecation('symfony/http-client', '7.3', 'Passing a "%s" as constructor\'s 2nd argument of "%s" is deprecated, "%s" expected.', StoreInterface::class, __CLASS__, TagAwareCacheInterface::class);
	trigger_deprecation('symfony/http-client', '7.4', 'Passing a "%s" as constructor\'s 2nd argument of "%s" is deprecated, "%s" expected.', StoreInterface::class, __CLASS__, TagAwareCacheInterface::class);

Uh oh!

[HttpClient] Make CachingHttpClient compatible with RFC 9111 #59576

Are you sure you want to change the base?

[HttpClient] Make CachingHttpClient compatible with RFC 9111 #59576

Conversation

Lctrs commented Jan 21, 2025 • edited by GromNaN Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stof commented Jan 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lctrs commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stof left a comment

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Sep 5, 2025

Uh oh!

Lctrs commented Sep 5, 2025

Uh oh!

nicolas-grekas commented Sep 5, 2025

Uh oh!

Uh oh!

[HttpClient] Make `CachingHttpClient` compatible with RFC 9111 #59576

[HttpClient] Make `CachingHttpClient` compatible with RFC 9111 #59576

Lctrs commented Jan 21, 2025 •

edited by GromNaN

Loading

Lctrs commented Feb 19, 2025 •

edited

Loading