switch to TagAwareCacheInterface

symfony · Lctrs · Jan 21, 2025 · Jan 22, 2025 · Jan 22, 2025 · Jan 22, 2025
commit 7c66ffd82f2fc9dedd07fd4ebe629ed6a34bbec3
diff --git a/src/Symfony/Component/HttpClient/CachingHttpClient.php b/src/Symfony/Component/HttpClient/CachingHttpClient.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\HttpClient;
 
-use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
 use Symfony\Component\HttpClient\Caching\Freshness;
 use Symfony\Component\HttpClient\Chunk\ErrorChunk;
 use Symfony\Component\HttpClient\Exception\ChunkCacheItemNotFoundException;
@@ -23,6 +22,8 @@
 use Symfony\Component\HttpKernel\HttpCache\HttpCache;
 use Symfony\Component\HttpKernel\HttpCache\StoreInterface;
 use Symfony\Component\HttpKernel\HttpClientKernel;
+use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 use Symfony\Contracts\HttpClient\ChunkInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -81,7 +82,7 @@
      */
     private const MAX_HEURISTIC_FRESHNESS_TTL = 86400;
 
-    private TagAwareAdapterInterface|HttpCache $cache;
+    private TagAwareCacheInterface|HttpCache $cache;
     private array $defaultOptions = self::OPTIONS_DEFAULTS;
 
     /**
@@ -94,13 +95,13 @@
      */
     public function __construct(
         private HttpClientInterface $client,
-        TagAwareAdapterInterface|StoreInterface $cache,
+        TagAwareCacheInterface|StoreInterface $cache,
         array $defaultOptions = [],
         private readonly bool $sharedCache = true,
         private readonly ?int $maxTtl = null,
     ) {
         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__, TagAwareAdapterInterface::class);
