Issue #3420988 by godotislate, smustgrave: Convert QueueWorker plugin discovery to attributes

core/lib/Drupal/Core/Queue/Attribute/QueueWorker.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Drupal\Core\Queue\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+/**
+ * Declare a worker class for processing a queue item.
+ *
+ * Worker plugins are used by some queues for processing the individual items
+ * in the queue. In that case, the ID of the worker plugin needs to match the
+ * machine name of a queue, so that you can retrieve the queue back end by
+ * calling \Drupal\Core\Queue\QueueFactory::get($plugin_id).
+ *
+ * \Drupal\Core\Cron::processQueues() processes queues that use workers; they
+ * can also be processed outside of the cron process.
+ *
+ * Some queues do not use worker plugins: you can create queues, add items to
+ * them, claim them, etc. without using a QueueWorker plugin. However, you will
+ * need to take care of processing the items in the queue in that case. You can
+ * look at \Drupal\Core\Cron::processQueues() for an example of how to process
+ * a queue that uses workers, and adapt it to your queue.
+ *
+ * Plugin Namespace: Plugin\QueueWorker
+ *
+ * For a working example, see
+ * \Drupal\locale\Plugin\QueueWorker\LocaleTranslation.
+ *
+ * @see \Drupal\Core\Queue\QueueWorkerInterface
+ * @see \Drupal\Core\Queue\QueueWorkerBase
+ * @see \Drupal\Core\Queue\QueueWorkerManager
+ * @see plugin_api
+ *
+ * @ingroup queue
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class QueueWorker extends Plugin {
+
+  /**
+   * @param string $id
+   *   The plugin ID.
+   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title
+   *   The human-readable title of the plugin.
+   * @param array|null $cron
+   *   (optional) An associative array of settings for cron. The array has one
+   *   key, time, which is set to the time Drupal cron should spend on calling
+   *   this worker in seconds. The default is set in
+   *   \Drupal\Core\Queue\QueueWorkerManager::processDefinition().
+   * @param class-string|null $deriver
+   *   (optional) The deriver class.
+   */
+  public function __construct(
+    public readonly string $id,
+    public readonly ?TranslatableMarkup $title = NULL,
+    public readonly ?array $cron = NULL,
+    public readonly ?string $deriver = NULL
+  ) {}
+
+}

core/lib/Drupal/Core/Queue/QueueWorkerManager.php

@@ -5,6 +5,7 @@ namespace Drupal\Core\Queue;
 use Drupal\Core\Cache\CacheBackendInterface;
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Plugin\DefaultPluginManager;
+use Drupal\Core\Queue\Attribute\QueueWorker;
 
 /**
  * Defines the queue worker manager.
@@ -28,7 +29,7 @@ class QueueWorkerManager extends DefaultPluginManager implements QueueWorkerMana
    *   The module handler.
    */
   public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
-    parent::__construct('Plugin/QueueWorker', $namespaces, $module_handler, 'Drupal\Core\Queue\QueueWorkerInterface', 'Drupal\Core\Annotation\QueueWorker');
+    parent::__construct('Plugin/QueueWorker', $namespaces, $module_handler, 'Drupal\Core\Queue\QueueWorkerInterface', QueueWorker::class, 'Drupal\Core\Annotation\QueueWorker');
 
     $this->setCacheBackend($cache_backend, 'queue_plugins');
     $this->alterInfo('queue_info');

core/modules/locale/src/Plugin/QueueWorker/LocaleTranslation.php

@@ -4,19 +4,20 @@ namespace Drupal\locale\Plugin\QueueWorker;
 
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueInterface;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Executes interface translation queue tasks.
- *
- * @QueueWorker(
- *   id = "locale_translation",
- *   title = @Translation("Update translations"),
- *   cron = {"time" = 30}
- * )
  */
