IBX-10186: Added limits to Repository Filtering count and subtree queries

phpstan-baseline.neon

@@ -32145,7 +32145,7 @@ parameters:
 		-
 			message: '#^Cannot access property \$id on Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\|null\.$#'
 			identifier: property.nonObject
-			count: 11
+			count: 9
 			path: tests/integration/Core/Repository/LocationServiceTest.php
 
 		-
@@ -32352,12 +32352,6 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/LocationServiceTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Integration\\Core\\Repository\\LocationServiceTest\:\:testGetSubtreeSize\(\) should return Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location but returns Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\|null\.$#'
-			identifier: return.type
-			count: 1
-			path: tests/integration/Core/Repository/LocationServiceTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Integration\\Core\\Repository\\LocationServiceTest\:\:testHideLocation\(\) has no return type specified\.$#'
 			identifier: missingType.return
@@ -32610,12 +32604,6 @@ parameters:
 			count: 1
 			path: tests/integration/Core/Repository/LocationServiceTest.php
 
-		-
-			message: '#^Parameter \#1 \$location of method Ibexa\\Contracts\\Core\\Repository\\LocationService\:\:getSubtreeSize\(\) expects Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location, Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\|null given\.$#'
-			identifier: argument.type
-			count: 2
-			path: tests/integration/Core/Repository/LocationServiceTest.php
-
 		-
 			message: '#^Parameter \#1 \$location of method Ibexa\\Contracts\\Core\\Repository\\LocationService\:\:moveSubtree\(\) expects Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location, Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\|null given\.$#'
 			identifier: argument.type

src/contracts/Persistence/Content/Location/Handler.php

@@ -111,7 +111,7 @@ public function loadParentLocationsForDraftContent($contentId);
      */
     public function copySubtree($sourceId, $destinationParentId);
 
-    public function getSubtreeSize(string $path): int;
+    public function getSubtreeSize(string $path, ?int $limit = null): int;
 
     /**
      * Moves location identified by $sourceId into new parent identified by $destinationParentId.

src/contracts/Persistence/Filter/Content/Handler.php

@@ -22,5 +22,5 @@ interface Handler
      */
     public function find(Filter $filter): iterable;
 
-    public function count(Filter $filter): int;
+    public function count(Filter $filter, ?int $limit = null): int;
 }

src/contracts/Persistence/Filter/Location/Handler.php

@@ -22,5 +22,5 @@ interface Handler
      */
     public function find(Filter $filter): iterable;
 
-    public function count(Filter $filter): int;
+    public function count(Filter $filter, ?int $limit = null): int;
 }

src/contracts/Persistence/Filter/Query/CountQueryBuilder.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Contracts\Core\Persistence\Filter\Query;
+
+use Doctrine\DBAL\Query\QueryBuilder;
+
+interface CountQueryBuilder
+{
+    public function wrap(QueryBuilder $queryBuilder, string $countableField, ?int $limit = null): QueryBuilder;
+}

src/contracts/Repository/ContentService.php

@@ -529,7 +529,10 @@ public function find(Filter $filter, ?array $languages = null): ContentList;
      *        If skipped, by default, unless SiteAccessAware layer has been disabled, languages set
      *        for a SiteAccess in a current context will be used.
      *
+     * @param int|null $limit If set, the count will be limited to first $limit items found.
+     *        In some cases it can significantly speed up a count operation for more complex filters.
+     *
      * @phpstan-return int<0, max>
      */
-    public function count(Filter $filter, ?array $languages = null): int;
+    public function count(Filter $filter, ?array $languages = null, ?int $limit = null): int;
 }

src/contracts/Repository/Decorator/ContentServiceDecorator.php

@@ -284,8 +284,8 @@ public function find(Filter $filter, ?array $languages = null): ContentList
         return $this->innerService->find($filter, $languages);
     }
 
-    public function count(Filter $filter, ?array $languages = null): int
+    public function count(Filter $filter, ?array $languages = null, ?int $limit = null): int
     {
-        return $this->innerService->count($filter, $languages);
+        return $this->innerService->count($filter, $languages, $limit);
     }
 }

