add suport for prefix invalidation

Author: deniak

doc/proxy-clients.rst

@@ -19,17 +19,17 @@ Supported invalidation methods
 Not all clients support all :ref:`invalidation methods <invalidation methods>`.
 This table provides of methods supported by each proxy client:
 
-============= ======= ======= ======= ======= =======
-Client        Purge   Refresh Ban     Tagging Clear
-============= ======= ======= ======= ======= =======
+============= ======= ======= ======= ======= ====== =======
+Client        Purge   Refresh Ban     Tagging Prefix Clear
+============= ======= ======= ======= ======= ====== =======
 Varnish       ✓       ✓       ✓       ✓
-Fastly        ✓       ✓               ✓       ✓
+Fastly        ✓       ✓               ✓              ✓
 NGINX         ✓       ✓
-Symfony Cache ✓       ✓               ✓ (1)   ✓ (1)
-Cloudflare    ✓                       ✓ (2)   ✓
-Noop          ✓       ✓       ✓       ✓       ✓
-Multiplexer   ✓       ✓       ✓       ✓       ✓
-============= ======= ======= ======= ======= =======
+Symfony Cache ✓       ✓               ✓ (1)          ✓ (1)
+Cloudflare    ✓                       ✓ (2)   ✓ (2)  ✓
+Noop          ✓       ✓       ✓       ✓              ✓
+Multiplexer   ✓       ✓       ✓       ✓              ✓
+============= ======= ======= ======= ======= ====== =======
 
 | (1): Only when using `Toflar Psr6Store`_.
 | (2): Only available with `Cloudflare Enterprise`_.
@@ -357,7 +357,7 @@ the HttpDispatcher is not available for Cloudflare)::
     Cloudflare supports different cache purge methods depending on your account.
     All Cloudflare accounts support purging the cache by URL and clearing all
     cache items. You need a `Cloudflare Enterprise`_ account to purge by cache
-    tags.
+    tags or prefixes.
 
 Zone identifier
 ^^^^^^^^^^^^^^^

src/CacheInvalidator.php

@@ -18,6 +18,7 @@
 use FOS\HttpCache\Exception\UnsupportedProxyOperationException;
 use FOS\HttpCache\ProxyClient\Invalidation\BanCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\ClearCapable;
+use FOS\HttpCache\ProxyClient\Invalidation\PrefixCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
@@ -216,6 +217,20 @@ public function invalidateTags(array $tags): static
         return $this;
     }
 
+    public function invalidatePrefixes(array $prefixes): static
+    {
+        if (!$this->cache instanceof PrefixCapable) {
+            throw UnsupportedProxyOperationException::cacheDoesNotImplement('Prefixes');
+        }
+        if (!$prefixes) {
+            return $this;
+        }
+
+        $this->cache->invalidatePrefixes($prefixes);
+
+        return $this;
+    }
+
     /**
      * Invalidate URLs based on a regular expression for the URI, an optional
      * content type and optional limit to certain hosts.

src/ProxyClient/Cloudflare.php

@@ -12,6 +12,7 @@
 namespace FOS\HttpCache\ProxyClient;
 
 use FOS\HttpCache\ProxyClient\Invalidation\ClearCapable;
+use FOS\HttpCache\ProxyClient\Invalidation\PrefixCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
 use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
 use Psr\Http\Message\RequestFactoryInterface;
@@ -27,7 +28,7 @@
  *
  * @author Simon Jones <simon@studio24.net>
  */
-class Cloudflare extends HttpProxyClient implements ClearCapable, PurgeCapable, TagCapable
+class Cloudflare extends HttpProxyClient implements ClearCapable, PrefixCapable, PurgeCapable, TagCapable
 {
     /**
      * @see https://api.cloudflare.com/#getting-started-endpoints
@@ -87,6 +88,30 @@ public function invalidateTags(array $tags): static
         return $this;
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * URL prefix only available with Cloudflare enterprise plans
+     *
+     * @see https://developers.cloudflare.com/api/resources/cache/methods/purge/
+     */
+    public function invalidatePrefixes(array $prefixes): static
+    {
+        if (!$prefixes) {
+            return $this;
+        }
+
+        $this->queueRequest(
+            'POST',
+            sprintf(self::API_ENDPOINT.'/zones/%s/purge_cache', $this->options['zone_identifier']),
+            [],
+            false,
+            json_encode(['prefixes' => $prefixes], JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES)
+        );
+
+        return $this;
+    }
+
     /**
      * @see https://api.cloudflare.com/#zone-purge-files-by-url
      * @see https://developers.cloudflare.com/cache/how-to/purge-cache#purge-by-single-file-by-url For details on headers you can pass to clear the cache correctly

src/ProxyClient/Invalidation/PrefixCapable.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\ProxyClient\Invalidation;
+
+use FOS\HttpCache\ProxyClient\ProxyClient;
+
+/**
+ * An HTTP cache that supports invalidation by a cache tag, that is, removing
+ * or expiring objects from the cache tagged with a given tag or set of tags.
+ *
+ * HTTP responses must carry the tags header name with the tags header value
+ * for tag invalidation to work.
+ */
+interface PrefixCapable extends ProxyClient
+{
+    /**
+     * Remove/Expire cache objects based on cache tags.
+     *
+     * @param string[] $tags Tags that should be removed/expired from the cache. An empty tag list should be ignored.
+     */
+    public function invalidatePrefixes(array $prefixes): static;
+}

tests/Unit/ProxyClient/CloudflareTest.php

@@ -71,6 +71,28 @@ function (RequestInterface $request) {
         $cloudflare->invalidateTags(['tag-one', 'tag-two']);
     }
 
+    public function testInvalidatePrefixesPurge(): void
+    {
+        $cloudflare = $this->getProxyClient();
+
+        $this->httpDispatcher->shouldReceive('invalidate')->once()->with(
+            \Mockery::on(
+                function (RequestInterface $request) {
+                    $this->assertEquals('POST', $request->getMethod());
+                    $this->assertEquals('Bearer '.self::AUTH_TOKEN, current($request->getHeader('Authorization')));
+                    $this->assertEquals(sprintf('/client/v4/zones/%s/purge_cache', self::ZONE_IDENTIFIER), $request->getRequestTarget());
+
+                    $this->assertEquals('{"prefixes":["example.com/one/","example.com/two/"]}', $request->getBody()->getContents());
+
+                    return true;
+                }
+            ),
+            false
+        );
+
+        $cloudflare->invalidateTags(['example.com/one/', 'example.com/two/']);
+    }
+
     public function testPurge(): void
     {
         $cloudflare = $this->getProxyClient();