TASK: Make the fusion autoconfiguration opt in via header X-FullPageCache-EnableFusionAutoconfiguration

The header is set for Neos.Neos:Page automatically once the enabled setting for Flowpack.FullPageCache is set.

This prevents the package from interfering with custom controllers and also enables custom controllers to control the
caching behavior via the headers `X-FullPageCache-Enabled`, `X-FullPageCache-Lifetime` and `X-FullPageCache-Tags`
or when fusion rendering is used by activating `X-FullPageCache-EnableFusionAutoconfiguration`

Resolves: #15

Author: mficzel

…ses/Middleware/CacheHeaderMiddleware.php …re/FusionAutoconfigurationMiddleware.phpClasses/Middleware/CacheHeaderMiddleware.php renamed to Classes/Middleware/FusionAutoconfigurationMiddleware.php Classes/Middleware/CacheHeaderMiddleware.php renamed to Classes/Middleware/FusionAutoconfigurationMiddleware.php

@@ -11,8 +11,9 @@
 use Flowpack\FullPageCache\Aspects\ContentCacheAspect;
 use Flowpack\FullPageCache\Cache\MetadataAwareStringFrontend;
 
-class CacheHeaderMiddleware implements MiddlewareInterface
+class FusionAutoconfigurationMiddleware implements MiddlewareInterface
 {
+    public const HEADER_ENABLED = 'X-FullPageCache-EnableFusionAutoconfiguration';
 
     /**
      * @Flow\Inject
@@ -35,11 +36,17 @@ class CacheHeaderMiddleware implements MiddlewareInterface
     public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
     {
         if (!$this->enabled || !$request->hasHeader(RequestCacheMiddleware::HEADER_ENABLED)) {
-            return $next->handle($request);
+            return $next->handle($request)->withoutHeader(self::HEADER_ENABLED);
         }
 
         $response = $next->handle($request);
 
+        if (!$response->hasHeader(self::HEADER_ENABLED)) {
+            return $response;
+        } else {
+            $response = $response->withoutHeader(self::HEADER_ENABLED);
+        }
+
         list($hasUncachedSegments, $tags, $lifetime) = $this->getFusionCacheInformations();
 
         if ($response->hasHeader('Set-Cookie') || $hasUncachedSegments) {

Classes/Middleware/PublicCacheHeaderMiddleware.php

@@ -32,7 +32,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
 
         $response = $next->handle($request);
 
-        if ($response->hasHeader("Cache-Control")) {
+        if ($response->hasHeader("Cache-Control") || !$response->hasHeader(RequestCacheMiddleware::HEADER_ENABLED)) {
             return $response;
         }
 

Configuration/Objects.yaml

@@ -1,4 +1,4 @@
-Flowpack\FullPageCache\Middleware\CacheHeaderMiddleware:
+Flowpack\FullPageCache\Middleware\FusionAutoconfigurationMiddleware:
   properties:
     contentCache:
       object:

Configuration/Settings.yaml

@@ -38,9 +38,13 @@ Neos:
         'fullPageRequestCache':
           middleware: 'Flowpack\FullPageCache\Middleware\RequestCacheMiddleware'
           position: 'after trustedProxies'
-        'fullPagePublicCacheHeader':
+        'fullPageCachePublicHeader':
           middleware: 'Flowpack\FullPageCache\Middleware\PublicCacheHeaderMiddleware'
-          position: 'before fullPageCacheHeader'
-        'fullPageCacheHeader':
-          middleware: 'Flowpack\FullPageCache\Middleware\CacheHeaderMiddleware'
-          position: 'after fullPageRequestCache'
+          position: 'after fullPageRequestCache 20'
+        'fullPageCacheFusionAutoconfiguration':
+          middleware: 'Flowpack\FullPageCache\Middleware\FusionAutoconfigurationMiddleware'
+          position: 'after fullPageRequestCache 10'
+  Neos:
+    fusion:
+      autoInclude:
+        Flowpack.FullPageCache: true

README.md

@@ -56,19 +56,21 @@ How it works
 
 The package defines three http middlewares:
 
-- RequestCacheMiddleware: If a request is cacheble the cache is asked first and only if no response is found the 
-  reqeust is passed down the middleware chain. The cache lifetime and tags are determined from the 
+- `fullPageRequestCache`: If a request is cacheble the cache is asked first and only if no response is found the 
+  request is passed down the middleware chain. The cache lifetime and tags are determined from the 
   `X-FullPageCache-Enabled`, `X-FullPageCache-Lifetime` and `X-FullPageCache-Tags` that are set by upstream middlewares 
   or controllers. 
 
-- PublicCacheHeaderMiddleware: Set `ETag` and `CacheControl` Headers based on the `X-FullPageCache-Enabled` and the 
+- `fullPageCachePublicHeader` : Set `ETag` and `CacheControl` Headers based on the `X-FullPageCache-Enabled` and the 
   `X-FullPageCache-Lifetime` headers taking the `maxPublicCacheTime` into account.
 
-- CacheHeaderMiddleware: Connects to the fusion cache and extracts tags plus the allowed lifetime which is then 
-  stored in the response headers `X-FullPageCache-Enabled`, `X-FullPageCache-Lifetime` and `X-FullPageCache-Tags`
+- `fullPageCacheFusionAutoconfiguration`: Connects to the fusion cache and extracts tags plus the allowed lifetime which is then 
+  stored in the response headers `X-FullPageCache-Enabled`, `X-FullPageCache-Lifetime` and `X-FullPageCache-Tags`. 
+  This component expects a header `X-FullPageCache-EnableFusionAutoconfiguration` which is set automatically for `Neos.Neos:Page`.
 
-Controllers that want to control the caching behavior directly can set the headers `X-FullPageCache-Enabled`, 
-`X-FullPageCache-Lifetime` and `X-FullPageCache-Tags` directly.
+Custom controllers that want to control the caching behavior directly can set the headers `X-FullPageCache-Enabled`, 
+`X-FullPageCache-Lifetime` and `X-FullPageCache-Tags` directly while fusion based controllers can enable the autoconfiguration
+by setting the header `X-FullPageCache-EnableFusionAutoconfiguration`.
 
 Warning
 -------

Resources/Private/Fusion/Root.fusion

@@ -0,0 +1,8 @@
+prototype(Neos.Neos:Page) {
+    httpResponseHead {
+        headers {
+            'X-FullPageCache-EnableFusionAutoconfiguration' = ''
+            'X-FullPageCache-EnableFusionAutoconfiguration'.@if.isEnabled = ${Configuration.setting('Flowpack.FullPageCache.enabled') == true}
+        }
+    }
+}