Debug server

composer-require-checker.json

@@ -15,6 +15,7 @@
         "Yiisoft\\Cache\\Dependency\\Dependency",
         "Yiisoft\\ErrorHandler\\Event\\ApplicationError",
         "PHPUnit\\Framework\\TestCase",
+        "Yiisoft\\VarDumper\\HandlerInterface",
         "opcache_invalidate"
     ]
 }

config/bootstrap.php

@@ -2,26 +2,35 @@
 
 declare(strict_types=1);
 
+use Psr\Container\ContainerInterface;
+use Yiisoft\VarDumper\Handler\CompositeHandler;
 use Yiisoft\VarDumper\VarDumper;
 use Yiisoft\Yii\Debug\Collector\VarDumperCollector;
 use Yiisoft\Yii\Debug\Collector\VarDumperHandlerInterfaceProxy;
+use Yiisoft\Yii\Debug\DebugServer\VarDumperHandler;
 
 /**
  * @var $params array
  */
 
 return [
-    static function ($container) use ($params) {
+    static function (ContainerInterface $container) use ($params) {
         if (!($params['yiisoft/yii-debug']['enabled'] ?? false)) {
             return;
         }
         if (!$container->has(VarDumperCollector::class)) {
             return;
         }
 
+        $decorated = VarDumper::getDefaultHandler();
+
+        if ($params['yiisoft/yii-debug']['devServer']['enabled'] ?? false) {
+            $decorated = new CompositeHandler([$decorated, new VarDumperHandler()]);
+        }
+
         VarDumper::setDefaultHandler(
             new VarDumperHandlerInterfaceProxy(
-                VarDumper::getDefaultHandler(),
+                $decorated,
                 $container->get(VarDumperCollector::class),
             ),
         );

config/di.php

@@ -5,14 +5,18 @@
 use Composer\Autoload\ClassLoader;
 use Psr\Container\ContainerInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
+use Psr\Log\LoggerInterface;
 use Yiisoft\Aliases\Aliases;
 use Yiisoft\VarDumper\ClosureExporter;
 use Yiisoft\VarDumper\UseStatementParser;
 use Yiisoft\Yii\Debug\Collector\ContainerInterfaceProxy;
 use Yiisoft\Yii\Debug\Collector\ContainerProxyConfig;
+use Yiisoft\Yii\Debug\Collector\LogCollector;
+use Yiisoft\Yii\Debug\Collector\LoggerInterfaceProxy;
 use Yiisoft\Yii\Debug\Collector\ServiceCollector;
 use Yiisoft\Yii\Debug\Collector\Stream\FilesystemStreamCollector;
 use Yiisoft\Yii\Debug\DebuggerIdGenerator;
+use Yiisoft\Yii\Debug\DebugServer\LoggerDecorator;
 use Yiisoft\Yii\Debug\Storage\FileStorage;
 use Yiisoft\Yii\Debug\Storage\StorageInterface;
 
@@ -44,13 +48,23 @@
         $params = $params['yiisoft/yii-debug'];
         $collector = $container->get(ServiceCollector::class);
         $dispatcher = $container->get(EventDispatcherInterface::class);
-        $debuggerEnabled = (bool) ($params['enabled'] ?? false);
+        $isDebuggerEnabled = (bool) ($params['enabled'] ?? false);
+        $isDevServerEnabled = (bool) ($params['devServer']['enabled'] ?? false);
+
         $trackedServices = (array) ($params['trackedServices'] ?? []);
+
+        if ($isDevServerEnabled) {
+            $trackedServices[LoggerInterface::class] = static fn (
+                ContainerInterface $container,
+                LoggerInterface $logger,
+            ) => new LoggerInterfaceProxy(new LoggerDecorator($logger), $container->get(LogCollector::class));
+        }
+
         $path = $container->get(Aliases::class)->get('@runtime/cache/container-proxy');
         $logLevel = $params['logLevel'] ?? ContainerInterfaceProxy::LOG_NOTHING;
 
         return new ContainerProxyConfig(
-            $debuggerEnabled,
+            $isDebuggerEnabled,
             $trackedServices,
             $dispatcher,
             $collector,

config/params.php

@@ -25,6 +25,8 @@
 use Yiisoft\Yii\Debug\Collector\Web\RequestCollector;
 use Yiisoft\Yii\Debug\Collector\Web\WebAppInfoCollector;
 use Yiisoft\Yii\Debug\Command\DebugResetCommand;
+use Yiisoft\Yii\Debug\Command\DebugServerBroadcastCommand;
+use Yiisoft\Yii\Debug\Command\DebugServerCommand;
 
 /**
  * @var $params array
@@ -33,6 +35,9 @@
 return [
     'yiisoft/yii-debug' => [
         'enabled' => true,
+        'devServer' => [
+            'enabled' => true,
+        ],
         'collectors' => [
             LogCollector::class,
             EventCollector::class,
@@ -88,6 +93,8 @@
     'yiisoft/yii-console' => [
         'commands' => [
             'debug:reset' => DebugResetCommand::class,
+            DebugServerCommand::COMMAND_NAME => DebugServerCommand::class,
+            DebugServerBroadcastCommand::COMMAND_NAME => DebugServerBroadcastCommand::class,
         ],
     ],
 ];

src/Collector/ContainerInterfaceProxy.php

@@ -28,8 +28,6 @@ final class ContainerInterfaceProxy implements ContainerInterface
 
     private ProxyManager $proxyManager;
 
-    private array $decoratedServices = [];
-
     private array $serviceProxy = [];
 
     public function __construct(
@@ -60,13 +58,7 @@ public function get($id): mixed
             $this->logProxy(ContainerInterface::class, $this->decorated, 'get', [$id], $instance, $timeStart);
         }
 
-        if (
-            is_object($instance)
-            && (
-                ($proxy = $this->getServiceProxyCache($id)) ||
-                ($proxy = $this->getServiceProxy($id, $instance))
-            )
-        ) {
+        if (is_object($instance) && ($proxy = $this->getServiceProxy($id, $instance))) {
             $this->setServiceProxyCache($id, $proxy);
             return $proxy;
         }
@@ -96,13 +88,12 @@ public function isActive(): bool
         return $this->config->getIsActive() && $this->config->getDecoratedServices() !== [];
     }
 
-    private function getServiceProxyCache(string $service): ?object
-    {
-        return $this->serviceProxy[$service] ?? null;
-    }
-
     private function getServiceProxy(string $service, object $instance): ?object
     {
+        if (isset($this->serviceProxy[$service])) {
+            return $this->serviceProxy[$service];
+        }
+
         if (!$this->isDecorated($service)) {
             return null;
         }

src/Command/DebugServerBroadcastCommand.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+declare(ticks=1);
+
+namespace Yiisoft\Yii\Debug\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Yiisoft\VarDumper\VarDumper;
+use Yiisoft\Yii\Console\ExitCode;
+use Yiisoft\Yii\Debug\DebugServer\Connection;
+
+final class DebugServerBroadcastCommand extends Command
+{
+    public const COMMAND_NAME = 'dev:broadcast';
+    protected static $defaultName = self::COMMAND_NAME;
+
+    protected static $defaultDescription = 'Runs PHP built-in web server';
+
+    public function configure(): void
+    {
+        $this
+            ->setHelp(
+                'Broadcasts a message to all connected clients.'
+            )
+            ->addOption('message', 'm', InputOption::VALUE_OPTIONAL, 'A text to broadcast', 'Test message')
+            ->addOption('env', 'e', InputOption::VALUE_OPTIONAL, 'It is only used for testing.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->title('Yii3 Debug Server');
+        $io->writeln('https://yiiframework.com' . "\n");
+
+        $env = $input->getOption('env');
+        if ($env === 'test') {
+            return ExitCode::OK;
+        }
+
+        $socket = Connection::create();
+        if (\function_exists('pcntl_signal')) {
+            $io->success('Quit the server with CTRL-C or COMMAND-C.');
+
+            \pcntl_signal(\SIGINT, static function () use ($socket): void {
+                $socket->close();
+                exit(1);
+            });
+        }
+
+        $data = $input->getOption('message');
+        $socket->broadcast(Connection::MESSAGE_TYPE_LOGGER, $data);
+        $socket->broadcast(Connection::MESSAGE_TYPE_VAR_DUMPER, VarDumper::create(['$data' => $data])->asJson(false));
+
+        return ExitCode::OK;
+    }
+}

src/Command/DebugServerCommand.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+declare(ticks=1);
+
+namespace Yiisoft\Yii\Debug\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Yiisoft\Yii\Console\ExitCode;
+use Yiisoft\Yii\Debug\DebugServer\Connection;
+
+final class DebugServerCommand extends Command
+{
+    public const COMMAND_NAME = 'dev';
+    protected static $defaultName = self::COMMAND_NAME;
+
+    protected static $defaultDescription = 'Runs PHP built-in web server';
+
+    public function __construct(
+        private readonly string $address = '0.0.0.0',
+        private readonly int $port = 8890,
+    ) {
+        parent::__construct();
+    }
+
+    public function configure(): void
+    {
+        $this
+            ->setHelp(
+                'In order to access server from remote machines use 0.0.0.0:8000. That is especially useful when running server in a virtual machine.'
+            )
+            ->addOption('address', 'a', InputOption::VALUE_OPTIONAL, 'Host to serve at', $this->address)
+            ->addOption('port', 'p', InputOption::VALUE_OPTIONAL, 'Port to serve at', $this->port)
+            ->addOption('env', 'e', InputOption::VALUE_OPTIONAL, 'It is only used for testing.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->title('Yii3 Debug Server');
+        $io->writeln('https://yiiframework.com' . "\n");
+
+        $env = $input->getOption('env');
+        if ($env === 'test') {
+            return ExitCode::OK;
+        }
+
+        $socket = Connection::create();
+        $socket->bind();
+
+        $io->success(
+            sprintf(
+                'Listening on "%s".',
+                $socket->getUri(),
+            )
+        );
+
+        if (\function_exists('pcntl_signal')) {
+            $io->success('Quit the server with CTRL-C or COMMAND-C.');
+
+            \pcntl_signal(\SIGINT, static function () use ($socket): void {
+                $socket->close();
+                exit(1);
+            });
+        }
+
+        foreach ($socket->read() as $message) {
+            if ($message[0] === Connection::TYPE_ERROR) {
+                $io->error('Connection closed with error: ' . $message[1]);
+                break;
+            }
+
+            $data = \json_decode($message[1], null, 512, JSON_THROW_ON_ERROR);
+            $type = match ($data[0]) {
+                Connection::MESSAGE_TYPE_VAR_DUMPER => 'VarDumper',
+                Connection::MESSAGE_TYPE_LOGGER => 'Logger',
+                default => 'Plain text',
+            };
+
+            $io->block($data[1], $type);
+        }
+
+        return ExitCode::OK;
+    }
+}