test(laravel): rules on a collection #7280

Author: soyuka

src/Laravel/Tests/ValidationTest.php

@@ -75,4 +75,14 @@ public function testRouteWithRequirements(): void
         $response = $this->get('api/issue_7194_requirements/1', ['accept' => 'application/ld+json']);
         $response->assertStatus(200);
     }
+
+    public function testGetCollectionWithFormRequestValidation(): void
+    {
+        $response = $this->get('/api/slots/dropoff', ['accept' => 'application/ld+json']);
+        $response->assertStatus(422);
+        $response->assertJsonFragment(['violations' => [
+            ['propertyPath' => 'pickupDate', 'message' => 'The pickup date field is required.'],
+            ['propertyPath' => 'pickupSlotId', 'message' => 'The pickup slot id field is required.'],
+        ]]);
+    }
 }

src/Laravel/workbench/app/ApiResource/SlotsForDate.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\ApiResource;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\GetCollection;
+use Workbench\App\Http\Requests\GetDropOffSlotsRequest;
+
+#[ApiResource(
+    operations: [
+        new GetCollection(
+            uriTemplate: '/slots/dropoff',
+            rules: GetDropOffSlotsRequest::class,
+            provider: [self::class, 'provide'],
+            output: SlotsForDate::class,
+        ),
+    ],
+)]
+class SlotsForDate
+{
+    public int $id = 1;
+    public string $name = 'Morning Slot';
+    public string $note = 'This is a morning slot';
+
+    public static function provide() {
+        return [];
+    }
+}

src/Laravel/workbench/app/Http/Requests/GetDropOffSlotsRequest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Http\Requests;
+
+use ApiPlatform\Laravel\State\ValidationErrorTrait;
+use Illuminate\Contracts\Validation\Validator;
+use Illuminate\Foundation\Http\FormRequest;
+
+class GetDropOffSlotsRequest extends FormRequest
+{
+    use ValidationErrorTrait;
+
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    protected function prepareForValidation(): void
+    {
+        $this->merge([
+            'pickupDate' => $this->query('pickupDate'),
+            'pickupSlotId' => $this->query('pickupSlotId'),
+        ]);
+
+    }
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @docs/guides/return-the-iri-of-your-resources-relations.php array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
+     */
+    public function rules(): array
+    {
+        return [
+            'pickupDate' => 'required|date|after_or_equal:today',
+            'pickupSlotId' => 'required|string',
+        ];
+    }
+
+    // to match api plaform validation response
+    protected function failedValidation(Validator $validator): void
+    {
+        $violations = collect($validator->errors())
+            ->map(fn($m, $f) => ['propertyPath' => $f, 'message' => $m[0]]) //** @phpstan-ignore-line */
+            ->values()->all();
+
+        throw new \ApiPlatform\Laravel\ApiResource\ValidationError(
+            $violations[0]['message'] ?? 'Validation failed.',
+            hash('xxh3', implode(',', array_column($violations, 'propertyPath'))),
+            new \Illuminate\Validation\ValidationException($validator),
+            $violations
+        );
+    }
+}