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-directly-of as 4.x-dev",
     "consolidation/robo": "^4.0.6 || ^5",
     "consolidation/site-alias": "^4",
     "consolidation/site-process": "^5.2.0",
@@ -88,7 +88,8 @@
   "config": {
     "allow-plugins": {
       "composer/installers": true,
-      "cweagans/composer-patches": true
+      "cweagans/composer-patches": true,
+      "symfony/runtime": true
     },
     "optimize-autoloader": true,
     "preferred-install": "dist",

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,34 @@ 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);
+    }
+
+    /**
+     * A base URL for help.
+     */
+    public function getDocsBaseUrl(): string
+    {
+        return 'https://www.drush.org/latest';
+    }
 }

src/Attributes/DefaultFields.php

@@ -5,7 +5,9 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use JetBrains\PhpStorm\Deprecated;
 
+#[Deprecated(replacement: 'Call \Drush\Formatters\FormatterTrait::configureFormatter during configure()')]
 #[Attribute(Attribute::TARGET_METHOD)]
 class DefaultFields extends \Consolidation\AnnotatedCommand\Attributes\DefaultFields
 {

src/Attributes/DefaultTableFields.php

@@ -5,7 +5,9 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use JetBrains\PhpStorm\Deprecated;
 
+#[Deprecated(replacement: 'Call \Drush\Formatters\FormatterTrait::configureFormatter during configure()')]
 #[Attribute(Attribute::TARGET_METHOD)]
 class DefaultTableFields extends \Consolidation\AnnotatedCommand\Attributes\DefaultTableFields
 {

src/Attributes/FieldLabels.php

@@ -5,7 +5,9 @@
 namespace Drush\Attributes;
 
 use Attribute;
+use JetBrains\PhpStorm\Deprecated;
 
+#[Deprecated(replacement: 'Call \Drush\Formatters\FormatterTrait::configureFormatter during configure()')]
 #[Attribute(Attribute::TARGET_METHOD)]
 class FieldLabels extends \Consolidation\AnnotatedCommand\Attributes\FieldLabels
 {

src/Attributes/FilterDefaultField.php

@@ -6,7 +6,7 @@
 
 use Attribute;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class FilterDefaultField extends \Consolidation\AnnotatedCommand\Attributes\FilterDefaultField
 {
 }

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

@@ -7,8 +7,10 @@
 use Attribute;
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Drush\Commands\DrushCommands;
+use JetBrains\PhpStorm\Deprecated;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Deprecated(replacement: 'Directly add options by calling \Drush\Commands\OptionSets::sql during configure()')]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class OptionsetSql
 {
     public static function handle(\ReflectionAttribute $attribute, CommandInfo $commandInfo)

src/Attributes/OptionsetTableSelection.php

@@ -7,7 +7,9 @@
 use Attribute;
 use Consolidation\AnnotatedCommand\Parser\CommandInfo;
 use Drush\Commands\DrushCommands;
+use JetBrains\PhpStorm\Deprecated;
 
+#[Deprecated(replacement: 'Call \Drush\Commands\OptionSets::tableSelection during configure()')]
 #[Attribute(Attribute::TARGET_METHOD)]
 class OptionsetTableSelection
 {
@@ -18,7 +20,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/Topics.php

@@ -6,7 +6,7 @@
 
 use Attribute;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 class Topics extends \Consolidation\AnnotatedCommand\Attributes\Topics
 {
 }

src/Attributes/ValidateEntityLoad.php

@@ -8,7 +8,9 @@
 use Consolidation\AnnotatedCommand\CommandData;
 use Consolidation\AnnotatedCommand\CommandError;
 use Drush\Utils\StringUtils;
+use JetBrains\PhpStorm\Deprecated;
 
+#[Deprecated(replacement: 'Copy \Drush\Commands\core\ImageFlushCommand::validateEntityLoad into command and call during execute()')]
 #[Attribute(Attribute::TARGET_METHOD)]
 class ValidateEntityLoad extends ValidatorBase implements ValidatorInterface
 {

src/Attributes/ValidateModulesEnabled.php

@@ -7,7 +7,9 @@
 use Attribute;
 use Consolidation\AnnotatedCommand\CommandData;
 use Consolidation\AnnotatedCommand\CommandError;
+use JetBrains\PhpStorm\Deprecated;
 
+#[Deprecated(replacement: 'Copy \Drush\Commands\core\ImageFlushCommand::validateModulesEnabled into command and call during execute()')]
 #[Attribute(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,27 @@
+<?php
+
+namespace Drush\Commands;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputOption;
+
+class OptionSets
+{
+    public static function sql(Command $command): void
+    {
+        $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.');
+    }
+
+    public static function tableSelection(Command $command): void
+    {
+        $command->addOption('skip-tables-key', '', InputOption::VALUE_REQUIRED, 'A key in the $skip_tables array. @see [Site aliases](../site-aliases.md)');
+        $command->addOption('structure-tables-key', '', InputOption::VALUE_REQUIRED, 'A key in the $structure_tables array. @see [Site aliases](../site-aliases.md)');
+        $command->addOption('tables-key', '', InputOption::VALUE_REQUIRED, 'A key in the $tables array.');
+        $command->addOption('skip-tables-list', '', InputOption::VALUE_REQUIRED, 'A comma-separated list of tables to exclude completely.');
+        $command->addOption('structure-tables-list', '', InputOption::VALUE_REQUIRED, 'A comma-separated list of tables to include for structure, but not data.');
+        $command->addOption('tables-list', '', InputOption::VALUE_REQUIRED, 'A comma-separated list of tables to transfer.', []);
+    }
+}

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
 {

src/Commands/core/ImageCommands.php

@@ -4,67 +4,17 @@
 
 namespace Drush\Commands\core;
 
-use Consolidation\AnnotatedCommand\AnnotationData;
-use Consolidation\AnnotatedCommand\Hooks\HookManager;
 use Drupal\image\Entity\ImageStyle;
 use Drush\Attributes as CLI;
-use Drush\Commands\DrushCommands;
-use Drush\Utils\StringUtils;
-use Symfony\Component\Console\Input\InputInterface;
 use Drush\Boot\DrupalBootLevels;
+use Drush\Commands\DrushCommands;
+use JetBrains\PhpStorm\Deprecated;
 
 final class ImageCommands extends DrushCommands
 {
-    const FLUSH = 'image:flush';
     const DERIVE = 'image:derive';
-
-    /**
-     * Flush all derived images for a given style.
-     */
-    #[CLI\Command(name: self::FLUSH, aliases: ['if', 'image-flush'])]
-    #[CLI\Argument(name: 'style_names', description: 'A comma delimited list of image style machine names. If not provided, user may choose from a list of names.')]
-    #[CLI\Option(name: 'all', description: 'Flush all derived images')]
-    #[CLI\Usage(name: 'drush image:flush', description: 'Pick an image style and then delete its derivatives.')]
-    #[CLI\Usage(name: 'drush image:flush thumbnail,large', description: 'Delete all thumbnail and large derivatives.')]
-    #[CLI\Usage(name: 'drush image:flush --all', description: 'Flush all derived images. They will be regenerated on demand.')]
-    #[CLI\ValidateEntityLoad(entityType: 'image_style', argumentName: 'style_names')]
-    #[CLI\ValidateModulesEnabled(modules: ['image'])]
-    #[CLI\Bootstrap(level: DrupalBootLevels::FULL)]
-    public function flush($style_names, $options = ['all' => false]): void
-    {
-        foreach (ImageStyle::loadMultiple(StringUtils::csvToArray($style_names)) as $style_name => $style) {
-            $style->flush();
-            $this->logger()->success(dt('Image style !style_name flushed', ['!style_name' => $style_name]));
-        }
-    }
-
-    #[CLI\Hook(type: HookManager::INTERACT, target: self::FLUSH)]
-    public function interactFlush(InputInterface $input, $output): void
-    {
-        $styles = array_keys(ImageStyle::loadMultiple());
-        $style_names = $input->getArgument('style_names');
-
-        if (empty($style_names)) {
-            $styles_all = $styles;
-            array_unshift($styles_all, 'all');
-            $choices = array_combine($styles_all, $styles_all);
-            $style_names = $this->io()->select(dt("Choose a style to flush"), $choices, 'all', scroll: 20);
-            if ($style_names == 'all') {
-                $style_names = implode(',', $styles);
-            }
-            $input->setArgument('style_names', $style_names);
-        }
-    }
-
-    #[CLI\Hook(type: HookManager::POST_INITIALIZE, target: self::FLUSH)]
-    public function postInit(InputInterface $input, AnnotationData $annotationData): void
-    {
-        // Needed for non-interactive calls.We use post-init phase because interact() methods run early
-        if ($input->getOption('all')) {
-            $styles = array_keys(ImageStyle::loadMultiple());
-            $input->setArgument('style_names', implode(",", $styles));
-        }
-    }
+    #[Deprecated(replacement: 'ImageFlushCommand::NAME')]
+    const FLUSH = ImageFlushCommand::NAME;
 
     /**
      * Create an image derivative.