AJenbo/php-tracer-weaver

<?php namespace PHPWeaver\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * @psalm-suppress UnusedClass
 */
class TraceCommand extends Command
{
    const RETURN_CODE_OK = 0;
    const RETURN_CODE_ERROR = 1;

    /**
     * Set up command parameteres and help message.
     */
    protected function configure(): void
    {
        $this->setName('trace')
            ->setDescription('Traces function signatures in a running PHP script')
            ->addArgument('phpscript', InputArgument::REQUIRED, 'A PHP script to execute and trace')
            ->addArgument('options', InputArgument::OPTIONAL, 'The PHP script is launched with these options')
            ->addOption('tracefile', null, InputOption::VALUE_OPTIONAL, 'Where to save trace', 'dumpfile')
            ->addOption('append', null, InputOption::VALUE_NONE, 'Append to an existing tracefile')
            ->setHelp(<<<EOT
The <info>%command.name%</info> command will execute a PHP script at save the trace data to a file:

    <info>%command.full_name% vendor/bin/phpunit</info>

You can specify parameteres to be passed to the script as the secound argument:

    <info>%command.full_name% vendor/bin/phpunit -- '-c tests/phpunit.xml'</info>

By default the trace will be saved to dumpfile.xt, but you can also specify a path (.xt is automattically appended):

    <info>%command.full_name% vendor/bin/phpunit --tracefile=traces/unitest</info>
EOT
        );
    }

    /**
     * Run the trace process.
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $tracefile = $input->getOption('tracefile');
        if (!is_string($tracefile)) {
            return self::RETURN_CODE_ERROR;
        }
        $append = $input->getOption('append');
        if (!is_bool($append)) {
            return self::RETURN_CODE_ERROR;
        }
        $phpscript = $input->getArgument('phpscript');
        if (!is_string($phpscript)) {
            return self::RETURN_CODE_ERROR;
        }
        $options = $input->getArgument('options') ?? '';
        if (!is_string($options)) {
            return self::RETURN_CODE_ERROR;
        }

        $command = PHP_BINARY;

        /** @var array<string, int|string|bool> $params */
        $params = [
            '-d xdebug.collect_includes'         => 0,
            '-d xdebug.auto_trace'               => 1,
            '-d xdebug.mode'                     => 'trace',
            '-d xdebug.start_with_request'       => 'yes',
            '-d xdebug.trace_options'            => $append,
            '-d xdebug.output_dir'               => getcwd(),
            '-d xdebug.trace_output_dir'         => getcwd(),
            '-d xdebug.trace_output_name'        => $tracefile,
            '-d xdebug.trace_format'             => 1,
            '-d xdebug.collect_params'           => 3, // Track full input value format (same as return format)
            '-d xdebug.collect_return'           => 1,
            '-d xdebug.var_display_max_data'     => 20, // Max length of numbers
            '-d xdebug.var_display_max_children' => 5, // Analyse the 5 first elements when determining array sub-type
            '-d xdebug.var_display_max_depth'    => 1, // 1 depth of array (and classes) to analyze array sub-type
        ];

        foreach ($params as $param => $value) {
            $command .= ' ' . $param . '=' . (string)$value;
        }
        $command .= ' ' . $phpscript . ' ' . $options;

        $output->writeln('Running script with instrumentation: ' . $phpscript . ' ' . $options);
        passthru($command);
        $output->writeln('TRACE COMPLETE');

        return self::RETURN_CODE_OK;
    }
}