Optional nested data failed validation (v2)

[davidkvasnovsky]

Let's assume we have following data structure:

UserData.php

class UserData extends Data
{
    public function __construct(
        public string $name,
        public AddressData|Optional $address,
        public string|Optional $phone,
    ) {
    }
}

AddressData.php

class AddressData extends Data
{
    public function __construct(
        public string $street,
        public string $city,
        public CoordsData|Optional $coords,
    ) {
    }
}

CoordsData.php

class CoordsData extends Data
{
    public function __construct(
        public float $lat,
        public float $lng,
    ) {
    }
}

CreateUserController.php

class CreateUserController extends Controller
{
    public function __invoke(UserData $userData): UserData
    {
        return $userData;
    }
}

I deliberately specified CreateUserController.php because this bug only occurs if the data is coming from a request object.

So let's make a POST request with JSON payload, that is given bellow:

{
    "name": "David",
    "address": {
        "street": "Street",
        "city": "City"
    }
}

We get the following error:

{
    "message": "The address.coords field is required. (and 2 more errors)",
    "errors": {
        "address.coords": [
            "The address.coords field is required."
        ],
        "address.coords.lat": [
            "The address.coords.lat field is required."
        ],
        "address.coords.lng": [
            "The address.coords.lng field is required."
        ]
    }
}

I assume that this behavior is not correct. It is possible to solve it temporarily by adding a validation rule #[WithoutValidation], but that doesn't seem very optimal.

[rubenvanassche]

Hi @davidkvasnovsky,

So in this case the coordinates property should be nullable due to the Undefined (we renamed it to Optional btw) typehint? That's probably correct, let's take a look on how to fix this.

[rubenvanassche]

Added a fix for this in v2!

[jskorlol]

In this state

{
     "name": "David",
     "address": {
         "street": "Street",
         "city": "City"
         "coords": {
             "lat": 13.44
         }
     }
}

call

the constructor requires 2 parameters, 1 given.Parameters given: lat.

will occur.

Can improve this problem ?

[davidkvasnovsky]

Yes, that's because lng is required and you provided only lat.

[jskorlol]

    public static function rules(array $payload): array
    {
        return [
            'lat' => [Rule::requiredIf((isset($payload['lat']) || isset($payload['coords']))), 'numeric'],
            'lng' => [Rule::requiredIf((isset($payload['lng']) || isset($payload['coords']))), 'numeric'],
        ];
    }

So I did it like this.

[thewebartisan7]

@rubenvanassche I get similar issue and seem not fixed in v2, the only solution seem to use #[WithoutValidation]..

My UserData name and email:

    public string|Lazy|null $name = null;

    public string|Lazy|null $email = null;

With validation rules() method in UserData.

However when I try to update a comment by passing body and user_id, without user the validation of UserData failed.

CommentData:

        //#[WithoutValidation]
        public UserData|Optional|Lazy|null $user = null,

Am I missing something?

Thanks

[rubenvanassche]

Could you please provide me a test producing the error?

[serhii-shpachynskyi]

Seems, I have similar issue or do something wrong
I use laravel v9.39 and laravel-data v2.0

Here is my data structure:

CreateUserRequest.php

class CreateUserRequest extends Data
{
    public function __construct(
        public string $first_name,
        public string $last_name,
        public string $email,
        public ?Address $address, //public Optional|Address $address - also tried such syntax
    ) {
    }

    public static function rules(): array
    {
        return [
            'first_name' => 'required|string',
            'last_name' => 'required|string',
            'email' => 'required|email',
            'address' => 'nullable|array:street,postcode,city,country',
        ];
    }
}

Address.php

class Address extends Data
{
    public function __construct(
        public string $street,
        public string $postcode,
        public string $city,
        public string $country,
    ) {
    }

    public static function rules(array $payload): array
    {
        return [
            'street' => 'required|string',
            'postcode' => 'required|string',
            'city' => 'required|string',
            'country' => 'required|string',
        ];
    }
}

UserController.php

class UserController extends Controller
{
    public function store(CreateUserRequest $createUserRequest)
    {
        // some logic
    }
}

When I send a request with following payload:

{
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
}

I get validation errors:

{
  "message": "The address.street field is required. (and 3 more errors)",
  "errors": {
    "address.street": [
      "The address.street field is required."
    ],
    "address.postcode": [
      "The address.postcode field is required."
    ],
    "address.city": [
      "The address.city field is required."
    ],
    "address.country": [
      "The address.country field is required."
    ]
  }
}

I am expecting, that address object won't be validated with such JSON payload and can be nullable. How can I handle such case? Thank you in advance

[francoism90]

@serhii-shpachynskyi You can use exclude_without or if I'm not mistaken sometimes.