adds limit to random endpoints

app/Dto/Concerns/PreparesData.php

@@ -16,17 +16,13 @@ trait PreparesData
     public static function prepareForPipeline(Collection $properties): Collection
     {
         // let's always set the limit parameter to the globally configured default value
-        // // commented out to prevent override for backwards compatibility in /random
-        //if (property_exists(static::class, "limit") && !$properties->has("limit")) {
-        //    $properties->put("limit", max_results_per_page(
-        //        property_exists(static::class, "defaultLimit") ? static::$defaultLimit : null));
-        //}
-
-        // apply defaultLimit for endpoints that have `limit` supplied
-        if (property_exists(static::class, "limit") && $properties->has("limit")) {
-            $properties->put("limit", max_results_per_page(
-                property_exists(static::class, "defaultLimit") ? static::$defaultLimit : null));
-        }
+        // // BUG: this causes override and always sets the default limit to config value
+        //         even if the property `limit` does not exist
+        //         max_results_per_page never accepts $defaultLimit and will always return config value
+        // if (property_exists(static::class, "limit") && !$properties->has("limit")) {
+        //     $properties->put("limit", max_results_per_page(
+        //         property_exists(static::class, "defaultLimit") ? static::$defaultLimit : null));
+        // }
 
         // we want to cast "true" and "false" string values to boolean before validation, so let's take all properties
         // of the class which are bool or bool|Optional type, and using their name read the values from the incoming

app/Dto/QueryRandomAnimeCommand.php

@@ -3,7 +3,7 @@
 namespace App\Dto;
 
 use App\Contracts\DataRequest;
-use App\Dto\Concerns\HasLimitParameter;
+use App\Dto\Concerns\HasLimitParameterWithSmallerMax;
 use App\Dto\Concerns\HasSfwParameter;
 use App\Dto\Concerns\HasUnapprovedParameter;
 use App\Http\Resources\V4\AnimeCollection;
@@ -17,7 +17,5 @@ final class QueryRandomAnimeCommand extends Data implements DataRequest
 {
     use HasSfwParameter,
         HasUnapprovedParameter,
-        HasLimitParameter;
-
-    protected static int $defaultLimit = 5;
+        HasLimitParameterWithSmallerMax;
 }

app/Dto/QueryRandomCharacterCommand.php

@@ -3,6 +3,7 @@
 namespace App\Dto;
 
 use App\Contracts\DataRequest;
+use App\Dto\Concerns\HasLimitParameterWithSmallerMax;
 use App\Http\Resources\V4\CharacterResource;
 use Spatie\LaravelData\Data;
 
@@ -11,4 +12,5 @@
  */
 final class QueryRandomCharacterCommand extends Data implements DataRequest
 {
+    use HasLimitParameterWithSmallerMax;
 }

app/Dto/QueryRandomMangaCommand.php

@@ -3,15 +3,19 @@
 namespace App\Dto;
 
 use App\Contracts\DataRequest;
+use App\Dto\Concerns\HasLimitParameterWithSmallerMax;
 use App\Dto\Concerns\HasSfwParameter;
 use App\Dto\Concerns\HasUnapprovedParameter;
+use App\Http\Resources\V4\MangaCollection;
 use App\Http\Resources\V4\MangaResource;
 use Spatie\LaravelData\Data;
 
 /**
- * @implements DataRequest<MangaResource>
+ * @implements DataRequest<MangaResource|MangaCollection>
  */
 final class QueryRandomMangaCommand extends Data implements DataRequest
 {
-    use HasSfwParameter, HasUnapprovedParameter;
+    use HasSfwParameter,
+        HasUnapprovedParameter,
+        HasLimitParameterWithSmallerMax;
 }

app/Dto/QueryRandomPersonCommand.php

@@ -3,12 +3,15 @@
 namespace App\Dto;
 
 use App\Contracts\DataRequest;
+use App\Dto\Concerns\HasLimitParameterWithSmallerMax;
+use App\Http\Resources\V4\PersonCollection;
 use App\Http\Resources\V4\PersonResource;
 use Spatie\LaravelData\Data;
 
 /**
- * @implements DataRequest<PersonResource>
+ * @implements DataRequest<PersonResource|PersonCollection>
  */
 final class QueryRandomPersonCommand extends Data implements DataRequest
 {
+    use HasLimitParameterWithSmallerMax;
 }

app/Dto/QueryRandomUserCommand.php

@@ -3,6 +3,7 @@
 namespace App\Dto;
 
 use App\Contracts\DataRequest;
+use App\Dto\Concerns\HasLimitParameterWithSmallerMax;
 use App\Http\Resources\V4\ProfileResource;
 use Spatie\LaravelData\Data;
 
@@ -11,4 +12,5 @@
  */
 final class QueryRandomUserCommand extends Data implements DataRequest
 {
+    use HasLimitParameterWithSmallerMax;
 }

app/Features/QueryRandomAnimeHandler.php

@@ -3,15 +3,11 @@
 namespace App\Features;
 
 use App\Anime;
-use App\Contracts\AnimeRepository;
 use App\Contracts\RequestHandler;
 use App\Dto\QueryRandomAnimeCommand;
 use App\Http\Resources\V4\AnimeCollection;
 use App\Http\Resources\V4\AnimeResource;
-use App\Services\QueryBuilderPaginatorService;
-use MongoDB\Collection;
 use Spatie\LaravelData\Optional;
-use function Amp\Iterator\merge;
 
 /**
  * @implements RequestHandler<QueryRandomAnimeCommand, AnimeResource|AnimeCollection>
@@ -25,10 +21,9 @@ public function handle($request): AnimeResource|AnimeCollection
     {
         $queryable = Anime::query();
 
-        $o = Optional::create();
-        $sfwParam = $request->sfw === $o ? false : $request->sfw;
-        $unapprovedParam = $request->unapproved === $o ? false : $request->unapproved;
-        $limit = $request->limit instanceof $o ? 1 : $request->limit;
+        $sfwParam = $request->sfw instanceof Optional ? false : $request->sfw;
+        $unapprovedParam = $request->unapproved instanceof Optional ? false : $request->unapproved;
+        $limit = $request->limit instanceof Optional ? 1 : $request->limit;
 
         $results = $queryable->random($limit, $sfwParam, $unapprovedParam);
 

app/Features/QueryRandomCharacterHandler.php

@@ -2,20 +2,33 @@
 
 namespace App\Features;
 
-use App\Contracts\CharacterRepository;
+use App\Character;
+use App\Contracts\RequestHandler;
 use App\Dto\QueryRandomCharacterCommand;
+use App\Http\Resources\V4\CharacterCollection;
 use App\Http\Resources\V4\CharacterResource;
-use Illuminate\Http\Resources\Json\JsonResource;
-use Illuminate\Support\Collection;
+use Spatie\LaravelData\Optional;
 
 /**
- * @extends QueryRandomItemHandler<QueryRandomCharacterCommand, CharacterResource>
+ * @extends QueryRandomCharacterHandler<QueryRandomCharacterCommand, CharacterResource|CharacterCollection>
  */
-final class QueryRandomCharacterHandler extends QueryRandomItemHandler
+final class QueryRandomCharacterHandler implements RequestHandler
 {
-    public function __construct(CharacterRepository $repository)
+
+    /**
+     * @inheritDoc
+     */
+    public function handle($request): CharacterResource|CharacterCollection
     {
-        parent::__construct($repository);
+        $queryable = Character::query();
+
+        $limit = $request->limit instanceof Optional ? 1 : $request->limit;
+
+        $results = $queryable->random($limit);
+
+        return $results->count() === 1
+            ? new CharacterResource($results->first())
+            : new CharacterCollection($results, false);
     }
 
     /**
@@ -25,9 +38,4 @@ public function requestClass(): string
     {
         return QueryRandomCharacterCommand::class;
     }
-
-    protected function resource(Collection $results): JsonResource
-    {
-        return new CharacterResource($results->first());
-    }
 }

app/Features/QueryRandomMangaHandler.php

@@ -4,29 +4,32 @@
 
 use App\Contracts\RequestHandler;
 use App\Dto\QueryRandomMangaCommand;
+use App\Http\Resources\V4\MangaCollection;
 use App\Http\Resources\V4\MangaResource;
 use App\Manga;
 use Spatie\LaravelData\Optional;
 
 /**
- * @implements RequestHandler<QueryRandomMangaCommand, MangaResource>
+ * @implements RequestHandler<QueryRandomMangaCommand, MangaResource|MangaCollection>
  */
 final class QueryRandomMangaHandler implements RequestHandler
 {
     /**
      * @inheritDoc
      */
-    public function handle($request)
+    public function handle($request): MangaResource|MangaCollection
     {
         $queryable = Manga::query();
 
-        $o = Optional::create();
-        $sfwParam = $request->sfw === $o ? false : $request->sfw;
-        $unapprovedParam = $request->unapproved === $o ? false : $request->unapproved;
+        $sfwParam = $request->sfw instanceof Optional ? false : $request->sfw;
+        $unapprovedParam = $request->unapproved instanceof Optional ? false : $request->unapproved;
+        $limit = $request->limit instanceof Optional ? 1 : $request->limit;
 
-        return new MangaResource(
-            $queryable->random(1, $sfwParam, $unapprovedParam)->first()
-        );
+        $results = $queryable->random($limit, $sfwParam, $unapprovedParam);
+
+        return $results->count() === 1
+            ? new MangaResource($results->first())
+            : new MangaCollection($results, false);
     }
 
     /**

app/Features/QueryRandomPersonHandler.php

@@ -2,20 +2,33 @@
 
 namespace App\Features;
 
-use App\Contracts\PeopleRepository;
+use App\Contracts\RequestHandler;
 use App\Dto\QueryRandomPersonCommand;
+use App\Http\Resources\V4\PersonCollection;
 use App\Http\Resources\V4\PersonResource;
-use Illuminate\Http\Resources\Json\JsonResource;
-use Illuminate\Support\Collection;
+use App\Person;
+use Spatie\LaravelData\Optional;
 
 /**
- * @extends QueryRandomItemHandler<QueryRandomPersonCommand, PersonResource>
+ * @extends RequestHandler<QueryRandomPersonCommand, PersonResource|PersonCollection>
  */
-final class QueryRandomPersonHandler extends QueryRandomItemHandler
+final class QueryRandomPersonHandler implements RequestHandler
 {
-    public function __construct(PeopleRepository $repository)
+
+    /**
+     * @inheritDoc
+     */
+    public function handle($request): PersonResource|PersonCollection
     {
-        parent::__construct($repository);
+        $queryable = Person::query();
+
+        $limit = $request->limit instanceof Optional ? 1 : $request->limit;
+
+        $results = $queryable->random($limit);
+
+        return $results->count() === 1
+            ? new PersonResource($results->first())
+            : new PersonCollection($results, false);
     }
 
     /**
@@ -25,9 +38,4 @@ public function requestClass(): string
     {
         return QueryRandomPersonCommand::class;
     }
-
-    protected function resource(Collection $results): JsonResource
-    {
-        return new PersonResource($results->first());
-    }
 }

app/Features/QueryRandomUserHandler.php

@@ -2,27 +2,32 @@
 
 namespace App\Features;
 
-use App\Contracts\UserRepository;
+use App\Contracts\RequestHandler;
 use App\Dto\QueryRandomUserCommand;
 use App\Http\Resources\V4\ProfileResource;
-use Illuminate\Http\Resources\Json\JsonResource;
-use Illuminate\Support\Collection;
+use App\Http\Resources\V4\UserCollection;
+use App\Profile;
+use Spatie\LaravelData\Optional;
 
 /**
- * @extends QueryRandomItemHandler<QueryRandomUserCommand, ProfileResource>
+ * @extends RequestHandler<QueryRandomUserCommand, ProfileResource|UserCollection>
  */
-final class QueryRandomUserHandler extends QueryRandomItemHandler
+final class QueryRandomUserHandler implements RequestHandler
 {
-    public function __construct(UserRepository $repository)
+    /**
+     * @inheritDoc
+     */
+    public function handle($request): ProfileResource|UserCollection
     {
-        parent::__construct($repository);
-    }
+        $queryable = Profile::query();
 
-    protected function resource(Collection $results): JsonResource
-    {
-        return new ProfileResource(
-            $results->first()
-        );
+        $limit = $request->limit instanceof Optional ? 1 : $request->limit;
+
+        $results = $queryable->random($limit);
+
+        return $results->count() === 1
+            ? new ProfileResource($results->first())
+            : new UserCollection($results, false);
     }
 
     /**

app/Http/Resources/V4/AnimeCollection.php

@@ -35,7 +35,7 @@ class AnimeCollection extends ResourceCollection
      */
     public $collects = 'App\Http\Resources\V4\AnimeResource';
 
-    private $pagination;
+    private ?array $pagination = null;
 
     public function __construct($resource, bool $paginated = true)
     {