ISSUE-345: paginated templates

tatevikg1 · tatevikg1 · commit 7ee40e8aceaa · 2025-05-04T19:34:49.000+04:00
diff --git a/src/Controller/AdministratorController.php b/src/Controller/AdministratorController.php
@@ -17,7 +17,6 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 
 /**
@@ -100,7 +99,7 @@ public function getAdministrators(Request $request): JsonResponse
     {
         $this->requireAuthentication($request);
 
-        return new JsonResponse(
+        return $this->json(
             $this->paginatedProvider->getPaginatedList($request, $this->normalizer, Administrator::class),
             Response::HTTP_OK
         );
@@ -141,7 +140,7 @@ public function createAdministrator(
         $administrator = $this->administratorManager->createAdministrator($dto);
         $json = $normalizer->normalize($administrator, 'json');
 
-        return new JsonResponse($json, Response::HTTP_CREATED);
+        return $this->json($json, Response::HTTP_CREATED);
     }
 
     #[Route('/{administratorId}', name: 'get_administrator', methods: ['GET'])]
@@ -178,11 +177,11 @@ public function getAdministrator(
         $this->requireAuthentication($request);
 
         if (!$administrator) {
-            throw new NotFoundHttpException('Administrator not found.');
+            throw $this->createNotFoundException('Administrator not found.');
         }
         $json = $this->normalizer->normalize($administrator, 'json');
 
-        return new JsonResponse($json, Response::HTTP_OK);
+        return $this->json($json, Response::HTTP_OK);
     }
 
     #[Route('/{administratorId}', name: 'update_administrator', methods: ['PUT'])]
@@ -223,13 +222,13 @@ public function updateAdministrator(
         $this->requireAuthentication($request);
 
         if (!$administrator) {
-            throw new NotFoundHttpException('Administrator not found.');
+            throw $this->createNotFoundException('Administrator not found.');
         }
         /** @var UpdateAdministratorRequest $dto */
         $dto = $this->validator->validate($request, UpdateAdministratorRequest::class);
         $this->administratorManager->updateAdministrator($administrator, $dto);
 
-        return new JsonResponse(null, Response::HTTP_OK);
+        return $this->json(null, Response::HTTP_OK);
     }
 
     #[Route('/{administratorId}', name: 'delete_administrator', methods: ['DELETE'])]
@@ -265,10 +264,10 @@ public function deleteAdministrator(
         $this->requireAuthentication($request);
 
         if (!$administrator) {
-            throw new NotFoundHttpException('Administrator not found.');
+            throw $this->createNotFoundException('Administrator not found.');
         }
         $this->administratorManager->deleteAdministrator($administrator);
 
-        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+        return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 }
diff --git a/src/Controller/CampaignController.php b/src/Controller/CampaignController.php
@@ -18,7 +18,6 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 
 /**
@@ -106,7 +105,7 @@ public function getMessages(Request $request): JsonResponse
 
         $filter = (new MessageFilter())->setOwner($authUer);
 
-        return new JsonResponse(
+        return $this->json(
             $this->paginatedProvider->getPaginatedList($request, $this->normalizer, Message::class, $filter),
             Response::HTTP_OK
         );
@@ -156,10 +155,10 @@ public function getMessage(
         $this->requireAuthentication($request);
 
         if (!$message) {
-            throw new NotFoundHttpException('Campaign not found.');
+            throw $this->createNotFoundException('Campaign not found.');
         }
 
-        return new JsonResponse($this->normalizer->normalize($message), Response::HTTP_OK);
+        return $this->json($this->normalizer->normalize($message), Response::HTTP_OK);
     }
 
     #[Route('', name: 'create_message', methods: ['POST'])]
@@ -221,7 +220,7 @@ public function createMessage(Request $request, MessageNormalizer $normalizer):
         $createMessageRequest = $this->validator->validate($request, CreateMessageRequest::class);
         $data = $this->messageManager->createMessage($createMessageRequest, $authUser);
 
-        return new JsonResponse($normalizer->normalize($data), Response::HTTP_CREATED);
+        return $this->json($normalizer->normalize($data), Response::HTTP_CREATED);
     }
 
     #[Route('/{messageId}', name: 'update_campaign', methods: ['PUT'])]
@@ -288,13 +287,13 @@ public function updateMessage(
         $authUser = $this->requireAuthentication($request);
 
         if (!$message) {
-            throw new NotFoundHttpException('Campaign not found.');
+            throw $this->createNotFoundException('Campaign not found.');
         }
         /** @var UpdateMessageRequest $updateMessageRequest */
         $updateMessageRequest = $this->validator->validate($request, UpdateMessageRequest::class);
         $data = $this->messageManager->updateMessage($updateMessageRequest, $message, $authUser);
 
