Improve cache clearing for Symfony and Laravel (#489)

dgafka · web-flow · commit 6046242f3f74 · 2025-06-14T19:51:40.000+02:00
* Improve cache clearing for Symfony and Laravel

* hook on cache clear for laravel
diff --git a/packages/Laravel/src/EcotoneCacheClear.php b/packages/Laravel/src/EcotoneCacheClear.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace Ecotone\Laravel;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\App;
+
+/**
+ * licence Apache-2.0
+ */
+class EcotoneCacheClear
+{
+    public static function clearEcotoneCacheDirectories(string $storagePath): void
+    {
+        $laravelCacheDirectory = $storagePath . DIRECTORY_SEPARATOR . 'ecotone';
+        if (is_dir($laravelCacheDirectory)) {
+            self::clearDirectory($laravelCacheDirectory);
+        }
+
+        // Clear EcotoneLite test cache directory
+        $liteCacheDirectory = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'ecotone';
+        if (is_dir($liteCacheDirectory)) {
+            self::clearDirectory($liteCacheDirectory);
+        }
+    }
+
+    private static function clearDirectory(string $directory): void
+    {
+        if (! is_dir($directory)) {
+            return;
+        }
+
+        $files = array_diff(scandir($directory), ['.', '..']);
+
+        foreach ($files as $file) {
+            $filePath = $directory . DIRECTORY_SEPARATOR . $file;
+
+            if (is_dir($filePath)) {
+                self::clearDirectory($filePath);
+                rmdir($filePath);
+            } else {
+                unlink($filePath);
+            }
+        }
+    }
+}
diff --git a/packages/Laravel/src/EcotoneProvider.php b/packages/Laravel/src/EcotoneProvider.php
@@ -2,10 +2,6 @@
 
 namespace Ecotone\Laravel;
 
-use function class_exists;
-
-use const DIRECTORY_SEPARATOR;
-
 use Ecotone\AnnotationFinder\AnnotationFinderFactory;
 use Ecotone\Messaging\Config\ConfiguredMessagingSystem;
 use Ecotone\Messaging\Config\ConsoleCommandResultSet;
@@ -19,13 +15,16 @@
 use Ecotone\Messaging\ConfigurationVariableService;
 use Ecotone\Messaging\Gateway\ConsoleCommandRunner;
 use Ecotone\Messaging\Handler\Recoverability\RetryTemplateBuilder;
+use Illuminate\Console\Events\CommandFinished;
 use Illuminate\Foundation\Console\ClosureCommand;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\ServiceProvider;
 use InvalidArgumentException;
 use ReflectionMethod;
+use function class_exists;
+use const DIRECTORY_SEPARATOR;
 
 /**
  * licence Apache-2.0
@@ -55,13 +54,13 @@ public function register()
 
         $errorChannel = Config::get('ecotone.defaultErrorChannel');
 
-        $skippedModules = Config::get('ecotone.skippedModulePackageNames');
+        $skippedModules = Config::get('ecotone.skippedModulePackageNames') ?? [];
         /** @TODO Ecotone 2.0 use ServiceContext to configure Laravel */
         $applicationConfiguration = ServiceConfiguration::createWithDefaults()
             ->withEnvironment($environment)
             ->withLoadCatalog(Config::get('ecotone.loadAppNamespaces') ? 'app' : '')
             ->withFailFast(false)
-            ->withNamespaces(Config::get('ecotone.namespaces'))
+            ->withNamespaces(Config::get('ecotone.namespaces') ?? [])
             ->withSkippedModulePackageNames($skippedModules)
             ->withCacheDirectoryPath($cacheDirectory);
 
@@ -182,6 +181,9 @@ public function boot()
         if (! $this->app->has('logger')) {
             $this->app->singleton('logger', LaravelLogger::class);
         }
+
+        // Hook into Laravel's optimization commands to clear Ecotone cache
+        $this->registerOptimizationHooks();
     }
 
     private function getCacheDirectoryPath(): string
@@ -296,4 +298,20 @@ public function prepareFromCache(mixed $useProductionCache, string $rootCatalog,
 
         return [$serviceCacheConfiguration, $definitionHolder];
     }
