Add setCacheDuration() method, with this we can modify the cache duration value at runtime (#7)

Author: richan-fongdasen

src/Concerns/ManipulateHttpResponse.php

@@ -36,11 +36,10 @@ protected function acknowledgeEsiSupport(Response $response)
      * the response as a cacheable content.
      *
      * @param \Symfony\Component\HttpFoundation\Response $response
-     * @param int                                        $cacheDuration
      */
-    protected function addCacheableHeader(Response $response, $cacheDuration)
+    protected function addCacheableHeader(Response $response)
     {
-        $duration = $this->getCacheDuration((int) $cacheDuration);
+        $duration = $this->getCacheDuration();
 
         $response->headers->set($this->getConfig('cacheable_header'), '1');
         $response->headers->set('Cache-Control', 'public, max-age='.$duration);
@@ -60,43 +59,49 @@ public function addUncacheableHeader(Response $response)
     }
 
     /**
-     * Normalize the given cache duration and convert
+     * Normalize the cache duration value and convert
      * it to seconds.
      *
-     * @param int $duration
-     *
      * @return int|float
      */
-    protected function getCacheDuration($duration)
+    protected function getCacheDuration()
     {
-        $cacheInMinutes = ($duration > 0) ? $duration : $this->getConfig('cache_duration');
-
-        return $cacheInMinutes * 60;
+        return $this->getConfig('cache_duration') * 60;
     }
 
     /**
      * Manipulate the current Http response.
      *
      * @param \Symfony\Component\HttpFoundation\Response $response
-     * @param int                                        $cacheDuration
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function manipulate(Response $response, $cacheDuration)
+    public function manipulate(Response $response)
     {
         $this->acknowledgeEsiSupport($response);
 
         if ($this->shouldNotCache($response)) {
             return $response;
         }
 
-        $this->addCacheableHeader($response, $cacheDuration);
+        $this->addCacheableHeader($response);
         $this->addLastModifiedHeader($response);
         $this->addEtagHeader($response);
 
         return $response;
     }
 
+    /**
+     * Set cache duration value in minutes. This value will
+     * be added to the HTTP response's Cache-Control header.
+     *
+     * @param int $duration [Cache duration value in minutes]
+     */
+    public function setCacheDuration($duration)
+    {
+        $this->setConfig('cache_duration', (int) $duration);
+    }
+
     /**
      * Set the current Http request headers.
      *
@@ -145,4 +150,14 @@ abstract protected function addLastModifiedHeader(Response $response);
      * @return mixed
      */
     abstract public function getConfig($key);
+
+    /**
+     * Set configuration value for a specific key.
+     *
+     * @param string $key
+     * @param mixed  $value
+     *
+     * @return void
+     */
+    abstract public function setConfig($key, $value);
 }

src/Middleware/CacheableByVarnish.php

@@ -19,8 +19,12 @@ public function handle(Request $request, Closure $next, $cacheDuration = null)
     {
         \Varnishable::setRequestHeaders($request->headers);
 
+        if ((int) $cacheDuration > 0) {
+            \Varnishable::setCacheDuration($cacheDuration);
+        }
+
         $response = $next($request);
 
-        return \Varnishable::manipulate($response, $cacheDuration);
+        return \Varnishable::manipulate($response);
     }
 }

tests/Concerns/ManipulateHttpResponseTests.php

@@ -70,7 +70,8 @@ public function it_wont_acknowledge_esi_supports_when_there_was_no_esi_header_sp
     /** @test */
     public function it_can_add_cacheable_header_to_the_current_response_object()
     {
-        $this->invokeMethod($this->service, 'addCacheableHeader', [$this->response, 60]);
+        \Varnishable::setCacheDuration(60);
+        $this->invokeMethod($this->service, 'addCacheableHeader', [$this->response]);
 
         $cacheable = $this->response->headers->get(\Varnishable::getConfig('cacheable_header'));
         $cacheControl = $this->response->headers->get('Cache-Control');
@@ -96,7 +97,8 @@ public function it_can_calculate_total_cache_duration_in_seconds()
         $expected = [300, 900, 1800, 3600];
 
         for ($i=0; $i<count($data); $i++) {
-            $actual = $this->invokeMethod($this->service, 'getCacheDuration', [$data[$i]]);
+            \Varnishable::setCacheDuration($data[$i]);
+            $actual = $this->invokeMethod($this->service, 'getCacheDuration');
 
             $this->assertEquals($expected[$i], $actual);
         }
@@ -105,12 +107,13 @@ public function it_can_calculate_total_cache_duration_in_seconds()
     /** @test */
     public function it_can_fully_manipulate_http_response_as_expected()
     {
+        \Varnishable::setCacheDuration(120);
         $this->headers->set(\Varnishable::getConfig('esi_capability_header'), 'v1.0');
         $this->response->header(\Varnishable::getConfig('cacheable_header'), '1');
 
         $this->service->setRequestHeaders($this->headers);
 
-        $this->service->manipulate($this->response, 120);
+        $this->service->manipulate($this->response);
 
         $actual = $this->response->headers->get(\Varnishable::getConfig('esi_reply_header'));
         $this->assertEquals('v1.0', $actual);