Merge branch 'hotfix/2.3.1'

Author: Toflar

src/Psr6Store.php

@@ -47,7 +47,6 @@ class Psr6Store implements Psr6StoreInterface, ClearableInterface
 {
     const NON_VARYING_KEY = 'non-varying';
     const COUNTER_KEY = 'write-operations-counter';
-    const CACHE_DEBUG_HEADER = 'toflar-psr6cache-requested-uri';
     const CLEANUP_LOCK_KEY = 'cleanup-lock';
 
     /**
@@ -182,9 +181,6 @@ public function write(Request $request, Response $response)
             throw new \InvalidArgumentException('HttpCache should not forward any response without any cache expiration time to the store.');
         }
 
-        // Add a debug header
-        $response->headers->set(self::CACHE_DEBUG_HEADER, $request->getUri());
-
         // Save the content digest if required
         $this->saveContentDigest($response);
 
@@ -206,6 +202,7 @@ public function write(Request $request, Response $response)
             'vary' => $response->getVary(),
             'headers' => $headers,
             'status' => $response->getStatusCode(),
+            'uri' => $request->getUri(), // For debugging purposes
         ];
 
         // Add content if content digests are disabled
@@ -590,9 +587,6 @@ private function saveDeferred(CacheItemInterface $item, $data, $expiresAfter = n
      */
     private function restoreResponse(array $cacheData)
     {
-        // Unset internal debug info
-        unset($cacheData['headers'][self::CACHE_DEBUG_HEADER]);
-
         // Check for content digest header
         if (!isset($cacheData['headers']['x-content-digest'][0])) {
             // No digest was generated but the content was stored inline

tests/Psr6StoreTest.php

@@ -344,6 +344,19 @@ public function testHttpAndHttpsGenerateTheSameCacheKey()
         $this->assertSame($cacheKeyHttps, $cacheKeyHttp);
     }
 
+    public function testDebugInfoIsAdded()
+    {
+        $request = Request::create('https://foobar.com/');
+        $response = new Response('hello world', 200, ['Cache-Control' => 's-maxage=600, public']);
+
+        $this->store->write($request, $response);
+
+        $cacheKey = $this->store->getCacheKey($request);
+        $cacheItem = $this->getCache()->getItem($cacheKey);
+        $entries = $cacheItem->get();
+        $this->assertSame('https://foobar.com/', $entries[Psr6Store::NON_VARYING_KEY]['uri']);
+    }
+
     public function testRegularLookup()
     {
         $request = Request::create('https://foobar.com/');
@@ -352,15 +365,13 @@ public function testRegularLookup()
 
         $this->store->write($request, $response);
 
-        $this->assertSame('https://foobar.com/', $response->headers->get(Psr6Store::CACHE_DEBUG_HEADER));
-
         $result = $this->store->lookup($request);
 
         $this->assertInstanceOf(Response::class, $result);
         $this->assertSame(200, $result->getStatusCode());
         $this->assertSame('hello world', $result->getContent());
         $this->assertSame('whatever', $result->headers->get('Foobar'));
-        $this->assertNull($result->headers->get(Psr6Store::CACHE_DEBUG_HEADER));
+
         $this->assertSame('enb94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9', $result->headers->get('X-Content-Digest'));
     }
 
@@ -377,15 +388,12 @@ public function testRegularLookupWithContentDigestsDisabled()
 
         $store->write($request, $response);
 
-        $this->assertSame('https://foobar.com/', $response->headers->get(Psr6Store::CACHE_DEBUG_HEADER));
-
         $result = $store->lookup($request);
 
         $this->assertInstanceOf(Response::class, $result);
         $this->assertSame(200, $result->getStatusCode());
         $this->assertSame('hello world', $result->getContent());
         $this->assertSame('whatever', $result->headers->get('Foobar'));
-        $this->assertNull($result->headers->get(Psr6Store::CACHE_DEBUG_HEADER));
         $this->assertNull($result->headers->get('X-Content-Digest'));
     }
 
@@ -403,7 +411,6 @@ public function testRegularLookupWithBinaryResponse()
         $this->assertSame(200, $result->getStatusCode());
         $this->assertSame(__DIR__.'/Fixtures/favicon.ico', $result->getFile()->getPathname());
         $this->assertSame('whatever', $result->headers->get('Foobar'));
-        $this->assertNull($result->headers->get(Psr6Store::CACHE_DEBUG_HEADER));
         $this->assertSame('bfe8149cee23ba25e6b878864c1c8b3344ee1b3d5c6d468b2e4f7593be65bb1b68', $result->headers->get('X-Content-Digest'));
     }
 
@@ -426,7 +433,6 @@ public function testRegularLookupWithBinaryResponseWithContentDigestsDisabled()
         $this->assertSame(200, $result->getStatusCode());
         $this->assertSame(__DIR__.'/Fixtures/favicon.ico', $result->getFile()->getPathname());
         $this->assertSame('whatever', $result->headers->get('Foobar'));
-        $this->assertNull($result->headers->get(Psr6Store::CACHE_DEBUG_HEADER));
         $this->assertSame('bfe8149cee23ba25e6b878864c1c8b3344ee1b3d5c6d468b2e4f7593be65bb1b68', $result->headers->get('X-Content-Digest'));
     }