Adjust from invalidateDomain to clearCache and invalidate

Author: alexander-schranz

composer.json

@@ -30,7 +30,7 @@
     "require-dev": {
         "php-http/guzzle6-adapter": "^1.0 || ^2.0",
         "php-http/message": "^1.0 || ^2.0",
-        "mockery/mockery": "^1.0 || ^2.0",
+        "mockery/mockery": "^1.0",
         "monolog/monolog": "*",
         "sensio/framework-extra-bundle": "^3.0 || ^4.0 || ^5.0",
         "symfony/browser-kit": "^3.4.4 || ^4.1.12 || ^5.0",

phpunit.xml.dist

@@ -32,5 +32,6 @@
         <env name="KERNEL_DIR" value="./tests/Functional/Fixtures/app" />
         <env name="KERNEL_CLASS" value="AppKernel" />
         <env name="SYMFONY_DEPRECATIONS_HELPER" value="weak" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="6.5" />
     </php>
 </phpunit>

src/Command/ClearCommand.php

@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCacheBundle 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\HttpCacheBundle\Command;
+
+use FOS\HttpCache\CacheInvalidator;
+use FOS\HttpCacheBundle\CacheManager;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * A command to trigger cache invalidation by path from the command line.
+ *
+ * @author Alexander Schranz <[email protected]>
+ */
+class ClearCommand extends BaseInvalidateCommand
+{
+    use PathSanityCheck;
+
+    protected static $defaultName = 'fos:httpcache:clear';
+
+    /**
+     * If no cache manager is specified explicitly, fos_http_cache.cache_manager
+     * is automatically loaded.
+     *
+     * @param CacheManager|null $cacheManager The cache manager to talk to
+     */
+    public function __construct(CacheManager $cacheManager = null)
+    {
+        parent::__construct($cacheManager);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName(static::$defaultName) // BC with 2.8
+            ->setDescription('Invalidate the whole http cache.')
+            ->setHelp(
+                <<<'EOF'
+The <info>%command.name%</info> command invalidates the whole cache in the configured caching proxies.
+
+Example:
+
+    <info>php %command.full_name%</info>
+EOF
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $cacheManager = $this->getCacheManager();
+
+        if ($cacheManager->supports(CacheInvalidator::CLEAR)) {
+            $this->getCacheManager()->clearCache();
+        } elseif ($cacheManager->supports(CacheInvalidator::INVALIDATE)) {
+            $this->getCacheManager()->invalidateRegex('.*');
+        } else {
+            $output->writeln(
+                '<error>The configured http cache does not support "clear" or "invalidate".</error>'
+            );
+
+            return 1;
+        }
+
+        return 0;
+    }
+}

src/Command/InvalidateDomainCommand.php

@@ -21,7 +21,7 @@
             <tag name="console.command"/>
         </service>
 
-        <service id="fos_http_cache.command.invalidate_domain" class="FOS\HttpCacheBundle\Command\InvalidateDomainCommand">
+        <service id="fos_http_cache.command.clear" class="FOS\HttpCacheBundle\Command\ClearCommand">
             <argument type="service" id="fos_http_cache.cache_manager" />
             <tag name="console.command"/>
         </service>

src/Resources/config/cache_manager_commands.xml

@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCacheBundle 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\HttpCacheBundle\Tests\Functional\Command;
+
+use FOS\HttpCache\CacheInvalidator;
+use FOS\HttpCacheBundle\CacheManager;
+
+class ClearCommandTest extends CommandTestCase
+{
+    public function testExecuteClearVerbose()
+    {
+        $client = self::createClient();
+
+        $mock = \Mockery::mock(CacheManager::class);
+        $mock->shouldReceive('supports')
+            ->with(CacheInvalidator::CLEAR)
+            ->andReturnTrue();
+        ;
+        $mock->shouldReceive('clearCache')
+            ->once()
+        ;
+        $mock->shouldReceive('flush')
+            ->once()
+            ->andReturn(1)
+        ;
+        $client->getContainer()->set('fos_http_cache.cache_manager', $mock);
+
+        $output = $this->runCommand($client, 'fos:httpcache:clear');
+
+        $this->assertEquals("Sent 1 invalidation request(s)\n", $output);
+    }
+
+    public function testExecuteBanVerbose()
+    {
+        $client = self::createClient();
+
+        $mock = \Mockery::mock(CacheManager::class);
+        $mock->shouldReceive('supports')
+            ->with(CacheInvalidator::CLEAR)
+            ->andReturnFalse();
+        $mock->shouldReceive('supports')
+            ->with(CacheInvalidator::INVALIDATE)
+            ->andReturnTrue();
+        ;
+        $mock->shouldReceive('invalidateRegex')
+            ->with('.*')
+            ->once()
+        ;
+        $mock->shouldReceive('flush')
+            ->once()
+            ->andReturn(1)
+        ;
+        $client->getContainer()->set('fos_http_cache.cache_manager', $mock);
+
+        $output = $this->runCommand($client, 'fos:httpcache:clear');
+
+        $this->assertEquals("Sent 1 invalidation request(s)\n", $output);
+    }
+
+    public function testExecuteErrorVerbose()
+    {
+        $client = self::createClient();
+
+        $mock = \Mockery::mock(CacheManager::class);
+        $mock->shouldReceive('supports')
+            ->with(CacheInvalidator::CLEAR)
+            ->andReturnFalse();
+        $mock->shouldReceive('supports')
+            ->with(CacheInvalidator::INVALIDATE)
+            ->andReturnFalse();
+        ;
+        $mock->shouldReceive('flush')
+            ->once()
+            ->andReturn(0)
+        ;
+        $client->getContainer()->set('fos_http_cache.cache_manager', $mock);
+
+        $output = $this->runCommand($client, 'fos:httpcache:clear', 1);
+
+        $this->assertStringContainsString("The configured http cache does not support \"clear\" or \"invalidate\".", $output);
+    }
+}