Added parameter "first" to the job list request.

Author: BluePsyduck

api/openapi.yaml

@@ -111,6 +111,12 @@ paths:
           schema:
             type: number
             default: 10
+        - name: first
+          in: query
+          description: The first job to return.
+          schema:
+            type: number
+            default: 0
       responses:
         200:
           description: The list of matched export jobs.

composer.json

@@ -20,7 +20,7 @@
     "bluepsyduck/mapper-manager": "^1.2",
     "doctrine/orm": "^2.6",
     "factorio-item-browser/common": "^1.3",
-    "factorio-item-browser/combination-api-client": "^1.0",
+    "factorio-item-browser/combination-api-client": "dev-master as 1.1",
     "laminas/laminas-config-aggregator": "^1.4",
     "laminas/laminas-diactoros": "^2.5",
     "laminas/laminas-log": "^2.13",

composer.lock

@@ -49,7 +49,13 @@ public function injectQueuePosition(Job $job): void
     private function fetchQueuePositions(): array
     {
         $positions = [];
-        $jobs = $this->jobRepository->findAll(null, JobStatus::QUEUED, ListOrder::PRIORITY, self::MAX_QUEUE_POSITION);
+        $jobs = $this->jobRepository->findAll(
+            null,
+            JobStatus::QUEUED,
+            ListOrder::PRIORITY,
+            self::MAX_QUEUE_POSITION,
+            0,
+        );
         foreach ($jobs as $index => $job) {
             $positions[$job->getId()->toString()] = $index + 1;
         }

src/Helper/QueuePositionHelper.php

@@ -45,7 +45,7 @@ public function findById(UuidInterface $jobId): ?Job
         $query->setParameter('jobId', $jobId, UuidBinaryType::NAME);
         try {
             return $query->getOneOrNullResult();
-        } catch (NonUniqueResultException $e) {
+        } catch (NonUniqueResultException) {
             // Will never happen: We are searching for the primary key.
             return null;
         }
@@ -57,14 +57,16 @@ public function findById(UuidInterface $jobId): ?Job
      * @param string $status
      * @param string $order
      * @param int $limit
+     * @param int $first
      * @return array<Job>
      */
-    public function findAll(?UuidInterface $combinationId, string $status, string $order, int $limit): array
+    public function findAll(?UuidInterface $combinationId, string $status, string $order, int $limit, int $first): array
     {
         $queryBuilder = $this->entityManager->createQueryBuilder();
         $queryBuilder->select('j')
                      ->from(Job::class, 'j')
-                     ->setMaxResults($limit);
+                     ->setMaxResults($limit)
+                     ->setFirstResult($first);
 
         if ($combinationId !== null) {
             $queryBuilder->andWhere('j.combination = :combinationId')

src/Repository/JobRepository.php

@@ -45,7 +45,7 @@ public function getJobFromRequestValue(string $jobId): Job
     {
         try {
             $id = Uuid::fromString($jobId);
-        } catch (Exception $e) {
+        } catch (Exception) {
             throw new InvalidJobIdException($jobId);
         }
 
@@ -65,15 +65,16 @@ public function getJobsFromQueryParams(array $queryParams): array
     {
         try {
             $combinationId = Uuid::fromString($queryParams[ParameterName::COMBINATION_ID] ?? '');
-        } catch (Exception $e) {
+        } catch (Exception) {
             $combinationId = null;
         }
 
         return $this->jobRepository->findAll(
             $combinationId,
             $queryParams[ParameterName::STATUS] ?? '',
             $queryParams[ParameterName::ORDER] ?? '',
-            (int) ($queryParams[ParameterName::LIMIT] ?? 10)
+            (int) ($queryParams[ParameterName::LIMIT] ?? 10),
+            (int) ($queryParams[ParameterName::FIRST] ?? 0),
         );
     }
 

src/Service/JobService.php

@@ -157,6 +157,7 @@ public function testFindAll(
         array $expectedOrders
     ): void {
         $limit = 42;
+        $first = 21;
 
         $jobs = [
             $this->createMock(Job::class),
@@ -189,6 +190,10 @@ public function testFindAll(
                      ->method('setMaxResults')
                      ->with($this->identicalTo($limit))
                      ->willReturnSelf();
+        $queryBuilder->expects($this->once())
+                     ->method('setFirstResult')
+                     ->with($this->identicalTo($first))
+                     ->willReturnSelf();
         $queryBuilder->expects($this->exactly(count($expectedOrders)))
                      ->method('addOrderBy')
                      ->withConsecutive(...$expectedOrders)
@@ -203,7 +208,7 @@ public function testFindAll(
                       ->willReturn($queryBuilder);
 
         $instance = new JobRepository($entityManager);
-        $result = $instance->findAll($combinationId, $status, $order, $limit);
+        $result = $instance->findAll($combinationId, $status, $order, $limit, $first);
 
         $this->assertSame($jobs, $result);
     }

test/src/Repository/JobRepositoryTest.php

@@ -110,6 +110,7 @@ public function testGetJobsFromQueryParams(): void
             'status' => 'abc',
             'order' => 'def',
             'limit' => '42',
+            'first' => '21',
         ];
         $jobs = [
             $this->createMock(Job::class),
@@ -122,7 +123,8 @@ public function testGetJobsFromQueryParams(): void
                                 $this->equalTo(Uuid::fromString('2f4a45fa-a509-a9d1-aae6-ffcf984a7a76')),
                                 $this->identicalTo('abc'),
                                 $this->identicalTo('def'),
-                                $this->identicalTo(42)
+                                $this->identicalTo(42),
+                                $this->identicalTo(21),
                             )
                             ->willReturn($jobs);
 
@@ -145,7 +147,8 @@ public function testGetJobsFromQueryParamsWithoutValues(): void
                                 $this->isNull(),
                                 $this->identicalTo(''),
                                 $this->identicalTo(''),
-                                $this->identicalTo(10)
+                                $this->identicalTo(10),
+                                $this->identicalTo(0),
                             )
                             ->willReturn($jobs);