[11.x] Allow exceptions to the optimize and optimize:clear comman…

…ds (#54070) * Allow exceptions to the optimize commands * Fix incorrect method name * Add tests * Update OptimizeClearCommand.php --------- Co-authored-by: Taylor Otwell <[email protected]>
laravel · Jan 9, 2025 · ceaedb4 · ceaedb4
1 parent 6694ebc
commit ceaedb4
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 2 deletions.
diff --git a/src/Illuminate/Foundation/Console/OptimizeClearCommand.php b/src/Illuminate/Foundation/Console/OptimizeClearCommand.php
@@ -3,8 +3,10 @@
 namespace Illuminate\Foundation\Console;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
 use Illuminate\Support\ServiceProvider;
 use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputOption;
 
 #[AsCommand(name: 'optimize:clear')]
 class OptimizeClearCommand extends Command
@@ -32,7 +34,17 @@ public function handle()
     {
         $this->components->info('Clearing cached bootstrap files.');
 
-        foreach ($this->getOptimizeClearTasks() as $description => $command) {
+        $exceptions = Collection::wrap(explode(',', $this->option('except')))
+            ->map(fn ($except) => trim($except))
+            ->filter()
+            ->unique()
+            ->flip();
+
+        $tasks = Collection::wrap($this->getOptimizeClearTasks())
+            ->reject(fn ($command, $key) => $exceptions->hasAny([$command, $key]))
+            ->toArray();
+
+        foreach ($tasks as $description => $command) {
             $this->components->task($description, fn () => $this->callSilently($command) == 0);
         }
 
@@ -56,4 +68,16 @@ public function getOptimizeClearTasks()
             ...ServiceProvider::$optimizeClearCommands,
         ];
     }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['except', 'e', InputOption::VALUE_OPTIONAL, 'The commands to skip'],
+        ];
+    }
 }
diff --git a/src/Illuminate/Foundation/Console/OptimizeCommand.php b/src/Illuminate/Foundation/Console/OptimizeCommand.php
@@ -3,8 +3,10 @@
 namespace Illuminate\Foundation\Console;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
 use Illuminate\Support\ServiceProvider;
 use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputOption;
 
 #[AsCommand(name: 'optimize')]
 class OptimizeCommand extends Command
@@ -32,7 +34,17 @@ public function handle()
     {
         $this->components->info('Caching framework bootstrap, configuration, and metadata.');
 
-        foreach ($this->getOptimizeTasks() as $description => $command) {
+        $exceptions = Collection::wrap(explode(',', $this->option('except')))
+            ->map(fn ($except) => trim($except))
+            ->filter()
+            ->unique()
+            ->flip();
+
+        $tasks = Collection::wrap($this->getOptimizeTasks())
+            ->reject(fn ($command, $key) => $exceptions->hasAny([$command, $key]))
+            ->toArray();
+
+        foreach ($tasks as $description => $command) {
             $this->components->task($description, fn () => $this->callSilently($command) == 0);
         }
 
@@ -54,4 +66,16 @@ protected function getOptimizeTasks()
             ...ServiceProvider::$optimizeCommands,
         ];
     }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['except', 'e', InputOption::VALUE_OPTIONAL, 'Do not run the commands matching the key or name'],
+        ];
+    }
 }
diff --git a/tests/Integration/Foundation/Console/OptimizeClearCommandTest.php b/tests/Integration/Foundation/Console/OptimizeClearCommandTest.php
@@ -19,6 +19,20 @@ public function testCanListenToOptimizingEvent(): void
             ->assertSuccessful()
             ->expectsOutputToContain('ServiceProviderWithOptimizeClear');
     }
+
+    public function testCanExcludeCommandsByKey(): void
+    {
+        $this->artisan('optimize:clear', ['--except' => 'my package'])
+            ->assertSuccessful()
+            ->doesntExpectOutputToContain('my package');
+    }
+
+    public function testCanExcludeCommandsByCommand(): void
+    {
+        $this->artisan('optimize:clear', ['--except' => 'my_package:cache'])
+            ->assertSuccessful()
+            ->doesntExpectOutputToContain('my_package:cache');
+    }
 }
 
 class ServiceProviderWithOptimizeClear extends ServiceProvider

diff --git a/tests/Integration/Foundation/Console/OptimizeCommandTest.php b/tests/Integration/Foundation/Console/OptimizeCommandTest.php
@@ -27,6 +27,20 @@ public function testCanListenToOptimizingEvent(): void
             ->assertSuccessful()
             ->expectsOutputToContain('my package');
     }
+
+    public function testCanExcludeCommandsByKey(): void
+    {
+        $this->artisan('optimize', ['--except' => 'my package'])
+            ->assertSuccessful()
+            ->doesntExpectOutputToContain('my package');
+    }
+
+    public function testCanExcludeCommandsByCommand(): void
+    {
+        $this->artisan('optimize', ['--except' => 'my_package:cache'])
+            ->assertSuccessful()
+            ->doesntExpectOutputToContain('my_package:cache');
+    }
 }
 
 class ServiceProviderWithOptimize extends ServiceProvider