src/contracts/Repository/Decorator/LocationServiceDecorator.php

@@ -81,14 +81,14 @@ public function loadParentLocationsForDraftContent(
         return $this->innerService->loadParentLocationsForDraftContent($versionInfo, $prioritizedLanguages);
     }
 
-    public function getLocationChildCount(Location $location): int
+    public function getLocationChildCount(Location $location, ?int $limit = null): int
     {
-        return $this->innerService->getLocationChildCount($location);
+        return $this->innerService->getLocationChildCount($location, $limit);
     }
 
-    public function getSubtreeSize(Location $location): int
+    public function getSubtreeSize(Location $location, ?int $limit = null): int
     {
-        return $this->innerService->getSubtreeSize($location);
+        return $this->innerService->getSubtreeSize($location, $limit);
     }
 
     public function createLocation(
@@ -159,8 +159,8 @@ public function find(Filter $filter, ?array $languages = null): LocationList
         return $this->innerService->find($filter, $languages);
     }
 
-    public function count(Filter $filter, ?array $languages = null): int
+    public function count(Filter $filter, ?array $languages = null, ?int $limit = null): int
     {
-        return $this->innerService->count($filter, $languages);
+        return $this->innerService->count($filter, $languages, $limit);
     }
 }

src/contracts/Repository/LocationService.php

@@ -123,17 +123,20 @@ public function loadParentLocationsForDraftContent(VersionInfo $versionInfo, ?ar
      * Returns the number of children which are readable by the current user of a location object.
      *
      * @param \Ibexa\Contracts\Core\Repository\Values\Content\Location $location
+     * @param int|null $limit If set, the count will be limited to first $limit items found.
      *
      * @return int
      */
-    public function getLocationChildCount(Location $location): int;
+    public function getLocationChildCount(Location $location, ?int $limit = null): int;
 
     /**
      * Return the subtree size of a given location.
      *
      * Warning! This method is not permission aware by design.
+     *
+     * @param int|null $limit
      */
-    public function getSubtreeSize(Location $location): int;
+    public function getSubtreeSize(Location $location, ?int $limit = null): int;
 
     /**
      * Creates the new $location in the content repository for the given content.
@@ -280,6 +283,8 @@ public function find(Filter $filter, ?array $languages = null): LocationList;
      * @param array<int, string>|null $languages a list of language codes to be added as additional constraints.
      *        If skipped, by default, unless SiteAccessAware layer has been disabled, languages set
      *        for a SiteAccess in a current context will be used.
+     * @param int|null $limit If set, the count will be limited to first $limit items found.
+     *        In some cases it can significantly speed up a count operation for more complex filters.
      */
-    public function count(Filter $filter, ?array $languages = null): int;
+    public function count(Filter $filter, ?array $languages = null, ?int $limit = null): int;
 }

src/lib/Persistence/Cache/LocationHandler.php

@@ -257,13 +257,14 @@ public function copySubtree($sourceId, $destinationParentId, $newOwnerId = null)
         return $this->persistenceHandler->locationHandler()->copySubtree($sourceId, $destinationParentId, $newOwnerId);
     }
 
-    public function getSubtreeSize(string $path): int
+    public function getSubtreeSize(string $path, ?int $limit = null): int
     {
         $this->logger->logCall(__METHOD__, [
             'path' => $path,
+            'limit' => $limit,
         ]);
 
-        return $this->persistenceHandler->locationHandler()->getSubtreeSize($path);
+        return $this->persistenceHandler->locationHandler()->getSubtreeSize($path, $limit);
     }
 
     /**

src/lib/Persistence/Legacy/Content/Location/Gateway.php

@@ -128,7 +128,7 @@ abstract public function getSubtreeNodeIdToContentIdMap(int $sourceId): array;
      */
     abstract public function getSubtreeChildrenDraftContentIds(int $sourceId): array;
 