+
+    /**
+     * Register hooks to clear Ecotone cache when Laravel optimization commands are run
+     */
+    private function registerOptimizationHooks(): void
+    {
+        $this->app['events']->listen(
+            CommandFinished::class,
+            function ($event) {
+                // Clear Ecotone cache when optimize commands finishes successfully
+                if (in_array($event->command, ['optimize', 'optimize:clear', 'cache:clear']) && $event->exitCode === 0) {
+                    EcotoneCacheClear::clearEcotoneCacheDirectories($this->getCacheDirectoryPath());
+                }
+            }
+        );
+    }
 }
diff --git a/packages/Laravel/tests/Application/Execution/ApplicationTest.php b/packages/Laravel/tests/Application/Execution/ApplicationTest.php
@@ -4,6 +4,7 @@
 
 namespace Test\Ecotone\Laravel\Application\Execution;
 
+use Ecotone\Laravel\EcotoneCacheClear;
 use Ecotone\Lite\Test\MessagingTestSupport;
 use Ecotone\Messaging\Config\ConfiguredMessagingSystem;
 use Ecotone\Modelling\CommandBus;
@@ -31,6 +32,8 @@ public function test_boot_application_with_ecotone()
             CommandBus::class,
             $app->get(CommandBus::class)
         );
+
+        EcotoneCacheClear::clearEcotoneCacheDirectories($app->storagePath());
     }
 
     public function createApplication()
diff --git a/packages/Laravel/tests/Licence/LicenceTest.php b/packages/Laravel/tests/Licence/LicenceTest.php
@@ -4,11 +4,13 @@
 
 namespace Test\Ecotone\Laravel\Licence;
 
+use Ecotone\Laravel\EcotoneCacheClear;
 use Ecotone\Modelling\CommandBus;
 use Ecotone\Modelling\QueryBus;
 use Ecotone\Test\LicenceTesting;
 use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Http\Kernel;
+use Illuminate\Support\Facades\Artisan;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -30,6 +32,8 @@ public function setUp(): void
         $this->app = $app;
         $this->queryBus = $app->get(QueryBus::class);
         $this->commandBus = $app->get(CommandBus::class);
+
+        EcotoneCacheClear::clearEcotoneCacheDirectories($app->storagePath());
     }
 
     protected function tearDown(): void
diff --git a/packages/Laravel/tests/MultiTenant/MultiTenantTest.php b/packages/Laravel/tests/MultiTenant/MultiTenantTest.php
@@ -5,12 +5,14 @@
 namespace Test\Ecotone\Laravel\MultiTenant;
 
 use App\MultiTenant\Application\Command\RegisterCustomer;
+use Ecotone\Laravel\EcotoneCacheClear;
 use Ecotone\Modelling\CommandBus;
 use Ecotone\Modelling\QueryBus;
 use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Http\Kernel;
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\File;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 
@@ -37,6 +39,35 @@ public function setUp(): void
         $this->app = $app;
         $this->queryBus = $app->get(QueryBus::class);
         $this->commandBus = $app->get(CommandBus::class);
+
+        EcotoneCacheClear::clearEcotoneCacheDirectories($app->storagePath());
+    }
+
+    public function test_optimize_clear_triggers_ecotone_cache_clear_via_event(): void
+    {
+        $laravelCacheDirectory = storage_path('framework/cache/data/ecotone');
+        $liteCacheDirectory = storage_path('framework/cache/data/ecotone');
+
+        // Create cache directories and test files
+        if(!File::exists($laravelCacheDirectory)) {
+            File::makeDirectory($laravelCacheDirectory, 0755, true);
+        }
+        File::put($laravelCacheDirectory . '/test_cache_file', 'test content');
+
+        if(!File::exists($liteCacheDirectory)) {
+            File::makeDirectory($liteCacheDirectory, 0755, true);
+        }
+        File::put($liteCacheDirectory . '/test_lite_cache_file', 'lite test content');
+
+        $this->assertTrue(File::exists($laravelCacheDirectory . '/test_cache_file'));
+        $this->assertTrue(File::exists($liteCacheDirectory . '/test_lite_cache_file'));
+
+        // Run optimize:clear command - this should trigger the CommandFinished event
+        Artisan::call('optimize:clear');
+
+        // Verify both Ecotone cache files were removed via the event listener
+        $this->assertFalse(File::exists($laravelCacheDirectory . '/test_cache_file'));
+        $this->assertFalse(File::exists($liteCacheDirectory . '/test_lite_cache_file'));
     }
 
     public function tearDown(): void
