ISSUE-345: pagination data provider

tatevikg1 · tatevikg1 · commit 9bd58bc6fb09 · 2025-05-03T23:05:04.000+04:00
diff --git a/config/services/providers.yml b/config/services/providers.yml
@@ -4,10 +4,6 @@ services:
     autoconfigure: true
     public: false
 
-  PhpList\RestBundle\Service\Provider\SubscriberListProvider:
-    autowire: true
-    autoconfigure: true
-
-  PhpList\RestBundle\Service\Provider\AdministratorProvider:
+  PhpList\RestBundle\Service\Provider\PaginatedDataProvider:
     autowire: true
     autoconfigure: true
diff --git a/src/Controller/AdministratorController.php b/src/Controller/AdministratorController.php
@@ -11,7 +11,7 @@
 use PhpList\RestBundle\Entity\Request\UpdateAdministratorRequest;
 use PhpList\RestBundle\Serializer\AdministratorNormalizer;
 use PhpList\RestBundle\Service\Manager\AdministratorManager;
-use PhpList\RestBundle\Service\Provider\AdministratorProvider;
+use PhpList\RestBundle\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Validator\RequestValidator;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -28,19 +28,19 @@ class AdministratorController extends BaseController
 {
     private AdministratorManager $administratorManager;
     private AdministratorNormalizer $normalizer;
-    private AdministratorProvider $administratorProvider;
+    private PaginatedDataProvider $paginatedProvider;
 
     public function __construct(
         Authentication $authentication,
+        RequestValidator $validator,
         AdministratorManager $administratorManager,
         AdministratorNormalizer $normalizer,
-        RequestValidator $validator,
-        AdministratorProvider $administratorProvider
+        PaginatedDataProvider $paginatedProvider
     ) {
         parent::__construct($authentication, $validator);
         $this->administratorManager = $administratorManager;
         $this->normalizer = $normalizer;
-        $this->administratorProvider = $administratorProvider;
+        $this->paginatedProvider = $paginatedProvider;
     }
 
     #[Route('', name: 'get_administrators', methods: ['GET'])]
@@ -101,7 +101,7 @@ public function getAdministrators(Request $request): JsonResponse
         $this->requireAuthentication($request);
 
         return new JsonResponse(
-            $this->administratorProvider->getPaginatedList($request),
+            $this->paginatedProvider->getPaginatedList($request, $this->normalizer, Administrator::class),
             Response::HTTP_OK
         );
     }
diff --git a/src/Controller/CampaignController.php b/src/Controller/CampaignController.php
@@ -5,12 +5,14 @@
 namespace PhpList\RestBundle\Controller;
 
 use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Filter\MessageFilter;
 use PhpList\Core\Domain\Model\Messaging\Message;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Entity\Request\CreateMessageRequest;
 use PhpList\RestBundle\Entity\Request\UpdateMessageRequest;
 use PhpList\RestBundle\Serializer\MessageNormalizer;
 use PhpList\RestBundle\Service\Manager\MessageManager;
