Support for artisan serve (built-in php dev server) (#4)

* Support `artisan serve` output forwarding

* Update readme

Author: Mitchell Macpherson

README.md

@@ -94,6 +94,9 @@ Unit tests ensure type-compatibility, expected behaviour is met & compatibility
 ---
 # Features
 
+## Artisan serve supported
+Logger output will be shown in your local development server console.
+
 ## Literally Effortless
 
 Your application **will not be coupled** with ConsoleLogg.

src/Binder/LogOutputBinder.php

@@ -6,10 +6,9 @@
 
 use DevThis\ConsoleLogg\Interfaces\Binder\LogOutputBindedInterface;
 use DevThis\ConsoleLogg\Interfaces\Factories\FilterableConsoleLoggerFactoryInterface;
-use Illuminate\Console\Events\CommandFinished;
-use Illuminate\Console\Events\CommandStarting;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Log\LogManager;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Responsible for binding a ConsoleLogger instance with the built-in Laravel Logger, and removing
@@ -39,12 +38,12 @@ public function __construct(FilterableConsoleLoggerFactoryInterface $consoleLogg
         $this->consoleLoggerFactory = $consoleLoggerFactory;
     }
 
-    public function attach(CommandStarting $commandEvent, LogManager $logManager): void
+    public function attach(OutputInterface $output, LogManager $logManager): void
     {
         $this->defaultDriver = $logManager->getDefaultDriver();
         $logManager->setDefaultDriver('console-logg');
 
-        $consoleLogger = $this->consoleLoggerFactory->create($commandEvent->output, $this->isFiltered);
+        $consoleLogger = $this->consoleLoggerFactory->create($output, $this->isFiltered);
 
         $logManager->extend(
             'console-logg',
@@ -54,7 +53,7 @@ function () use ($consoleLogger) {
         );
     }
 
-    public function detach(CommandFinished $commandFinished, LogManager $logManager): void
+    public function detach(LogManager $logManager): void
     {
         $logManager->forgetChannel('console-logg');
         $logManager->setDefaultDriver($this->defaultDriver);

src/Interfaces/Binder/LogOutputBindedInterface.php

@@ -4,13 +4,12 @@
 
 namespace DevThis\ConsoleLogg\Interfaces\Binder;
 
-use Illuminate\Console\Events\CommandFinished;
-use Illuminate\Console\Events\CommandStarting;
 use Illuminate\Log\LogManager;
+use Symfony\Component\Console\Output\OutputInterface;
 
 interface LogOutputBindedInterface
 {
-    public function attach(CommandStarting $commandEvent, LogManager $logManager): void;
+    public function attach(OutputInterface $output, LogManager $logManager): void;
 
-    public function detach(CommandFinished $commandFinished, LogManager $logManager): void;
+    public function detach(LogManager $logManager): void;
 }

src/Listeners/LogManagerResolverListener.php

@@ -11,6 +11,7 @@
 use Illuminate\Contracts\Events\Dispatcher as EventDispatcher;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Log\LogManager;
+use Symfony\Component\Console\Output\StreamOutput;
 
 class LogManagerResolverListener implements LogManagerResolverListenerInterface
 {
@@ -35,18 +36,31 @@ public function __construct(EventDispatcher $eventDispatcher, LogOutputBindedInt
      */
     public function handle(LogManager $logManager, Application $application): void
     {
+        if ($this->isCliServer() === true) {
+            // Parent process forwards standard output
+            $output = new StreamOutput(\fopen('php://stdout', 'wb'));
+            $this->logOutputBinder->attach($output, $logManager);
+
+            return;
+        }
+
         $this->eventDispatcher->listen(
             CommandStarting::class,
             function (CommandStarting $event) use ($logManager) {
-                $this->logOutputBinder->attach($event, $logManager);
+                $this->logOutputBinder->attach($event->output, $logManager);
             }
         );
 
         $this->eventDispatcher->listen(
             CommandFinished::class,
             function (CommandFinished $event) use ($logManager) {
-                $this->logOutputBinder->detach($event, $logManager);
+                $this->logOutputBinder->detach($logManager);
             }
         );
     }
+
+    protected function isCliServer(): bool
+    {
+        return PHP_SAPI === 'cli-server';
+    }
 }

src/Providers/ConsoleLoggServiceProvider.php

@@ -40,7 +40,8 @@ public function boot()
      */
     public function register()
     {
-        if ($this->app->runningInConsole() === false) {
+        // Support built-in PHP dev server or console kernel
+        if (PHP_SAPI !== 'cli-server' && $this->app->runningInConsole() === false) {
             return;
         }
 

tests/Doubles/Spies/Binder/LogOutputBinderFake.php

@@ -5,45 +5,38 @@
 namespace Tests\Doubles\Spies\Binder;
 
 use DevThis\ConsoleLogg\Interfaces\Binder\LogOutputBindedInterface;
-use Illuminate\Console\Events\CommandFinished;
-use Illuminate\Console\Events\CommandStarting;
 use Illuminate\Log\LogManager;
+use Symfony\Component\Console\Output\OutputInterface;
 
 class LogOutputBinderFake implements LogOutputBindedInterface
 {
-    private $lastAttachEvent = null;
-
     private $lastAttachLogManager = null;
 
+    private $lastAttachOutput = null;
+
     private $lastDetachEvent = null;
 
     private $lastDetachLogManager = null;
 
-    public function attach(CommandStarting $commandEvent, LogManager $logManager): void
+    public function attach(OutputInterface $output, LogManager $logManager): void
     {
-        $this->lastAttachEvent = $commandEvent;
+        $this->lastAttachOutput = $output;
         $this->lastAttachLogManager = $logManager;
     }
 
-    public function detach(CommandFinished $commandFinished, LogManager $logManager): void
+    public function detach(LogManager $logManager): void
     {
-        $this->lastDetachEvent = $commandFinished;
         $this->lastDetachLogManager = $logManager;
     }
 
-    public function getLastAttachEvent(): ?CommandStarting
-    {
-        return $this->lastAttachEvent;
-    }
-
     public function getLastAttachLogManager(): ?LogManager
     {
         return $this->lastAttachLogManager;
     }
 
-    public function getLastDetachEvent(): ?CommandFinished
+    public function getLastAttachOutput(): ?OutputInterface
     {
-        return $this->lastDetachEvent;
+        return $this->lastAttachOutput;
     }
 
     public function getLastDetachLogManager(): ?LogManager

tests/Unit/Binder/LogOutputBinderTest.php

@@ -5,11 +5,8 @@
 namespace Tests\Unit\Binder;
 
 use DevThis\ConsoleLogg\Binder\LogOutputBinder;
-use Illuminate\Console\Events\CommandFinished;
-use Illuminate\Console\Events\CommandStarting;
 use Illuminate\Log\LogManager;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Console\Input\StringInput;
 use Symfony\Component\Console\Output\NullOutput;
 use Tests\Doubles\Fakes\vendor\Illuminate\ApplicationFake;
 use Tests\Doubles\Spies\Factories\FilterableConsoleLoggerFactorySpy;
@@ -26,13 +23,12 @@ public function testAttachSetsDefaultDriver(): void
         $config = new RepositoryStub();
         $filterableConsoleLoggerFactory = new FilterableConsoleLoggerFactorySpy();
         $logOutputBinder = new LogOutputBinder($filterableConsoleLoggerFactory, $config);
-        $stringInput = new StringInput('some:command');
-        $commandStarting = new CommandStarting('Some\Command', $stringInput, new NullOutput());
+        $output = new NullOutput();
         $app = new ApplicationFake(['config' => ['logging.default' => ['driver' => 'the-default']]]);
         $logManager = new LogManager($app);
         $expectation = 'console-logg';
 
-        $logOutputBinder->attach($commandStarting, $logManager);
+        $logOutputBinder->attach($output, $logManager);
 
         self::assertSame($expectation, $logManager->getDefaultDriver());
     }
@@ -42,14 +38,12 @@ public function testAttachedConsoleLoggerRespectsFilteredOption(): void
         $config = new RepositoryStub();
         $filterableConsoleLoggerFactory = new FilterableConsoleLoggerFactorySpy();
         $logOutputBinder = new LogOutputBinder($filterableConsoleLoggerFactory, $config);
-        $stringInput = new StringInput('some:command');
         $output = new NullOutput();
-        $commandStarting = new CommandStarting('Some\Command', $stringInput, $output);
         $defaultDriver = ['driver' => 'the-default'];
         $app = new ApplicationFake(['config' => ['logging.default' => $defaultDriver]]);
         $logManager = new LogManagerSpy($app);
 
-        $logOutputBinder->attach($commandStarting, $logManager);
+        $logOutputBinder->attach($output, $logManager);
 
         self::assertEquals(
             $filterableConsoleLoggerFactory->getLastCreated(),
@@ -62,15 +56,13 @@ public function testDefaultDriverAfterDetachIsNotConsoleLogg(): void
         $config = new RepositoryStub();
         $filterableConsoleLoggerFactory = new FilterableConsoleLoggerFactorySpy();
         $logOutputBinder = new LogOutputBinder($filterableConsoleLoggerFactory, $config);
-        $stringInput = new StringInput('some:command');
-        $commandStarting = new CommandStarting('Some\Command', $stringInput, new NullOutput());
-        $commandFinished = new CommandFinished('Some\Command', $stringInput, new NullOutput(), 0);
+        $output = new NullOutput();
         $defaultDriver = ['driver' => 'the-default'];
         $app = new ApplicationFake(['config' => ['logging.default' => $defaultDriver]]);
         $logManager = new LogManager($app);
 
-        $logOutputBinder->attach($commandStarting, $logManager);
-        $logOutputBinder->detach($commandFinished, $logManager);
+        $logOutputBinder->attach($output, $logManager);
+        $logOutputBinder->detach($logManager);
 
         self::assertSame($defaultDriver, $logManager->getDefaultDriver());
     }

tests/Unit/Listeners/LogManagerResolverListenerTest.php

@@ -12,6 +12,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Input\StringInput;
 use Symfony\Component\Console\Output\NullOutput;
+use Symfony\Component\Console\Output\StreamOutput;
 use Tests\Doubles\Fakes\vendor\Illuminate\ApplicationFake;
 use Tests\Doubles\Fakes\vendor\Illuminate\EventDispatcherFake;
 use Tests\Doubles\Spies\Binder\LogOutputBinderFake;
@@ -30,6 +31,35 @@ public function getInputsForEventDispatchListeningTo(): iterable
         yield 'CommandFinished' => [CommandFinished::class];
     }
 
+    public function testCliServerDetection(): void
+    {
+        $eventDispatcher = new EventDispatcherFake();
+        $logOutputBinder = new LogOutputBinderFake();
+        $logManagerResolverListener = new class($eventDispatcher, $logOutputBinder) extends LogManagerResolverListener {
+            protected function isCliServer(): bool
+            {
+                return true;
+            }
+        };
+        $app = new ApplicationFake();
+        $logManager = new LogManager($app);
+        $logManagerResolverListener->handle($logManager, $app);
+
+        self::assertInstanceOf(StreamOutput::class, $logOutputBinder->getLastAttachOutput());
+    }
+
+    public function testCliServerSkips(): void
+    {
+        $eventDispatcher = new EventDispatcherFake();
+        $logOutputBinder = new LogOutputBinderFake();
+        $logManagerResolverListener = new LogManagerResolverListener($eventDispatcher, $logOutputBinder);
+        $app = new ApplicationFake();
+        $logManager = new LogManager($app);
+        $logManagerResolverListener->handle($logManager, $app);
+
+        self::assertNotInstanceOf(StreamOutput::class, $logOutputBinder->getLastAttachOutput());
+    }
+
     /**
      * Slightly weak test
      * Testing the spy doesn't prove with certainty
@@ -69,16 +99,13 @@ public function testEventListenerAttachesLogManager(): void
         $app = new ApplicationFake();
         $logManager = new LogManager($app);
         $logManagerResolverListener->handle($logManager, $app);
-        $event = new CommandStarting('some:command', new StringInput(''), new NullOutput());
-        $actualBeforeEvent = $logOutputBinder->getLastAttachEvent();
-        $expectedBeforeEvent = null;
-        $expectedAfterEvent = $event;
+        $output = new NullOutput();
+        $event = new CommandStarting('some:command', new StringInput(''), $output);
         // @todo stubs with Input/Output interface
         $closure = $eventDispatcher->getListener(CommandStarting::class);
         $closure($event, new LogManagerStub());
 
-        self::assertSame($expectedAfterEvent, $logOutputBinder->getLastAttachEvent());
-        self::assertSame($expectedBeforeEvent, $actualBeforeEvent);
+        self::assertSame($output, $logOutputBinder->getLastAttachOutput());
     }
 
     /**
@@ -95,13 +122,13 @@ public function testEventListenerDetachesLogManager(): void
         $logManager = new LogManager($app);
         $logManagerResolverListener->handle($logManager, $app);
         $event = new CommandFinished('some:command', new StringInput(''), new NullOutput(), 1);
-        $actualBeforeEvent = $logOutputBinder->getLastDetachEvent();
+        $actualBeforeEvent = $logOutputBinder->getLastDetachLogManager();
         $expectedBeforeEvent = null;
-        $expectedAfterEvent = $event;
+        $expectedAfterEvent = $logManager;
         $closure = $eventDispatcher->getListener(CommandFinished::class);
-        $closure($event, new LogManagerStub());
+        $closure($event, $logManager);
 
-        self::assertSame($expectedAfterEvent, $logOutputBinder->getLastDetachEvent());
         self::assertSame($expectedBeforeEvent, $actualBeforeEvent);
+        self::assertSame($expectedAfterEvent, $logOutputBinder->getLastDetachLogManager());
     }
 }