IBX-10186: Added limits to Repository Filtering count and subtree queries (#696)

For more details see https://ibexa.atlassian.net/browse/IBX-10186 and #696

Key changes:

* Added limit parameter to count and subtree size methods in various services

* [Tests] Updated tests coverage


---------

Co-Authored-By: <ryanolee@users.noreply.github.com>

Author: wiewiurdp

phpstan-baseline.neon

@@ -32133,7 +32133,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
 
 		-
@@ -32340,12 +32340,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
@@ -32598,12 +32592,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);
     }
 
     /**