feat: set max pagination limit to null to prevent a breaking change

Author: alexzarbn

src/Contracts/Paginator.php

@@ -6,7 +6,7 @@
 
 interface Paginator
 {
-    public function __construct(int $defaultLimit, int $maxLimit);
+    public function __construct(int $defaultLimit, ?int $maxLimit);
 
     public function resolvePaginationLimit(Request $request): int;
 }

src/Drivers/Standard/Paginator.php

@@ -13,16 +13,17 @@ class Paginator implements \Orion\Contracts\Paginator
     protected $defaultLimit;
 
     /**
-     * @var int $maxLimit
+     * @var int|null $maxLimit
      */
     protected $maxLimit;
 
     /**
      * Paginator constructor.
      *
      * @param int $defaultLimit
+     * @param int|null $maxLimit
      */
-    public function __construct(int $defaultLimit, int $maxLimit)
+    public function __construct(int $defaultLimit, ?int $maxLimit)
     {
         $this->defaultLimit = $defaultLimit;
         $this->maxLimit = $maxLimit;
@@ -36,9 +37,10 @@ public function __construct(int $defaultLimit, int $maxLimit)
      */
     public function resolvePaginationLimit(Request $request): int
     {
-        $limit = (int)$request->get('limit');
+        $limit = (int) $request->get('limit');
+
         return tap($limit > 0 ? $limit : $this->defaultLimit, function ($limit) {
-            if ($limit > $this->maxLimit) {
+            if ($this->maxLimit && $limit > $this->maxLimit) {
                 throw new MaxPaginationLimitExceededException(422, __("Pagination limit of :max is exceeded. Current: :limit", ['max' => $this->maxLimit, 'limit' => $limit]));
             }
         });

src/Http/Controllers/BaseController.php

@@ -249,11 +249,11 @@ public function limit(): int
     /**
      * Max pagination limit.
      *
-     * @return int
+     * @return int?
      */
-    public function maxLimit(): int
+    public function maxLimit(): ?int
     {
-        return 500;
+        return null;
     }
 
     /**

tests/Unit/Http/Controllers/BaseControllerTest.php

@@ -41,7 +41,7 @@ public function dependencies_are_resolved_correctly()
         $fakeComponentsResolver = new ComponentsResolver(Post::class);
         $fakeParamsValidator = new ParamsValidator();
         $fakeRelationsResolver = new RelationsResolver([], []);
-        $fakePaginator = new Paginator(15, 500);
+        $fakePaginator = new Paginator(15, null);
         $fakeSearchBuilder = new SearchBuilder([]);
         $fakeQueryBuilder = new QueryBuilder(Post::class, $fakeParamsValidator, $fakeRelationsResolver, $fakeSearchBuilder);
 
@@ -75,7 +75,7 @@ public function dependencies_are_resolved_correctly()
             \Orion\Contracts\Paginator::class,
             [
                 'defaultLimit' => 15,
-                'maxLimit' => 500,
+                'maxLimit' => null,
             ]
         )->once()->andReturn($fakePaginator);
 

tests/Unit/Http/Controllers/RelationControllerTest.php

@@ -34,7 +34,7 @@ public function dependencies_are_resolved_correctly()
         $fakeComponentsResolver = new ComponentsResolver(Post::class);
         $fakeParamsValidator = new ParamsValidator();
         $fakeRelationsResolver = new RelationsResolver([], []);
-        $fakePaginator = new Paginator(15, 500);
+        $fakePaginator = new Paginator(15, null);
         $fakeSearchBuilder = new SearchBuilder([]);
         $fakeQueryBuilder = new QueryBuilder(Post::class, $fakeParamsValidator, $fakeRelationsResolver, $fakeSearchBuilder);
         $fakeRelationQueryBuilder = new QueryBuilder(User::class, $fakeParamsValidator, $fakeRelationsResolver, $fakeSearchBuilder);
@@ -69,7 +69,7 @@ public function dependencies_are_resolved_correctly()
             \Orion\Contracts\Paginator::class,
             [
                 'defaultLimit' => 15,
-                'maxLimit' => 500,
+                'maxLimit' => null,
             ]
         )->once()->andReturn($fakePaginator);