-        return new JsonResponse($this->normalizer->normalize($data), Response::HTTP_OK);
+        return $this->json($this->normalizer->normalize($data), Response::HTTP_OK);
     }
 
     #[Route('/{messageId}', name: 'delete_campaign', methods: ['DELETE'])]
@@ -346,11 +345,11 @@ public function deleteMessage(
         $this->requireAuthentication($request);
 
         if (!$message) {
-            throw new NotFoundHttpException('Campaign not found.');
+            throw $this->createNotFoundException('Campaign not found.');
         }
 
         $this->messageManager->delete($message);
 
-        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+        return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 }
diff --git a/src/Controller/ListController.php b/src/Controller/ListController.php
@@ -16,7 +16,6 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 
 /**
@@ -104,7 +103,7 @@ public function getLists(Request $request): JsonResponse
     {
         $this->requireAuthentication($request);
 
-        return new JsonResponse(
+        return $this->json(
             $this->paginatedDataProvider->getPaginatedList($request, $this->normalizer, SubscriberList::class),
             Response::HTTP_OK
         );
@@ -166,10 +165,10 @@ public function getList(
         $this->requireAuthentication($request);
 
         if (!$list) {
-            throw new NotFoundHttpException('Subscriber list not found.');
+            throw $this->createNotFoundException('Subscriber list not found.');
         }
 
-        return new JsonResponse($this->normalizer->normalize($list), Response::HTTP_OK);
+        return $this->json($this->normalizer->normalize($list), Response::HTTP_OK);
     }
 
     #[Route('/{listId}', name: 'delete_list', methods: ['DELETE'])]
@@ -218,12 +217,12 @@ public function deleteList(
         $this->requireAuthentication($request);
 
         if (!$list) {
-            throw new NotFoundHttpException('Subscriber list not found.');
+            throw $this->createNotFoundException('Subscriber list not found.');
         }
 
         $this->subscriberListManager->delete($list);
 
-        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+        return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 
     #[Route('', name: 'create_list', methods: ['POST'])]
@@ -282,6 +281,6 @@ public function createList(Request $request, SubscriberListNormalizer $normalize
         $subscriberListRequest = $this->validator->validate($request, CreateSubscriberListRequest::class);
         $data = $this->subscriberListManager->createSubscriberList($subscriberListRequest, $authUser);
 
-        return new JsonResponse($normalizer->normalize($data), Response::HTTP_CREATED);
+        return $this->json($normalizer->normalize($data), Response::HTTP_CREATED);
     }
 }
diff --git a/src/Controller/SessionController.php b/src/Controller/SessionController.php
@@ -16,7 +16,6 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 
 /**
@@ -95,7 +94,7 @@ public function createSession(
 
         $json = $normalizer->normalize($token, 'json');
 
-        return new JsonResponse($json, Response::HTTP_CREATED);
+        return $this->json($json, Response::HTTP_CREATED);
     }
 
     /**
@@ -104,7 +103,6 @@ public function createSession(
      * This action may only be called for sessions that are owned by the authenticated administrator.
      *
      * @throws AccessDeniedHttpException
-     * @throws NotFoundHttpException
      */
     #[Route('/{sessionId}', name: 'delete_session', methods: ['DELETE'])]
     #[OA\Delete(
@@ -145,14 +143,14 @@ public function deleteSession(
         $administrator = $this->requireAuthentication($request);
 
         if (!$token) {
-            throw new NotFoundHttpException('Token not found.');
+            throw $this->createNotFoundException('Token not found.');
         }
         if ($token->getAdministrator() !== $administrator) {
             throw new AccessDeniedHttpException('You do not have access to this session.', null, 1519831644);
         }
 
         $this->sessionManager->deleteSession($token);
 
-        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+        return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 }
diff --git a/src/Controller/SubscriberController.php b/src/Controller/SubscriberController.php
@@ -16,7 +16,6 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 
 /**
@@ -101,7 +100,7 @@ public function createSubscriber(Request $request): JsonResponse
         $subscriberRequest = $this->validator->validate($request, CreateSubscriberRequest::class);
         $subscriber = $this->subscriberManager->createSubscriber($subscriberRequest);
 
-        return new JsonResponse(
+        return $this->json(
             $this->subscriberNormalizer->normalize($subscriber, 'json'),
             Response::HTTP_CREATED
         );
@@ -174,13 +173,13 @@ public function updateSubscriber(
         $this->requireAuthentication($request);
 
         if (!$subscriber) {
-            throw new NotFoundHttpException('Subscriber not found.');
+            throw $this->createNotFoundException('Subscriber not found.');
         }
         /** @var UpdateSubscriberRequest $dto */
         $dto = $this->validator->validate($request, UpdateSubscriberRequest::class);
         $subscriber = $this->subscriberManager->updateSubscriber($dto);
 
