Deprecate Annotated Commands in favor of native Symfony Console commands

.circleci/config.yml

@@ -14,6 +14,7 @@ defaults: &defaults
     PHP_EXTENSIONS_DISABLE: xdebug
     PHP_XDEBUG_MODE: off
 
+#No longer used
 requires: &requires
   requires:
     - check_mergable
@@ -173,7 +174,8 @@ workflows:
 #      - test_80_drupal92_security:
 #          <<: *requires
       - test:
-          <<: *requires
+          # Not used, for now.
+          #          <<: *requires
           <<: *poststeps
           matrix:
             parameters:

composer.json

@@ -39,7 +39,7 @@
     "consolidation/annotated-command": "^4.9.2",
     "consolidation/config": "^2.1.2 || ^3",
     "consolidation/filter-via-dot-access-data": "^2.0.2",
-    "consolidation/output-formatters": "^4.3.2",
+    "consolidation/output-formatters": "dev-use-command-drush as 4.x-dev",
     "consolidation/robo": "^4.0.6 || ^5",
     "consolidation/site-alias": "^4",
     "consolidation/site-process": "^5.2.0",

src-symfony-compatibility/v6/Style/DrushStyle.php

@@ -37,8 +37,7 @@ public function confirm(string $question, bool $default = true, string $yes = 'Y
         return confirm($question, $default, $yes, $no, $required, $validate, $hint);
     }
 
-    #[Deprecated('Use select() or multiselect() instead.')]
-    public function choice(string $question, array $choices, mixed $default = null, bool $multiSelect = false, int $scroll = 10, ?\Closure $validate = null, string $hint = '', bool|string $required = true): mixed
+    public function choice(string $question, array $choices, mixed $default = null, bool $multiSelect = false, int $scroll = 15, ?\Closure $validate = null, string $hint = '', bool|string $required = true): mixed
     {
         if ($multiSelect) {
             // For backward compat. Deprecated.

src/Application.php

@@ -11,6 +11,7 @@
 use Drush\Boot\DrupalBootLevels;
 use Drush\Command\RemoteCommandProxy;
 use Drush\Config\ConfigAwareTrait;
+use Drush\Event\ConsoleDefinitionsEvent;
 use Drush\Runtime\RedispatchHook;
 use Drush\Runtime\ServiceManager;
 use Drush\Runtime\TildeExpansionHook;
@@ -309,6 +310,8 @@ public function configureAndRegisterCommands(InputInterface $input, OutputInterf
         // any of the configuration steps we do here.
         $this->configureIO($input, $output);
 
+        $this->addListeners($commandfileSearchpath);
+
         // Directly add the yaml-cli commands.
         $this->addCommands($this->serviceManager->instantiateYamlCliCommands());
 
@@ -327,6 +330,9 @@ public function configureAndRegisterCommands(InputInterface $input, OutputInterf
         // Note that Robo::register can accept either Annotated Command
         // command handlers or Symfony Console Command objects.
         Robo::register($this, $commandInstances);
+
+        // Dispatch our custom event. It also fires later in \Drush\Boot\DrupalBoot8::bootstrapDrupalFull.
+        Drush::getContainer()->get('eventDispatcher')->dispatch(new ConsoleDefinitionsEvent($this), ConsoleDefinitionsEvent::class);
     }
 
     /**
@@ -338,4 +344,26 @@ public function renderThrowable(\Throwable $e, OutputInterface $output): void
 
         $this->doRenderThrowable($e, $output);
     }
+
+    // Discover event listeners, and add those that do not require bootstrap.
+    protected function addListeners($commandfileSearchpath): void
+    {
+        $listenerClasses = $this->serviceManager->discoverListeners($commandfileSearchpath, '\Drush');
+        $listenerClasses = $this->serviceManager->filterListeners($listenerClasses);
+        $this->serviceManager->addListeners($listenerClasses, Drush::getContainer());
+    }
+
+    /**
+     * Remove a command. Initially used by WootDefinitionListener and its test.
+     *
+     * An alternative would be console.excluded https://github.com/search?q=repo%3AHuttopia%2Fconsole-bundle%20console.excluded&type=code
+     */
+    public function remove(string $id): void
+    {
+        $rf = new \ReflectionProperty(\Symfony\Component\Console\Application::class, 'commands');
+        $rf->setAccessible(true);
+        $commands = $rf->getValue($this);
+        unset($commands[$id]);
+        $rf->setValue($this, $commands);
+    }
 }

src/Attributes/DefaultFields.php

@@ -5,8 +5,24 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class DefaultFields extends \Consolidation\AnnotatedCommand\Attributes\DefaultFields
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
+class DefaultFields
 {
+    const KEY = 'default-fields';
+
+    /**
+     * @param $fields
+     *   An array of field names to show by default.
+     */
+    public function __construct(public array $fields)
+    {
+    }
+
+    public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)
+    {
+        $args = $attribute->getArguments();
+        $commandInfo->addAnnotation('default-fields', $args['fields']);
+    }
 }

src/Attributes/DefaultTableFields.php

@@ -5,8 +5,25 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use Consolidation\AnnotatedCommand\Parser\CommandInfo;
+use Consolidation\OutputFormatters\Options\FormatterOptions;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class DefaultTableFields extends \Consolidation\AnnotatedCommand\Attributes\DefaultTableFields
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
+class DefaultTableFields
 {
+    const KEY = FormatterOptions::DEFAULT_TABLE_FIELDS;
+
+    /**
+     * @param $fields
+     *   An array of field names to show by default when using table formatter.
+     */
+    public function __construct(public array $fields)
+    {
+    }
+
+    public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)
+    {
+        $args = $attribute->getArguments();
+        $commandInfo->addAnnotation('default-table-fields', $args['fields']);
+    }
 }