-    abstract public function getSubtreeSize(string $path): int;
+    abstract public function getSubtreeSize(string $path, ?int $limit = null): int;
 
     /**
      * Returns data for the first level children of the location identified by given $locationId.

src/lib/Persistence/Legacy/Content/Location/Gateway/DoctrineDatabase.php

@@ -17,6 +17,7 @@
 use Ibexa\Contracts\Core\Persistence\Content\Location;
 use Ibexa\Contracts\Core\Persistence\Content\Location\CreateStruct;
 use Ibexa\Contracts\Core\Persistence\Content\Location\UpdateStruct;
+use Ibexa\Contracts\Core\Persistence\Filter\Query\CountQueryBuilder;
 use Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\CriterionInterface;
 use Ibexa\Core\Base\Exceptions\DatabaseException;
@@ -44,7 +45,8 @@ public function __construct(
         private readonly Connection $connection,
         private readonly MaskGenerator $languageMaskGenerator,
         private readonly CriteriaConverter $trashCriteriaConverter,
-        private readonly SortClauseConverter $trashSortClauseConverter
+        private readonly SortClauseConverter $trashSortClauseConverter,
+        private readonly CountQueryBuilder $countQueryBuilder
     ) {
     }
 
@@ -249,7 +251,10 @@ public function getSubtreeChildrenDraftContentIds(int $sourceId): array
         return $query->executeQuery()->fetchFirstColumn();
     }
 
-    public function getSubtreeSize(string $path): int
+    /**
+     * @phpstan-param positive-int $limit
+     */
+    public function getSubtreeSize(string $path, ?int $limit = null): int
     {
         $query = $this->createNodeQueryBuilder(['COUNT(node_id)']);
         $query->andWhere(
@@ -261,6 +266,12 @@ public function getSubtreeSize(string $path): int
             )
         );
 
+        $query = $this->countQueryBuilder->wrap(
+            $query,
+            't.node_id',
+            $limit
+        );
+
         return (int) $query->executeQuery()->fetchOne();
     }
 

src/lib/Persistence/Legacy/Content/Location/Gateway/ExceptionConversion.php

@@ -128,10 +128,10 @@ public function getSubtreeChildrenDraftContentIds(int $sourceId): array
         }
     }
 
-    public function getSubtreeSize(string $path): int
+    public function getSubtreeSize(string $path, ?int $limit = null): int
     {
         try {
-            return $this->innerGateway->getSubtreeSize($path);
+            return $this->innerGateway->getSubtreeSize($path, $limit);
         } catch (DBALException | PDOException $e) {
             throw DatabaseException::wrap($e);
         }

src/lib/Persistence/Legacy/Content/Location/Handler.php

@@ -327,9 +327,9 @@ public function copySubtree($sourceId, $destinationParentId, $newOwnerId = null)
         return $copiedSubtreeRootLocation;
     }
 
-    public function getSubtreeSize(string $path): int
+    public function getSubtreeSize(string $path, ?int $limit = null): int
     {
-        return $this->locationGateway->getSubtreeSize($path);
+        return $this->locationGateway->getSubtreeSize($path, $limit);
     }
 
     /**

src/lib/Persistence/Legacy/Filter/Gateway/Content/Doctrine/DoctrineGateway.php

@@ -13,6 +13,7 @@
 use Doctrine\DBAL\FetchMode;
 use Ibexa\Contracts\Core\Persistence\Filter\CriterionVisitor;
 use Ibexa\Contracts\Core\Persistence\Filter\Doctrine\FilteringQueryBuilder;
+use Ibexa\Contracts\Core\Persistence\Filter\Query\CountQueryBuilder;
 use Ibexa\Contracts\Core\Persistence\Filter\SortClauseVisitor;
 use Ibexa\Contracts\Core\Repository\Values\Filter\FilteringCriterion;
 use Ibexa\Core\Persistence\Legacy\Content\Gateway as ContentGateway;
@@ -57,17 +58,27 @@ final class DoctrineGateway implements Gateway
     public function __construct(
         private readonly Connection $connection,
         private readonly CriterionVisitor $criterionVisitor,
-        private readonly SortClauseVisitor $sortClauseVisitor
+        private readonly SortClauseVisitor $sortClauseVisitor,
+        private readonly CountQueryBuilder $countQueryBuilder
     ) {
     }
 
-    public function count(FilteringCriterion $criterion): int
+    /**
+     * @phpstan-param positive-int $limit
+     */
+    public function count(FilteringCriterion $criterion, ?int $limit = null): int
     {
         $query = $this->buildQuery(
             ['COUNT(DISTINCT content.id)'],
             $criterion
         );
 
+        $query = $this->countQueryBuilder->wrap(
+            $query,
+            'content.id',
+            $limit
+        );
+
         return (int)$query->executeQuery()->fetch(FetchMode::COLUMN);
     }
 