diff --git a/packages/Symfony/DependencyInjection/Compiler/CacheClearer.php b/packages/Symfony/DependencyInjection/Compiler/CacheClearer.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Ecotone\SymfonyBundle\DependencyInjection\Compiler;
+
+use Ecotone\Messaging\Config\ConfiguredMessagingSystem;
+use Ecotone\Messaging\Config\ServiceCacheConfiguration;
+use Ecotone\Messaging\Handler\Gateway\ProxyFactory;
+use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
+
+/**
+ * licence Apache-2.0
+ */
+class CacheClearer implements CacheClearerInterface
+{
+    public function __construct(
+        private ServiceCacheConfiguration $serviceCacheConfiguration
+    ) {
+    }
+
+    public function isOptional(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Clears any caches necessary.
+     */
+    public function clear(string $cacheDir): void
+    {
+        $this->deleteDirectory($this->serviceCacheConfiguration->getPath());
+        $this->deleteDirectory(sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'ecotone');
+    }
+
+    private function deleteDirectory(string $directory): void
+    {
+        if (! is_dir($directory)) {
+            return;
+        }
+
+        $files = array_diff(scandir($directory), ['.', '..']);
+
+        foreach ($files as $file) {
+            $filePath = $directory . DIRECTORY_SEPARATOR . $file;
+
+            if (is_dir($filePath)) {
+                $this->deleteDirectory($filePath);
+                rmdir($filePath);
+            } else {
+                unlink($filePath);
+            }
+        }
+    }
+}
diff --git a/packages/Symfony/DependencyInjection/EcotoneExtension.php b/packages/Symfony/DependencyInjection/EcotoneExtension.php
@@ -9,6 +9,7 @@
 use Ecotone\Messaging\Gateway\ConsoleCommandRunner;
 use Ecotone\Messaging\Handler\Logger\LoggingGateway;
 use Ecotone\Messaging\Handler\Recoverability\RetryTemplateBuilder;
+use Ecotone\SymfonyBundle\DependencyInjection\Compiler\CacheClearer;
 use Ecotone\SymfonyBundle\DependencyInjection\Compiler\CacheWarmer;
 use Ecotone\SymfonyBundle\DependencyInjection\Compiler\SymfonyConfigurationVariableService;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -82,6 +83,7 @@ public function load(array $configs, ContainerBuilder $container): void
             ]);
 
         $container->register(CacheWarmer::class)->setAutowired(true)->addTag('kernel.cache_warmer');