+#[QueueWorker(
+  id: 'locale_translation',
+  title: new TranslatableMarkup('Update translations'),
+  cron: ['time' => 30]
+)]
 class LocaleTranslation extends QueueWorkerBase implements ContainerFactoryPluginInterface {
 
   /**

core/modules/media/src/Plugin/QueueWorker/ThumbnailDownloader.php

@@ -4,18 +4,19 @@ namespace Drupal\media\Plugin\QueueWorker;
 
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Process a queue of media items to fetch their thumbnails.
- *
- * @QueueWorker(
- *   id = "media_entity_thumbnail",
- *   title = @Translation("Thumbnail downloader"),
- *   cron = {"time" = 60}
- * )
  */
+#[QueueWorker(
+  id: 'media_entity_thumbnail',
+  title: new TranslatableMarkup('Thumbnail downloader'),
+  cron: ['time' => 60]
+)]
 class ThumbnailDownloader extends QueueWorkerBase implements ContainerFactoryPluginInterface {
 
   /**

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestDatabaseDelayException.php

@@ -2,18 +2,19 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\DelayedRequeueException;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * A queue worker for testing cron exception handling.
- *
- * @QueueWorker(
- *   id = "cron_queue_test_database_delay_exception",
- *   title = @Translation("Database delay exception test"),
- *   cron = {"time" = 1}
- * )
  */
+#[QueueWorker(
+  id: 'cron_queue_test_database_delay_exception',
+  title: new TranslatableMarkup('Database delay exception test'),
+  cron: ['time' => 1]
+)]
 class CronQueueTestDatabaseDelayException extends QueueWorkerBase {
 
   const DELAY_INTERVAL = 100;

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestDeriverQueue.php

@@ -2,16 +2,20 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\cron_queue_test\Plugin\Derivative\CronQueueTestDeriver;
 
 /**
- * @QueueWorker(
- *   id = \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestDeriverQueue::PLUGIN_ID,
- *   title = @Translation("Deriver queue test"),
- *   cron = {"time" = 1},
- *   deriver = \Drupal\cron_queue_test\Plugin\Derivative\CronQueueTestDeriver::class
- * )
+ * A queue worker for testing derivatives.
  */
+#[QueueWorker(
+  id: self::PLUGIN_ID,
+  title: new TranslatableMarkup('Deriver queue test'),
+  cron: ['time' => 1],
+  deriver: CronQueueTestDeriver::class
+)]
 class CronQueueTestDeriverQueue extends QueueWorkerBase {
 
   /**

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestException.php

@@ -2,15 +2,18 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
- * @QueueWorker(
- *   id = \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestException::PLUGIN_ID,
- *   title = @Translation("Exception test"),
- *   cron = {"time" = 1}
- * )
+ * A queue worker for testing exceptions.
  */
+#[QueueWorker(
+  id: self::PLUGIN_ID,
+  title: new TranslatableMarkup('Exception test'),
+  cron: ['time' => 1]
+)]
 class CronQueueTestException extends QueueWorkerBase {
 
   /**

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestLeaseTime.php

@@ -2,15 +2,18 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
- * @QueueWorker(
- *   id = "cron_queue_test_lease_time",
- *   title = @Translation("Lease time test"),
- *   cron = {"time" = 100}
- * )
+ * A queue worker for testing lease time.
  */
+#[QueueWorker(
+  id: 'cron_queue_test_lease_time',
+  title: new TranslatableMarkup('Lease time test'),
+  cron: ['time' => 100]
+)]
 class CronQueueTestLeaseTime extends QueueWorkerBase {
 
   /**

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestMemoryDelayException.php

@@ -2,18 +2,19 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\DelayedRequeueException;
 use Drupal\Core\Queue\QueueWorkerBase;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * A queue worker for testing cron exception handling.
- *
- * @QueueWorker(
- *   id = "cron_queue_test_memory_delay_exception",
- *   title = @Translation("Memory delay exception test"),
- *   cron = {"time" = 1}
- * )
  */
+#[QueueWorker(
+  id: 'cron_queue_test_memory_delay_exception',
+  title: new TranslatableMarkup('Memory delay exception test'),
+  cron: ['time' => 1]
+)]
 class CronQueueTestMemoryDelayException extends QueueWorkerBase {
 
   /**

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestRequeueException.php

@@ -2,16 +2,19 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueWorkerBase;
 use Drupal\Core\Queue\RequeueException;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
- * @QueueWorker(
- *   id = \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestRequeueException::PLUGIN_ID,
- *   title = @Translation("RequeueException test"),
- *   cron = {"time" = 60}
- * )
+ * A queue worker for testing re-queueing items.
  */
+#[QueueWorker(
+  id: self::PLUGIN_ID,
+  title: new TranslatableMarkup('RequeueException test'),
+  cron: ['time' => 60]
+)]
 class CronQueueTestRequeueException extends QueueWorkerBase {
 
   /**

core/modules/system/tests/modules/cron_queue_test/src/Plugin/QueueWorker/CronQueueTestSuspendQueue.php

@@ -2,16 +2,19 @@
 
 namespace Drupal\cron_queue_test\Plugin\QueueWorker;
 
+use Drupal\Core\Queue\Attribute\QueueWorker;
 use Drupal\Core\Queue\QueueWorkerBase;
 use Drupal\Core\Queue\SuspendQueueException;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
- * @QueueWorker(
- *   id = \Drupal\cron_queue_test\Plugin\QueueWorker\CronQueueTestSuspendQueue::PLUGIN_ID,
- *   title = @Translation("Suspend queue test"),
- *   cron = {"time" = 60}
- * )
+ * A queue worker for testing suspending queue run.
  */
+#[QueueWorker(
+  id: self::PLUGIN_ID,
+  title: new TranslatableMarkup('Suspend queue test'),
+  cron: ['time' => 60]
+)]
 class CronQueueTestSuspendQueue extends QueueWorkerBase {
 
   /**