Fixes CommandStarting and CommandFinished not working (#1272)

* Fixes `CommandStarting` and `CommandFinished` not working

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* Apply fixes from StyleCI

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

---------

Signed-off-by: Mior Muhammad Zaki <[email protected]>
Co-authored-by: StyleCI Bot <[email protected]>

Author: crynobone

src/Application.php

@@ -1006,6 +1006,7 @@ public function flush()
         $this->router = null;
         $this->dispatcher = null;
         static::$instance = null;
+        static::$aliasesRegistered = false;
     }
 
     /**

src/Console/Kernel.php

@@ -3,14 +3,21 @@
 namespace Laravel\Lumen\Console;
 
 use Illuminate\Console\Application as Artisan;
+use Illuminate\Console\Events\CommandFinished;
+use Illuminate\Console\Events\CommandStarting;
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Console\Scheduling\ScheduleRunCommand;
 use Illuminate\Contracts\Console\Kernel as KernelContract;
 use Illuminate\Contracts\Debug\ExceptionHandler;
+use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Http\Request;
 use Laravel\Lumen\Application;
 use Laravel\Lumen\Exceptions\Handler;
 use RuntimeException;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Throwable;
 
 class Kernel implements KernelContract
@@ -22,6 +29,13 @@ class Kernel implements KernelContract
      */
     protected $app;
 
+    /**
+     * The Symfony event dispatcher implementation.
+     *
+     * @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface|null
+     */
+    protected $symfonyDispatcher;
+
     /**
      * The Artisan application instance.
      *
@@ -55,6 +69,8 @@ public function __construct(Application $app)
 
         if ($this->app->runningInConsole()) {
             $this->setRequestForConsole($this->app);
+        } else {
+            $this->rerouteSymfonyCommandEvents();
         }
 
         $this->app->prepareForConsoleCommand($this->aliases);
@@ -87,6 +103,34 @@ protected function setRequestForConsole(Application $app)
         ));
     }
 
+    /**
+     * Re-route the Symfony command events to their Laravel counterparts.
+     *
+     * @internal
+     *
+     * @return $this
+     */
+    public function rerouteSymfonyCommandEvents()
+    {
+        if (is_null($this->symfonyDispatcher)) {
+            $this->symfonyDispatcher = new EventDispatcher;
+
+            $this->symfonyDispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
+                $this->app[Dispatcher::class]->dispatch(
+                    new CommandStarting($event->getCommand()->getName(), $event->getInput(), $event->getOutput())
+                );
+            });
+
+            $this->symfonyDispatcher->addListener(ConsoleEvents::TERMINATE, function (ConsoleTerminateEvent $event) {
+                $this->app[Dispatcher::class]->dispatch(
+                    new CommandFinished($event->getCommand()->getName(), $event->getInput(), $event->getOutput(), $event->getExitCode())
+                );
+            });
+        }
+
+        return $this;
+    }
+
     /**
      * Define the application's command schedule.
      *
@@ -212,9 +256,14 @@ public function output()
     protected function getArtisan()
     {
         if (is_null($this->artisan)) {
-            return $this->artisan = (new Artisan($this->app, $this->app->make('events'), $this->app->version()))
+            $this->artisan = (new Artisan($this->app, $this->app->make('events'), $this->app->version()))
                                 ->resolveCommands($this->getCommands())
                                 ->setContainerCommandLoader();
+
+            if ($this->symfonyDispatcher instanceof EventDispatcher) {
+                $this->artisan->setDispatcher($this->symfonyDispatcher);
+                $this->artisan->setSignalsToDispatchEvent();
+            }
         }
 
         return $this->artisan;

tests/Console/KernelTest.php

@@ -0,0 +1,42 @@
+<?php
+
+use Illuminate\Console\Events\CommandFinished;
+use Illuminate\Console\Events\CommandStarting;
+use Illuminate\Contracts\Console\Kernel as ConsoleKernelContract;
+use Illuminate\Contracts\Debug\ExceptionHandler as ExceptionHandlerContract;
+use Laravel\Lumen\Application;
+use Laravel\Lumen\Console\Kernel as ConsoleKernel;
+use Laravel\Lumen\Exceptions\Handler as ExceptionHandler;
+
+class KernelTest extends \Laravel\Lumen\Testing\TestCase
+{
+    /**
+     * Creates the application.
+     *
+     * Needs to be implemented by subclasses.
+     *
+     * @return \Symfony\Component\HttpKernel\HttpKernelInterface
+     */
+    public function createApplication()
+    {
+        $app = new Application();
+
+        $app->configure('app');
+
+        $app->singleton(ExceptionHandlerContract::class, fn () => new ExceptionHandler());
+        $app->singleton(ConsoleKernelContract::class, function () use ($app) {
+            return tap(new ConsoleKernel($app), function ($kernel) {
+                $kernel->rerouteSymfonyCommandEvents();
+            });
+        });
+
+        return $app;
+    }
+
+    public function testItCanRerouteToSymfonyEvent()
+    {
+        $this->expectsEvents([CommandStarting::class, CommandFinished::class]);
+
+        $this->artisan('cache:forget', ['key' => 'lumen']);
+    }
+}

tests/FullApplicationTest.php

@@ -4,6 +4,7 @@
 use Illuminate\Contracts\Debug\ExceptionHandler;
 use Illuminate\Contracts\Validation\Factory;
 use Illuminate\Http\Response;
+use Illuminate\Support\Facades\Facade;
 use Illuminate\View\ViewServiceProvider;
 use Laravel\Lumen\Application;
 use Laravel\Lumen\Console\ConsoleServiceProvider;
@@ -16,6 +17,11 @@
 
 class FullApplicationTest extends TestCase
 {
+    protected function setUp(): void
+    {
+        Facade::clearResolvedInstances();
+    }
+
     protected function tearDown(): void
     {
         m::close();