-        return new JsonResponse($this->subscriberNormalizer->normalize($subscriber, 'json'), Response::HTTP_OK);
+        return $this->json($this->subscriberNormalizer->normalize($subscriber, 'json'), Response::HTTP_OK);
     }
 
     #[Route('/{subscriberId}', name: 'get_subscriber_by_id', methods: ['GET'])]
@@ -229,7 +228,7 @@ public function getSubscriber(Request $request, int $subscriberId): JsonResponse
 
         $subscriber = $this->subscriberManager->getSubscriber($subscriberId);
 
-        return new JsonResponse($this->subscriberNormalizer->normalize($subscriber), Response::HTTP_OK);
+        return $this->json($this->subscriberNormalizer->normalize($subscriber), Response::HTTP_OK);
     }
 
     #[Route('/{subscriberId}', name: 'delete_subscriber', requirements: ['subscriberId' => '\d+'], methods: ['DELETE'])]
@@ -278,10 +277,10 @@ public function deleteSubscriber(
         $this->requireAuthentication($request);
 
         if (!$subscriber) {
-            throw new NotFoundHttpException('Subscriber not found.');
+            throw $this->createNotFoundException('Subscriber not found.');
         }
         $this->subscriberManager->deleteSubscriber($subscriber);
 
-        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+        return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 }
diff --git a/src/Controller/SubscriptionController.php b/src/Controller/SubscriptionController.php
@@ -123,7 +123,7 @@ public function getListMembers(
             throw $this->createNotFoundException('Subscriber list not found.');
         }
 
