Outdated: fix detecting outdated with parallel > 1

Author: forrest79

phpstan.neon

@@ -22,11 +22,6 @@ parameters:
 			count: 1
 			path: src/File.php
 
-		-
-			message: "#^Strict comparison using \\=\\=\\= between bool and 1 will always evaluate to false\\.$#"
-			count: 1
-			path: src/OutdatedFiles.php
-
 		-
 			message: '#^Parameter \$phpcsFile of method Forrest79\\PhpCsIgnores\\BaselineReport\:\:generateFileReport\(\) has invalid type PHP_CodeSniffer\\File\.$#'
 			count: 1

src/File.php

@@ -22,15 +22,19 @@ final class File extends PHP_CodeSniffer\Files\LocalFile
 	private int $ignoredFixableCount = 0;
 
 
-	/**
-	 * @param string $path
-	 */
-	public function __construct($path, PHP_CodeSniffer\Ruleset $ruleset, PHP_CodeSniffer\Config $config)
+	public function __construct(
+		int $numFiles,
+		string $path,
+		PHP_CodeSniffer\Ruleset $ruleset,
+		PHP_CodeSniffer\Config $config,
+	)
 	{
 		parent::__construct($path, $ruleset, $config);
 
 		$this->originalIgnoreErrors = Ignores::getInstance()->getRemainingIgnoreErrorsForFileAndClean($path);
 		$this->ignoreErrors = $this->originalIgnoreErrors;
+
+		OutdatedFiles::getInstance()?->setRealParallelCount($numFiles);
 	}
 
 

src/OutdatedFiles.php

@@ -12,32 +12,34 @@ final class OutdatedFiles
 
 	private Ignores $ignores;
 
-	private PHP_CodeSniffer\Config $config;
-
 	private string $outdatedVirtualFile;
 
+	private int $originalParallelCount;
+
+	private int|NULL $realParallelCount = NULL;
+
 	private string|NULL $outdatedDataFile = NULL;
 
 
 	public function __construct(Ignores $ignores, PHP_CodeSniffer\Config $config, string $outdatedVirtualFile)
 	{
 		$this->ignores = $ignores;
-		$this->config = $config;
 		$this->outdatedVirtualFile = $outdatedVirtualFile;
+		$this->originalParallelCount = (int) $config->parallel; // PHPStan fix bad annotation hack
 
 		$files = $config->files;
 		$files[] = $outdatedVirtualFile; // this must be last file to check - it's file that perform check what ignored files was not matched
 		$config->files = $files;
 
-		if ($config->parallel === 1) {
+		if ($this->originalParallelCount === 1) {
 			$this->outdatedDataFile = NULL;
 		} else {
 			$outdatedDataFile = tempnam(sys_get_temp_dir(), 'phpcs-ignores-outdated');
 			if ($outdatedDataFile === FALSE) {
 				throw new \RuntimeException('Can\'t create phpcs-ignores-outdated temp file.');
 			}
 
-			file_put_contents($outdatedDataFile, json_encode(['processCount' => $config->parallel, 'completedCount' => 0, 'remainingIgnoreErrors' => []]));
+			file_put_contents($outdatedDataFile, json_encode(['completedCount' => 0, 'remainingIgnoreErrors' => []]));
 			$this->outdatedDataFile = $outdatedDataFile;
 		}
 	}
@@ -65,9 +67,9 @@ public function __destruct()
 			$json = $this->loadOutdatedDataFile();
 			$json['completedCount']++;
 
-			// we know that one file is only in one process, so valid remaining ignore errors are these it's in all processes
+			// we know that one checked file is only in one process, so valid remaining ignore errors are these it's in all processes (array_intersect_key)
 			$json['remainingIgnoreErrors'] = $json['completedCount'] === 1
-				? $this->ignores->getRemainingIgnoreErrors()
+				? $this->ignores->getRemainingIgnoreErrors() // for first process we need to fill array, so in next proceses we can make intersect (array_intersect_key)
 				: array_intersect_key($json['remainingIgnoreErrors'], $this->ignores->getRemainingIgnoreErrors());
 
 			file_put_contents($this->outdatedDataFile, json_encode($json));
@@ -92,13 +94,14 @@ public function checkOutdatedFiles(): array
 		$outdatedFiles = [];
 
 		$remainingOutdatedErrors = $this->ignores->getRemainingIgnoreErrors();
-		if ($this->config->parallel > 1) {
+
+		if ($this->outdatedDataFile !== NULL) {
 			// wait to complete all processes
 			$start = microtime(TRUE);
 			do {
 				try {
 					$json = $this->loadOutdatedDataFile();
-					if ($json['processCount'] === ($json['completedCount'] + 1)) {
+					if (($this->realParallelCount ?? $this->originalParallelCount) === ($json['completedCount'] + 1)) {
 						$remainingOutdatedErrors = array_intersect_key($json['remainingIgnoreErrors'], $remainingOutdatedErrors);
 						break;
 					}
@@ -159,7 +162,7 @@ private function getOutdatedDataFileLock(): string
 
 
 	/**
-	 * @return array{processCount: int, completedCount: int, remainingIgnoreErrors: array<array<string, mixed>>}
+	 * @return array{completedCount: int, remainingIgnoreErrors: array<array<string, mixed>>}
 	 */
 	private function loadOutdatedDataFile(): array
 	{
@@ -172,7 +175,7 @@ private function loadOutdatedDataFile(): array
 			throw new \RuntimeException('Can\'t load outdated data file.');
 		}
 
-		/** @phpstan-var array{processCount: int, completedCount: int, remainingIgnoreErrors: array<array<string, mixed>>} */
+		/** @phpstan-var array{completedCount: int, remainingIgnoreErrors: array<array<string, mixed>>} */
 		return json_decode($data, NULL, 512, JSON_THROW_ON_ERROR | JSON_OBJECT_AS_ARRAY);
 	}
 
@@ -202,6 +205,20 @@ public static function formatOutdatedMessage(
 	}
 
 
+	public function setRealParallelCount(int $numFiles): void
+	{
+		if (($this->realParallelCount === NULL) && ($this->outdatedDataFile !== NULL)) {
+			$batch = ceil($numFiles / $this->originalParallelCount);
+			for ($i = 2; $i <= $this->originalParallelCount; $i++) {
+				if (($batch * $i) >= $numFiles) {
+					$this->realParallelCount = $i;
+					break;
+				}
+			}
+		}
+	}
+
+
 	public function setInstance(): static
 	{
 		if (self::$instance !== NULL) {

src/PhpCsInjections.php

@@ -37,7 +37,7 @@ public static function register(): void
 					return $code;
 				}
 
-				$injectCode = 'new \\' . File::class . '(';
+				$injectCode = 'new \\' . File::class . '($this->numFiles, ';
 
 				return str_replace($search, $injectCode, $code);
 			}