[Monolog] Use stream helper and test server:log command

louismariegaborit · louismariegaborit · commit 0131c92858a2 · 2024-01-11T21:00:22.000+01:00
diff --git a/src/Symfony/Bridge/Monolog/Command/ServerLogCommand.php b/src/Symfony/Bridge/Monolog/Command/ServerLogCommand.php
@@ -20,7 +20,6 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\LogicException;
-use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -34,7 +33,6 @@ class ServerLogCommand extends Command
 {
     private const BG_COLOR = ['black', 'blue', 'cyan', 'green', 'magenta', 'red', 'white', 'yellow'];
 
-    private ExpressionLanguage $el;
     private HandlerInterface $handler;
 
     public function isEnabled(): bool
@@ -78,12 +76,13 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $el = null;
         $filter = $input->getOption('filter');
         if ($filter) {
             if (!class_exists(ExpressionLanguage::class)) {
                 throw new LogicException('Package "symfony/expression-language" is required to use the "filter" option. Try running "composer require symfony/expression-language".');
             }
-            $this->el = new ExpressionLanguage();
+            $el = new ExpressionLanguage();
         }
 
         $this->handler = new ConsoleHandler($output, true, [
@@ -101,49 +100,28 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $host = 'tcp://'.$host;
         }
 
-        if (!$socket = stream_socket_server($host, $errno, $errstr)) {
-            throw new RuntimeException(sprintf('Server start failed on "%s": ', $host).$errstr.' '.$errno);
-        }
-
-        foreach ($this->getLogs($socket) as $clientId => $message) {
-            $record = unserialize(base64_decode($message));
+        $streamHelper = $this->getHelper('stream');
+        $streamHelper->listen(
+            $input,
+            $output,
+            $host,
+            function (int $clientId, string $message) use ($el, $filter, $output) {
+                $record = unserialize(base64_decode($message));
+
+                // Impossible to decode the message, give up.
+                if (false === $record) {
+                    return;
+                }
 
-            // Impossible to decode the message, give up.
-            if (false === $record) {
-                continue;
-            }
+                if ($filter && !$el->evaluate($filter, $record)) {
+                    return;
+                }
 
-            if ($filter && !$this->el->evaluate($filter, $record)) {
-                continue;
+                $this->displayLog($output, $clientId, $record);
             }
+        );
 
-            $this->displayLog($output, $clientId, $record);
-        }
-
-        return 0;
-    }
-
-    private function getLogs($socket): iterable
-    {
-        $sockets = [(int) $socket => $socket];
-        $write = [];
-
-        while (true) {
-            $read = $sockets;
-            stream_select($read, $write, $write, null);
-
-            foreach ($read as $stream) {
-                if ($socket === $stream) {
-                    $stream = stream_socket_accept($socket);
-                    $sockets[(int) $stream] = $stream;
-                } elseif (feof($stream)) {
-                    unset($sockets[(int) $stream]);
-                    fclose($stream);
-                } else {
-                    yield (int) $stream => fgets($stream);
-                }
-            }
-        }
+        return Command::SUCCESS;
     }
 
     private function displayLog(OutputInterface $output, int $clientId, array $record): void
diff --git a/src/Symfony/Bridge/Monolog/Tests/Command/ServerLogCommandTest.php b/src/Symfony/Bridge/Monolog/Tests/Command/ServerLogCommandTest.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Tests\Command;
+
+use Monolog\Level;
+use Monolog\LogRecord;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Monolog\Command\ServerLogCommand;
+use Symfony\Component\Console\Helper\HelperSet;
+use Symfony\Component\Console\Helper\StreamHelper;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class ServerLogCommandTest extends TestCase
+{
+    public function testServerLogSuccess()
+    {
+        $command = $this->createCommand();
+        $commandTester = new CommandTester($command);
+
+        $record = new LogRecord(
+            new \DateTimeImmutable('2024-01-02 18:05'),
+            'console',
+            Level::Info,
+            'test log command',
+        );
+        $recordFormatted = $record->toArray();
+        $input = base64_encode(serialize($recordFormatted))."\n";
+
+        $commandTester->setInputs([$input]);
+
+        $commandTester->execute([]);
+
+        $commandTester->assertCommandIsSuccessful();
+
+        $output = $commandTester->getDisplay();
+        $this->assertStringContainsString('18:05:00 INFO      [console] test log command', $output);
+    }
+
+    private function createCommand(): ServerLogCommand
+    {
+        $command = new ServerLogCommand();
+        $command->setHelperSet(new HelperSet([new StreamHelper()]));
+
+        return $command;
+    }
+}
diff --git a/src/Symfony/Component/Console/Tests/Helper/StreamHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/StreamHelperTest.php
