Merge pull request #38 from notpron/honor-correct-config

Honor task specific config

Author: tersmitten

src/Model/Table/QueuedTasksTable.php

@@ -452,17 +452,45 @@ public function rerun($taskName): int
     /**
      * Cleanup/Delete Completed Tasks.
      *
+     * @param array $capabilities Available QueueWorkerTasks.
      * @return void
      */
-    public function cleanOldJobs(): void
+    public function cleanOldJobs(array $capabilities): void
     {
-        if (!Configure::read('Queue.cleanuptimeout')) {
-            return;
+        $conditions = [];
+
+        // Generate the job specific conditions
+        foreach ($capabilities as $task) {
+            list ($plugin, $name) = pluginSplit($task['name']);
+            $conditions['OR'][] = [
+                'task' => $name,
+                'completed <' => date('Y-m-d H:i:s', time() - (int)$task['cleanupTimeout'])
+            ];
+        }
+
+        $this->deleteAll($conditions);
+    }
+
+    /**
+     * Cleanups / delete failed jobs with given capabilities after maximum retries.
+     *
+     * @param array $capabilities Available QueueWorkerTasks.
+     * @return void
+     */
+    public function cleanFailedJobs(array $capabilities): void
+    {
+        $conditions = [];
+
+        // Generate the job specific conditions.
+        foreach ($capabilities as $task) {
+            list ($plugin, $name) = pluginSplit($task['name']);
+            $conditions['OR'][] = [
+                'task' => $name,
+                'failed_count >' => $task['retries']
+            ];
         }
 
-        $this->deleteAll([
-            'completed <' => time() - (int)Configure::read('Queue.cleanuptimeout')
-        ]);
+        $this->deleteAll($conditions);
     }
 
     /**

src/Shell/QueueShell.php

@@ -208,7 +208,7 @@ public function runworker(): void
             }
             if ($this->_exit || mt_rand(0, 100) > (100 - Config::gcprob())) {
                 $this->out(__d('queue', 'Performing old job cleanup.'));
-                $this->QueuedTasks->cleanOldJobs();
+                $this->QueuedTasks->cleanOldJobs($this->_getTaskConf());
             }
             $this->hr();
         }
@@ -276,12 +276,20 @@ protected function runJob(QueuedTask $queuedTask): void
      */
     public function clean(): void
     {
-        if (!Configure::read('Queue.cleanupTimeout')) {
-            $this->abort('You disabled cleanuptimout in config. Aborting.');
-        }
+        $this->out(__d('queue', 'Deleting old completed jobs, that have had cleanup timeout.'));
+        $this->QueuedTasks->cleanOldJobs($this->_getTaskConf());
+    }
 
-        $this->out('Deleting old jobs, that have finished before ' . date('Y-m-d H:i:s', time() - (int)Configure::read('Queue.cleanupTimeout')));
-        $this->QueuedTasks->cleanOldJobs();
+    /**
+     * Manually trigger a Failed job cleanup.
+     *
+     * @return void
+     */
+    //@codingStandardsIgnoreLine
+    public function clean_failed(): void
+    {
+        $this->out(__d('queue', 'Deleting failed jobs, that have had maximum worker retries.'));
+        $this->QueuedTasks->cleanFailedJobs($this->_getTaskConf());
     }
 
     /**
@@ -363,6 +371,10 @@ public function getOptionParser(): ConsoleOptionParser
                 'help' => 'Remove old jobs (cleanup)',
                 'parser' => $subcommandParser
             ])
+            ->addSubcommand('clean_failed', [
+                'help' => 'Remove old failed jobs (cleanup)',
+                'parser' => $subcommandParser
+            ])
             ->addSubcommand('add', [
                 'help' => 'Add Job',
                 'parser' => $subcommandParser

src/Shell/Task/QueueTask.php

@@ -30,20 +30,6 @@ abstract class QueueTask extends Shell implements QueueTaskInterface
      */
     public $QueuedTasks;
 
-    /**
-     * Timeout for run, after which the Task is reassigned to a new worker.
-     *
-     * @var int
-     */
-    public $timeout = 120;
-
-    /**
-     * Number of times a failed instance of this task should be restarted before giving up.
-     *
-     * @var int
-     */
-    public $retries = 1;
-
     /**
      *
      * @param \Cake\Console\ConsoleIo|null $io IO