Remove DRUSH_EXECUTION_COMPLETED and DRUSH_EXIT_CODE handling (#3780)

* Drush no longer cares about DRUSH_EXECUTION_COMPLETED and DRUSH_EXIT_CODE

* Update test.

* Bring back handling of exit() during termination

* Remove drush_return_status().

* Bring back drush_return_status(). It changes exit code based on drush_get_error()

Also mark a few context methods as deprecated

* Use new CommandResult class

* Use newly released Annotated Command.

Author: weitzman

composer.json

@@ -34,7 +34,7 @@
     "ext-dom": "*",
     "chi-teck/drupal-code-generator": "^1.27.0",
     "composer/semver": "^1.4",
-    "consolidation/annotated-command": "^2.9.1",
+    "consolidation/annotated-command": "^2.10.0",
     "consolidation/config": "^1.1.0",
     "consolidation/filter-via-dot-access-data": "^0.4",
     "consolidation/output-formatters": "^3.3.1",

includes/context.inc

@@ -200,6 +200,8 @@ function drush_set_config_special_contexts(&$options) {
  *
  * @return
  *   An associative array of the settings specified in the request context.
+ *
+ * @deprecated
  */
 function drush_set_context($context, $value) {
   $cache =& drush_get_context($context);
@@ -235,6 +237,8 @@ function drush_set_context($context, $value) {
  *   If context is not supplied, the entire context cache will be returned.
  *   Otherwise only the requested context will be returned.
  *   If the context does not exist yet, it will be initialized to an empty array.
+ *
+ * @deprecated
  */
 function &drush_get_context($context = NULL, $default = NULL) {
   static $cache = [];
@@ -273,6 +277,8 @@ function drush_set_arguments($arguments) {
  *   the array will not include the command name.
  *
  * @see drush_set_arguments()
+ *
+ * @deprecated
  */
 function drush_get_arguments() {
   return drush_get_context('arguments');
@@ -294,6 +300,8 @@ function drush_set_command($command) {
 
 /**
  * Return the command being executed.
+ *
+ * @deprecated()
  */
 function drush_get_command() {
   return drush_get_context('command');
@@ -312,6 +320,8 @@ function drush_get_command() {
  *   Optional. The value to return if the option has not been set
  * @param context
  *   Optional. The context to check for the option. If this is set, only this context will be searched.
+ *
+ * @deprecated
  */
 function drush_get_option($option, $default = NULL, $context = NULL) {
   // Uncomment when fumigating.

includes/environment.inc

@@ -55,19 +55,6 @@ function drush_error_handler($errno, $message, $filename, $line) {
   }
 }
 
-/**
- * Evalute the environment after an abnormal termination and
- * see if we can determine any configuration settings that the user might
- * want to adjust.
- */
-function _drush_postmortem() {
-  // Make sure that the memory limit has been bumped up from the minimum default value of 32M.
-  $php_memory_limit = drush_memory_limit();
-  if (($php_memory_limit > 0) && ($php_memory_limit <= 32*DRUSH_KILOBYTE*DRUSH_KILOBYTE)) {
-    drush_set_error('DRUSH_MEMORY_LIMIT', dt('Your memory limit is set to !memory_limit; Drush needs as much memory to run as Drupal.  !php_ini_msg', ['!memory_limit' => $php_memory_limit / (DRUSH_KILOBYTE*DRUSH_KILOBYTE) . 'M', '!php_ini_msg' => _drush_php_ini_loaded_file_message()]));
-  }
-}
-
 /**
  * Converts a Windows path (dir1\dir2\dir3) into a Unix path (dir1/dir2/dir3).
  * Also converts a cygwin "drive emulation" path (/cygdrive/c/dir1) into a

includes/preflight.inc

@@ -6,6 +6,7 @@
  */
 
 use Drush\Drush;
+use Drush\Runtime\Runtime;
 
 /**
  * The main Drush function.
@@ -18,21 +19,6 @@ function drush_main() {
 }
 
 /**
- * We set this context to let the shutdown function know we reached the end of drush_main().
- *
- * @see drush_main()
- */
-function drush_postflight() {
-  drush_set_context("DRUSH_EXECUTION_COMPLETED", TRUE);
-}
-
-/**
- * Shutdown function for use while Drush and Drupal are bootstrapping and to return any
- * registered errors.
- *
- * The shutdown command checks whether certain options are set to reliably
- * detect and log some common Drupal initialization errors.
- *
  * If the command is being executed with the --backend option, the script
  * will return a json string containing the options and log information
  * used by the script.
@@ -46,21 +32,8 @@ function drush_shutdown() {
     return;
   }
 
-  // Mysteriously make $user available during sess_write(). Avoids a NOTICE.
-  global $user;
-
-  if (!drush_get_context('DRUSH_EXECUTION_COMPLETED', FALSE) && !drush_get_context('DRUSH_USER_ABORT', FALSE)) {
-    $php_error_message = '';
-    if ($error = error_get_last()) {
-      $php_error_message = "\n" . dt('Error: !message in !file, line !line', ['!message' => $error['message'], '!file' => $error['file'], '!line' => $error['line']]);
-    }
-    // We did not reach the end of the drush_main function,
-    // this generally means somewhere in the code a call to exit(),
-    // was made. We catch this, so that we can trigger an error in
-    // those cases.
-    drush_set_error("DRUSH_NOT_COMPLETED", dt("Drush command terminated abnormally due to an unrecoverable error.!message", ['!message' => $php_error_message]));
-    // Attempt to give the user some advice about how to fix the problem
-    _drush_postmortem();
+  if (!Drush::config()->get(Runtime::DRUSH_RUNTIME_COMPLETED_NAMESPACE)) {
+      throw new RuntimeException('Drush command terminated abnormally. Check for an exit() in your Drupal site.');
   }
 
   if (Drush::backend()) {
@@ -108,6 +81,9 @@ function drush_coverage_shutdown() {
   }
 }
 
+/**
+ * @deprecated. This function will be removed in Drush 10. Throw an exception to indicate an error.
+ */
 function drush_return_status() {
   // If a specific exit code was set, then use it.
   $exit_code = drush_get_context('DRUSH_EXIT_CODE');

scenarios/phpunit4/composer.json

@@ -34,21 +34,20 @@
     "ext-dom": "*",
     "chi-teck/drupal-code-generator": "^1.27.0",
     "composer/semver": "^1.4",
-    "consolidation/annotated-command": "^2.9.1",
+    "consolidation/annotated-command": "^2.10.0",
     "consolidation/config": "^1.1.0",
     "consolidation/filter-via-dot-access-data": "^0.4",
     "consolidation/output-formatters": "^3.3.1",
     "consolidation/robo": "^1.1.5",
-    "consolidation/site-alias": "^1.1.6",
+    "consolidation/site-alias": "^1.1.6|^2",
     "consolidation/site-process": "^0.1.13",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",
     "psr/log": "~1.0",
     "psy/psysh": "~0.6",
-    "symfony/config": "^3.4",
     "symfony/console": "^3.4",
     "symfony/event-dispatcher": "^3.4",
-    "symfony/finder": "^3.4",
+    "symfony/finder": "^3.4 || ^4.0",
     "symfony/process": "^3.4",
     "symfony/var-dumper": "^3.4 || ^4.0",
     "symfony/yaml": "^3.4",

src/Commands/DrushCommands.php

@@ -18,6 +18,10 @@ abstract class DrushCommands implements IOAwareInterface, LoggerAwareInterface,
     const REQ=InputOption::VALUE_REQUIRED;
     const OPT=InputOption::VALUE_OPTIONAL;
 
+    // Common exit codes.
+    const EXIT_SUCCESS = 0;
+    const EXIT_FAILURE = 1;
+
     use LoggerAwareTrait;
     use ConfigAwareTrait {
         // Move aside this method so we can replace. See https://stackoverflow.com/a/37687295.

src/Commands/core/UpdateDBCommands.php

@@ -69,15 +69,14 @@ public function updatedb($options = ['cache-clear' => true, 'entity-updates' =>
                 // Caches were just cleared in updateFinished callback.
             }
 
-            if (!$success) {
-                drush_set_context('DRUSH_EXIT_CODE', DRUSH_FRAMEWORK_ERROR);
-            }
-
             $level = $success ? ConsoleLogLevel::SUCCESS : LogLevel::ERROR;
             $this->logger()->log($level, dt('Finished performing updates.'));
         } else {
             $this->logger()->success(dt('No pending updates.'));
+            $success = true;
         }
+
+        return $success ? DRUSH_SUCCESS : DRUSH_FRAMEWORK_ERROR;
     }
 
     /**

src/Commands/pm/SecurityUpdateCommands.php

@@ -1,9 +1,8 @@
 <?php
 namespace Drush\Commands\pm;
 
-use Composer\Semver\Comparator;
 use Composer\Semver\Semver;
-use Consolidation\AnnotatedCommand\CommandData;
+use Consolidation\AnnotatedCommand\CommandResult;
 use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
@@ -15,12 +14,6 @@
  */
 class SecurityUpdateCommands extends DrushCommands
 {
-
-    /**
-     * @var array
-     */
-    protected $securityUpdates;
-
     /**
      * Check Drupal Composer packages for pending security updates.
      *
@@ -45,37 +38,30 @@ class SecurityUpdateCommands extends DrushCommands
      */
     public function security()
     {
-        $this->securityUpdates = [];
         $security_advisories_composer_json = $this->fetchAdvisoryComposerJson();
         $composer_lock_data = $this->loadSiteComposerLock();
-        $this->registerAllSecurityUpdates($composer_lock_data, $security_advisories_composer_json);
-        if ($this->securityUpdates) {
-            // @todo Modernize.
-            drush_set_context('DRUSH_EXIT_CODE', DRUSH_FRAMEWORK_ERROR);
-            $result = new RowsOfFields($this->securityUpdates);
-            return $result;
+        $updates = $this->calculateSecurityUpdates($composer_lock_data, $security_advisories_composer_json);
+        if ($updates) {
+            $this->suggestComposerCommand($updates);
+            return CommandResult::dataWithExitCode(new RowsOfFields($updates), self::EXIT_FAILURE);
         } else {
             $this->logger()->success("<info>There are no outstanding security updates for Drupal projects.</info>");
         }
     }
 
     /**
      * Emit suggested Composer command for security updates.
-     *
-     * @hook post-command pm:security
      */
-    public function suggestComposerCommand($result, CommandData $commandData)
+    public function suggestComposerCommand($updates)
     {
-        if (!empty($this->securityUpdates)) {
-            $suggested_command = 'composer require ';
-            foreach ($this->securityUpdates as $package) {
-                $suggested_command .= $package['name'] . ' ';
-            }
-            $suggested_command .= '--update-with-dependencies';
-            $this->logger()->warning("One or more of your dependencies has an outstanding security update. Please apply update(s) immediately.");
-            $this->logger()->notice("Try running: <comment>$suggested_command</comment>");
-            $this->logger()->notice("If that fails due to a conflict then you must update one or more root dependencies.");
+        $suggested_command = 'composer require ';
+        foreach ($updates as $package) {
+            $suggested_command .= $package['name'] . ' ';
         }
+        $suggested_command .= '--update-with-dependencies';
+        $this->logger()->warning('One or more of your dependencies has an outstanding security update.');
+        $this->logger()->notice("Try running: <comment>$suggested_command</comment>");
+        $this->logger()->notice("If that fails due to a conflict then you must update one or more root dependencies.");
     }
 
     /**
@@ -128,24 +114,29 @@ protected function loadSiteComposerLock()
     }
 
     /**
-     * Register all available security updates in $this->securityUpdates.
+     * Return  available security updates.
+     *
      * @param array $composer_lock_data
      *   The contents of the local Drupal application's composer.lock file.
      * @param array $security_advisories_composer_json
      *   The composer.json array from drupal-security-advisories.
+     *
+     * @return array
      */
-    protected function registerAllSecurityUpdates($composer_lock_data, $security_advisories_composer_json)
+    protected function calculateSecurityUpdates($composer_lock_data, $security_advisories_composer_json)
     {
+        $updates = [];
         $both = array_merge($composer_lock_data['packages-dev'], $composer_lock_data['packages']);
         $conflict = $security_advisories_composer_json['conflict'];
         foreach ($both as $package) {
             $name = $package['name'];
             if (!empty($conflict[$name]) && Semver::satisfies($package['version'], $security_advisories_composer_json['conflict'][$name])) {
-                $this->securityUpdates[$name] = [
+                $updates[$name] = [
                     'name' => $name,
                     'version' => $package['version'],
                 ];
             }
         }
+        return $updates;
     }
 }

src/Drupal/Commands/core/CliCommands.php

@@ -8,6 +8,7 @@
 use Drush\Psysh\DrushHelpCommand;
 use Drupal\Component\Assertion\Handle;
 use Drush\Psysh\Shell;
+use Drush\Runtime\Runtime;
 use Psy\Configuration;
 use Psy\VersionUpdater\Checker;
 use Webmozart\PathUtil\Path;
@@ -67,7 +68,7 @@ public function cli(array $options = ['version-history' => false, 'cwd' => null]
         // PsySH will never return control to us, but our shutdown handler will still
         // run after the user presses ^D.  Mark this command as completed to avoid a
         // spurious error message.
-        drush_set_context('DRUSH_EXECUTION_COMPLETED', true);
+        Runtime::setCompleted();
 
         // Run the terminate event before the shell is run. Otherwise, if the shell
         // is forking processes (the default), any child processes will close the

src/Runtime/RedispatchHook.php

@@ -116,14 +116,12 @@ protected function alterArgsForRedispatch($redispatchArgs)
      */
     protected function exitEarly($exit_code)
     {
-        Drush::logger()->log(LogLevel::DEBUG, 'Redispatch hook exit early');
+        Drush::logger()->debug('Redispatch hook exit early');
 
-        // TODO: This is how Drush exits from redispatch commands today;
-        // perhaps this could be somewhat improved, though.
         // Note that RemoteCommandProxy::execute() is expecting that
         // the redispatch() method will not return, so that will need
         // to be altered if this behavior is changed.
-        drush_set_context('DRUSH_EXECUTION_COMPLETED', true);
+        Runtime::setCompleted();
         exit($exit_code);
     }
 }