Clean up finished jobs after batch processing

Author: kedarkhaire

modules/apigee_edge_teams/src/Controller/TeamMemberSyncController.php

@@ -148,6 +148,7 @@ public static function getBatch(): array {
       'operations' => [
         [[static::class, 'batchGenerateJobs'], [$tag]],
         [[static::class, 'batchExecuteJobs'], [$tag]],
+        [[static::class, 'batchCleanupJobs'], [$tag]],
       ],
       'finished' => [static::class, 'batchFinished'],
     ];
@@ -199,6 +200,23 @@ public static function batchExecuteJobs(string $tag, array &$context) {
     $context['finished'] = $executor->countJobs($tag, [Job::FAILED, Job::FINISHED]) / $executor->countJobs($tag);
   }
 
+  /**
+   * The third batch operation.
+   *
+   * @param string $tag
+   *   Job tag.
+   * @param array $context
+   *   Batch context.
+   */
+  public static function batchCleanupJobs(string $tag, array &$context) {
+    $executor = apigee_edge_get_executor();
+    $executor->cleanup($tag);
+    // This is needed to prevent the Drush CLI throwing warnings.
+    $context['message'] = '';
+    // This is needed to tell the Drush CLI we're finished.
+    $context['finished'] = 1.0;
+  }
+
   /**
    * Batch finish callback.
    */

src/Controller/DeveloperSyncController.php

@@ -148,6 +148,7 @@ public static function getBatch(): array {
       'operations' => [
         [[static::class, 'batchGenerateJobs'], [$tag]],
         [[static::class, 'batchExecuteJobs'], [$tag]],
+        [[static::class, 'batchCleanupJobs'], [$tag]],
       ],
       'finished' => [static::class, 'batchFinished'],
     ];
@@ -199,6 +200,23 @@ public static function batchExecuteJobs(string $tag, array &$context) {
     $context['finished'] = $executor->countJobs($tag, [Job::FAILED, Job::FINISHED]) / $executor->countJobs($tag);
   }
 
+  /**
+   * The third batch operation.
+   *
+   * @param string $tag
+   *   Job tag.
+   * @param array $context
+   *   Batch context.
+   */
+  public static function batchCleanupJobs(string $tag, array &$context) {
+    $executor = apigee_edge_get_executor();
+    $executor->cleanup($tag);
+    // This is needed to prevent the Drush CLI throwing warnings.
+    $context['message'] = '';
+    // This is needed to tell the Drush CLI we're finished.
+    $context['finished'] = 1.0;
+  }
+
   /**
    * Batch finish callback.
    */

src/JobExecutor.php

@@ -192,4 +192,14 @@ public function countJobs(?string $tag = NULL, ?array $statuses = NULL): int {
       ->fetchField();
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function cleanup(string $tag): void {
+    $query = $this->connection->delete('apigee_edge_job')
+      ->condition('status', Job::FINISHED)
+      ->condition('tag', $tag);
+    $query->execute();
+  }
+
 }

src/JobExecutorInterface.php

@@ -99,4 +99,14 @@ public function cast(Job $job);
    */
   public function countJobs(?string $tag = NULL, ?array $statuses = NULL): int;
 
+  /**
+   * Cleans up finished jobs in the queue.
+   *
+   * @param string $tag
+   *   Tag to filter with.
+   *
+   * @todo Handle race conditions.
+   */
+  public function cleanup(string $tag): void;
+
 }