src/Attributes/FieldLabels.php

@@ -1,12 +1,28 @@
 <?php
 
-declare(strict_types=1);
-
 namespace Drush\Attributes;
 
 use Attribute;
+use Consolidation\AnnotatedCommand\Parser\CommandInfo;
+use Consolidation\OutputFormatters\Options\FormatterOptions;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class FieldLabels extends \Consolidation\AnnotatedCommand\Attributes\FieldLabels
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
+class FieldLabels
 {
+    const KEY = FormatterOptions::FIELD_LABELS;
+
+    /**
+     * @param $labels
+     *   An associative array of field names and labels for display.
+     */
+    public function __construct(
+        public array $labels
+    ) {
+    }
+
+    public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)
+    {
+        $args = $attribute->getArguments();
+        $commandInfo->addAnnotation('field-labels', $args['labels']);
+    }
 }

src/Attributes/FilterDefaultField.php

@@ -1,12 +1,27 @@
 <?php
 
-declare(strict_types=1);
-
 namespace Drush\Attributes;
 
 use Attribute;
+use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 
-#[Attribute(Attribute::TARGET_METHOD)]
-class FilterDefaultField extends \Consolidation\AnnotatedCommand\Attributes\FilterDefaultField
+#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS)]
+class FilterDefaultField
 {
+    const KEY = 'filter-default-field';
+
+    /**
+     * @param $field
+     *   A field name to filter on by default.
+     */
+    public function __construct(
+        public string $field
+    ) {
+    }
+
+    public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)
+    {
+        $args = $attribute->getArguments();
+        $commandInfo->addAnnotation('filter-default-field', $args['field']);
+    }
 }

src/Attributes/Format.php

@@ -7,7 +7,6 @@
 use Attribute;
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Consolidation\OutputFormatters\Options\FormatterOptions;
-use Drush\Boot\Kernels;
 use JetBrains\PhpStorm\ExpectedValues;
 
 #[Attribute(Attribute::TARGET_METHOD)]

src/Attributes/OptionsetSql.php

@@ -8,7 +8,7 @@
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Drush\Commands\DrushCommands;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class OptionsetSql
 {
     public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)

src/Attributes/OptionsetTableSelection.php

@@ -8,7 +8,7 @@
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Drush\Commands\DrushCommands;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class OptionsetTableSelection
 {
     public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)
@@ -18,7 +18,6 @@ public static function handle(\ReflectionAttribute $attribute, CommandInfo $comm
         $commandInfo->addOption('tables-key', 'A key in the $tables array.', [], DrushCommands::REQ);
         $commandInfo->addOption('skip-tables-list', 'A comma-separated list of tables to exclude completely.', [], DrushCommands::REQ);
         $commandInfo->addOption('structure-tables-list', 'A comma-separated list of tables to include for structure, but not data.', [], DrushCommands::REQ);
-        $commandInfo->addOption('skip-tables-list', 'A comma-separated list of tables to exclude completely.', [], DrushCommands::REQ);
         $commandInfo->addOption('tables-list', 'A comma-separated list of tables to transfer.', [], DrushCommands::REQ);
     }
 }

src/Attributes/ValidateEntityLoad.php

