TASK: improve APIs

Author: skurfuerst

Classes/Dto/Jobs.php

@@ -2,6 +2,7 @@
 
 namespace Flowpack\Prunner\Dto;
 
+use Flowpack\Prunner\ValueObject\PipelineName;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -29,11 +30,11 @@ public function fromJsonArray(array $in): self
         return new self($converted);
     }
 
-    public function forPipeline(string $pipeline): Jobs
+    public function forPipeline(PipelineName $pipeline): Jobs
     {
         $filteredJobs = [];
         foreach ($this->jobs as $job) {
-            if ($job->getPipeline() === $pipeline) {
+            if ($job->getPipeline() === $pipeline->getName()) {
                 $filteredJobs[] = $job;
             }
         }
@@ -42,7 +43,25 @@ public function forPipeline(string $pipeline): Jobs
     }
 
     /**
-     * @return \Iterator<Job>
+     * Filter running jobs
+     *
+     * @return Jobs
+     */
+    public function running(): Jobs
+    {
+        $filteredJobs = [];
+        foreach ($this->jobs as $job) {
+            // running = started jobs which have not finished.
+            if ($job->getStart() !== null && !$job->getEnd()) {
+                $filteredJobs[] = $job;
+            }
+        }
+
+        return new self($filteredJobs);
+    }
+
+    /**
+     * @return \Iterator<Job>|Job[]
      */
     public function getIterator()
     {

Classes/Dto/PipelinesAndJobsResponse.php

@@ -19,7 +19,7 @@ protected function __construct(Pipelines $pipelines, Jobs $jobs)
         $this->jobs = $jobs;
     }
 
-    public function fromJsonArray(array $in): self
+    public static function fromJsonArray(array $in): self
     {
         $pipelines = Pipelines::fromJsonArray($in['pipelines']);
         $jobs = Jobs::fromJsonArray($in['jobs']);

Classes/PrunnerApiService.php

@@ -3,6 +3,7 @@
 namespace Flowpack\Prunner;
 
 use Firebase\JWT\JWT;
+use Flowpack\Prunner\Dto\Job;
 use Flowpack\Prunner\Dto\PipelinesAndJobsResponse;
 use Flowpack\Prunner\ValueObject\JobId;
 use Flowpack\Prunner\ValueObject\PipelineName;
@@ -50,6 +51,13 @@ public function loadPipelinesAndJobs(): PipelinesAndJobsResponse
         return PipelinesAndJobsResponse::fromJsonArray($result);
     }
 
+    public function loadJobDetail(JobId $jobId): Job
+    {
+        $resultString = $this->apiCall('GET', 'job/detail?' . http_build_query(['id' => $jobId->getId()]), null)->getBody()->getContents();
+        $result = json_decode($resultString, true);
+        return Job::fromJsonArray($result);
+    }
+
     public function schedulePipeline(PipelineName $pipeline, array $variables): JobId
     {
         $response = $this->apiCall('POST', 'pipelines/schedule', json_encode([
@@ -64,6 +72,14 @@ public function schedulePipeline(PipelineName $pipeline, array $variables): JobI
         return JobId::create($tmp['jobId']);
     }
 
+    public function cancelJob(Job $job): void
+    {
+        $response = $this->apiCall('POST', 'job/cancel?' . http_build_query(['id' => $job->getId()]), '');
+        if ($response->getStatusCode() !== 200) {
+            throw new \RuntimeException('Cancelling a job should have returned status code 200, but got: ' . $response->getStatusCode());
+        }
+    }
+
     /**
      * Low-Level method, handling only the authentication.
      *