Cache bypass header now also prevents an already cached response from…

… being returned (#407)

* Test that we won't return a cached response if request asks for bypass, even if cache already exists

* Refactor bypass header implementation

src/CacheProfiles/BaseCacheProfile.php

@@ -36,18 +36,4 @@ public function isRunningInConsole(): bool
 
         return app()->runningInConsole();
     }
-
-    public function requestHasCacheBypassHeader(Request $request): bool
-    {
-        // Ensure we return if cache_bypass_header is not setup
-        if (! config('responsecache.cache_bypass_header.name')) {
-            return false;
-        }
-        // Ensure we return if cache_bypass_header is not setup
-        if (! config('responsecache.cache_bypass_header.value')) {
-            return false;
-        }
-
-        return $request->header(config('responsecache.cache_bypass_header.name')) === config('responsecache.cache_bypass_header.value');
-    }
 }

src/CacheProfiles/CacheAllSuccessfulGetRequests.php

@@ -18,10 +18,6 @@ public function shouldCacheRequest(Request $request): bool
             return false;
         }
 
-        if ($this->requestHasCacheBypassHeader($request)) {
-            return false;
-        }
-
         return $request->isMethod('get');
     }
 

src/Middlewares/CacheResponse.php

@@ -26,7 +26,7 @@ public function handle(Request $request, Closure $next, ...$args): Response
         $lifetimeInSeconds = $this->getLifetime($args);
         $tags = $this->getTags($args);
 
-        if ($this->responseCache->enabled($request)) {
+        if ($this->responseCache->enabled($request) && ! $this->responseCache->shouldBypass($request)) {
             if ($this->responseCache->hasBeenCached($request, $tags)) {
                 event(new ResponseCacheHit($request));
 
@@ -44,7 +44,7 @@ public function handle(Request $request, Closure $next, ...$args): Response
 
         $response = $next($request);
 
-        if ($this->responseCache->enabled($request)) {
+        if ($this->responseCache->enabled($request) && ! $this->responseCache->shouldBypass($request)) {
             if ($this->responseCache->shouldCache($request, $response)) {
                 $this->makeReplacementsAndCacheResponse($request, $response, $lifetimeInSeconds, $tags);
             }

src/ResponseCache.php

@@ -37,6 +37,20 @@ public function shouldCache(Request $request, Response $response): bool
         return $this->cacheProfile->shouldCacheResponse($response);
     }
 
+    public function shouldBypass(Request $request): bool
+    {
+        // Ensure we return if cache_bypass_header is not setup
+        if (! config('responsecache.cache_bypass_header.name')) {
+            return false;
+        }
+        // Ensure we return if cache_bypass_header is not setup
+        if (! config('responsecache.cache_bypass_header.value')) {
+            return false;
+        }
+
+        return $request->header(config('responsecache.cache_bypass_header.name')) === (string) config('responsecache.cache_bypass_header.value');
+    }
+
     public function cacheResponse(
         Request $request,
         Response $response,

tests/IntegrationTest.php

@@ -277,15 +277,17 @@ public function it_can_add_a_cache_age_header()
     }
 
     /** @test */
-    public function it_wont_serve_cached_response_if_request_has_bypass_header()
+    public function it_wont_cache_nor_serve_a_cached_response_if_request_has_bypass_header()
     {
         $headerName = 'X-Cache-Bypass';
         $headerValue = rand(1, 99999);
         $this->app['config']->set('responsecache.cache_bypass_header.name', $headerName);
         $this->app['config']->set('responsecache.cache_bypass_header.value', $headerValue);
 
-        $response = $this->get('/', ['X-Cache-Bypass' => $headerValue]);
+        $firstResponse = $this->get('/', ['X-Cache-Bypass' => $headerValue]);
+        $secondResponse = $this->get('/', ['X-Cache-Bypass' => $headerValue]);
 
-        $this->assertRegularResponse($response);
+        $this->assertRegularResponse($firstResponse);
+        $this->assertRegularResponse($secondResponse);
     }
 }