⚡ lazy nested field validation

Author: GautierDele

config/rest.php

@@ -1,20 +1,6 @@
 <?php
 
 return [
-
-    /*
-    |--------------------------------------------------------------------------
-    | Filters
-    |--------------------------------------------------------------------------
-    |
-    | Custom filters
-    |
-    */
-
-    'filters' => [
-        'max_depth' => 3,
-    ],
-
     /*
     |--------------------------------------------------------------------------
     | Rest Gates

src/Concerns/Resource/ConfiguresRestParameters.php

@@ -2,7 +2,10 @@
 
 namespace Lomkit\Rest\Concerns\Resource;
 
+use Illuminate\Support\Facades\App;
+use Illuminate\Support\Str;
 use Lomkit\Rest\Http\Requests\RestRequest;
+use Lomkit\Rest\Relations\Relation;
 
 trait ConfiguresRestParameters
 {
@@ -38,45 +41,26 @@ public function getFields(\Lomkit\Rest\Http\Requests\RestRequest $request): arra
     }
 
     /**
-     * Get nested fields by prefixing them with a given prefix.
+     * Verify the field is correct including nested relations
      *
-     * @param RestRequest $request
-     * @param string      $prefix
-     * @param array       $loadedRelations
-     *
-     * @return array
+     * @param string $field
+     * @return bool
      */
-    public function getNestedFields(RestRequest $request, int $maxDepth = 3, string $prefix = '', array $loadedRelations = [])
+    public function isNestedField(string $field, Relation $relation = null)
     {
-        if ($prefix !== '') {
-            $prefix = $prefix.'.';
-        }
+        if (Str::contains($field ,'.')) {
+
+            // In case we are on a pivot we look for the relation pivot fields
+            if (Str::before($field, '.') === 'pivot') {
+                return method_exists($relation, 'getPivotFields') && in_array(Str::after($field, '.'), $relation->getPivotFields());
+            }
+
+            $fieldRelation = $this->relation(Str::before($field, '.'));
 
-        $fields = array_map(
-            function ($field) use ($prefix) {
-                return $prefix.$field;
-            },
-            $this->getFields($request)
-        );
-
-        foreach (
-            collect($this->getRelations($request))
-                ->filter(function ($relation) use ($loadedRelations) {
-                    return !in_array($relation->relation, $loadedRelations);
-                })
-            as $relation
-        ) {
-            $loadedRelations[] = $relation->relation;
-            array_push(
-                $fields,
-                ...($maxDepth > 0 ? $relation->resource()->getNestedFields($request, $maxDepth - 1, $prefix.$relation->relation, $loadedRelations) : []),
-                // We push the pivot fields if they exists
-                ...collect(method_exists($relation, 'getPivotFields') ? $relation->getPivotFields() : [])
-                        ->map(function ($field) use ($relation, $prefix) { return $prefix.$relation->relation.'.pivot.'.$field; })
-            );
+            return $fieldRelation->resource()->isNestedField(Str::after($field, '.'), $fieldRelation);
         }
 
-        return $fields;
+        return in_array($field, $this->getFields(App::make(RestRequest::class)));
     }
 
     /**

src/Rules/IsNestedField.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Lomkit\Rest\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Contracts\Validation\ValidatorAwareRule;
+use Illuminate\Validation\Validator;
+use Lomkit\Rest\Http\Requests\RestRequest;
+use Lomkit\Rest\Http\Resource;
+
+class IsNestedField implements ValidationRule
+{
+    /**
+     * The validator instance.
+     *
+     * @var \Illuminate\Validation\Validator
+     */
+    protected $validator;
+
+    /**
+     * The resource instance.
+     *
+     * @var resource
+     */
+    protected Resource $resource;
+
+    /**
+     * The request instance.
+     *
+     * @var RestRequest
+     */
+    protected RestRequest $request;
+
+    public function __construct(\Lomkit\Rest\Http\Resource $resource, RestRequest $request)
+    {
+        $this->resource = $resource;
+        $this->request = $request;
+    }
+
+    public function validate(string $attribute, mixed $value, Closure $fail): void
+    {
+        if (!$this->resource->isNestedField($value)) {
+            $fail('The '.$attribute.' field is not valid.');
+        }
+    }
+}

src/Rules/SearchRules.php

@@ -111,7 +111,7 @@ public function filtersRules(\Lomkit\Rest\Http\Resource $resource, string $prefi
         $rules = array_merge(
             [
                 $prefix.'.*.field' => [
-                    Rule::in($resource->getNestedFields($this->request, config('rest.filters.max_depth'))),
+                    new IsNestedField($resource, $this->request),
                     "required_without:$prefix.*.nested",
                     'string',
                 ],