Added support for BinaryFileResponse instances

Author: Toflar

README.md

@@ -26,6 +26,7 @@ of expired entries on the filesystem trying to prevent flooding the filesystem.
 * …allows you to use a different PSR-6 cache adapters as well as a different 
 lock adapter than the local filesystem ones.
  However, **be careful about choosing the right adapters**, see warning below.
+* …supports `BinaryFileResponse` instances.
 
 ## Installation
 
@@ -111,6 +112,14 @@ passing an array of `$options` in the constructor:
 
   **Type**: `string`
   **Default**: `Cache-Tags`
+  
+### Caching `BinaryFileResponse` instances
+
+This cache implementation allows to cache `BinaryFileResponse` instances but the files are not actually copied to
+the cache directory. It will just try to fetch the original file and if that does not exist anymore, the store returns
+`null`, causing HttpCache to deal with it as a cache miss and continue normally.
+It is ideal for use cases such as caching `/favicon.ico` requests where you would like to prevent the application from
+being started and thus deliver the response from HttpCache.
 
 ### Cache tagging
 

src/Psr6Store.php

@@ -18,6 +18,9 @@
 use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+use Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException;
+use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Lock\Exception\LockReleasingException;
@@ -203,7 +206,11 @@ public function write(Request $request, Response $response)
         if (!$response->headers->has('X-Content-Digest')) {
             $contentDigest = $this->generateContentDigest($response);
 
-            if (false === $this->saveDeferred($contentDigest, $response->getContent())) {
+            $cacheValue = $this->isBinaryFileResponseContentDigest($contentDigest) ?
+                $response->getFile()->getPathname() :
+                $response->getContent();
+
+            if (false === $this->saveDeferred($contentDigest, $cacheValue)) {
                 throw new \RuntimeException('Unable to store the entity.');
             }
 
@@ -462,9 +469,25 @@ public function getVaryKey(array $vary, Request $request)
      */
     public function generateContentDigest(Response $response)
     {
+        if ($response instanceof BinaryFileResponse) {
+            return 'bf'.hash_file('sha256', $response->getFile()->getPathname());
+        }
+
         return 'en'.hash('sha256', $response->getContent());
     }
 
+    /**
+     * Test whether a given digest identifies a BinaryFileResponse.
+     *
+     * @param string $digest
+     *
+     * @return bool
+     */
+    private function isBinaryFileResponseContentDigest($digest)
+    {
+        return 'bf' === substr($digest, 0, 2);
+    }
+
     /**
      * Increases a counter every time an item is stored to the cache and then
      * prunes expired cache entries if a configurable threshold is reached.
@@ -522,20 +545,34 @@ private function saveDeferred($key, $data, $expiresAfter = null, $tags = [])
      */
     private function restoreResponse(array $cacheData)
     {
-        $body = null;
-
         if (isset($cacheData['headers']['x-content-digest'][0])) {
             $item = $this->cache->getItem($cacheData['headers']['x-content-digest'][0]);
             if ($item->isHit()) {
-                $body = $item->get();
+                $value = $item->get();
+
+                if ($this->isBinaryFileResponseContentDigest($cacheData['headers']['x-content-digest'][0])) {
+                    try {
+                        $file = new File($value);
+                    } catch (FileNotFoundException $e) {
+                        return null;
+                    }
+
+                    return new BinaryFileResponse(
+                        $file,
+                        $cacheData['status'],
+                        $cacheData['headers']
+                    );
+                }
+
+                return new Response(
+                        $value,
+                        $cacheData['status'],
+                        $cacheData['headers']
+                    );
             }
         }
 
-        return new Response(
-            $body,
-            $cacheData['status'],
-            $cacheData['headers']
-        );
+        return null;
     }
 
     /**

tests/Fixtures/favicon.ico

@@ -18,7 +18,9 @@
 use Symfony\Component\Cache\Adapter\RedisAdapter;
 use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\Cookie;
+use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Lock\Exception\LockReleasingException;
@@ -347,6 +349,41 @@ public function testRegularLookup()
         $this->assertSame('whatever', $result->headers->get('Foobar'));
     }
 
+    public function testRegularLookupWithBinaryResponse()
+    {
+        $request = Request::create('https://foobar.com/');
+        $response = new BinaryFileResponse(__DIR__.'/Fixtures/favicon.ico');
+        $response->headers->set('Foobar', 'whatever');
+
+        $this->store->write($request, $response);
+
+        $result = $this->store->lookup($request);
+
+        $this->assertInstanceOf(BinaryFileResponse::class, $result);
+        $this->assertSame(200, $result->getStatusCode());
+        $this->assertSame(__DIR__.'/Fixtures/favicon.ico', $result->getFile()->getPathname());
+        $this->assertSame('whatever', $result->headers->get('Foobar'));
+    }
+
+    public function testRegularLookupWithRemovedBinaryResponse()
+    {
+        $request = Request::create('https://foobar.com/');
+        $file = new File(__DIR__.'/Fixtures/favicon.ico');
+        $response = new BinaryFileResponse($file);
+        $response->headers->set('Foobar', 'whatever');
+
+        $this->store->write($request, $response);
+
+        // Now move (same as remove) the file somewhere else
+        $movedFile = $file->move(__DIR__.'/Fixtures', 'favicon_bu.ico');
+
+        $result = $this->store->lookup($request);
+        $this->assertNull($result);
+
+        // Move back for other tests
+        $movedFile->move(__DIR__.'/Fixtures', 'favicon.ico');
+    }
+
     public function testLookupWithVaryOnCookies()
     {
         // Cookies match