Closes #1151

Author: sebastianbergmann

ChangeLog-14.1.md

@@ -2,6 +2,12 @@
 
 All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+## [14.1.3] - 2026-MM-DD
+
+### Fixed
+
+* [#1151](https://github.com/sebastianbergmann/php-code-coverage/issues/1151): Version check in `Unserializer::unserialize()` is too restrictive
+
 ## [14.1.2] - 2026-04-15
 
 ### Fixed
@@ -28,6 +34,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt
 
 * [#1147](https://github.com/sebastianbergmann/php-code-coverage/pull/1147): `CoversClass` does not transitively target traits used by enumerations
 
+[14.1.3]: https://github.com/sebastianbergmann/php-code-coverage/compare/14.1.2...14.1
 [14.1.2]: https://github.com/sebastianbergmann/php-code-coverage/compare/14.1.1...14.1.2
 [14.1.1]: https://github.com/sebastianbergmann/php-code-coverage/compare/14.1.0...14.1.1
 [14.1.0]: https://github.com/sebastianbergmann/php-code-coverage/compare/14.0.0...14.1.0

src/Exception/VersionMismatchException.php

@@ -18,13 +18,13 @@
  */
 final class VersionMismatchException extends RuntimeException implements Exception
 {
-    public function __construct(string $storedVersion, string $currentVersion)
+    public function __construct(int $storedFormat, int $supportedFormat)
     {
         parent::__construct(
             sprintf(
-                'Coverage data was written by version %s and cannot be read by version %s',
-                $storedVersion,
-                $currentVersion,
+                'Coverage data was written using serialization format %d and cannot be read by code that supports serialization format %d',
+                $storedFormat,
+                $supportedFormat,
             ),
         );
     }

src/Serialization/Merger.php

@@ -103,8 +103,9 @@ public function merge(array $paths, bool $requireMatchingGitInformation = true,
             'timestamp'       => (new DateTimeImmutable)->format('D M j G:i:s T Y'),
             'runtime'         => $refRuntime,
             'phpCodeCoverage' => [
-                'version'           => Version::id(),
-                'driverInformation' => $refDriver,
+                'version'             => Version::id(),
+                'serializationFormat' => Serializer::SERIALIZATION_FORMAT,
+                'driverInformation'   => $refDriver,
             ],
         ];
 

src/Serialization/Serializer.php

@@ -33,6 +33,7 @@
  *         },
  *         phpCodeCoverage: array{
  *             version: string,
+ *             serializationFormat: int,
  *             driverInformation: array{
  *                 name: non-empty-string,
  *                 version: non-empty-string,
@@ -55,6 +56,8 @@
  */
 final readonly class Serializer
 {
+    public const int SERIALIZATION_FORMAT = 1;
+
     /**
      * @param non-empty-string $target
      *
@@ -72,8 +75,9 @@ public function serialize(string $target, CodeCoverage $codeCoverage, bool $incl
                 'vendorUrl' => $runtime->getVendorUrl(),
             ],
             'phpCodeCoverage' => [
-                'version'           => Version::id(),
-                'driverInformation' => $codeCoverage->driverInformation(),
+                'version'             => Version::id(),
+                'serializationFormat' => self::SERIALIZATION_FORMAT,
+                'driverInformation'   => $codeCoverage->driverInformation(),
             ],
         ];
 
@@ -111,7 +115,7 @@ public function serialize(string $target, CodeCoverage $codeCoverage, bool $incl
 
         Filesystem::write(
             $target,
-            '<?php // phpunit/php-code-coverage version ' . Version::id() . PHP_EOL .
+            '<?php // phpunit/php-code-coverage serialization format ' . self::SERIALIZATION_FORMAT . PHP_EOL .
             "return \unserialize(<<<'END_OF_COVERAGE_SERIALIZATION'" . PHP_EOL .
             $serializedData . PHP_EOL .
             'END_OF_COVERAGE_SERIALIZATION' . PHP_EOL .

src/Serialization/Unserializer.php

@@ -15,13 +15,13 @@
 use function fopen;
 use function is_array;
 use function is_bool;
+use function is_int;
 use function is_string;
 use function preg_match;
 use function restore_error_handler;
 use function set_error_handler;
 use function trim;
 use SebastianBergmann\CodeCoverage\Data\ProcessedCodeCoverageData;
-use SebastianBergmann\CodeCoverage\Version;
 
 /**
  * @phpstan-import-type SerializedCoverage from Serializer
@@ -55,14 +55,14 @@ public function unserialize(string $path): array
             throw new FileCouldNotBeReadException('Cannot read from file: ' . $path);
         }
 
-        if (preg_match('/^<\?php \/\/ phpunit\/php-code-coverage version (.+)$/', trim($firstLine), $matches) !== 1) {
-            throw new FileCouldNotBeReadException('File does not contain phpunit/php-code-coverage version information: ' . $path);
+        if (preg_match('/^<\?php \/\/ phpunit\/php-code-coverage serialization format (\d+)$/', trim($firstLine), $matches) !== 1) {
+            throw new FileCouldNotBeReadException('File does not contain phpunit/php-code-coverage serialization format information: ' . $path);
         }
 
-        $storedVersion = $matches[1];
+        $storedFormat = (int) $matches[1];
 
-        if ($storedVersion !== Version::id()) {
-            throw new VersionMismatchException($storedVersion, Version::id());
+        if ($storedFormat !== Serializer::SERIALIZATION_FORMAT) {
+            throw new VersionMismatchException($storedFormat, Serializer::SERIALIZATION_FORMAT);
         }
 
         set_error_handler(
@@ -126,6 +126,10 @@ private function validate(mixed $data): void
             throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.version\' key');
         }
 
+        if (!array_key_exists('serializationFormat', $phpCodeCoverage) || !is_int($phpCodeCoverage['serializationFormat'])) {
+            throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.serializationFormat\' key');
+        }
+
         if (!array_key_exists('driverInformation', $phpCodeCoverage) || !is_array($phpCodeCoverage['driverInformation'])) {
             throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.driverInformation\' key');
         }

tests/tests/Exception/VersionMismatchExceptionTest.php

@@ -19,10 +19,10 @@ final class VersionMismatchExceptionTest extends TestCase
 {
     public function testHasMessage(): void
     {
-        $e = new VersionMismatchException('1.0', '2.0');
+        $e = new VersionMismatchException(1, 2);
 
         $this->assertSame(
-            'Coverage data was written by version 1.0 and cannot be read by version 2.0',
+            'Coverage data was written using serialization format 1 and cannot be read by code that supports serialization format 2',
             $e->getMessage(),
         );
     }

tests/tests/Serialization/MergerTest.php

@@ -301,8 +301,9 @@ private function makeItem(array $overrides = [], ?ProcessedCodeCoverageData $cov
                     'vendorUrl' => 'https://php.net',
                 ],
                 'phpCodeCoverage' => [
-                    'version'           => Version::id(),
-                    'driverInformation' => [
+                    'version'             => Version::id(),
+                    'serializationFormat' => Serializer::SERIALIZATION_FORMAT,
+                    'driverInformation'   => [
                         'name'    => 'Xdebug',
                         'version' => '3.3.0',
                     ],
@@ -342,7 +343,7 @@ private function writeFile(string $filename, array $data): string
     {
         $path = TEST_FILES_PATH . 'tmp/' . $filename;
 
-        $content = '<?php // phpunit/php-code-coverage version ' . Version::id() . PHP_EOL .
+        $content = '<?php // phpunit/php-code-coverage serialization format ' . Serializer::SERIALIZATION_FORMAT . PHP_EOL .
             "return \unserialize(<<<'END_OF_COVERAGE_SERIALIZATION'" . PHP_EOL .
             serialize($data) . PHP_EOL .
             'END_OF_COVERAGE_SERIALIZATION' . PHP_EOL .

tests/tests/Serialization/SerializerTest.php

@@ -32,7 +32,7 @@ protected function tearDown(): void
         $this->removeTemporaryFiles();
     }
 
-    public function testSerializedFileHasVersionHeaderOnFirstLine(): void
+    public function testSerializedFileHasSerializationFormatHeaderOnFirstLine(): void
     {
         $coverage = $this->getLineCoverageForBankAccount();
         $target   = TEST_FILES_PATH . 'tmp/serialized.php';
@@ -43,8 +43,8 @@ public function testSerializedFileHasVersionHeaderOnFirstLine(): void
         $firstLine = fgets($file);
         fclose($file);
 
-        $this->assertMatchesRegularExpression(
-            '/^<\?php \/\/ phpunit\/php-code-coverage version .+$/',
+        $this->assertSame(
+            '<?php // phpunit/php-code-coverage serialization format ' . Serializer::SERIALIZATION_FORMAT,
             trim($firstLine),
         );
     }
@@ -125,6 +125,7 @@ public function testSerializedDataPreservesBuildInformation(): void
         $this->assertArrayHasKey('timestamp', $data['buildInformation']);
         $this->assertArrayHasKey('runtime', $data['buildInformation']);
         $this->assertArrayHasKey('phpCodeCoverage', $data['buildInformation']);
+        $this->assertSame(Serializer::SERIALIZATION_FORMAT, $data['buildInformation']['phpCodeCoverage']['serializationFormat']);
         $this->assertEquals($coverage->driverInformation(), $data['buildInformation']['phpCodeCoverage']['driverInformation']);
     }