@@ -9,7 +9,7 @@
 use Consolidation\AnnotatedCommand\CommandError;
 use Drush\Utils\StringUtils;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class ValidateEntityLoad extends ValidatorBase implements ValidatorInterface
 {
     /**

src/Attributes/ValidateModulesEnabled.php

@@ -8,7 +8,7 @@
 use Consolidation\AnnotatedCommand\CommandData;
 use Consolidation\AnnotatedCommand\CommandError;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class ValidateModulesEnabled extends ValidatorBase implements ValidatorInterface
 {
     /**

src/Boot/DrupalBoot8.php

@@ -13,11 +13,10 @@
 use Drush\Config\ConfigLocator;
 use Drush\Drupal\DrushLoggerServiceProvider;
 use Drush\Drush;
+use Drush\Event\ConsoleDefinitionsEvent;
 use Drush\Runtime\LegacyServiceFinder;
 use Drush\Runtime\LegacyServiceInstantiator;
 use Drush\Runtime\ServiceManager;
-use Psr\Log\LoggerAwareInterface;
-use Psr\Log\LoggerInterface;
 use Robo\Robo;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -215,12 +214,20 @@ public function bootstrapDrupalFull(BootstrapManager $manager): void
         // Directly add the Drupal core bootstrapped commands.
         Drush::getApplication()->addCommands($this->serviceManager->instantiateDrupalCoreBootstrappedCommands());
 
+        $this->addBootstrapListeners();
+
         $this->addDrupalModuleDrushCommands($manager);
 
+        // Dispatch our custom event. It also fires earlier in \Drush\Application::configureAndRegisterCommands.
+        Drush::getContainer()->get('eventDispatcher')->dispatch(new ConsoleDefinitionsEvent(Drush::getApplication()), ConsoleDefinitionsEvent::class);
+
         // Set a default account to make sure the correct timezone is set
         $this->kernel->getContainer()->get('current_user')->setAccount(new AnonymousUserSession());
     }
 
+    /**
+     * Adds module supplied commands, as well as Drush Console commands that require bootstrap.
+     */
     public function addDrupalModuleDrushCommands(BootstrapManager $manager): void
     {
         $application = Drush::getApplication();
@@ -323,4 +330,17 @@ public function bootstrapDrupalSite(BootstrapManager $manager)
     {
         $this->bootstrapDoDrupalSite($manager);
     }
+
+    // Add the Listeners that require bootstrap.
+    public function addBootstrapListeners(): void
+    {
+        $listenersInThisModule = [];
+        $moduleHandler = \Drupal::moduleHandler();
+        foreach ($moduleHandler->getModuleList() as $moduleId => $extension) {
+            $path = DRUPAL_ROOT . '/' . $extension->getPath() . '/src/Drush';
+            $listenersInThisModule = array_merge($listenersInThisModule, $this->serviceManager->discoverListeners([$path], "\Drupal\\$moduleId\Drush"));
+        }
+        $classes = $this->serviceManager->bootstrapListenerClasses();
+        $this->serviceManager->addListeners(array_merge($listenersInThisModule, $classes), Drush::getContainer(), \Drupal::getContainer());
+    }
 }

src/Commands/AutowireTrait.php

@@ -21,8 +21,6 @@ trait AutowireTrait
      *
      * @param ContainerInterface $container
      *   The service container this instance should use.
-     *
-     * @return static
      */
     public static function create(ContainerInterface $container)
     {

src/Commands/OptionSets.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Drush\Commands;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputOption;
+
+class OptionSets
+{
+    public static function sql(Command $command)
+    {
+        $command->addOption('database', '', InputOption::VALUE_REQUIRED, 'The DB connection key if using multiple connections in settings.php.', 'default');
+        $command->addOption('db-url', '', InputOption::VALUE_REQUIRED, 'A Drupal 6 style database URL. For example <info>mysql://root:pass@localhost:port/dbname</info>');
+        $command->addOption('target', '', InputOption::VALUE_REQUIRED, 'The name of a target within the specified database connection.', 'default');
+        $command->addOption('show-passwords', '', InputOption::VALUE_NONE, 'Show password on the CLI. Useful for debugging.');
+    }
+}

src/Commands/Validators.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Drush\Commands;
+
+class Validators
+{
+    public static function entityLoad(array $ids, string $entityType): void
+    {
+        // @todo It is a burden for the caller to inject the entityTypeManager.
+        $loaded = \Drupal::entityTypeManager()->getStorage($entityType)->loadMultiple($ids);
+        if ($missing = array_diff($ids, array_keys($loaded))) {
+            $msg = dt('Unable to load the !type: !str', ['!type' => $entityType, '!str' => implode(', ', $missing)]);
+            throw new \Exception($msg);
+        }
+    }
+}

src/Commands/core/CoreCommands.php

@@ -4,12 +4,12 @@
 
 namespace Drush\Commands\core;
 
+use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\OutputFormatters\StructuredData\PropertyList;
+use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
 use Drush\Attributes as CLI;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
-use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
-use Consolidation\OutputFormatters\Options\FormatterOptions;
 
 final class CoreCommands extends DrushCommands
 {