Merge pull request #365 from reliforp/improve-speedscope-converter

Add a configuration option to the speedscope converter for the handling of utf8 errors

src/Command/Converter/SpeedscopeCommand.php

@@ -14,6 +14,7 @@
 namespace Reli\Command\Converter;
 
 use Reli\Converter\PhpSpyCompatibleParser;
+use Reli\Converter\Speedscope\Settings\SpeedscopeConverterSettingsFromConsoleInput;
 use Reli\Converter\Speedscope\SpeedscopeConverter;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -24,6 +25,7 @@ final class SpeedscopeCommand extends Command
     public function __construct(
         private SpeedscopeConverter $speedscope_converter,
         private PhpSpyCompatibleParser $parser,
+        private SpeedscopeConverterSettingsFromConsoleInput $settings_from_console_input,
     ) {
         parent::__construct();
     }
@@ -33,16 +35,21 @@ public function configure(): void
         $this->setName('converter:speedscope')
             ->setDescription('convert traces to the speedscope file format')
         ;
+        $this->settings_from_console_input->setOptions($this);
     }
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
+        $settings = $this->settings_from_console_input->createSettings($input);
+
         $output->write(
             \json_encode(
                 $this->speedscope_converter->collectFrames(
-                    $this->parser->parseFile(STDIN)
+                    $this->parser->parseFile(STDIN),
+                    $settings,
                 ),
-            )
+                JSON_THROW_ON_ERROR | $settings->utf8_error_handling_type->toFlag(),
+            ),
         );
         return 0;
     }

src/Converter/Speedscope/Settings/SpeedscopeConverterSettings.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * This file is part of the reliforp/reli-prof package.
+ *
+ * (c) sji <sji@sj-i.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Reli\Converter\Speedscope\Settings;
+
+final class SpeedscopeConverterSettings
+{
+    public function __construct(
+        public Utf8ErrorHandlingType $utf8_error_handling_type,
+    ) {
+    }
+}

src/Converter/Speedscope/Settings/SpeedscopeConverterSettingsException.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is part of the reliforp/reli-prof package.
+ *
+ * (c) sji <sji@sj-i.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Reli\Converter\Speedscope\Settings;
+
+use Reli\Inspector\Settings\InspectorSettingsException;
+
+final class SpeedscopeConverterSettingsException extends InspectorSettingsException
+{
+    public const UNSUPPORTED_UTF8_ERROR_HANDLING = 1;
+
+    protected const ERRORS = [
+        self::UNSUPPORTED_UTF8_ERROR_HANDLING => 'unsupported utf8 error handling type is specified',
+    ];
+}

src/Converter/Speedscope/Settings/SpeedscopeConverterSettingsFromConsoleInput.php

@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * This file is part of the reliforp/reli-prof package.
+ *
+ * (c) sji <sji@sj-i.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Reli\Converter\Speedscope\Settings;
+
+use PhpCast\Cast;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+
+final class SpeedscopeConverterSettingsFromConsoleInput
+{
+    /** @codeCoverageIgnore */
+    public function setOptions(Command $command): void
+    {
+        $command
+            ->addOption(
+                'utf8-errors',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'utf8 error handling type (ignore|substitute|fail)',
+                'ignore'
+            );
+        ;
+    }
+
+    public function createSettings(InputInterface $input): SpeedscopeConverterSettings
+    {
+        return new SpeedscopeConverterSettings(
+            $this->utf8ErrorHandlingTypeFromString(
+                Cast::toString($input->getOption('utf8-errors'))
+            ),
+        );
+    }
+
+    private function utf8ErrorHandlingTypeFromString(string $input): Utf8ErrorHandlingType
+    {
+        return match ($input) {
+            'substitute' => Utf8ErrorHandlingType::Substitute,
+            'ignore' => Utf8ErrorHandlingType::Ignore,
+            'fail' => Utf8ErrorHandlingType::Fail,
+            default => throw SpeedscopeConverterSettingsException::create(
+                SpeedscopeConverterSettingsException::UNSUPPORTED_UTF8_ERROR_HANDLING
+            ),
+        };
+    }
+}

src/Converter/Speedscope/Settings/Utf8ErrorHandlingType.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * This file is part of the reliforp/reli-prof package.
+ *
+ * (c) sji <sji@sj-i.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Reli\Converter\Speedscope\Settings;
+
+enum Utf8ErrorHandlingType
+{
+    case Ignore;
+    case Substitute;
+    case Fail;
+
+    public function toFlag(): int
+    {
+        return match ($this) {
+            self::Ignore => \JSON_INVALID_UTF8_IGNORE,
+            self::Substitute => \JSON_INVALID_UTF8_SUBSTITUTE,
+            self::Fail => 0,
+        };
+    }
+}

src/Converter/Speedscope/SpeedscopeConverter.php

@@ -14,14 +14,18 @@
 namespace Reli\Converter\Speedscope;
 
 use Reli\Converter\ParsedCallTrace;
+use Reli\Converter\Speedscope\Settings\SpeedscopeConverterSettings;
 
 class SpeedscopeConverter
 {
     /** @param iterable<ParsedCallTrace> $call_frames */
-    public function collectFrames(iterable $call_frames): array
-    {
+    public function collectFrames(
+        iterable $call_frames,
+        SpeedscopeConverterSettings $settings,
+    ): array {
         $mapper = fn(array $value): string | false => \json_encode(
             $value,
+            $settings->utf8_error_handling_type->toFlag()
         );
         $trace_map = [];
         $result_frames = [];