Reduce number of file_get_contents() and hash() calls

Author: sebastianbergmann

ChangeLog-12.2.md

@@ -8,6 +8,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 * [#1074](https://github.com/sebastianbergmann/php-code-coverage/issues/1074): Use more efficient `AttributeParentConnectingVisitor`
 * [#1076](https://github.com/sebastianbergmann/php-code-coverage/issues/1076): Replace unmaintained JavaScript library for charts with billboard.js
+* Reduced number of I/O and hashing operations when using the static analysis cache
 * Use SHA-256 instead of MD5 to generate cache keys for static analysis cache (as SHA-256 is significantly faster than MD5 with PHP >= 8.4 on modern CPUs)
 
 [12.2.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/12.1.2...main

src/CodeCoverage.php

@@ -25,9 +25,9 @@
 use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Node\Builder;
 use SebastianBergmann\CodeCoverage\Node\Directory;
-use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingFileAnalyser;
+use SebastianBergmann\CodeCoverage\StaticAnalysis\CachingSourceAnalyser;
 use SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser;
-use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingFileAnalyser;
+use SebastianBergmann\CodeCoverage\StaticAnalysis\ParsingSourceAnalyser;
 use SebastianBergmann\CodeCoverage\Test\Target\MapBuilder;
 use SebastianBergmann\CodeCoverage\Test\Target\Mapper;
 use SebastianBergmann\CodeCoverage\Test\Target\TargetCollection;
@@ -436,7 +436,7 @@ private function applyExecutableLinesFilter(RawCodeCoverageData $data): void
                 continue;
             }
 
-            $linesToBranchMap = $this->analyser()->executableLinesIn($filename);
+            $linesToBranchMap = $this->analyser()->analyse($filename)->executableLines();
 
             $data->keepLineCoverageDataOnlyForLines(
                 $filename,
@@ -459,7 +459,7 @@ private function applyIgnoredLinesFilter(RawCodeCoverageData $data): void
 
             $data->removeCoverageDataForLines(
                 $filename,
-                $this->analyser()->ignoredLinesFor($filename),
+                $this->analyser()->analyse($filename)->ignoredLines(),
             );
         }
     }
@@ -627,20 +627,21 @@ private function analyser(): FileAnalyser
             return $this->analyser;
         }
 
-        $this->analyser = new ParsingFileAnalyser(
-            $this->useAnnotationsForIgnoringCode,
-            $this->ignoreDeprecatedCode,
-        );
+        $sourceAnalyser = new ParsingSourceAnalyser;
 
         if ($this->cachesStaticAnalysis()) {
-            $this->analyser = new CachingFileAnalyser(
+            $sourceAnalyser = new CachingSourceAnalyser(
                 $this->cacheDirectory,
-                $this->analyser,
-                $this->useAnnotationsForIgnoringCode,
-                $this->ignoreDeprecatedCode,
+                $sourceAnalyser,
             );
         }
 
+        $this->analyser = new FileAnalyser(
+            $sourceAnalyser,
+            $this->useAnnotationsForIgnoringCode,
+            $this->ignoreDeprecatedCode,
+        );
+
         return $this->analyser;
     }
 }

src/Data/RawCodeCoverageData.php

@@ -90,7 +90,7 @@ public static function fromUncoveredFile(string $filename, FileAnalyser $analyse
     {
         $lineCoverage = array_map(
             static fn (): int => Driver::LINE_NOT_EXECUTED,
-            $analyser->executableLinesIn($filename),
+            $analyser->analyse($filename)->executableLines(),
         );
 
         return new self([$filename => $lineCoverage], []);

src/Node/Builder.php

@@ -70,17 +70,19 @@ private function addItems(Directory $root, array $items, array $tests): void
                 $filename = $root->pathAsString() . DIRECTORY_SEPARATOR . $key;
 
                 if (is_file($filename)) {
+                    $analysisResult = $this->analyser->analyse($filename);
+
                     $root->addFile(
                         new File(
                             $key,
                             $root,
                             $value['lineCoverage'],
                             $value['functionCoverage'],
                             $tests,
-                            $this->analyser->classesIn($filename),
-                            $this->analyser->traitsIn($filename),
-                            $this->analyser->functionsIn($filename),
-                            $this->analyser->linesOfCodeFor($filename),
+                            $analysisResult->classes(),
+                            $analysisResult->traits(),
+                            $analysisResult->functions(),
+                            $analysisResult->linesOfCode(),
                         ),
                     );
                 }

src/Node/File.php

@@ -13,8 +13,8 @@
 use function count;
 use function range;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\StaticAnalysis\AnalysisResult;
 use SebastianBergmann\CodeCoverage\StaticAnalysis\Class_;
-use SebastianBergmann\CodeCoverage\StaticAnalysis\FileAnalyser;
 use SebastianBergmann\CodeCoverage\StaticAnalysis\Function_;
 use SebastianBergmann\CodeCoverage\StaticAnalysis\LinesOfCode;
 use SebastianBergmann\CodeCoverage\StaticAnalysis\Method;
@@ -24,7 +24,7 @@
  * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
  *
  * @phpstan-import-type TestType from CodeCoverage
- * @phpstan-import-type LinesType from FileAnalyser
+ * @phpstan-import-type LinesType from AnalysisResult
  *
  * @phpstan-type ProcessedFunctionType array{
  *     functionName: string,

src/StaticAnalysis/CacheWarmer.php

@@ -9,38 +9,36 @@
  */
 namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
 
+use function file_get_contents;
 use SebastianBergmann\CodeCoverage\Filter;
 
-final class CacheWarmer
+/**
+ * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
+ */
+final readonly class CacheWarmer
 {
     /**
      * @return array{cacheHits: non-negative-int, cacheMisses: non-negative-int}
      */
     public function warmCache(string $cacheDirectory, bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecatedCode, Filter $filter): array
     {
-        $analyser = new CachingFileAnalyser(
+        $analyser = new CachingSourceAnalyser(
             $cacheDirectory,
-            new ParsingFileAnalyser(
-                $useAnnotationsForIgnoringCode,
-                $ignoreDeprecatedCode,
-            ),
-            $useAnnotationsForIgnoringCode,
-            $ignoreDeprecatedCode,
+            new ParsingSourceAnalyser,
         );
 
-        $cacheHits   = 0;
-        $cacheMisses = 0;
-
         foreach ($filter->files() as $file) {
-            $statistics = $analyser->process($file);
-
-            $cacheHits   += $statistics['cacheHits'];
-            $cacheMisses += $statistics['cacheMisses'];
+            $analyser->analyse(
+                $file,
+                file_get_contents($file),
+                $useAnnotationsForIgnoringCode,
+                $ignoreDeprecatedCode,
+            );
         }
 
         return [
-            'cacheHits'   => $cacheHits,
-            'cacheMisses' => $cacheMisses,
+            'cacheHits'   => $analyser->cacheHits(),
+            'cacheMisses' => $analyser->cacheMisses(),
         ];
     }
 }