Parallel execution - minor changes

.php-cs-fixer.dist.php

@@ -14,10 +14,10 @@
 
 use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
-use PhpCsFixer\Runner\Parallel\ParallelConfig;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 
 return (new Config())
-    ->setParallelConfig(ParallelConfig::detect())
+    ->setParallelConfig(ParallelConfigFactory::detect())
     ->setRiskyAllowed(true)
     ->setRules([
         '@PHP74Migration' => true,

doc/usage.rst

@@ -21,14 +21,14 @@ If you do not have config file, you can run following command to fix non-hidden,
 
     php php-cs-fixer.phar fix .
 
-You can also fix files in parallel, utilising more CPU cores. You can do this by using config class that implements ``PhpCsFixer\Runner\Parallel\ParallelConfig\ParallelRunnerConfigInterface``, and use ``setParallelConfig()`` method. Recommended way is to utilise auto-detecting parallel configuration:
+You can also fix files in parallel, utilising more CPU cores. You can do this by using config class that implements ``PhpCsFixer\Runner\Parallel\ParallelConfig\ParallelAwareConfigInterface``, and use ``setParallelConfig()`` method. Recommended way is to utilise auto-detecting parallel configuration:
 
 .. code-block:: php
 
     <?php
 
     return (new PhpCsFixer\Config())
-        ->setParallelConfig(ParallelConfig::detect())
+        ->setParallelConfig(ParallelConfigFactory::detect())
     ;
 
 However, in some case you may want to fine-tune parallelisation with explicit values (e.g. in environments where auto-detection does not work properly and suggests more cores than it should):

src/Cache/FileCacheManager.php

@@ -14,6 +14,8 @@
 
 namespace PhpCsFixer\Cache;
 
+use PhpCsFixer\Tokenizer\CodeHasher;
+
 /**
  * Class supports caching information about state of fixing files.
  *
@@ -136,6 +138,6 @@ private function writeCache(): void
 
     private function calcHash(string $content): string
     {
-        return md5($content);
+        return CodeHasher::calculateCodeHash($content);
     }
 }

src/Config.php

@@ -16,13 +16,14 @@
 
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Runner\Parallel\ParallelConfig;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 
 /**
  * @author Fabien Potencier <[email protected]>
  * @author Katsuhiro Ogawa <[email protected]>
  * @author Dariusz Rumiński <[email protected]>
  */
-class Config implements ConfigInterface, ParallelRunnerConfigInterface
+class Config implements ConfigInterface, ParallelAwareConfigInterface
 {
     private string $cacheFile = '.php-cs-fixer.cache';
 
@@ -48,7 +49,7 @@ class Config implements ConfigInterface, ParallelRunnerConfigInterface
 
     private string $name;
 
-    private ?ParallelConfig $parallelRunnerConfig;
+    private ?ParallelConfig $parallelConfig;
 
     /**
      * @var null|string
@@ -125,7 +126,9 @@ public function getName(): string
 
     public function getParallelConfig(): ParallelConfig
     {
-        return $this->parallelRunnerConfig ?? ParallelConfig::sequential();
+        $this->parallelConfig ??= ParallelConfigFactory::sequential();
+
+        return $this->parallelConfig;
     }
 
     public function getPhpExecutable(): ?string
@@ -201,7 +204,7 @@ public function setLineEnding(string $lineEnding): ConfigInterface
 
     public function setParallelConfig(ParallelConfig $config): ConfigInterface
     {
-        $this->parallelRunnerConfig = $config;
+        $this->parallelConfig = $config;
 
         return $this;
     }

src/Console/Command/FixCommand.php

@@ -214,7 +214,7 @@ protected function configure(): void
                 new InputOption('format', '', InputOption::VALUE_REQUIRED, 'To output results in other formats.'),
                 new InputOption('stop-on-violation', '', InputOption::VALUE_NONE, 'Stop execution on first violation.'),
                 new InputOption('show-progress', '', InputOption::VALUE_REQUIRED, 'Type of progress indicator (none, dots).'),
-                new InputOption('sequential', 's', InputOption::VALUE_NONE, 'Enforce sequential analysis.'),
+                new InputOption('sequential', '', InputOption::VALUE_NONE, 'Enforce sequential analysis.'),
             ]
         );
     }

src/Console/Command/WorkerCommand.php

@@ -21,7 +21,7 @@
 use PhpCsFixer\Error\ErrorsManager;
 use PhpCsFixer\FixerFileProcessedEvent;
 use PhpCsFixer\Runner\Parallel\ParallelAction;
-use PhpCsFixer\Runner\Parallel\ParallelConfig;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 use PhpCsFixer\Runner\Parallel\ParallelisationException;
 use PhpCsFixer\Runner\Parallel\ReadonlyCacheManager;
 use PhpCsFixer\Runner\Runner;
@@ -77,43 +77,13 @@
     {
         $this->setDefinition(
             [
-                new InputOption(
-                    'port',
-                    null,
-                    InputOption::VALUE_REQUIRED,
-                    'Specifies parallelisation server\'s port.'
-                ),
-                new InputOption(
-                    'identifier',
-                    null,
-                    InputOption::VALUE_REQUIRED,
-                    'Specifies parallelisation process\' identifier.'
-                ),
-                new InputOption(
-                    'allow-risky',
-                    '',
-                    InputOption::VALUE_REQUIRED,
-                    'Are risky fixers allowed (can be `yes` or `no`).'
-                ),
+                new InputOption('port', null, InputOption::VALUE_REQUIRED, 'Specifies parallelisation server\'s port.'),
+                new InputOption('identifier', null, InputOption::VALUE_REQUIRED, 'Specifies parallelisation process\' identifier.'),
+                new InputOption('allow-risky', '', InputOption::VALUE_REQUIRED, 'Are risky fixers allowed (can be `yes` or `no`).'),
                 new InputOption('config', '', InputOption::VALUE_REQUIRED, 'The path to a config file.'),
-                new InputOption(
-                    'dry-run',
-                    '',
-                    InputOption::VALUE_NONE,
-                    'Only shows which files would have been modified.'
-                ),
-                new InputOption(
-                    'rules',
-                    '',
-                    InputOption::VALUE_REQUIRED,
-                    'List of rules that should be run against configured paths.'
-                ),
-                new InputOption(
-                    'using-cache',
-                    '',
-                    InputOption::VALUE_REQUIRED,
-                    'Should cache be used (can be `yes` or `no`).'
-                ),
+                new InputOption('dry-run', '', InputOption::VALUE_NONE, 'Only shows which files would have been modified.'),
+                new InputOption('rules', '', InputOption::VALUE_REQUIRED, 'List of rules that should be run against configured paths.'),
+                new InputOption('using-cache', '', InputOption::VALUE_REQUIRED, 'Should cache be used (can be `yes` or `no`).'),
                 new InputOption('cache-file', '', InputOption::VALUE_REQUIRED, 'The path to the cache file.'),
                 new InputOption('diff', '', InputOption::VALUE_NONE, 'Prints diff for each file.'),
             ]
@@ -182,7 +152,7 @@
                         /** @var iterable<int, string> $files */
                         $files = $json['files'];
 
-                        foreach ($files as $i => $absolutePath) {
+                        foreach ($files as $absolutePath) {
                             $relativePath = $this->configurationResolver->getDirectory()->getRelativePathTo($absolutePath);
 
                             // Reset events because we want to collect only those coming from analysed files chunk
@@ -231,13 +201,13 @@
 
         $this->configurationResolver = new ConfigurationResolver(
             new Config(),
             [
                 'allow-risky' => $input->getOption('allow-risky'),
                 'config' => $passedConfig,
                 'dry-run' => $input->getOption('dry-run'),
                 'rules' => $passedRules,
                 'path' => [],
-                'path-mode' => ConfigurationResolver::PATH_MODE_OVERRIDE,
+                'path-mode' => ConfigurationResolver::PATH_MODE_OVERRIDE, // IMPORTANT! WorkerCommand is called with file that already passed filtering, so here we can rely on PATH_MODE_OVERRIDE.
                 'using-cache' => $input->getOption('using-cache'),
                 'cache-file' => $input->getOption('cache-file'),
                 'diff' => $input->getOption('diff'),
@@ -258,7 +228,7 @@
             new ReadonlyCacheManager($this->configurationResolver->getCacheManager()),
             $this->configurationResolver->getDirectory(),
             $this->configurationResolver->shouldStopOnViolation(),
-            ParallelConfig::sequential(), // IMPORTANT! Worker must run in sequential mode
+            ParallelConfigFactory::sequential(), // IMPORTANT! Worker must run in sequential mode.
             null,
             $this->configurationResolver->getConfigFile()
         );

src/Console/ConfigurationResolver.php

@@ -35,10 +35,11 @@
 use PhpCsFixer\FixerFactory;
 use PhpCsFixer\Linter\Linter;
 use PhpCsFixer\Linter\LinterInterface;
-use PhpCsFixer\ParallelRunnerConfigInterface;
+use PhpCsFixer\ParallelAwareConfigInterface;
 use PhpCsFixer\RuleSet\RuleSet;
 use PhpCsFixer\RuleSet\RuleSetInterface;
 use PhpCsFixer\Runner\Parallel\ParallelConfig;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 use PhpCsFixer\StdinFileInfo;
 use PhpCsFixer\ToolInfoInterface;
 use PhpCsFixer\Utils;
@@ -281,9 +282,9 @@
     {
         $config = $this->getConfig();
 
-        return true !== $this->options['sequential'] && $config instanceof ParallelRunnerConfigInterface
+        return true !== $this->options['sequential'] && $config instanceof ParallelAwareConfigInterface
             ? $config->getParallelConfig()
-            : ParallelConfig::sequential();
+            : ParallelConfigFactory::sequential();
     }
 
     public function getConfigFile(): ?string
@@ -966,6 +967,7 @@
     {
         return $this->toolInfo->isInstalledAsPhar()
             || $this->toolInfo->isInstalledByComposer()
-            || $this->toolInfo->isRunInsideDocker();
+            || $this->toolInfo->isRunInsideDocker()
+            || filter_var(getenv('PHP_CS_FIXER_ENFORCE_CACHE'), FILTER_VALIDATE_BOOL);
     }
 }

src/ParallelRunnerConfigInterface.php → src/ParallelAwareConfigInterface.php

@@ -19,9 +19,9 @@
 /**
  * @author Greg Korba <[email protected]>
  *
- * @TODO 4.0 Include parallel runner config in main config
+ * @TODO 4.0 Include parallel runner config in main ConfigInterface
  */
-interface ParallelRunnerConfigInterface extends ConfigInterface
+interface ParallelAwareConfigInterface extends ConfigInterface
 {
     public function getParallelConfig(): ParallelConfig;
 

src/Runner/Parallel/ParallelConfig.php

@@ -14,10 +14,6 @@
 
 namespace PhpCsFixer\Runner\Parallel;
 
-use Fidry\CpuCoreCounter\CpuCoreCounter;
-use Fidry\CpuCoreCounter\Finder\DummyCpuCoreFinder;
-use Fidry\CpuCoreCounter\Finder\FinderRegistry;
-
 /**
  * @author Greg Korba <[email protected]>
  */
@@ -63,25 +59,4 @@ public function getProcessTimeout(): int
     {
         return $this->processTimeout;
     }
-
-    public static function sequential(): self
-    {
-        return new self(1);
-    }
-
-    /**
-     * @param positive-int $filesPerProcess
-     * @param positive-int $processTimeout
-     */
-    public static function detect(
-        int $filesPerProcess = self::DEFAULT_FILES_PER_PROCESS,
-        int $processTimeout = self::DEFAULT_PROCESS_TIMEOUT
-    ): self {
-        $counter = new CpuCoreCounter([
-            ...FinderRegistry::getDefaultLogicalFinders(),
-            new DummyCpuCoreFinder(1),
-        ]);
-
-        return new self($counter->getCount(), $filesPerProcess, $processTimeout);
-    }
 }

src/Runner/Parallel/ParallelConfigFactory.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *     Dariusz Rumiński <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Runner\Parallel;
+
+use Fidry\CpuCoreCounter\CpuCoreCounter;
+use Fidry\CpuCoreCounter\Finder\DummyCpuCoreFinder;
+use Fidry\CpuCoreCounter\Finder\FinderRegistry;
+
+/**
+ * @author Dariusz Rumiński <[email protected]>
+ */
+final class ParallelConfigFactory
+{
+    private function __construct() {}
+
+    public static function sequential(): ParallelConfig
+    {
+        return new ParallelConfig(1);
+    }
+
+    /**
+     * @param null|positive-int $filesPerProcess
+     * @param null|positive-int $processTimeout
+     */
+    public static function detect(
+        ?int $filesPerProcess = null,
+        ?int $processTimeout = null
+    ): ParallelConfig {
+        $counter = new CpuCoreCounter([
+            ...FinderRegistry::getDefaultLogicalFinders(),
+            new DummyCpuCoreFinder(1),
+        ]);
+
+        return new ParallelConfig(
+            ...array_filter(
+                [$counter->getCount(), $filesPerProcess, $processTimeout],
+                static fn ($value): bool => null !== $value
+            )
+        );
+    }
+}

src/Runner/Parallel/ProcessFactory.php

@@ -49,6 +49,8 @@ public function create(
     }
 
     /**
+     * @private
+     *
      * @return list<string>
      */
     public function getCommandArgs(int $serverPort, ProcessIdentifier $identifier, RunnerConfig $runnerConfig): array