+use PhpList\RestBundle\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Validator\RequestValidator;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -29,16 +31,19 @@ class CampaignController extends BaseController
 {
     private MessageNormalizer $normalizer;
     private MessageManager $messageManager;
+    private PaginatedDataProvider $paginatedProvider;
 
     public function __construct(
         Authentication $authentication,
         RequestValidator $validator,
         MessageNormalizer $normalizer,
-        MessageManager $messageManager
+        MessageManager $messageManager,
+        PaginatedDataProvider $paginatedProvider,
     ) {
         parent::__construct($authentication, $validator);
         $this->normalizer = $normalizer;
         $this->messageManager = $messageManager;
+        $this->paginatedProvider = $paginatedProvider;
     }
 
     #[Route('', name: 'get_campaigns', methods: ['GET'])]
@@ -56,15 +61,36 @@ public function __construct(
                 schema: new OA\Schema(
                     type: 'string'
                 )
+            ),
+            new OA\Parameter(
+                name: 'after_id',
+                description: 'Last id (starting from 0)',
+                in: 'query',
+                required: false,
+                schema: new OA\Schema(type: 'integer', default: 1, minimum: 1)
+            ),
+            new OA\Parameter(
+                name: 'limit',
+                description: 'Number of results per page',
+                in: 'query',
+                required: false,
+                schema: new OA\Schema(type: 'integer', default: 25, maximum: 100, minimum: 1)
             )
         ],
         responses: [
             new OA\Response(
                 response: 200,
                 description: 'Success',
                 content: new OA\JsonContent(
-                    type: 'array',
-                    items: new OA\Items(ref: '#/components/schemas/Message')
+                    properties: [
+                        new OA\Property(
+                            property: 'items',
+                            type: 'array',
+                            items: new OA\Items(ref: '#/components/schemas/Message')
+                        ),
+                        new OA\Property(property: 'pagination', ref: '#/components/schemas/CursorPagination')
+                    ],
+                    type: 'object'
                 )
             ),
             new OA\Response(
@@ -77,13 +103,13 @@ public function __construct(
     public function getMessages(Request $request): JsonResponse
     {
         $authUer = $this->requireAuthentication($request);
-        $data = $this->messageManager->getMessagesByOwner($authUer);
 
-        $normalized = array_map(function ($item) {
-            return $this->normalizer->normalize($item);
-        }, $data);
+        $filter = (new MessageFilter())->setOwner($authUer);
 
-        return new JsonResponse($normalized, Response::HTTP_OK);
+        return new JsonResponse(
+            $this->paginatedProvider->getPaginatedList($request, $this->normalizer, Message::class, $filter),
+            Response::HTTP_OK
+        );
     }
 
     #[Route('/{messageId}', name: 'get_campaign', methods: ['GET'])]
diff --git a/src/Controller/ListController.php b/src/Controller/ListController.php
@@ -9,9 +9,8 @@
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Entity\Request\CreateSubscriberListRequest;
 use PhpList\RestBundle\Serializer\SubscriberListNormalizer;
-use PhpList\RestBundle\Service\Factory\PaginationCursorRequestFactory;
 use PhpList\RestBundle\Service\Manager\SubscriberListManager;
-use PhpList\RestBundle\Service\Provider\SubscriberListProvider;
+use PhpList\RestBundle\Service\Provider\PaginatedDataProvider;
 use PhpList\RestBundle\Validator\RequestValidator;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -32,22 +31,19 @@ class ListController extends BaseController
 {
     private SubscriberListNormalizer $normalizer;
     private SubscriberListManager $subscriberListManager;
-    private PaginationCursorRequestFactory $paginationFactory;
-    private SubscriberListProvider $subscriberListProvider;
+    private PaginatedDataProvider $paginatedDataProvider;
 
     public function __construct(
         Authentication $authentication,
-        SubscriberListNormalizer $normalizer,
         RequestValidator $validator,
+        SubscriberListNormalizer $normalizer,
         SubscriberListManager $subscriberListManager,
-        PaginationCursorRequestFactory $paginationFactory,
-        SubscriberListProvider $subscriberListProvider
+        PaginatedDataProvider $paginatedDataProvider,
     ) {
         parent::__construct($authentication, $validator);
         $this->normalizer = $normalizer;
         $this->subscriberListManager = $subscriberListManager;
-        $this->paginationFactory = $paginationFactory;
-        $this->subscriberListProvider = $subscriberListProvider;
+        $this->paginatedDataProvider = $paginatedDataProvider;
     }
 
     #[Route('', name: 'get_lists', methods: ['GET'])]
@@ -107,10 +103,9 @@ public function __construct(
     public function getLists(Request $request): JsonResponse
     {
         $this->requireAuthentication($request);
-        $pagination = $this->paginationFactory->fromRequest($request);
 
         return new JsonResponse(
-            $this->subscriberListProvider->getPaginatedList($pagination),
+            $this->paginatedDataProvider->getPaginatedList($request, $this->normalizer, SubscriberList::class),
             Response::HTTP_OK
         );
     }
diff --git a/src/Controller/SessionController.php b/src/Controller/SessionController.php
@@ -32,8 +32,8 @@ class SessionController extends BaseController
 
     public function __construct(
         Authentication $authentication,
+        RequestValidator $validator,
         SessionManager $sessionManager,
-        RequestValidator $validator
     ) {
         parent::__construct($authentication, $validator);
 
diff --git a/src/Controller/SubscriberController.php b/src/Controller/SubscriberController.php
@@ -33,8 +33,8 @@ class SubscriberController extends BaseController
 
     public function __construct(
         Authentication $authentication,
-        SubscriberManager $subscriberManager,
         RequestValidator $validator,
+        SubscriberManager $subscriberManager,
         SubscriberNormalizer $subscriberNormalizer,
     ) {
         parent::__construct($authentication, $validator);
diff --git a/src/Controller/SubscriptionController.php b/src/Controller/SubscriptionController.php
@@ -33,8 +33,8 @@ class SubscriptionController extends BaseController
 
     public function __construct(
         Authentication $authentication,
-        SubscriptionManager $subscriptionManager,
         RequestValidator $validator,
+        SubscriptionManager $subscriptionManager,
         SubscriberNormalizer $subscriberNormalizer,
         SubscriptionNormalizer $subscriptionNormalizer,
     ) {
diff --git a/src/Controller/TemplateController.php b/src/Controller/TemplateController.php
@@ -33,9 +33,9 @@ class TemplateController extends BaseController
 
     public function __construct(
         Authentication $authentication,
+        RequestValidator $validator,
         TemplateRepository $templateRepository,
         TemplateNormalizer $normalizer,
-        RequestValidator $validator,
         TemplateManager $templateManager
     ) {
         parent::__construct($authentication, $validator);
diff --git a/src/Service/Provider/AdministratorProvider.php b/src/Service/Provider/AdministratorProvider.php
diff --git a/src/Service/Provider/PaginatedDataProvider.php b/src/Service/Provider/PaginatedDataProvider.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Service\Provider;
+
+use Doctrine\ORM\EntityManagerInterface;
+use PhpList\Core\Domain\Filter\FilterRequestInterface;
+use PhpList\Core\Domain\Repository\Interfaces\PaginatableRepositoryInterface;
+use PhpList\RestBundle\Entity\Dto\CursorPaginationResult;
+use PhpList\RestBundle\Serializer\CursorPaginationNormalizer;
+use PhpList\RestBundle\Service\Factory\PaginationCursorRequestFactory;
+use RuntimeException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class PaginatedDataProvider
+{
+    public function __construct(
+        private readonly CursorPaginationNormalizer $paginationNormalizer,
+        private readonly PaginationCursorRequestFactory $paginationFactory,
+        private readonly EntityManagerInterface $entityManager,
+    ) {
+    }
+
+    public function getPaginatedList(
+        Request $request,
+        NormalizerInterface $normalizer,
+        string $className,
+        FilterRequestInterface $filter = null
+    ): array {
+        $pagination = $this->paginationFactory->fromRequest($request);
+
+        $repository = $this->entityManager->getRepository($className);
+
+        if (!$repository instanceof PaginatableRepositoryInterface) {
+            throw new RuntimeException('Repository not found');
+        }
+
+        $items = $repository->getFilteredAfterId($pagination->afterId, $pagination->limit, $filter);
+        $total = $repository->count();
+
+        $normalizedItems = array_map(
+            fn($item) => $normalizer->normalize($item, 'json'),
+            $items
+        );
+
+        return $this->paginationNormalizer->normalize(
+            new CursorPaginationResult($normalizedItems, $pagination->limit, $total)
+        );
+    }
+}
diff --git a/src/Service/Provider/SubscriberListProvider.php b/src/Service/Provider/SubscriberListProvider.php
diff --git a/tests/Unit/Controller/TemplateControllerTest.php b/tests/Unit/Controller/TemplateControllerTest.php
@@ -36,9 +36,9 @@ protected function setUp(): void
 
         $this->controller = new TemplateController(
             $authentication,
+            $this->validator,
             $this->templateRepository,
             $this->normalizer,
-            $this->validator,
             $this->templateManager
         );
     }
