Remove shutdown handling from Drush

drush.php

@@ -134,7 +134,7 @@
 // Preflight and run
 $preflight = new Preflight($environment);
 $di = new DependencyInjection();
-$di->desiredHandlers(['errorHandler', 'shutdownHandler']);
+$di->desiredHandlers(['errorHandler']);
 $runtime = new Runtime($preflight, $di);
 $status_code = $runtime->run($_SERVER['argv']);
 

src/Runtime/DependencyInjection.php

@@ -146,9 +146,8 @@ protected function addDrushServices($container, ClassLoader $loader, DrushDrupal
             ->addMethodCall('addSearchLocation', ['CommandFiles'])
             ->addMethodCall('setSearchPattern', ['#.*(Commands|CommandFile).php$#']);
 
-        // Error and Shutdown handlers
+        // Error handler
         Robo::addShared($container, 'errorHandler', 'Drush\Runtime\ErrorHandler');
-        Robo::addShared($container, 'shutdownHandler', 'Drush\Runtime\ShutdownHandler');
 
         // Add inflectors. @see \Drush\Boot\BaseBoot::inflect
         $container->inflector(SiteAliasManagerAwareInterface::class)

src/Runtime/Runtime.php

@@ -4,6 +4,7 @@
 
 namespace Drush\Runtime;
 
+use JetBrains\PhpStorm\Deprecated;
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Drush\Application;
 use Drush\Commands\DrushCommands;
@@ -21,8 +22,8 @@
  */
 class Runtime
 {
+    #[Deprecated("Remove for Drush 13")]
     const DRUSH_RUNTIME_COMPLETED_NAMESPACE = 'runtime.execution.completed';
-    const DRUSH_RUNTIME_EXIT_CODE_NAMESPACE = 'runtime.exit_code';
 
     public function __construct(protected Preflight $preflight, protected DependencyInjection $di)
     {
@@ -109,40 +110,18 @@ protected function doRun($argv, $output): int
         // Bootstrap: bootstrap site to the level requested by the command (via a 'post-init' hook)
         $status = $application->run($input, $output);
 
-        // Placate the Drush shutdown handler.
+        // Placate the Drush shutdown handler (@todo remove for v13).
         Runtime::setCompleted();
-        Runtime::setExitCode($status);
 
         return $status;
     }
 
     /**
      * Mark the current request as having completed successfully.
      */
+    #[Deprecated("Shutdown handling removed from Drush. Please remove the call to Runtime::setCompleted()")]
     public static function setCompleted(): void
     {
         Drush::config()->set(self::DRUSH_RUNTIME_COMPLETED_NAMESPACE, true);
     }
-
-    /**
-     * Mark the exit code for current request.
-     *
-     * @deprecated
-     *   Was used by backend.inc
-     */
-    public static function setExitCode(int $code): void
-    {
-        Drush::config()->set(self::DRUSH_RUNTIME_EXIT_CODE_NAMESPACE, $code);
-    }
-
-    /**
-     * Get the exit code for current request.
-     *
-     * @deprecated
-     *   Was used by backend.inc
-     */
-    public static function exitCode()
-    {
-        return Drush::config()->get(self::DRUSH_RUNTIME_EXIT_CODE_NAMESPACE, 0);
-    }
 }

tests/functional/ShutdownAndErrorHandlerTest.php

@@ -20,10 +20,10 @@ class ShutdownAndErrorHandlerTest extends CommandUnishTestCase
      */
     public function testShutdownFunctionAbruptExit()
     {
-        // Run some garbage php with a syntax error.
-        $this->drush(PhpCommands::EVAL, ['exit(0);'], [], null, null, DrushCommands::EXIT_FAILURE);
-
-        $this->assertStringContainsString("Drush command terminated abnormally.", $this->getErrorOutput(), 'Error handler did not log a message.');
+        // Run some garbage php with a syntax error and assert correct exit code.
+        $this->drush(PhpCommands::EVAL, ['exit(1);'], [], null, null, DrushCommands::EXIT_FAILURE);
+        // Placate phpunit. If above succeeds we are done here.
+        $this->addToAssertionCount(1);
     }
 
     /**
@@ -46,9 +46,9 @@ public function testShutdownFunctionExitCodePassedThrough()
     public function testShutdownFunctionPHPError()
     {
         // Run some garbage php with a syntax error.
-        $this->drush(PhpCommands::EVAL, ['\Drush\Drush::setContainer("string is the wrong type to pass here");'], [], null, null, PHP_MAJOR_VERSION == 5 ? 255 : DrushCommands::EXIT_FAILURE);
-
-        $this->assertStringContainsString("Drush command terminated abnormally.", $this->getErrorOutput(), 'Error handler did not log a message.');
+        $this->drush(PhpCommands::EVAL, ['\Drush\Drush::setContainer("string is the wrong type to pass here");'], [], null, null, DrushCommands::EXIT_FAILURE);
+        // Placate phpunit. If above succeeds we are done here.
+        $this->addToAssertionCount(1);
     }
 
     /**
@@ -58,12 +58,6 @@ public function testErrorHandler()
     {
         // Access a missing array element
         $this->drush(PhpCommands::EVAL, ['$a = []; print $a["b"];']);
-
-        if (empty($this->logLevel()) && PHP_MAJOR_VERSION <= 7) {
-            $this->assertEquals('', $this->getErrorOutput(), 'Error handler did not suppress deprecated message.');
-        } else {
-            $msg = PHP_MAJOR_VERSION >= 8 ? 'Undefined array key "b" PhpCommands.php' : 'Undefined index: b PhpCommands.php';
-            $this->assertStringContainsString($msg, $this->getErrorOutput());
-        }
+        $this->assertStringContainsString('Undefined array key "b" PhpCommands.php', $this->getErrorOutput());
     }
 }