feature #98 Total count JobExecution matched by query

yokai-php · Jan 11, 2024 · e5d3940 · e5d3940
1 parent f6f6826
commit e5d3940
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 27 deletions.
diff --git a/src/batch-doctrine-dbal/src/DoctrineDBALJobExecutionStorage.php b/src/batch-doctrine-dbal/src/DoctrineDBALJobExecutionStorage.php
@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Driver\Result;
 use Doctrine\DBAL\Exception as DBALException;
+use Doctrine\DBAL\Query\QueryBuilder;
 use Doctrine\DBAL\Schema\Comparator;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
@@ -147,34 +148,10 @@ public function list(string $jobName): iterable
 
     public function query(Query $query): iterable
     {
-        $queryParameters = [];
-        $queryTypes = [];
-
         $qb = $this->connection->createQueryBuilder();
         $qb->select('*')
             ->from($this->table);
 
-        $names = $query->jobs();
-        if (\count($names) > 0) {
-            $qb->andWhere($qb->expr()->in('job_name', ':jobNames'));
-            $queryParameters['jobNames'] = $names;
-            $queryTypes['jobNames'] = Connection::PARAM_STR_ARRAY;
-        }
-
-        $ids = $query->ids();
-        if (\count($ids) > 0) {
-            $qb->andWhere($qb->expr()->in('id', ':ids'));
-            $queryParameters['ids'] = $ids;
-            $queryTypes['ids'] = Connection::PARAM_STR_ARRAY;
-        }
-
-        $statuses = $query->statuses();
-        if (\count($statuses) > 0) {
-            $qb->andWhere($qb->expr()->in('status', ':statuses'));
-            $queryParameters['statuses'] = $statuses;
-            $queryTypes['statuses'] = Connection::PARAM_INT_ARRAY;
-        }
-
         switch ($query->sort()) {
             case Query::SORT_BY_START_ASC:
                 $qb->orderBy('start_time', 'asc');
@@ -193,7 +170,18 @@ public function query(Query $query): iterable
         $qb->setMaxResults($query->limit());
         $qb->setFirstResult($query->offset());
 
-        yield from $this->queryList($qb->getSQL(), $queryParameters, $queryTypes);
+        yield from $this->queryList($qb->getSQL(), ...$this->addWheres($query, $qb));
+    }
+
+    public function count(Query $query): int
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->select('count(*)')
+            ->from($this->table);
+
+        [$parameters, $types] = $this->addWheres($query, $qb);
+
+        return $this->connection->executeQuery($qb->getSQL(), $parameters, $types)->fetchOne();
     }
 
     private function getSchema(): Schema
@@ -303,6 +291,16 @@ private function queryList(string $query, array $parameters, array $types): Gene
         $statement->free();
     }
 
+    /**
+     * @phpstan-param array<string, mixed>      $parameters
+     * @phpstan-param array<string, int|string> $types
+     */
+    private function queryCount(string $query, array $parameters, array $types): false|int
+    {
+        /** @var Result $statement */
+        return $this->connection->executeQuery($query, $parameters, $types)->fetchOne();
+    }
+
     /**
      * @phpstan-return array<string, mixed>
      */
@@ -325,4 +323,36 @@ private function getNormalizer(): JobExecutionRowNormalizer
 
         return $this->normalizer;
     }
+
+    /**
+     * @return array<array<string|int>>
+     */
+    private function addWheres(Query $query, QueryBuilder $qb): array
+    {
+        $queryParameters = [];
+        $queryTypes = [];
+
+        $names = $query->jobs();
+        if (count($names) > 0) {
+            $qb->andWhere($qb->expr()->in('job_name', ':jobNames'));
+            $queryParameters['jobNames'] = $names;
+            $queryTypes['jobNames'] = Connection::PARAM_STR_ARRAY;
+        }
+
+        $ids = $query->ids();
+        if (count($ids) > 0) {
+            $qb->andWhere($qb->expr()->in('id', ':ids'));
+            $queryParameters['ids'] = $ids;
+            $queryTypes['ids'] = Connection::PARAM_STR_ARRAY;
+        }
+
+        $statuses = $query->statuses();
+        if (count($statuses) > 0) {
+            $qb->andWhere($qb->expr()->in('status', ':statuses'));
+            $queryParameters['statuses'] = $statuses;
+            $queryTypes['statuses'] = Connection::PARAM_INT_ARRAY;
+        }
+
+        return [$queryParameters, $queryTypes];
+    }
 }
diff --git a/src/batch-doctrine-dbal/tests/DoctrineDBALJobExecutionStorageTest.php b/src/batch-doctrine-dbal/tests/DoctrineDBALJobExecutionStorageTest.php
@@ -275,13 +275,14 @@ public function testList(): void
     /**
      * @dataProvider queries
      */
-    public function testQuery(QueryBuilder $queryBuilder, array $expectedCouples): void
+    public function testQuery(QueryBuilder $queryBuilder, array $expectedCouples, int $expectedCount): void
     {
         $storage = $this->createStorage();
         $storage->setup();
         $this->loadFixtures($storage);
 
         self::assertExecutions($expectedCouples, $storage->query($queryBuilder->getQuery()));
+        self::assertSame($expectedCount, $storage->count($queryBuilder->getQuery()));
     }
 
     public function queries(): Generator
