FEATURE: add TaskResults filter API, callable from Eel

This is useful for building custom UIs which display the pipeline

Author: skurfuerst

Classes/Dto/TaskResult.php

@@ -19,6 +19,13 @@ class TaskResult
     private bool $errored;
     private ?string $error;
 
+    public const STATUS_WAITING = 'waiting';
+    public const STATUS_RUNNING = 'running';
+    public const STATUS_SKIPPED = 'skipped';
+    public const STATUS_DONE = 'done';
+    public const STATUS_ERROR = 'error';
+    public const STATUS_CANCELED = 'canceled';
+
     private function __construct(string $name, string $status, ?\DateTimeImmutable $start, ?\DateTimeImmutable $end, bool $skipped, int $exitCode, bool $errored, ?string $error)
     {
         $this->name = $name;
@@ -55,6 +62,8 @@ public function getName(): string
     }
 
     /**
+     * see the STATUS_* constants here.
+     *
      * @return string
      */
     public function getStatus(): string

Classes/Dto/TaskResults.php

@@ -1,28 +1,141 @@
 <?php
 
-
 namespace Flowpack\Prunner\Dto;
 
+use Neos\Eel\ProtectedContextAwareInterface;
 use Neos\Flow\Annotations as Flow;
 
 /**
  * @Flow\Proxy(false)
  */
-class TaskResults implements \IteratorAggregate
+final class TaskResults implements \IteratorAggregate, \Countable, ProtectedContextAwareInterface
 {
+    /**
+     * @var TaskResult[]
+     */
     protected array $taskResults;
 
+    private function __construct(array $taskResults)
+    {
+        $this->taskResults = $taskResults;
+    }
+
+
     public function fromJsonArray(array $in): self
     {
         $converted = [];
         foreach ($in as $el) {
             $converted[] = TaskResult::fromJsonArray($el);
         }
+        return new self($converted);
+    }
+
+    /**
+     * return a new, immutable list containing only the tasks matching a certain prefix. Especially useful if you want to filter
+     * the lists before rendering them in Fusion
+     *
+     * @param string $prefix
+     * @return $this
+     */
+    public function filteredByPrefix(string $prefix): self
+    {
+        $filtered = [];
+        foreach ($this->taskResults as $taskResult) {
+            if (strpos($taskResult->getName(), $prefix) === 0) {
+                $filtered[] = $taskResult;
+            }
+        }
+        return new self($filtered);
+    }
+
+    /**
+     * return a new, immutable list containing all the tasks EXCEPT $taskNamesToSkip. Especially useful if you want to filter
+     * the lists before rendering them in Fusion
+     *
+     * @param string $prefix
+     * @return $this
+     */
+    public function withoutTasks(string ...$taskNamesToSkip): self
+    {
+        $filtered = [];
+        foreach ($this->taskResults as $taskResult) {
+            if (!in_array($taskResult->getName(), $taskNamesToSkip)) {
+                $filtered[] = $taskResult;
+            }
+        }
+        return new self($filtered);
+    }
+
+    /**
+     * an aggregated status string - useful for rendering a status in a UI:
+     * - If one of the elements is ERROR, it is failed.
+     * - If one of the elements is RUNNING, it is running.
+     * - If one element is CANCELED, it is cancelled.
+     * - If all elements are DONE, it is done.
+     * - If all elements are WAITING, it is waiting.
+     * - If all elements are SKIPPED, it is skipped.
+     * - otherwise, UNKNOWN
+     *
+     * @return string
+     */
+    public function getAggregatedStatus(): string
+    {
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getStatus() === TaskResult::STATUS_ERROR) {
+                return TaskResult::STATUS_ERROR;
+            }
+        }
+
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getStatus() === TaskResult::STATUS_RUNNING) {
+                return TaskResult::STATUS_RUNNING;
+            }
+        }
+
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getStatus() === TaskResult::STATUS_CANCELED) {
+                return TaskResult::STATUS_CANCELED;
+            }
+        }
+
+        $allDone = true;
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getStatus() !== TaskResult::STATUS_DONE) {
+                $allDone = false;
+            }
+        }
+        if ($allDone) {
+            return TaskResult::STATUS_DONE;
+        }
+
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getStatus() === TaskResult::STATUS_WAITING) {
+                return TaskResult::STATUS_WAITING;
+            }
+        }
+
+        $allSkipped = true;
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getStatus() !== TaskResult::STATUS_SKIPPED) {
+                $allSkipped = false;
+            }
+        }
+        if ($allSkipped) {
+            return TaskResult::STATUS_SKIPPED;
+        }
+
+        return 'unknown';
+    }
 
+    public function get(string $taskName): ?TaskResult
+    {
+        foreach ($this->taskResults as $taskResult) {
+            if ($taskResult->getName() === $taskName) {
+                return $taskResult;
+            }
+        }
+        return null;
 
-        $taskResults = new self();
-        $taskResults->taskResults = $converted;
-        return $taskResults;
     }
 
     /**
@@ -32,4 +145,15 @@ public function getIterator()
     {
         return new \ArrayIterator($this->taskResults);
     }
+
+    public function count()
+    {
+        return count($this->taskResults);
+    }
+
+    public function allowsCallOfMethod($methodName)
+    {
+        return true;
+    }
+
 }