+        $container->register(CacheClearer::class)->setAutowired(true)->addTag('kernel.cache_clearer')->setPublic(true);
 
         $messagingConfiguration = MessagingSystemConfiguration::prepare(
             realpath(($container->hasParameter('kernel.project_dir') ? $container->getParameter('kernel.project_dir') : $container->getParameter('kernel.root_dir') . '/..')),
diff --git a/packages/Symfony/tests/phpunit/CacheClearingTest.php b/packages/Symfony/tests/phpunit/CacheClearingTest.php
@@ -0,0 +1,68 @@
+<?php
+
+namespace Test;
+
+use Ecotone\Messaging\Config\ServiceCacheConfiguration;
+use Ecotone\SymfonyBundle\DependencyInjection\Compiler\CacheClearer;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Filesystem\Filesystem;
+
+/**
+ * @internal
+ */
+/**
+ * licence Apache-2.0
+ * @internal
+ */
+class CacheClearingTest extends KernelTestCase
+{
+    private string $symfonyEcotoneCacheDir;
+    private string $ecotoneLiteCacheDir;
+    private Filesystem $filesystem;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        
+        self::bootKernel([
+            'environment' => 'test',
+        ]);
+        
+        $this->filesystem = new Filesystem();
+        
+        // Get the actual cache directories
+        /** @var ServiceCacheConfiguration $cacheConfig */
+        $cacheConfig = self::getContainer()->get(ServiceCacheConfiguration::REFERENCE_NAME);
+        $this->symfonyEcotoneCacheDir = $cacheConfig->getPath();
+        $this->ecotoneLiteCacheDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'ecotone';
+    }
+
+    public function test_cache_clear_command_triggers_ecotone_cache_clearing(): void
+    {
+        // Create cache directories and test files
+        $this->filesystem->mkdir($this->symfonyEcotoneCacheDir);
+        $this->filesystem->dumpFile($this->symfonyEcotoneCacheDir . '/test_symfony_cache.txt', 'Symfony Ecotone cache content');
+
+        $this->filesystem->mkdir($this->ecotoneLiteCacheDir);
+        $this->filesystem->dumpFile($this->ecotoneLiteCacheDir . '/test_lite_cache.txt', 'EcotoneLite cache content');
+
+        // Verify files exist
+        $this->assertTrue($this->filesystem->exists($this->symfonyEcotoneCacheDir . '/test_symfony_cache.txt'));
+        $this->assertTrue($this->filesystem->exists($this->ecotoneLiteCacheDir . '/test_lite_cache.txt'));
+
+        // Run cache:clear command with --no-warmup to avoid cache regeneration issues
+        $application = new Application(self::$kernel);
+        $command = $application->find('cache:clear');
+        $commandTester = new CommandTester($command);
+        $commandTester->execute(['--no-warmup' => true]);
+
+        // Verify both Ecotone cache files were removed by the cache:clear command
+        $this->assertFalse($this->filesystem->exists($this->symfonyEcotoneCacheDir . '/test_symfony_cache.txt'));
+        $this->assertFalse($this->filesystem->exists($this->ecotoneLiteCacheDir . '/test_lite_cache.txt'));
+
+        // Verify command executed successfully
+        $this->assertEquals(0, $commandTester->getStatusCode());
+    }
+}
diff --git a/packages/Symfony/tests/phpunit/Licence/LicenceTest.php b/packages/Symfony/tests/phpunit/Licence/LicenceTest.php
@@ -6,6 +6,7 @@
 
 use Ecotone\Modelling\CommandBus;
 use Ecotone\Modelling\QueryBus;
+use Ecotone\SymfonyBundle\DependencyInjection\Compiler\CacheClearer;
 use Ecotone\Test\LicenceTesting;
 use PHPUnit\Framework\TestCase;
 use Symfony\App\Licence\Configuration\Kernel;
@@ -30,6 +31,8 @@ public function setUp(): void
         $this->commandBus = $app->get(CommandBus::class);
         $this->queryBus = $app->get(QueryBus::class);
         $this->kernel = $kernel;
+
+        $this->kernel->getContainer()->get(CacheClearer::class)->clear('');
     }
 
     protected function tearDown(): void
diff --git a/packages/Symfony/tests/phpunit/MultiTenant/MultiTenantTest.php b/packages/Symfony/tests/phpunit/MultiTenant/MultiTenantTest.php
@@ -6,6 +6,7 @@
 
 use Ecotone\Modelling\CommandBus;
 use Ecotone\Modelling\QueryBus;
+use Ecotone\SymfonyBundle\DependencyInjection\Compiler\CacheClearer;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use Symfony\App\MultiTenant\Application\Command\RegisterCustomer;
@@ -39,6 +40,8 @@ public function setUp(): void
         $this->commandBus = $app->get(CommandBus::class);
         $this->queryBus = $app->get(QueryBus::class);
         $this->kernel = $kernel;
+
+        $this->kernel->getContainer()->get(CacheClearer::class)->clear('');
     }
 
     protected function tearDown(): void
diff --git a/packages/Symfony/tests/phpunit/SingleTenant/SingleTenantTest.php b/packages/Symfony/tests/phpunit/SingleTenant/SingleTenantTest.php
diff --git a/quickstart-examples/ConsoleCommand/Laravel/test.sh b/quickstart-examples/ConsoleCommand/Laravel/test.sh
diff --git a/quickstart-examples/ConsoleCommand/Symfony/test.sh b/quickstart-examples/ConsoleCommand/Symfony/test.sh
diff --git a/quickstart-examples/composer.json b/quickstart-examples/composer.json
