[11.x] Optimize commands registration

Author: erikgaal

src/Illuminate/Foundation/Console/OptimizeClearCommand.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Foundation\Console;
 
 use Illuminate\Console\Command;
+use Illuminate\Contracts\Events\Dispatcher;
 use Symfony\Component\Console\Attribute\AsCommand;
 
 #[AsCommand(name: 'optimize:clear')]
@@ -22,6 +23,12 @@ class OptimizeClearCommand extends Command
      */
     protected $description = 'Remove the cached bootstrap files';
 
+    public function __construct(
+        protected Dispatcher $events,
+    ) {
+        parent::__construct();
+    }
+
     /**
      * Execute the console command.
      *
@@ -31,15 +38,23 @@ public function handle()
     {
         $this->components->info('Clearing cached bootstrap files.');
 
-        collect([
-            'cache' => fn () => $this->callSilent('cache:clear') == 0,
-            'compiled' => fn () => $this->callSilent('clear-compiled') == 0,
-            'config' => fn () => $this->callSilent('config:clear') == 0,
-            'events' => fn () => $this->callSilent('event:clear') == 0,
-            'routes' => fn () => $this->callSilent('route:clear') == 0,
-            'views' => fn () => $this->callSilent('view:clear') == 0,
-        ])->each(fn ($task, $description) => $this->components->task($description, $task));
+        foreach ($this->getOptimizeClearTasks() as $description => $command) {
+            $this->components->task($description, fn () => $this->callSilently($command) == 0);
+        }
 
         $this->newLine();
     }
+
+    public function getOptimizeClearTasks(): array
+    {
+        return [
+            'cache' => 'cache:clear',
+            'compiled' => 'clear-compiled',
+            'config' => 'config:clear',
+            'events' => 'event:clear',
+            'routes' => 'route:clear',
+            'views' => 'view:clear',
+            ...ServiceProvider::$optimizeClearingCommands
+        ];
+    }
 }

src/Illuminate/Foundation/Console/OptimizeCommand.php

@@ -3,6 +3,9 @@
 namespace Illuminate\Foundation\Console;
 
 use Illuminate\Console\Command;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Foundation\Events\Optimizing;
+use Illuminate\Support\ServiceProvider;
 use Symfony\Component\Console\Attribute\AsCommand;
 
 #[AsCommand(name: 'optimize')]
@@ -22,6 +25,12 @@ class OptimizeCommand extends Command
      */
     protected $description = 'Cache framework bootstrap, configuration, and metadata to increase performance';
 
+    public function __construct(
+        protected Dispatcher $events,
+    ) {
+        parent::__construct();
+    }
+
     /**
      * Execute the console command.
      *
@@ -31,13 +40,21 @@ public function handle()
     {
         $this->components->info('Caching framework bootstrap, configuration, and metadata.');
 
-        collect([
-            'config' => fn () => $this->callSilent('config:cache') == 0,
-            'events' => fn () => $this->callSilent('event:cache') == 0,
-            'routes' => fn () => $this->callSilent('route:cache') == 0,
-            'views' => fn () => $this->callSilent('view:cache') == 0,
-        ])->each(fn ($task, $description) => $this->components->task($description, $task));
+        foreach ($this->getOptimizeTasks() as $description => $command) {
+            $this->components->task($description, fn () => $this->callSilently($command) == 0);
+        }
 
         $this->newLine();
     }
+
+    protected function getOptimizeTasks(): array
+    {
+        return [
+            'config' => 'config:cache',
+            'events' => 'event:cache',
+            'routes' => 'route:cache',
+            'views' => 'view:cache',
+            ...ServiceProvider::$optimizationCommands
+        ];
+    }
 }

src/Illuminate/Support/ServiceProvider.php

@@ -51,6 +51,20 @@ abstract class ServiceProvider
      */
     public static $publishGroups = [];
 
+    /**
+     * Commands that should be run during the optimize command.
+     *
+     * @var array<string, string>
+     */
+    public static array $optimizationCommands = [];
+
+    /**
+     * Commands that should be run during the optimize:clear command.
+     *
+     * @var array<string, string>
+     */
+    public static array $optimizeClearingCommands = [];
+
     /**
      * The migration paths available for publishing.
      *
@@ -537,4 +551,15 @@ public static function addProviderToBootstrapFile(string $provider, ?string $pat
 
         return true;
     }
+
+    protected function registerOptimizeCommands(string $key, string $optimize = null, string $optimizeClear = null): void
+    {
+        if ($optimize) {
+            static::$optimizationCommands[$key] = $optimize;
+        }
+
+        if ($optimizeClear) {
+            static::$optimizeClearingCommands[$key] = $optimizeClear;
+        }
+    }
 }

tests/Integration/Foundation/Console/OptimizeClearCommandTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Foundation\Console;
+
+use Illuminate\Foundation\Console\ClosureCommand;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Tests\Integration\Generators\TestCase;
+
+class OptimizeClearCommandTest extends TestCase
+{
+    protected function getPackageProviders($app): array
+    {
+        return [TestServiceProvider::class];
+    }
+
+    public function testCanListenToOptimizingEvent(): void
+    {
+        $this->artisan('optimize:clear')
+            ->assertSuccessful()
+            ->expectsOutputToContain('my package');
+    }
+}
+
+class TestServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->commands([
+            new ClosureCommand('my_package:clear', fn () => 0),
+        ]);
+
+        $this->registerOptimizeCommands(
+            key: 'my package',
+            optimizeClear: 'my_package:clear',
+        );
+    }
+}

tests/Integration/Foundation/Console/OptimizeCommandTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Foundation\Console;
+
+use Illuminate\Foundation\Console\ClosureCommand;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Tests\Integration\Generators\TestCase;
+
+class OptimizeCommandTest extends TestCase
+{
+    protected function getPackageProviders($app): array
+    {
+        return [TestServiceProvider::class];
+    }
+
+    public function testCanListenToOptimizingEvent(): void
+    {
+        $this->artisan('optimize')
+            ->assertSuccessful()
+            ->expectsOutputToContain('my package');
+    }
+}
+
+class TestServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->commands([
+            new ClosureCommand('my_package:cache', fn () => 0),
+        ]);
+
+        $this->registerOptimizeCommands(
+            key: 'my package',
+            optimize: 'my_package:cache',
+        );
+    }
+}