[Improvement] Add filters based on type (#28)

* Add filters based on type * Apply php-cs-fixer changes * Add default for invalid filter type * Apply php-cs-fixer changes * Add types to interface * Apply php-cs-fixer changes * Make classes internal * Apply php-cs-fixer changes * Move Refresh to request * Remove unecessary test * Add internal --------- Co-authored-by: mattamon <[email protected]>
pimcore · Apr 17, 2024 · 4c75aab · 4c75aab
1 parent 6a3cfc8
commit 4c75aab
Show file tree

Hide file tree

Showing 58 changed files with 320 additions and 83 deletions.
diff --git a/config/filters.yaml b/config/filters.yaml
@@ -33,4 +33,4 @@ services:
 
   # DataObject
   Pimcore\Bundle\StudioApiBundle\Filter\DataObject\ClassIdFilter:
-      tags: [ 'pimcore.studio_api.collection.filter' ]
+      tags: [ 'pimcore.studio_api.collection.data_object.filter' ]
diff --git a/src/Attributes/Request/TokenRequestBody.php b/src/Attributes/Request/TokenRequestBody.php
@@ -19,7 +19,7 @@
 use Attribute;
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\RequestBody;
-use Pimcore\Bundle\StudioApiBundle\Dto\Token\Refresh;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Refresh;
 
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class TokenRequestBody extends RequestBody

diff --git a/src/Attributes/Request/TranslationRequestBody.php b/src/Attributes/Request/TranslationRequestBody.php
@@ -19,7 +19,7 @@
 use Attribute;
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\RequestBody;
-use Pimcore\Bundle\StudioApiBundle\Dto\Translation;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Translation;
 
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class TranslationRequestBody extends RequestBody

diff --git a/src/Attributes/Response/UnauthorizedResponse.php b/src/Attributes/Response/UnauthorizedResponse.php
@@ -19,7 +19,7 @@
 use Attribute;
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\Response;
-use Pimcore\Bundle\StudioApiBundle\Dto\Unauthorized;
+use Pimcore\Bundle\StudioApiBundle\Response\Schema\Unauthorized;
 
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class UnauthorizedResponse extends Response

diff --git a/src/Config/OpenApi/Security.php b/src/Config/OpenApi/Security.php
@@ -18,6 +18,10 @@
 
 use OpenApi\Attributes\SecurityScheme;
 
+/**
+ * @internal
+ * This class exists to document the public api
+ */
 #[SecurityScheme(
     securityScheme: 'auth_token',
     type: 'http',

diff --git a/src/Config/OpenApi/Spec.php b/src/Config/OpenApi/Spec.php
@@ -19,6 +19,10 @@
 use OpenApi\Attributes\Info;
 use OpenApi\Attributes\License;
 
+/**
+ * @internal
+ * This class exists to document the public api
+ */
 #[Info(
     version: '0.0.1',
     description: 'API for Studio generated by OpenApi Generator via zircote/swagger-php',

diff --git a/src/Config/Tags.php b/src/Config/Tags.php
@@ -18,6 +18,9 @@
 
 use OpenApi\Attributes\Tag;
 
+/**
+ * @internal
+ */
 #[Tag(name: Tags::Assets->name, description: 'Asset operations to get/update/create/delete assets')]
 #[Tag(name: Tags::Authorization->name, description: 'Login via username and password to get a token or refresh the token')]
 #[Tag(name: Tags::DataObjects->name, description: 'DataObject operations to get/update/create/delete data objects')]

diff --git a/src/Controller/Api/AbstractApiController.php b/src/Controller/Api/AbstractApiController.php
@@ -21,6 +21,9 @@
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @internal
+ */
 #[Route('/studio/api')]
 abstract class AbstractApiController extends AbstractController
 {

diff --git a/src/Controller/Api/Assets/CollectionController.php b/src/Controller/Api/Assets/CollectionController.php
@@ -33,8 +33,8 @@
 use Pimcore\Bundle\StudioApiBundle\Controller\Api\AbstractApiController;
 use Pimcore\Bundle\StudioApiBundle\Controller\Trait\PaginatedResponseTrait;
 use Pimcore\Bundle\StudioApiBundle\Dto\Asset;
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\Parameters;
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidQueryTypeException;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\Parameters;
 use Pimcore\Bundle\StudioApiBundle\Service\AssetSearchServiceInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterServiceInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\AssetQuery;
@@ -43,6 +43,9 @@
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @internal
+ */
 final class CollectionController extends AbstractApiController
 {
     use PaginatedResponseTrait;
@@ -84,7 +87,10 @@ public function __construct(
     public function getAssets(#[MapQueryString] Parameters $parameters): JsonResponse
     {
         /** @var AssetQuery $assetQuery */
-        $assetQuery = $this->filterService->applyCollectionFilter($parameters, 'asset');
+        $assetQuery = $this->filterService->applyFilters(
+            $parameters,
+            FilterServiceInterface::TYPE_ASSET
+        );
 
         $result = $this->assetSearchService->searchAssets($assetQuery);
 

diff --git a/src/Controller/Api/Assets/GetController.php b/src/Controller/Api/Assets/GetController.php
@@ -29,6 +29,9 @@
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @internal
+ */
 final class GetController extends AbstractApiController
 {
     public function __construct(

diff --git a/src/Controller/Api/Authorization/AuthorizationController.php b/src/Controller/Api/Authorization/AuthorizationController.php
@@ -25,8 +25,8 @@
 use Pimcore\Bundle\StudioApiBundle\Config\Tags;
 use Pimcore\Bundle\StudioApiBundle\Controller\Api\AbstractApiController;
 use Pimcore\Bundle\StudioApiBundle\Dto\Credentials;
-use Pimcore\Bundle\StudioApiBundle\Dto\Token;
-use Pimcore\Bundle\StudioApiBundle\Dto\Token\Refresh;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Refresh;
+use Pimcore\Bundle\StudioApiBundle\Response\Schema\Token;
 use Pimcore\Bundle\StudioApiBundle\Service\SecurityServiceInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\TokenServiceInterface;
 use Pimcore\Security\User\User;
@@ -35,6 +35,9 @@
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @internal
+ */
 final class AuthorizationController extends AbstractApiController
 {
     public function __construct(

diff --git a/src/Controller/Api/DataObjects/CollectionController.php b/src/Controller/Api/DataObjects/CollectionController.php
@@ -34,8 +34,8 @@
 use Pimcore\Bundle\StudioApiBundle\Controller\Api\AbstractApiController;
 use Pimcore\Bundle\StudioApiBundle\Controller\Trait\PaginatedResponseTrait;
 use Pimcore\Bundle\StudioApiBundle\Dto\DataObject;
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\DataObjectParameters;
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidQueryTypeException;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\DataObjectParameters;
 use Pimcore\Bundle\StudioApiBundle\Service\DataObjectSearchServiceInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\Filter\FilterServiceInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\DataObjectQuery;
@@ -87,7 +87,7 @@ public function getDataObjects(#[MapQueryString] DataObjectParameters $parameter
     {
 
         /** @var DataObjectQuery $dataObjectQuery */
-        $dataObjectQuery = $this->filterService->applyCollectionFilter($parameters, 'dataObject');
+        $dataObjectQuery = $this->filterService->applyFilters($parameters, 'dataObject');
 
         $result = $this->dataObjectSearchService->searchDataObjects($dataObjectQuery);
 

diff --git a/src/Controller/Api/OpenApiController.php b/src/Controller/Api/OpenApiController.php
@@ -22,6 +22,9 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 
+/**
+ * @internal
+ */
 final class OpenApiController extends AbstractController
 {
     public function __construct(private readonly OpenApiServiceInterface $openApiService)

diff --git a/src/Controller/Api/TranslationController.php b/src/Controller/Api/TranslationController.php
@@ -22,13 +22,16 @@
 use Pimcore\Bundle\StudioApiBundle\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioApiBundle\Attributes\Response\UnauthorizedResponse;
 use Pimcore\Bundle\StudioApiBundle\Config\Tags;
-use Pimcore\Bundle\StudioApiBundle\Dto\Translation;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Translation;
 use Pimcore\Bundle\StudioApiBundle\Service\TranslatorServiceInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @internal
+ */
 final class TranslationController extends AbstractApiController
 {
     private const PATH = '/translations';

diff --git a/src/Controller/Trait/PaginatedResponseTrait.php b/src/Controller/Trait/PaginatedResponseTrait.php
@@ -19,6 +19,9 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\Serializer\SerializerInterface;
 
+/**
+ * @internal
+ */
 trait PaginatedResponseTrait
 {
     private const HEADER_TOTAL_ITEMS = 'X-Pimcore-Total-Items';

diff --git a/src/DependencyInjection/CompilerPass/FilterPass.php b/src/DependencyInjection/CompilerPass/FilterPass.php
@@ -36,9 +36,13 @@ final class FilterPass implements CompilerPassInterface
     public function process(ContainerBuilder $container): void
     {
         $taggedServices = array_keys(
-            $container->findTaggedServiceIds(
-                TaggedIteratorAdapter::FILTER_TAG
-            )
+            [
+                ... $container->findTaggedServiceIds(TaggedIteratorAdapter::FILTER_TAG),
+                ... $container->findTaggedServiceIds(TaggedIteratorAdapter::FILTER_ASSET_TAG),
+                ... $container->findTaggedServiceIds(TaggedIteratorAdapter::FILTER_DATA_OBJECT_TAG),
+                ... $container->findTaggedServiceIds(TaggedIteratorAdapter::FILTER_DOCUMENT_TAG),
+
+            ]
         );
 
         foreach ($taggedServices as $environmentType) {

diff --git a/tests/Unit/Dto/Token/OutputTest.php → src/Exception/AccessDeniedException.php b/tests/Unit/Dto/Token/OutputTest.php → src/Exception/AccessDeniedException.php
@@ -14,18 +14,13 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioApiBundle\Tests\Unit\Dto\Token;
+namespace Pimcore\Bundle\StudioApiBundle\Exception;
 
-use Codeception\Test\Unit;
-use Pimcore\Bundle\StudioApiBundle\Dto\Token;
+use Symfony\Component\HttpKernel\Exception\HttpException;
 
-final class OutputTest extends Unit
+/**
+ * @internal
+ */
+final class AccessDeniedException extends HttpException
 {
-    public function testTokenOutput(): void
-    {
-        $output = new Token('token', 3600, 'test');
-        $this->assertSame('token', $output->getToken());
-        $this->assertSame(3600, $output->getLifetime());
-        $this->assertSame('test', $output->getUsername());
-    }
 }
diff --git a/src/Exception/InvalidFilterTypeException.php b/src/Exception/InvalidFilterTypeException.php
@@ -0,0 +1,26 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioApiBundle\Exception;
+
+use Exception;
+
+/**
+ * @internal
+ */
+final class InvalidFilterTypeException extends Exception
+{
+}
diff --git a/src/Exception/InvalidPathException.php b/src/Exception/InvalidPathException.php
@@ -18,6 +18,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 final class InvalidPathException extends Exception
 {
 }
diff --git a/src/Exception/InvalidQueryTypeException.php b/src/Exception/InvalidQueryTypeException.php
@@ -18,6 +18,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 final class InvalidQueryTypeException extends Exception
 {
 }
diff --git a/src/Exception/NoRequestException.php b/src/Exception/NoRequestException.php
@@ -18,6 +18,9 @@
 
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+/**
+ * @internal
+ */
 final class NoRequestException extends HttpException
 {
 }
diff --git a/src/Exception/NonPublicTranslationException.php b/src/Exception/NonPublicTranslationException.php
@@ -18,6 +18,9 @@
 
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+/**
+ * @internal
+ */
 final class NonPublicTranslationException extends HttpException
 {
 }
diff --git a/src/Exception/NotAuthorizedException.php b/src/Exception/NotAuthorizedException.php
@@ -18,6 +18,9 @@
 
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
+/**
+ * @internal
+ */
 final class NotAuthorizedException extends HttpException
 {
 }
diff --git a/src/Factory/QueryFactory.php b/src/Factory/QueryFactory.php
@@ -21,6 +21,9 @@
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\DataObjectQueryProviderInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
+/**
+ * @internal
+ */
 final readonly class QueryFactory implements QueryFactoryInterface
 {
     public function __construct(

diff --git a/src/Factory/QueryFactoryInterface.php b/src/Factory/QueryFactoryInterface.php
@@ -19,6 +19,9 @@
 use Pimcore\Bundle\StudioApiBundle\Exception\InvalidQueryTypeException;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
+/**
+ * @internal
+ */
 interface QueryFactoryInterface
 {
     /**

diff --git a/src/Filter/DataObject/ClassIdFilter.php b/src/Filter/DataObject/ClassIdFilter.php
@@ -16,12 +16,15 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter\DataObject;
 
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\DataObjectParametersInterface;
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\ParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Filter\FilterInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\DataObjectParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\DataObjectQuery;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
+/**
+ * @internal
+ */
 final class ClassIdFilter implements FilterInterface
 {
     public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface

diff --git a/src/Filter/ExcludeFolderFilter.php b/src/Filter/ExcludeFolderFilter.php
@@ -16,9 +16,12 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
+/**
+ * @internal
+ */
 final class ExcludeFolderFilter implements FilterInterface
 {
     public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface

diff --git a/src/Filter/FilterInterface.php b/src/Filter/FilterInterface.php
@@ -16,9 +16,12 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
+/**
+ * @internal
+ */
 interface FilterInterface
 {
     public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface;

diff --git a/src/Filter/IdSearchFilter.php b/src/Filter/IdSearchFilter.php
@@ -16,9 +16,12 @@
 
 namespace Pimcore\Bundle\StudioApiBundle\Filter;
 
-use Pimcore\Bundle\StudioApiBundle\Dto\Filter\ParametersInterface;
+use Pimcore\Bundle\StudioApiBundle\Request\Query\Filter\ParametersInterface;
 use Pimcore\Bundle\StudioApiBundle\Service\GenericData\V1\QueryInterface;
 
+/**
+ * @internal
+ */
 final class IdSearchFilter implements FilterInterface
 {
     public function apply(ParametersInterface $parameters, QueryInterface $query): QueryInterface