+            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);
 
             if (!class_exists(HttpClientKernel::class)) {
                 throw new \LogicException(\sprintf('Using "%s" requires the HttpKernel component, try running "composer require symfony/http-kernel".', __CLASS__));
@@ -149,19 +150,17 @@
 
         $requestHash = self::hash($method.$fullUrl);
         $varyKey = "vary_{$requestHash}";
-        $varyItem = $this->cache->getItem($varyKey);
-        $varyFields = $varyItem->isHit() ? $varyItem->get() : [];
+        $varyFields = $this->cache->get($varyKey, static fn (): array => []);
 
         $metadataKey = self::getMetadataKey($requestHash, $options['normalized_headers'], $varyFields);
-        $metadataItem = $this->cache->getItem($metadataKey);
-        $cachedData = $metadataItem->isHit() ? $metadataItem->get() : null;
+        $cachedData = $this->cache->get($metadataKey, static fn (): null => null);
-        $cachedData = $this->cache->get($metadataKey, static fn (): null => null);
+        $cachedData = $this->cache->get($metadataKey, fn ($item, &$save) => $save = false;)
-        $cachedData = $this->cache->get($metadataKey, static fn (): null => null);
+        $cachedData = $this->cache->get($metadataKey, fn ($item, &$save) => $save = false;)
 
         $freshness = null;
         if (\is_array($cachedData)) {
            $freshness = $this->evaluateCacheFreshness($cachedData);

            if (Freshness::Fresh === $freshness) {
                return $this->createResponseFromCache($metadataKey, $cachedData, $method, $url, $options, $fullUrlTag);
            }

            if (isset($cachedData['headers']['etag'])) {
@@ -185,9 +184,8 @@
                 $expiresAt,
                 $fullUrlTag,
                 $requestHash,
-                $varyItem,
+                $varyKey,
                 &$metadataKey,
-                $metadataItem,
                 $cachedData,
                 $freshness,
                 $url,
@@ -202,7 +200,7 @@
                        // avoid throwing exception in ErrorChunk#__destruct()
                        $chunk instanceof ErrorChunk && $chunk->didThrow(true);
                        $context->passthru();
                        $context->replaceResponse($this->createResponseFromCache($metadataKey, $cachedData, $method, $url, $options, $fullUrlTag));

                        return;
                    }
@@ -230,16 +228,19 @@
                     if (304 === $statusCode && null !== $freshness) {
                         $maxAge = $this->determineMaxAge($headers, $cacheControl);
 
-                        $cachedData['expires_at'] = self::calculateExpiresAt($maxAge);
-                        $cachedData['stored_at'] = time();
-                        $cachedData['initial_age'] = (int) ($headers['age'][0] ?? 0);
-                        $cachedData['headers'] = array_merge($cachedData['headers'], array_diff_key($headers, self::EXCLUDED_HEADERS));
+                        $this->cache->get($metadataKey, static function (ItemInterface $item) use ($headers, $maxAge, $cachedData, $expiresAt, $fullUrlTag): array {
+                            $item->expiresAt($expiresAt)->tag($fullUrlTag);
 
-                        $metadataItem->set($cachedData)->expiresAt($expiresAt);
-                        $this->cache->save($metadataItem);
+                            $cachedData['expires_at'] = self::calculateExpiresAt($maxAge);
+                            $cachedData['stored_at'] = time();
+                            $cachedData['initial_age'] = (int) ($headers['age'][0] ?? 0);
+                            $cachedData['headers'] = array_merge($cachedData['headers'], array_diff_key($headers, self::EXCLUDED_HEADERS));
+
+                            return $cachedData;
+                        }, \INF);
 
                         $context->passthru();
                         $context->replaceResponse($this->createResponseFromCache($metadataKey, $cachedData, $method, $url, $options, $fullUrlTag));

                        return;
                    }
@@ -247,7 +248,7 @@
                    if ($statusCode >= 500 && $statusCode < 600) {
                        if (Freshness::StaleButUsable === $freshness) {
                            $context->passthru();
                            $context->replaceResponse($this->createResponseFromCache($metadataKey, $cachedData, $method, $url, $options, $fullUrlTag));

                            return;
                        }
@@ -292,25 +293,26 @@
                 }
 
                 if ($chunk->isLast()) {
-                    $this->cache->saveDeferred($varyItem->set($varyFields)->tag($fullUrlTag)->expiresAt($expiresAt));
+                    $this->cache->get($varyKey, static function (ItemInterface $item) use ($varyFields, $expiresAt, $fullUrlTag): array {
+                        $item->tag($fullUrlTag)->expiresAt($expiresAt);
+
+                        return $varyFields;
+                    }, \INF);
 
                     $maxAge = $this->determineMaxAge($headers, $cacheControl);
 
-                    $this->cache->saveDeferred(
-                        $this->cache->getItem($metadataKey)
-                            ->tag($fullUrlTag)
-                            ->set([
-                                'status_code' => $context->getStatusCode(),
-                                'headers' => array_diff_key($headers, self::EXCLUDED_HEADERS),
-                                'initial_age' => (int) ($headers['age'][0] ?? 0),
-                                'stored_at' => time(),
-                                'expires_at' => self::calculateExpiresAt($maxAge),
-                                'chunks_count' => $chunkIndex,
-                            ])
-                            ->expiresAt($expiresAt)
-                    );
-
-                    $this->cache->commit();
+                    $this->cache->get($metadataKey, static function (ItemInterface $item) use ($context, $headers, $maxAge, $expiresAt, $fullUrlTag, $chunkIndex): array {
+                        $item->tag($fullUrlTag)->expiresAt($expiresAt);
+
+                        return [
+                            'status_code' => $context->getStatusCode(),
+                            'headers' => array_diff_key($headers, self::EXCLUDED_HEADERS),
+                            'initial_age' => (int) ($headers['age'][0] ?? 0),
+                            'stored_at' => time(),
+                            'expires_at' => self::calculateExpiresAt($maxAge),
+                            'chunks_count' => $chunkIndex,
+                        ];
+                    }, \INF);
 
                     yield $chunk;
 
@@ -319,12 +321,11 @@
 
                 ++$chunkIndex;
                 $chunkKey = "{$metadataKey}_chunk_{$chunkIndex}";
-                $chunkItem = $this->cache->getItem($chunkKey)
-                    ->tag($fullUrlTag)
-                    ->set($chunk->getContent())
-                    ->expiresAt($expiresAt);
+                $this->cache->get($chunkKey, static function (ItemInterface $item) use ($expiresAt, $fullUrlTag, $chunk): string {
+                    $item->tag($fullUrlTag)->expiresAt($expiresAt);
 
-                $this->cache->save($chunkItem);
+                    return $chunk->getContent();
+                }, \INF);
 
                 yield $chunk;
             }
@@ -684,15 +685,11 @@
             new MockResponse(
                 (function () use ($key, $cachedData, $fullUrlTag): \Generator {
                     for ($i = 0; $i <= $cachedData['chunks_count']; ++$i) {
-                        $chunkItem = $this->cache->getItem("{$key}_chunk_{$i}");
-
-                        if (!$chunkItem->isHit()) {
+                        yield $this->cache->get("{$key}_chunk_{$i}", function (ItemInterface $item) use ($fullUrlTag): never {
                             $this->cache->invalidateTags([$fullUrlTag]);
 
-                            throw new ChunkCacheItemNotFoundException(\sprintf('Missing cache item for chunk with key "%s". This indicates an internal cache inconsistency.', $chunkItem->getKey()));
-                        }
-
-                        yield $chunkItem->get();
+                            throw new ChunkCacheItemNotFoundException(\sprintf('Missing cache item for chunk with key "%s". This indicates an internal cache inconsistency.', $item->getKey()));
+                        }, 0);
                     }
                 })(),
                 ['http_code' => $cachedData['status_code'], 'response_headers' => ['age' => $cachedData['initial_age'] + (time() - $cachedData['stored_at'])] + $cachedData['headers']]

diff --git a/src/Symfony/Component/HttpClient/Tests/LegacyCachingHttpClientTest.php b/src/Symfony/Component/HttpClient/Tests/LegacyCachingHttpClientTest.php
@@ -28,7 +28,7 @@ class LegacyCachingHttpClientTest extends TestCase
 
     public function testRequestHeaders()
     {
-        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Component\Cache\Adapter\TagAwareAdapterInterface" expected.');
+        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Contracts\Cache\TagAwareCacheInterface" expected.');
 
         $options = [
             'headers' => [
@@ -51,7 +51,7 @@ public function testRequestHeaders()
 
     public function testDoesNotEvaluateResponseBody()
     {
-        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Component\Cache\Adapter\TagAwareAdapterInterface" expected.');
+        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Contracts\Cache\TagAwareCacheInterface" expected.');
 
         $body = file_get_contents(__DIR__.'/Fixtures/assertion_failure.php');
         $response = $this->runRequest(new MockResponse($body, ['response_headers' => ['X-Body-Eval' => true]]));
@@ -63,7 +63,7 @@ public function testDoesNotEvaluateResponseBody()
 
     public function testDoesNotIncludeFile()
     {
-        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Component\Cache\Adapter\TagAwareAdapterInterface" expected.');
+        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Contracts\Cache\TagAwareCacheInterface" expected.');
 
         $file = __DIR__.'/Fixtures/assertion_failure.php';
 
@@ -82,7 +82,7 @@ public function testDoesNotIncludeFile()
 
     public function testDoesNotReadFile()
     {
-        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Component\Cache\Adapter\TagAwareAdapterInterface" expected.');
+        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Contracts\Cache\TagAwareCacheInterface" expected.');
 
         $file = __DIR__.'/Fixtures/assertion_failure.php';
 
@@ -99,7 +99,7 @@ public function testDoesNotReadFile()
 
     public function testRemovesXContentDigest()
     {
-        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Component\Cache\Adapter\TagAwareAdapterInterface" expected.');
+        $this->expectDeprecation('Since symfony/http-client 7.3: Passing a "Symfony\Component\HttpKernel\HttpCache\StoreInterface" as constructor\'s 2nd argument of "Symfony\Component\HttpClient\CachingHttpClient" is deprecated, "Symfony\Contracts\Cache\TagAwareCacheInterface" expected.');
 
         $response = $this->runRequest(new MockResponse(
             'test', [