Don't break processing if a single file fails. (#24)

Author: floriankraemer

src/Application.php

@@ -9,13 +9,15 @@
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Baseline;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\CognitiveMetricsCollector;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\FileProcessed;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\ParserFailed;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\SourceFilesFound;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Parser;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\ScoreCalculator;
 use Phauthentic\CognitiveCodeAnalysis\Business\DirectoryScanner;
 use Phauthentic\CognitiveCodeAnalysis\Business\MetricsFacade;
 use Phauthentic\CognitiveCodeAnalysis\Command\ChurnCommand;
 use Phauthentic\CognitiveCodeAnalysis\Command\CognitiveMetricsCommand;
+use Phauthentic\CognitiveCodeAnalysis\Command\EventHandler\ParserErrorHandler;
 use Phauthentic\CognitiveCodeAnalysis\Command\EventHandler\ProgressBarHandler;
 use Phauthentic\CognitiveCodeAnalysis\Command\EventHandler\VerboseHandler;
 use Phauthentic\CognitiveCodeAnalysis\Command\Handler\ChurnReportHandler;
@@ -177,6 +179,9 @@ private function configureEventBus(): void
                 $progressbar,
                 $verbose
             ],
+            ParserFailed::class => [
+                new ParserErrorHandler($this->get(OutputInterface::class))
+            ],
         ]);
 
         $messageBus = new MessageBus([

src/Business/Cognitive/CognitiveMetricsCollector.php

@@ -5,6 +5,7 @@
 namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\FileProcessed;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\ParserFailed;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\SourceFilesFound;
 use Phauthentic\CognitiveCodeAnalysis\Business\DirectoryScanner;
 use Phauthentic\CognitiveCodeAnalysis\CognitiveAnalysisException;
@@ -13,6 +14,7 @@
 use SplFileInfo;
 use Symfony\Component\Messenger\Exception\ExceptionInterface;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Throwable;
 
 /**
  * CognitiveMetricsCollector class that collects cognitive metrics from source files
@@ -69,16 +71,24 @@ private function getCodeFromFile(SplFileInfo $file): string
      *
      * @param iterable<SplFileInfo> $files
      * @return CognitiveMetricsCollection
-     * @throws CognitiveAnalysisException|ExceptionInterface
+     * @throws ExceptionInterface
      */
     private function findMetrics(iterable $files): CognitiveMetricsCollection
     {
         $metricsCollection = new CognitiveMetricsCollection();
 
         foreach ($files as $file) {
-            $metrics = $this->parser->parse(
-                $this->getCodeFromFile($file)
-            );
+            try {
+                $metrics = $this->parser->parse(
+                    $this->getCodeFromFile($file)
+                );
+            } catch (Throwable $exception) {
+                $this->messageBus->dispatch(new ParserFailed(
+                    $file,
+                    $exception
+                ));
+                continue;
+            }
 
             $metricsCollection = $this->processMethodMetrics(
                 $metrics,

src/Business/Cognitive/Events/FileProcessed.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events;
 
 use SplFileInfo;

src/Business/Cognitive/Events/ParserFailed.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events;
+
+use SplFileInfo;
+use Throwable;
+
+/**
+ *
+ */
+class ParserFailed
+{
+    public function __construct(
+        public readonly SplFileInfo $file,
+        public readonly Throwable $throwable
+    ) {
+    }
+}

src/Business/Cognitive/Events/SourceFilesFound.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events;
 
 use SplFileInfo;

src/Command/EventHandler/ParserErrorHandler.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\CognitiveCodeAnalysis\Command\EventHandler;
+
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Events\ParserFailed;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ParserErrorHandler
+{
+    public function __construct(
+        private readonly OutputInterface $output,
+    ) {
+    }
+
+    public function __invoke(ParserFailed $event): void
+    {
+        $this->output->writeln(
+            sprintf(
+                '<error>Parser failed for file %s: %s</error>',
+                $event->file->getRealPath(),
+                $event->throwable->getMessage()
+            )
+        );
+        $this->output->writeln(
+            sprintf(
+                '<comment>Stack trace:</comment> %s',
+                $event->throwable->getTraceAsString()
+            )
+        );
+        $this->output->writeln(
+            sprintf(
+                '<info>Please create an issue on Github and provide the code that could not pe parsed.</info> %s',
+                $event->throwable->getTraceAsString()
+            )
+        );
+    }
+}