-        return new JsonResponse(
+        return $this->json(
             $this->paginatedProvider->getPaginatedList(
                 $request,
                 $this->subscriberNormalizer,
@@ -188,7 +188,7 @@ public function getSubscribersCount(
             throw $this->createNotFoundException('Subscriber list not found.');
         }
 
-        return new JsonResponse(['subscribers_count' => count($list->getSubscribers())], Response::HTTP_OK);
+        return $this->json(['subscribers_count' => count($list->getSubscribers())], Response::HTTP_OK);
     }
 
     #[Route('/{listId}/subscribers', name: 'create_subscription', methods: ['POST'])]
@@ -279,7 +279,7 @@ public function createSubscription(
         $subscriptions = $this->subscriptionManager->createSubscriptions($list, $subscriptionRequest->emails);
         $normalized = array_map(fn($item) => $this->subscriptionNormalizer->normalize($item), $subscriptions);
 
-        return new JsonResponse($normalized, Response::HTTP_CREATED);
+        return $this->json($normalized, Response::HTTP_CREATED);
     }
 
     #[Route('/{listId}/subscribers', name: 'delete_subscription', methods: ['DELETE'])]
@@ -343,6 +343,6 @@ public function deleteSubscriptions(
         $subscriptionRequest = $this->validator->validateDto($subscriptionRequest);
         $this->subscriptionManager->deleteSubscriptions($list, $subscriptionRequest->emails);
 
-        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+        return $this->json(null, Response::HTTP_NO_CONTENT);
     }
 }
diff --git a/src/Controller/TemplateController.php b/src/Controller/TemplateController.php
diff --git a/tests/Integration/Controller/TemplateControllerTest.php b/tests/Integration/Controller/TemplateControllerTest.php
diff --git a/tests/Unit/Controller/TemplateControllerTest.php b/tests/Unit/Controller/TemplateControllerTest.php

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@`
`16`	`16`	`use Symfony\Component\HttpFoundation\JsonResponse;`
`17`	`17`	`use Symfony\Component\HttpFoundation\Request;`
`18`	`18`	`use Symfony\Component\HttpFoundation\Response;`
`19`		`-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;`
`20`	`19`	`use Symfony\Component\Routing\Attribute\Route;`
`21`	`20`
`22`	`21`	`/**`
`@@ -104,7 +103,7 @@ public function getLists(Request $request): JsonResponse`
`104`	`103`	`{`
`105`	`104`	`$this->requireAuthentication($request);`
`106`	`105`
`107`		`- return new JsonResponse(`
	`106`	`+ return $this->json(`
`108`	`107`	`$this->paginatedDataProvider->getPaginatedList($request, $this->normalizer, SubscriberList::class),`
`109`	`108`	`Response::HTTP_OK`
`110`	`109`	`);`
`@@ -166,10 +165,10 @@ public function getList(`
`166`	`165`	`$this->requireAuthentication($request);`
`167`	`166`
`168`	`167`	`if (!$list) {`
`169`		`- throw new NotFoundHttpException('Subscriber list not found.');`
	`168`	`+ throw $this->createNotFoundException('Subscriber list not found.');`
`170`	`169`	`}`
`171`	`170`
`172`		`- return new JsonResponse($this->normalizer->normalize($list), Response::HTTP_OK);`
	`171`	`+ return $this->json($this->normalizer->normalize($list), Response::HTTP_OK);`
`173`	`172`	`}`
`174`	`173`
`175`	`174`	`#[Route('/{listId}', name: 'delete_list', methods: ['DELETE'])]`
`@@ -218,12 +217,12 @@ public function deleteList(`
`218`	`217`	`$this->requireAuthentication($request);`
`219`	`218`
`220`	`219`	`if (!$list) {`
`221`		`- throw new NotFoundHttpException('Subscriber list not found.');`
	`220`	`+ throw $this->createNotFoundException('Subscriber list not found.');`
`222`	`221`	`}`
`223`	`222`
`224`	`223`	`$this->subscriberListManager->delete($list);`
`225`	`224`
`226`		`- return new JsonResponse(null, Response::HTTP_NO_CONTENT);`
	`225`	`+ return $this->json(null, Response::HTTP_NO_CONTENT);`
`227`	`226`	`}`
`228`	`227`
`229`	`228`	`#[Route('', name: 'create_list', methods: ['POST'])]`
`@@ -282,6 +281,6 @@ public function createList(Request $request, SubscriberListNormalizer $normalize`
`282`	`281`	`$subscriberListRequest = $this->validator->validate($request, CreateSubscriberListRequest::class);`
`283`	`282`	`$data = $this->subscriberListManager->createSubscriberList($subscriberListRequest, $authUser);`
`284`	`283`
`285`		`- return new JsonResponse($normalizer->normalize($data), Response::HTTP_CREATED);`
	`284`	`+ return $this->json($normalizer->normalize($data), Response::HTTP_CREATED);`
`286`	`285`	`}`
`287`	`286`	`}`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ public function getListMembers(`
`123`	`123`	`throw $this->createNotFoundException('Subscriber list not found.');`
`124`	`124`	`}`
`125`	`125`
`126`		`- return new JsonResponse(`
	`126`	`+ return $this->json(`
`127`	`127`	`$this->paginatedProvider->getPaginatedList(`
`128`	`128`	`$request,`
`129`	`129`	`$this->subscriberNormalizer,`
`@@ -188,7 +188,7 @@ public function getSubscribersCount(`
`188`	`188`	`throw $this->createNotFoundException('Subscriber list not found.');`
`189`	`189`	`}`
`190`	`190`
`191`		`- return new JsonResponse(['subscribers_count' => count($list->getSubscribers())], Response::HTTP_OK);`
	`191`	`+ return $this->json(['subscribers_count' => count($list->getSubscribers())], Response::HTTP_OK);`
`192`	`192`	`}`
`193`	`193`
`194`	`194`	`#[Route('/{listId}/subscribers', name: 'create_subscription', methods: ['POST'])]`
`@@ -279,7 +279,7 @@ public function createSubscription(`
`279`	`279`	`$subscriptions = $this->subscriptionManager->createSubscriptions($list, $subscriptionRequest->emails);`
`280`	`280`	`$normalized = array_map(fn($item) => $this->subscriptionNormalizer->normalize($item), $subscriptions);`
`281`	`281`
`282`		`- return new JsonResponse($normalized, Response::HTTP_CREATED);`
	`282`	`+ return $this->json($normalized, Response::HTTP_CREATED);`
`283`	`283`	`}`
`284`	`284`
`285`	`285`	`#[Route('/{listId}/subscribers', name: 'delete_subscription', methods: ['DELETE'])]`
`@@ -343,6 +343,6 @@ public function deleteSubscriptions(`
`343`	`343`	`$subscriptionRequest = $this->validator->validateDto($subscriptionRequest);`
`344`	`344`	`$this->subscriptionManager->deleteSubscriptions($list, $subscriptionRequest->emails);`
`345`	`345`
`346`		`- return new JsonResponse(null, Response::HTTP_NO_CONTENT);`
	`346`	`+ return $this->json(null, Response::HTTP_NO_CONTENT);`
`347`	`347`	`}`
`348`	`348`	`}`