Allow empty tag list (#553)

---------

Co-authored-by: David Buchmann <[email protected]>

Author: ro0NL

CHANGELOG.md

@@ -14,6 +14,7 @@ See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpC
 * Test with PHP 8.2 and 8.3
 * Drop support for PHP < 8.1
 * Parameter and return type declarations where possible.
+* Ignore empty tag lists passed to `TagCapable::invalidateTags` so you don't need to check if there are tags or not.
 
 2.x
 ===

src/CacheInvalidator.php

@@ -221,7 +221,7 @@ public function invalidate(array $headers)
      *
      * @see TagCapable::tags()
      *
-     * @param array $tags Tags that should be removed/expired from the cache
+     * @param array $tags Tags that should be removed/expired from the cache. An empty tag list is ignored.
      *
      * @return $this
      *
@@ -232,6 +232,10 @@ public function invalidateTags(array $tags)
         if (!$this->cache instanceof TagCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('Tags');
         }
+        if (!$tags) {
+            return $this;
+        }
+
         $this->cache->invalidateTags($tags);
 
         return $this;

src/ProxyClient/Cloudflare.php

@@ -70,6 +70,10 @@ public function __construct(
      */
     public function invalidateTags(array $tags)
     {
+        if (!$tags) {
+            return $this;
+        }
+
         $this->queueRequest(
             'POST',
             sprintf(self::API_ENDPOINT.'/zones/%s/purge_cache', $this->options['zone_identifier']),

src/ProxyClient/Fastly.php

@@ -62,6 +62,10 @@ public function __construct(
      */
     public function invalidateTags(array $tags)
     {
+        if (!$tags) {
+            return $this;
+        }
+
         $url = sprintf(self::API_ENDPOINT.'/service/%s/purge', $this->options['service_identifier']);
         $headers = ['Accept' => 'application/json'];
         if (true === $this->options['soft_purge']) {

src/ProxyClient/Invalidation/TagCapable.php

@@ -25,7 +25,7 @@ interface TagCapable extends ProxyClient
     /**
      * Remove/Expire cache objects based on cache tags.
      *
-     * @param array $tags Tags that should be removed/expired from the cache
+     * @param array $tags Tags that should be removed/expired from the cache. An empty tag list should be ignored.
      *
      * @return $this
      */

src/ProxyClient/MultiplexerClient.php

@@ -107,6 +107,10 @@ public function flush()
      */
     public function invalidateTags(array $tags)
     {
+        if (!$tags) {
+            return $this;
+        }
+
         $this->invoke(TagCapable::class, 'invalidateTags', [$tags]);
 
         return $this;

src/ProxyClient/Symfony.php

@@ -69,6 +69,10 @@ protected function configureOptions()
 
     public function invalidateTags(array $tags)
     {
+        if (!$tags) {
+            return $this;
+        }
+
         $escapedTags = $this->escapeTags($tags);
 
         $chunkSize = $this->determineTagsPerHeader($escapedTags, ',');

src/ProxyClient/Varnish.php

@@ -69,6 +69,10 @@ class Varnish extends HttpProxyClient implements BanCapable, PurgeCapable, Refre
 
     public function invalidateTags(array $tags)
     {
+        if (!$tags) {
+            return $this;
+        }
+
         $banMode = self::TAG_BAN === $this->options['tag_mode'];
 
         // If using BAN's, escape each tag