IBX-10186: Added limits to Repository Filtering count and subtree queries #600
There are no files selected for viewing
|
Member
There was a problem hiding this comment. So, as a consequence of what @konradoboza mentioned earlier, we don't need to introduce here an extra interface. Explanation: Repository services do not undergo SPI [1] Backwards compatibility promise. This means that we only promise BC on consumption. In the past, throughout the life-cycle of eZ Platform 1.x, 2.x, Ibexa 3.x, 4.x, we've added methods and optional arguments to methods on both API and persistence level. Persistence layer is even explicitly documented as not frozen in README.md. The reason is maintenance and stability - technical issues (like the one you've experienced with a proxy). We support extending only classes and interfaces which have been explicitly documented in the Ibexa Developer Documentation for that purpose, e.g., field type classes. Doing this in any other way would make very hard to add new features to the Product. [1] In this context - a Service Provider Interface - class/interface meant for extending. Treating everything as SPI seems to be a default BC policy for Symfony. We approach this a bit differently.
Author
There was a problem hiding this comment. Thanks, I think this strategy was derived from form initial advice given in #600 (review) given uncertain how strict core repository contract guarantees are between minor version releases in ibexa core. Have reverted all of the Symfony style BC break compatible changes in preference of just changing the public API's outright 🙌 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <?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\Future\Repository; | ||
|
|
||
| use Ibexa\Contracts\Core\Repository\ContentService; | ||
| use Ibexa\Contracts\Core\Repository\Values\Filter\Filter; | ||
|
|
||
| /** | ||
| * @internal Future version of ContentService to be released in Ibexa Core 5.0. Used to force value proxies to generate correct types. For internal use only. | ||
| */ | ||
| interface FutureContentService extends ContentService | ||
| { | ||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| public function count(Filter $filter, ?array $languages = null, ?int $limit = null): int; | ||
| } |
|
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| <?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\Future\Repository; | ||
|
|
||
| use Ibexa\Contracts\Core\Repository\LocationService; | ||
| use Ibexa\Contracts\Core\Repository\Values\Content\Location; | ||
| use Ibexa\Contracts\Core\Repository\Values\Filter\Filter; | ||
|
|
||
| /** | ||
| * @internal Future version of LocationService to be released in Ibexa Core 5.0. Used to force value proxies to generate correct types. For internal use only. | ||
| */ | ||
| interface FutureLocationService extends LocationService | ||
| { | ||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| public function getLocationChildCount(Location $location, ?int $limit = null): int; | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| public function getSubtreeSize(Location $location, ?int $limit = null): int; | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| public function count(Filter $filter, ?array $languages = null, ?int $limit = null): int; | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Expectation remark: after addressing the feedback we expect here not to have any new issues, only removals.
If something unrelated to your changes pops up after rebasing onto main, please let me know. We address such issues regularly as they occur quite often.