Revert "feat!: Remove the deprecations from 2.x (#316)" (#334)

theofidry · web-flow · commit 0cda2e539d5a · 2025-04-20T21:01:28.000+02:00
This reverts commit ef8a3bf.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,25 +1,3 @@
-## From 2.x to 3.x
-
-- Removed the deprecated `PhpExecutableFinder::tryToFind()` method. Use the `::find()` method instead.
-- Removed the following deprecations from the `Parallelization` trait:
-    - `#logError: bool` property: override the `::createErrorHandler()` method instead.
-    - `::configureParallelization()`: use ParallelizationInput::configureCommand()
-    - `::getProgressSymbol()`: Override `::configureParallelExecutableFactory()` and use `::withProgressSymbol()` of the
-      factory.
-    - `::detectPhpExecutable()`: Override `::configureParallelExecutableFactory()` and use `::withPhpExecutable()` of the
-      factory.
-    - `::getWorkingDirectory()`: Override `::configureParallelExecutableFactory()` and use `::withWorkingDirectory()` of
-      the factory.
-    - `::getEnvironmentVariables()`: Override `::configureParallelExecutableFactory()` and use
-      `::withExtraEnvironmentVariables()` of the factory.
-    - `::getSegmentSize()`: Override `::configureParallelExecutableFactory()` and use `::withSegmentSize()` of the
-      factory.
-    - `::getBatchSize()`: Override `::configureParallelExecutableFactory()` and use `::withBatchSize()` of the
-      factory.
-    - `::getConsolePath()`: Override `::configureParallelExecutableFactory()` and use `::withScriptPath()` of the
-      factory.
-
-
 ## From 1.x to 2.x
 
 - `Parallelization::fetchItems()` now requires `OutputInterface` as a second parameter
diff --git a/phpstan-tests.neon.dist b/phpstan-tests.neon.dist
@@ -18,6 +18,8 @@ parameters:
           message: '#ParallelizationIntegrationTest::\$importUnknownMoviesCountCommand#'
         - path: tests/Integration/ParallelizationIntegrationTest.php
           message: '#ParallelizationIntegrationTest::\$noSubProcessCommand#'
+        - path: tests/Integration/ParallelizationIntegrationTest.php
+          message: '#ParallelizationIntegrationTest::\$legacyCommand#'
         - path: tests/Integration/DebugChildProcessInputsTest.php
           message: '#DebugChildProcessInputsTest::\$command#'
 
@@ -32,6 +34,9 @@ parameters:
         - path: tests/ParallelExecutorFactoryTest.php
           message: '#ParallelExecutorFactory::create\(\) expects Closure#'
 
+        - path: tests/Fixtures/Command/LegacyCommand.php
+          message: '#Static method .* is unused#'
+
         - path: tests/Input/RawInputTest.php
           message: '#Webmozarts\\Console\\Parallelization\\Input\\FakeInput#'
 
diff --git a/src/ParallelCommand.php b/src/ParallelCommand.php
@@ -33,6 +33,9 @@
 
 abstract class ParallelCommand extends Command
 {
+    // TODO: simply add the Parallelization trait for 3.x where all the BC
+    //  layer of the trait is removed.
+
     protected function configure(): void
     {
         ParallelizationInput::configureCommand($this);
diff --git a/src/Parallelization.php b/src/Parallelization.php
@@ -28,6 +28,12 @@
 use Webmozarts\Console\Parallelization\Logger\DebugProgressBarFactory;
 use Webmozarts\Console\Parallelization\Logger\Logger;
 use Webmozarts\Console\Parallelization\Logger\StandardLogger;
+use Webmozarts\Console\Parallelization\Process\PhpExecutableFinder;
+use function chr;
+use function dirname;
+use function getcwd;
+use function getenv;
+use function realpath;
 
 /**
  * Adds parallelization capabilities to console commands.
@@ -60,13 +66,26 @@
  */
 trait Parallelization
 {
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override the method ::createErrorHandler() instead.
+     */
+    private bool $logError = true;
+
     /**
      * Provided by Symfony Command class.
      *
      * @return string The command name
      */
     abstract public function getName();
 
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Use ParallelizationInput::configureCommand() instead.
+     */
+    protected static function configureParallelization(Command $command): void
+    {
+        ParallelizationInput::configureCommand($command);
+    }
+
     /**
      * Fetches the items that should be processed.
      *
@@ -147,11 +166,102 @@ protected function getParallelExecutableFactory(
         // overriding this method, it is highly recommended you don't and just
         // call `ParallelExecutorFactory::create(...func_get_args())`.
         //
-        // Configuring the factory is recommended to be done in
-        // ::configureParallelExecutableFactory() instead which is
-        // simpler to override, unless you _really_ need one of the
-        // parameters passed to this method.
-        return ParallelExecutorFactory::create(...func_get_args())
+        // The only exception is if you need the whole BC layer with the API
+        // from 1.x.
+        $factory = ParallelExecutorFactory::create(
+            $fetchItems,
+            $runSingleCommand,
+            $getItemName,
+            $commandName,
+            $commandDefinition,
+            $errorHandler,
+        );
+
+        $container = $this->getContainer();
+
+        $progressSymbol = $this->getProgressSymbol();
+        $legacyDefaultProgressSymbol = chr(254);
+        if ($legacyDefaultProgressSymbol !== $progressSymbol) {
+            Deprecation::trigger(
+                'The method ::getProgressSymbol() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your progress symbol to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withProgressSymbol($progressSymbol);
+        }
+
+        $phpExecutable = $this->detectPhpExecutable();
+        $legacyDefaultPhpExecutable = PhpExecutableFinder::tryToFind();
+        if ($phpExecutable !== $legacyDefaultPhpExecutable) {
+            Deprecation::trigger(
+                'The method ::detectPhpExecutable() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your PHP executable path to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withPhpExecutable($phpExecutable);
+        }
+
+        $workingDirectory = $this->getWorkingDirectory($container);
+        $legacyDefaultWorkingDirectory = dirname($container->getParameter('kernel.project_dir'));
+        if ($workingDirectory !== $legacyDefaultWorkingDirectory) {
+            Deprecation::trigger(
+                'The method ::getWorkingDirectory() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your working directory path to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withWorkingDirectory($workingDirectory);
+        }
+
+        $environmentVariables = $this->getEnvironmentVariables($container);
+        $legacyDefaultEnvironmentVariables = [
+            'PATH' => getenv('PATH'),
+            'HOME' => getenv('HOME'),
+            'SYMFONY_DEBUG' => $container->getParameter('kernel.debug'),
+            'SYMFONY_ENV' => $container->getParameter('kernel.environment'),
+        ];
+        if ($environmentVariables !== $legacyDefaultEnvironmentVariables) {
+            Deprecation::trigger(
+                'The method ::getEnvironmentVariables() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your extra environment variables to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withExtraEnvironmentVariables($environmentVariables);
+        }
+
+        $segmentSize = $this->getSegmentSize();
+        $legacyDefaultSegmentSize = 50;
+        if ($segmentSize !== $legacyDefaultSegmentSize) {
+            Deprecation::trigger(
+                'The method ::getSegmentSize() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your segment size to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withSegmentSize($segmentSize);
+        }
+
+        $batchSize = $this->getBatchSize();
+        $legacyDefaultBatchSize = $segmentSize;
+        if ($batchSize !== $legacyDefaultBatchSize) {
+            Deprecation::trigger(
+                'The method ::getBatchSize() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your batch size to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withBatchSize($batchSize);
+        }
+
+        $consolePath = $this->getConsolePath();
+        $legacyDefaultConsolePath = realpath(getcwd().'/bin/console');
+        if ($consolePath !== $legacyDefaultConsolePath) {
+            Deprecation::trigger(
+                'The method ::getConsolePath() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your script path to the factory.',
+                __FUNCTION__,
+            );
+
+            $factory = $factory->withScriptPath($consolePath);
+        }
+
+        return $factory
             ->withRunBeforeFirstCommand($this->runBeforeFirstCommand(...))
             ->withRunAfterLastCommand($this->runAfterLastCommand(...))
             ->withRunBeforeBatch($this->runBeforeBatch(...))
@@ -176,11 +286,21 @@ protected function configureParallelExecutableFactory(
 
     protected function createErrorHandler(InputInterface $input, OutputInterface $output): ErrorHandler
     {
-        return new LoggingErrorHandler(
-            new ThrowableCodeErrorHandler(
-                ResetServiceErrorHandler::forContainer($this->getContainer()),
-            ),
+        $errorHandler = new ThrowableCodeErrorHandler(
+            ResetServiceErrorHandler::forContainer($this->getContainer()),
         );
+
+        if (!$this->logError) {
+            Deprecation::trigger(
+                'The %s#logError property is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to produce the desired error handler.',
+                self::class,
+                __FUNCTION__,
+            );
+
+            return $errorHandler;
+        }
+
+        return new LoggingErrorHandler($errorHandler);
     }
 
     protected function createLogger(InputInterface $input, OutputInterface $output): Logger
@@ -198,7 +318,7 @@ protected function getContainer(): ?ContainerInterface
         // The container is required to reset the container upon failure to
         // avoid things such as a broken UoW or entity manager.
         //
-        // If no such behaviour is desired, ::createErrorHandler() can be
+        // If no such behaviour is desired, `::createErrorHandler()` can be
         // overridden to provide a different error handler.
         $application = $this->getApplication();
 
@@ -209,6 +329,51 @@ protected function getContainer(): ?ContainerInterface
         return null;
     }
 
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register the progress symbol to the factory
+     *             instead.
+     */
+    private static function getProgressSymbol(): string
+    {
+        return chr(254);
+    }
+
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register the PHP executable path to the
+     *             factory instead.
+     */
+    private static function detectPhpExecutable(): string
+    {
+        return PhpExecutableFinder::find();
+    }
+
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register the working directory path to the
+     *             factory instead.
+     */
+    private static function getWorkingDirectory(ContainerInterface $container): string
+    {
+        return dirname($container->getParameter('kernel.project_dir'));
+    }
+
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register the working directory path to the
+     *             factory instead.
+     */
+    protected function getEnvironmentVariables(ContainerInterface $container): array
+    {
+        return [
+            'PATH' => getenv('PATH'),
+            'HOME' => getenv('HOME'),
+            'SYMFONY_DEBUG' => $container->getParameter('kernel.debug'),
+            'SYMFONY_ENV' => $container->getParameter('kernel.environment'),
+        ];
+    }
+
     protected function runBeforeFirstCommand(
         InputInterface $input,
         OutputInterface $output
@@ -240,4 +405,34 @@ protected function runAfterBatch(
         array $items
     ): void {
     }
+
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register your segment size
+     *             to the factory instead.
+     */
+    protected function getSegmentSize(): int
+    {
+        return 50;
+    }
+
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register your batch size
+     *             to the factory instead.
+     */
+    protected function getBatchSize(): int
+    {
+        return $this->getSegmentSize();
+    }
+
+    /**
+     * @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
+     *             ::getParallelExecutableFactory() to register your console path
+     *             to the factory instead.
+     */
+    protected function getConsolePath(): string
+    {
+        return realpath(getcwd().'/bin/console');
+    }
 }
diff --git a/tests/Fixtures/Command/LegacyCommand.php b/tests/Fixtures/Command/LegacyCommand.php
diff --git a/tests/Integration/ParallelizationIntegrationTest.php b/tests/Integration/ParallelizationIntegrationTest.php

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@`
`33`	`33`
`34`	`34`	`abstract class ParallelCommand extends Command`
`35`	`35`	`{`
	`36`	`+ // TODO: simply add the Parallelization trait for 3.x where all the BC`
	`37`	`+ // layer of the trait is removed.`
	`38`	`+`
`36`	`39`	`protected function configure(): void`
`37`	`40`	`{`
`38`	`41`	`ParallelizationInput::configureCommand($this);`