yiisoft / yii-debug

src/Collector/Console/CommandCollector.php

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Collector\Console;

use RuntimeException;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\Console\Event\ConsoleErrorEvent;
use Symfony\Component\Console\Event\ConsoleEvent;
use Symfony\Component\Console\Event\ConsoleTerminateEvent;
use Yiisoft\Yii\Debug\Collector\CollectorInterface;
use Yiisoft\Yii\Debug\Collector\CollectorTrait;
use Yiisoft\Yii\Debug\Collector\IndexCollectorInterface;

use function is_object;

final class CommandCollector implements CollectorInterface, IndexCollectorInterface
{
    use CollectorTrait;

    /**
     * Let -1 mean that it was not set during the process.
     */
    private const UNDEFINED_EXIT_CODE = -1;
    private array $commands = [];

    public function getCollected(): array
    {
        return $this->commands;
    }

    public function collect(ConsoleEvent|ConsoleErrorEvent|ConsoleTerminateEvent $event): void
    {
        if (!is_object($event) || !$this->isActive()) {
            return;
        }

        $command = $event->getCommand();

        if ($event instanceof ConsoleErrorEvent) {
            $this->commands[$event::class] = [
                'name' => $event->getInput()->getFirstArgument() ?? '',
                'command' => $command,
                'input' => $event->getInput()->__toString(),

The method __toString() does not exist on Symfony\Component\Console\Input\InputInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Symfony\Component\Console\Input\StreamableInputInterface or Symfony\Component\Console\Input\Input or Symfony\Component\Console\Input\Input. Are you sure you never get one of those?

                'output' => $event->getOutput()->fetch(),

The method fetch() does not exist on Symfony\Component\Console\Output\OutputInterface. It seems like you code against a sub-type of Symfony\Component\Console\Output\OutputInterface such as Symfony\Component\Console\Output\BufferedOutput or Symfony\Component\Console\Output\TrimmedBufferOutput or Yiisoft\Yii\Console\Output\ConsoleBufferedOutput or Yiisoft\Yii\Console\Output\ConsoleBufferedOutput.

                'error' => $event->getError()->getMessage(),
                'exitCode' => $event->getExitCode(),
            ];

            return;
        }

        if ($event instanceof ConsoleTerminateEvent) {
            $this->commands[$event::class] = [
                'name' => $command->getName(),
                'command' => $command,
                'input' => $event->getInput()->__toString(),
                'output' => $event->getOutput()->fetch(),
                'exitCode' => $event->getExitCode(),
            ];
            return;
        }

        if ($event instanceof ConsoleEvent) {
            $this->commands[$event::class] = [
                'name' => $command->getName(),
                'command' => $command,
                'input' => $event->getInput()->__toString(),
                'output' => $event->getOutput()->fetch(),
                'arguments' => $command->getDefinition()->getArguments(),
                'options' => $command->getDefinition()->getOptions(),
            ];
        }
    }

    public function getIndexData(): array
    {
        $eventTypes = [
            ConsoleErrorEvent::class,
            ConsoleTerminateEvent::class,
            ConsoleCommandEvent::class,
        ];

        $commandEvent = null;
        foreach ($eventTypes as $eventType) {
            if (!array_key_exists($eventType, $this->commands)) {
                continue;
            }

            $commandEvent = $this->commands[$eventType];
            break;
        }

        if ($commandEvent === null) {
            $types = array_keys($this->commands);
            throw new RuntimeException(
                sprintf(
                    'Unsupported event type encountered among "%s". Supported only "%s"',
                    implode('", "', $types),
                    implode('", "', $eventTypes),
                )
            );
        }

        return [
            'command' => [
                'name' => $commandEvent['name'],
                'class' => $commandEvent['command'] instanceof Command ? $commandEvent['command']::class : null,
                'input' => $commandEvent['input'],
                'exitCode' => $commandEvent['exitCode'] ?? self::UNDEFINED_EXIT_CODE,
            ],
        ];
    }

    private function reset(): void
    {
        $this->commands = [];
    }
}