feat: get the last executed spark command name (#10085)

* feat: get the last executed spark command name

* add test for DEFAULT_COMMAND

Author: paulbalandan

system/Boot.php

@@ -431,7 +431,11 @@ protected static function runCommand(Console $console): int
         $exitCode = $console->initialize()->run();
 
         if (! is_int($exitCode)) {
-            @trigger_error(sprintf('Starting with CodeIgniter v4.8.0, commands must return an integer exit code. Last command exited with %s. Defaulting to EXIT_SUCCESS.', get_debug_type($exitCode)), E_USER_DEPRECATED);
+            @trigger_error(sprintf(
+                'Since v4.8.0, commands must return an integer exit code. Last command "%s" exited with %s. Defaulting to EXIT_SUCCESS.',
+                $console->getCommand(),
+                get_debug_type($exitCode),
+            ), E_USER_DEPRECATED);
             $exitCode = EXIT_SUCCESS;
         }
 

system/CLI/Console.php

@@ -22,7 +22,12 @@
  */
 class Console
 {
-    private const DEFAULT_COMMAND = 'list';
+    /**
+     * @internal
+     */
+    public const DEFAULT_COMMAND = 'list';
+
+    private string $command = '';
 
     /**
      * @var array<string, string|null>
@@ -60,9 +65,9 @@ public function run(array $tokens = [])
             }
         }
 
-        $command = array_shift($arguments) ?? self::DEFAULT_COMMAND;
+        $this->command = array_shift($arguments) ?? self::DEFAULT_COMMAND;
 
-        return service('commands')->run($command, array_merge($arguments, $this->options));
+        return service('commands')->run($this->command, array_merge($arguments, $this->options));
     }
 
     public function initialize(): static
@@ -73,6 +78,14 @@ public function initialize(): static
         return $this;
     }
 
+    /**
+     * Returns the command that is being executed.
+     */
+    public function getCommand(): string
+    {
+        return $this->command;
+    }
+
     /**
      * Displays basic information about the Console.
      *

tests/system/CLI/ConsoleTest.php

@@ -160,6 +160,24 @@ public function testHelpArgumentAndHelpOptionCombined(): void
         $this->assertStringContainsString('Displays basic usage information.', $this->getStreamFilterBuffer());
     }
 
+    public function testConsoleReturnsTheLastExecutedCommand(): void
+    {
+        $console = new Console();
+        $this->assertSame('', $console->getCommand());
+
+        $this->initializeConsole();
+        $console->run();
+        $this->assertSame(Console::DEFAULT_COMMAND, $console->getCommand());
+
+        $this->initializeConsole('help');
+        $console->run();
+        $this->assertSame('help', $console->getCommand());
+
+        $this->initializeConsole('list');
+        $console->run();
+        $this->assertSame('list', $console->getCommand());
+    }
+
     private function initializeConsole(string ...$tokens): void
     {
         service('superglobals')

user_guide_src/source/changelogs/v4.8.0.rst

@@ -172,6 +172,7 @@ Enhancements
 Commands
 ========
 
+- You can now retrieve the last executed command in the console using the new ``Console::getCommand()`` method. This is useful for logging, debugging, or any situation where you need to know which command was run.
 - ``CLI`` now supports the ``--`` separator to mean that what follows are arguments, not options. This allows you to have arguments that start with ``-`` without them being treated as options.
     For example: ``spark my:command -- --myarg`` will pass ``--myarg`` as an argument instead of an option.
 - ``CLI`` now supports options with values specified using an equals sign (e.g., ``--option=value``) in addition to the existing space-separated syntax (e.g., ``--option value``).