3961: Commands cleanup

Author: jekuaitk

README.md

@@ -26,7 +26,9 @@ composer require os2web/os2web_audit
 drush pm:enable os2web_audit
 ```
 
-### Drush
+## Drush
+
+### Test audit log
 
 The module provides a Drush command named audit:log. This command enables you
 to log a test message to the configured logger. The audit:log command accepts a
@@ -39,6 +41,15 @@ and once as an error message.
 drush audit:log 'This is a test message'
 ```
 
+### Retry jobs
+
+The module also comes with method for retrying failed jobs. This will retry,
+all failed jobs in the `os2web_audit` queue.
+
+```shell
+drush audit:retry-jobs
+```
+
 ## Usage
 
 The module exposes a simple `Logger` service which can log an `info` and `error`

src/Drush/Commands/Commands.php renamed to src/Drush/Commands/LogMessageCommand.php

@@ -2,8 +2,6 @@
 
 namespace Drupal\os2web_audit\Drush\Commands;
 
-use Drupal\Core\Database\Connection;
-use Drupal\advancedqueue\Job;
 use Drupal\os2web_audit\Service\Logger;
 use Drush\Attributes\Argument;
 use Drush\Attributes\Command;
@@ -15,20 +13,17 @@
 /**
  * Simple command to send log message into audit log.
  */
-class Commands extends DrushCommands {
+class LogMessageCommand extends DrushCommands {
 
   /**
    * Commands constructor.
    *
    * @param \Drupal\os2web_audit\Service\Logger $auditLogger
    *   Audit logger service.
-   * @param \Drupal\Core\Database\Connection $connection
-   *   The database connection.
    */
   public function __construct(
     #[Autowire(service: 'os2web_audit.logger')]
     protected readonly Logger $auditLogger,
-    protected Connection $connection,
   ) {
     parent::__construct();
   }
@@ -39,7 +34,6 @@ public function __construct(
   public static function create(ContainerInterface $container): self {
     return new static(
       $container->get('os2web_audit.logger'),
-      $container->get('database'),
     );
   }
 
@@ -60,24 +54,4 @@ public function logMessage(string $log_message): void {
     $this->auditLogger->error('test', $log_message, TRUE, ['from' => 'drush']);
   }
 
-  /**
-  * Retries all failed jobs in the os2web_audit queue.
-  */
-  #[Command(name: 'audit:retry-jobs')]
-  public function retryJobs(): void {
-
-    try {
-      $this->connection->update('advancedqueue')
-        ->fields(['state' => Job::STATE_QUEUED])
-        ->condition('queue_id', 'os2web_audit')
-        ->condition('state', Job::STATE_FAILURE)
-        ->execute();
-
-      $this->output()->writeln('Successfully retried all failed jobs.');
-    }
-    catch (\Exception $e) {
-      $this->output()->writeln($e->getMessage());
-    }
-  }
-
 }

src/Drush/Commands/RetryFailedQueueCommand.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace Drupal\os2web_audit\Drush\Commands;
+
+use Drupal\Core\Database\Connection;
+use Drupal\advancedqueue\Job;
+use Drush\Attributes\Argument;
+use Drush\Attributes\Command;
+use Drush\Attributes\Option;
+use Drush\Commands\DrushCommands;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Simple command to send log message into audit log.
+ */
+class RetryFailedQueueCommand extends DrushCommands {
+
+  private const OS2WEB_AUDIT_QUEUE_ID = 'os2web_audit';
+  private const ADVANCEDQUEUE_TABLE = 'advancedqueue';
+
+  /**
+   * Commands constructor.
+   *
+   * @param \Drupal\Core\Database\Connection $connection
+   *   The database connection.
+   */
+  public function __construct(
+    protected Connection $connection,
+  ) {
+    parent::__construct();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container): self {
+    return new static(
+      $container->get('database'),
+    );
+  }
+
+  /**
+   * Retries failed jobs in the os2web_audit queue.
+   */
+  #[Command(name: 'audit:retry-failed-jobs')]
+  #[Argument(name: 'limit', description: "The number of jobs to retry. Minimum: 1, Maximum: 5000")]
+  public function retryJobs(int $limit = 1000): void {
+
+    if ($limit < 1 || $limit > 5000) {
+      $this->output()->writeln('Limit should be an integer between 1 and 5000.');
+      return;
+    }
+
+    $ids = $this->connection->select(self::ADVANCEDQUEUE_TABLE, 'a')
+      ->fields('a', ['job_id'])
+      ->condition('queue_id', self::OS2WEB_AUDIT_QUEUE_ID)
+      ->condition('state', Job::STATE_FAILURE)
+      ->range(0, $limit)
+      ->execute()
+      ->fetchCol();
+
+    try {
+      $this->connection->update(self::ADVANCEDQUEUE_TABLE)
+        ->fields(['state' => Job::STATE_QUEUED])
+        ->condition('queue_id', self::OS2WEB_AUDIT_QUEUE_ID)
+        ->condition('state', Job::STATE_FAILURE)
+        ->condition('job_id', $ids, 'IN')
+        ->execute();
+
+      $this->output()->writeln('Successfully retried failed jobs.');
+    }
+    catch (\Exception $e) {
+      $this->output()->writeln($e->getMessage());
+    }
+  }
+
+  /**
+   * Retries failed job.
+   */
+  #[Command(name: 'audit:retry-job')]
+  #[Argument(name: 'id', description: "The job ID to retry.")]
+  #[Option(name: 'ignore-state', description: 'Retries job regardless of state.')]
+  public function retryJob(int $id, bool $ignoreState): void {
+
+    try {
+      // Check that job exists by fetching its state.
+      $query = $this->connection->select(self::ADVANCEDQUEUE_TABLE, 'a')
+        ->fields('a', ['state'])
+        ->condition('job_id', $id);
+
+      $result = $query->execute()->fetchAssoc();
+
+      if (!$result) {
+        $this->output()->writeln('Job not found.');
+        return;
+      }
+
+      // State check.
+      if (!$ignoreState && $result['state'] !== Job::STATE_FAILURE) {
+        $this->output()->writeln('Job is not in a failed state.');
+        return;
+      }
+
+      $query = $this->connection->update(self::ADVANCEDQUEUE_TABLE)
+        ->fields(['state' => Job::STATE_QUEUED])
+        ->condition('queue_id', self::OS2WEB_AUDIT_QUEUE_ID)
+        ->condition('job_id', $id);
+
+      if (!$ignoreState) {
+        $query->condition('state', Job::STATE_FAILURE);
+      }
+
+      $result = $query->execute();
+
+      if ($result) {
+        $this->output()->writeln('Successfully retried job.');
+      }
+      else {
+        $this->output()->writeln('Failed retrying job.');
+      }
+
+    }
+    catch (\Exception $e) {
+      $this->output()->writeln($e->getMessage());
+    }
+  }
+
+}