src/lib/Persistence/Legacy/Filter/Gateway/Gateway.php

@@ -18,9 +18,9 @@
 interface Gateway
 {
     /**
-     * Return number of matched rows for the given Criteria (a total count w/o pagination constraints).
+     * Return number of matched rows for the given Criteria (a total count w/o pagination constraints, Unless a limit is passed).
      */
-    public function count(FilteringCriterion $criterion): int;
+    public function count(FilteringCriterion $criterion, ?int $limit = null): int;
 
     /**
      * Return iterator for raw Repository data for the given Query result filtered by the given Criteria,

src/lib/Persistence/Legacy/Filter/Gateway/Location/Doctrine/DoctrineGateway.php

@@ -12,6 +12,7 @@
 use Doctrine\DBAL\FetchMode;
 use Ibexa\Contracts\Core\Persistence\Filter\CriterionVisitor;
 use Ibexa\Contracts\Core\Persistence\Filter\Doctrine\FilteringQueryBuilder;
+use Ibexa\Contracts\Core\Persistence\Filter\Query\CountQueryBuilder;
 use Ibexa\Contracts\Core\Persistence\Filter\SortClauseVisitor;
 use Ibexa\Contracts\Core\Repository\Values\Filter\FilteringCriterion;
 use Ibexa\Core\Persistence\Legacy\Content\Gateway as ContentGateway;
@@ -26,16 +27,26 @@
     public function __construct(
         private Connection $connection,
         private CriterionVisitor $criterionVisitor,
-        private SortClauseVisitor $sortClauseVisitor
+        private SortClauseVisitor $sortClauseVisitor,
+        private CountQueryBuilder $countQueryBuilder
     ) {
     }
 
-    public function count(FilteringCriterion $criterion): int
+    /**
+     * @phpstan-param positive-int $limit
+     */
+    public function count(FilteringCriterion $criterion, ?int $limit = null): int
     {
         $query = $this->buildQuery($criterion);
 
         $query->select('COUNT(DISTINCT location.node_id)');
 
+        $query = $this->countQueryBuilder->wrap(
+            $query,
+            'location.node_id',
+            $limit
+        );
+
         return (int)$query->executeQuery()->fetch(FetchMode::COLUMN);
     }
 

src/lib/Persistence/Legacy/Filter/Handler/ContentFilteringHandler.php

@@ -73,8 +73,8 @@ function (array $row): ContentItem {
         return $list;
     }
 
-    public function count(Filter $filter): int
+    public function count(Filter $filter, ?int $limit = null): int
     {
-        return $this->gateway->count($filter->getCriterion());
+        return $this->gateway->count($filter->getCriterion(), $limit);
     }
 }

src/lib/Persistence/Legacy/Filter/Handler/LocationFilteringHandler.php

@@ -69,8 +69,8 @@ function (array $row): LocationWithContentInfo {
         return $list;
     }
 
-    public function count(Filter $filter): int
+    public function count(Filter $filter, ?int $limit = null): int
     {
-        return $this->gateway->count($filter->getCriterion());
+        return $this->gateway->count($filter->getCriterion(), $limit);
     }
 }