@@ -294,6 +295,7 @@ public function queries(): Generator
                 ['import', '789'],
                 ['import', '987'],
             ],
+            4
         ];
         yield 'Filter ids' => [
             (new QueryBuilder())
@@ -302,20 +304,23 @@ public function queries(): Generator
                 ['export', '123'],
                 ['import', '987'],
             ],
+            2
         ];
         yield 'Filter job names' => [
             (new QueryBuilder())
                 ->jobs(['export']),
             [
                 ['export', '123'],
             ],
+            1,
         ];
         yield 'Filter statuses' => [
             (new QueryBuilder())
                 ->statuses([BatchStatus::FAILED]),
             [
                 ['import', '456'],
             ],
+            1,
         ];
         yield 'Order by start ASC' => [
             (new QueryBuilder())
@@ -326,6 +331,7 @@ public function queries(): Generator
                 ['export', '123'],
                 ['import', '456'],
             ],
+            4,
         ];
         yield 'Order by start DESC' => [
             (new QueryBuilder())
@@ -336,6 +342,7 @@ public function queries(): Generator
                 ['import', '789'],
                 ['import', '987'],
             ],
+            4,
         ];
         yield 'Order by end ASC' => [
             (new QueryBuilder())
@@ -346,6 +353,7 @@ public function queries(): Generator
                 ['export', '123'],
                 ['import', '456'],
             ],
+            4,
         ];
         yield 'Order by end DESC' => [
             (new QueryBuilder())
@@ -356,6 +364,7 @@ public function queries(): Generator
                 ['import', '987'],
                 ['import', '789'],
             ],
+            4,
         ];
     }
 

diff --git a/src/batch/src/Storage/FilesystemJobExecutionStorage.php b/src/batch/src/Storage/FilesystemJobExecutionStorage.php
@@ -139,6 +139,11 @@ public function query(Query $query): iterable
         return \array_slice($candidates, $query->offset(), $query->limit());
     }
 
+    public function count(Query $query): int
+    {
+        return count($this->query($query));
+    }
+
     private function buildFilePath(string $jobName, string $executionId): string
     {
         return \implode(DIRECTORY_SEPARATOR, [$this->directory, $jobName, $executionId]) .

diff --git a/src/batch/src/Storage/QueryableJobExecutionStorageInterface.php b/src/batch/src/Storage/QueryableJobExecutionStorageInterface.php
@@ -17,4 +17,9 @@ interface QueryableJobExecutionStorageInterface extends ListableJobExecutionStor
      * @return iterable|JobExecution[]
      */
     public function query(Query $query): iterable;
+
+    /**
+     * Execute query against stored job executions, and return count result.
+     */
+    public function count(Query $query): int;
 }
diff --git a/src/batch/tests/Storage/FilesystemJobExecutionStorageTest.php b/src/batch/tests/Storage/FilesystemJobExecutionStorageTest.php
@@ -142,14 +142,15 @@ public function list(): \Generator
     /**
      * @dataProvider query
      */
-    public function testQueryWithProvider(QueryBuilder $query, array $expectedCouples): void
+    public function testQueryWithProvider(QueryBuilder $query, array $expectedCouples, int $expectedCount): void
     {
         $storage = $this->createStorage(
             __DIR__ . '/fixtures/filesystem-job-execution',
             new JsonJobExecutionSerializer()
         );
 
         self::assertExecutions($expectedCouples, $storage->query($query->getQuery()));
+        self::assertEquals($expectedCount, $storage->count($query->getQuery()));
     }
 
     public function query(): \Generator
@@ -163,6 +164,7 @@ public function query(): \Generator
                 ['list', '20210915'],
                 ['list', '20210920'],
             ],
+            5
         ];
         yield 'Filter ids' => [
             (new QueryBuilder())
@@ -171,6 +173,7 @@ public function query(): \Generator
                 ['export', '20210920'],
                 ['list', '20210920'],
             ],
+            2
         ];
         yield 'Filter job names' => [
             (new QueryBuilder())
@@ -180,13 +183,15 @@ public function query(): \Generator
                 ['list', '20210915'],
                 ['list', '20210920'],
             ],
+            3
         ];
         yield 'Filter statuses' => [
             (new QueryBuilder())
                 ->statuses([BatchStatus::FAILED]),
             [
                 ['list', '20210910'],
             ],
+            1
         ];
         yield 'Order by start ASC' => [
             (new QueryBuilder())
@@ -198,6 +203,7 @@ public function query(): \Generator
                 ['list', '20210920'],
                 ['export', '20210922'],
             ],
+            5
         ];
         yield 'Order by start DESC' => [
             (new QueryBuilder())
@@ -209,6 +215,7 @@ public function query(): \Generator
                 ['list', '20210915'],
                 ['list', '20210910'],
             ],
+            5
         ];
         yield 'Order by end ASC' => [
             (new QueryBuilder())
@@ -220,6 +227,7 @@ public function query(): \Generator
                 ['list', '20210920'],
                 ['export', '20210922'],
             ],
+            5
         ];
         yield 'Order by end DESC' => [
             (new QueryBuilder())
@@ -231,6 +239,7 @@ public function query(): \Generator
                 ['list', '20210915'],
                 ['list', '20210910'],
             ],
+            5
         ];
     }