Merge pull request #52 from nlx-lars/feature/http-cache-2

FEATURE: Update to fos/http-cache:~2.0

Author: paxuclus

.travis.yml

@@ -16,7 +16,7 @@ before_script:
           "bin-dir": "bin"
       },
       "require": {
-          "neos/neos": "^4.0",
+          "neos/neos": "^5.0",
           "moc/varnish": "${VERSION}"
       },
       "require-dev": {

Classes/Http/CacheControlHeaderComponent.php

@@ -7,29 +7,29 @@
 use MOC\Varnish\Cache\MetadataAwareStringFrontend;
 use MOC\Varnish\Service\TokenStorage;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
-use Neos\ContentRepository\Exception\NodeException;
+use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Http\Component\ComponentContext;
 use Neos\Flow\Http\Component\ComponentInterface;
 use Neos\Flow\Log\Utility\LogEnvironment;
 use Neos\Flow\Mvc\DispatchComponent;
 use Neos\Flow\Mvc\Exception\NoSuchArgumentException;
 use Neos\Flow\Property\PropertyMapper;
-use Neos\Flow\Annotations as Flow;
 use Psr\Log\LoggerInterface;
 
 class CacheControlHeaderComponent implements ComponentInterface
 {
+
     /**
-     * @var ContentCacheAspect
-     * @Flow\Inject
+     * @var array
+     * @Flow\InjectConfiguration(path="cacheHeaders")
      */
-    protected $contentCacheAspect;
+    protected $cacheHeaderSettings;
 
     /**
-     * @var MetadataAwareStringFrontend
+     * @var ContentCacheAspect
      * @Flow\Inject
      */
-    protected $contentCacheFrontend;
+    protected $contentCacheAspect;
 
     /**
      * @var TokenStorage
@@ -38,42 +38,38 @@ class CacheControlHeaderComponent implements ComponentInterface
     protected $tokenStorage;
 
     /**
-     * @Flow\Inject
      * @var LoggerInterface
+     * @Flow\Inject
      */
     protected $logger;
 
     /**
-     * @Flow\InjectConfiguration()
-     * @var array
+     * @var PropertyMapper
+     * @Flow\Inject
      */
-    protected $cacheHeaderSettings;
+    protected $propertyMapper;
 
     /**
-     * @Flow\Inject
-     * @var PropertyMapper
+     * @var MetadataAwareStringFrontend
      */
-    protected $propertyMapper;
+    protected $contentCacheFrontend;
 
     /**
      * @param ComponentContext $componentContext
      * @return void
-     * @throws NodeException
      * @throws NoSuchArgumentException
      * @throws \Exception
      * @api
      */
     public function handle(ComponentContext $componentContext)
     {
-
         if ($this->cacheHeaderSettings['disabled'] ?? false) {
             $this->logger->debug(sprintf('Varnish cache headers disabled (see configuration setting MOC.Varnish.cacheHeaders.disabled)'), LogEnvironment::fromMethodName(__METHOD__));
             return;
         }
 
         /** @var \Neos\Flow\Mvc\ActionRequest $actionRequest */
         $actionRequest = $componentContext->getParameter(DispatchComponent::class, 'actionRequest');
-
         if (!$actionRequest->hasArgument('node') || !$actionRequest->getArgument('node')) {
             return;
         }
@@ -113,15 +109,15 @@ public function handle(ComponentContext $componentContext)
         list($tags, $cacheLifetime) = $this->getCacheTagsAndLifetime();
 
         if (count($tags) > 0) {
-            $modifiedResponse = $modifiedResponse->withHeader('X-Cache-Tags', $tags);
+            $modifiedResponse = $modifiedResponse->withHeader('X-Cache-Tags', implode(',', $tags));
         }
 
         $modifiedResponse = $modifiedResponse->withHeader('X-Site', $this->tokenStorage->getToken());
 
         $nodeLifetime = $node->getProperty('cacheTimeToLive');
 
         if ($nodeLifetime === '' || $nodeLifetime === null) {
-            $defaultLifetime = $this->cacheHeaderSettings['cacheHeaders']['defaultSharedMaximumAge'] ?? null;
+            $defaultLifetime = $this->cacheHeaderSettings['defaultSharedMaximumAge'] ?? null;
             $timeToLive = $defaultLifetime;
             if ($defaultLifetime === null) {
                 $timeToLive = $cacheLifetime;

Classes/Service/ProxyClient/Varnish.php

@@ -0,0 +1,49 @@
+<?php
+declare(strict_types=1);
+
+namespace MOC\Varnish\Service\ProxyClient;
+
+use FOS\HttpCache\ProxyClient\Varnish as FOSVarnish;
+
+/**
+ * Varnish ProxyClient that allows banning by tags and hosts
+ * at the same time
+ */
+class Varnish extends FOSVarnish
+{
+
+    /**
+     * @var array
+     */
+    private $hosts = [];
+
+    public function forHosts(string ... $hosts): self
+    {
+        $this->hosts = $hosts;
+
+        return $this;
+    }
+
+    public function ban(array $headers)
+    {
+        $headers = array_merge(
+            $this->getHostHeader(),
+            $headers
+        );
+
+        return parent::ban($headers);
+    }
+
+    private function getHostHeader(): array
+    {
+        switch (count($this->hosts)) {
+            case 0:
+                return [];
+            case 1:
+                return [self::HTTP_HEADER_HOST => current($this->hosts)];
+            default:
+                return [self::HTTP_HEADER_HOST => '^(' . implode('|', $this->hosts) . ')$'];
+        }
+    }
+
+}

Classes/Service/VarnishBanService.php

@@ -7,8 +7,8 @@
 use FOS\HttpCache\Exception\ExceptionCollection;
 use FOS\HttpCache\Exception\ProxyResponseException;
 use FOS\HttpCache\Exception\ProxyUnreachableException;
-use FOS\HttpCache\Handler\TagHandler;
 use FOS\HttpCache\ProxyClient;
+use MOC\Varnish\Service\ProxyClient\Varnish;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -35,7 +35,7 @@ class VarnishBanService
     protected $settings;
 
     /**
-     * @var ProxyClient\Varnish
+     * @var Varnish
      */
     protected $varnishProxyClient;
 
@@ -45,10 +45,9 @@ class VarnishBanService
     protected $cacheInvalidator;
 
     /**
-     * @var TagHandler
+     * @param array $settings
+     * @return void
      */
-    protected $tagHandler;
-
     public function injectSettings(array $settings): void
     {
         $this->settings = $settings;
@@ -61,10 +60,15 @@ public function initializeObject(): void
         array_walk($varnishUrls, function (&$varnishUrl) {
             $varnishUrl = rtrim($varnishUrl, '/');
         });
-        $this->varnishProxyClient = new ProxyClient\Varnish($varnishUrls);
-        $this->varnishProxyClient->setDefaultBanHeader('X-Site', $this->tokenStorage->getToken());
+        $httpDispatcher = new ProxyClient\HttpDispatcher($varnishUrls);
+        $options = [
+            'header_length' => $this->settings['maximumHeaderLength'] ?? 7500,
+            'default_ban_headers' => [
+                'X-Site' => $this->tokenStorage->getToken()
+            ]
+        ];
+        $this->varnishProxyClient = new Varnish($httpDispatcher, $options);
         $this->cacheInvalidator = new CacheInvalidator($this->varnishProxyClient);
-        $this->tagHandler = new TagHandler($this->cacheInvalidator, 'X-Cache-Tags', $this->settings['maximumHeaderLength'] ?? 7500);
     }
 
     /**
@@ -81,6 +85,7 @@ public function initializeObject(): void
      */
     public function banAll($domains = null, $contentType = null): void
     {
+        $this->varnishProxyClient->forHosts(...$this->domainsToArray($domains));
         $this->cacheInvalidator->invalidateRegex('.*', $contentType, $domains);
         $this->logger->debug(sprintf('Clearing all Varnish cache%s%s', $domains ? ' for domains "' . (is_array($domains) ? implode(', ', $domains) : $domains) . '"' : '', $contentType ? ' with content type "' . $contentType . '"' : ''));
         $this->execute();
@@ -112,16 +117,9 @@ public function banByTags(array $tags, $domains = null): void
             $tags[$key] = strtr($tag, '.:', '_-');
         }
 
-        // Set specific domain before invalidating tags
-        if ($domains) {
-            $this->varnishProxyClient->setDefaultBanHeader(ProxyClient\Varnish::HTTP_HEADER_HOST, is_array($domains) ? '^(' . implode('|', $domains) . ')$' : $domains);
-        }
-        $this->tagHandler->invalidateTags($tags);
-        // Unset specific domain after invalidating tags
-        if ($domains) {
-            $this->varnishProxyClient->setDefaultBanHeader(ProxyClient\Varnish::HTTP_HEADER_HOST, ProxyClient\Varnish::REGEX_MATCH_ALL);
-        }
-        $this->logger->debug(sprintf('Clearing Varnish cache for tags "%s"%s', implode(',', $tags), $domains ? ' for domains "' . (is_array($domains) ? implode(', ', $domains) : $domains) . '"' : ''));
+        $this->varnishProxyClient->forHosts(...$this->domainsToArray($domains));
+        $this->cacheInvalidator->invalidateTags($tags);
+        $this->logger->debug(sprintf('Cleared Varnish cache for tags "%s"%s', implode(',', $tags), $domains ? ' for domains "' . (is_array($domains) ? implode(', ', $domains) : $domains) . '"' : ''));
         $this->execute();
     }
 
@@ -141,4 +139,13 @@ protected function execute(): void
             }
         }
     }
+
+    /**
+     * @param string|string[]|null $domains
+     * @return array
+     */
+    private function domainsToArray($domains = null): array
+    {
+        return is_array($domains) ? $domains : (is_string($domains) ? [$domains] : []);
+    }
 }

composer.json

@@ -33,7 +33,8 @@
     ],
     "require": {
         "neos/neos": "^5.0",
-        "friendsofsymfony/http-cache": "~1.3"
+        "friendsofsymfony/http-cache": "~2.0",
+        "php-http/curl-client": "~1"
     },
     "autoload": {
         "psr-4": {