Validation: Custom attributes names of DataCollections not working

[wijzijnweb]

Consider this data class:

class RelationData extends Data
{
    public function __construct(
        public string      $name,

        #[DataCollectionOf(AddressData::class)]
        public DataCollection $addresses
    )
    {
    }

    public static function attributes(...$args): array
    {
        return [
            'name' => 'naam'
        ];
    }
}

It has a DataCollection of AddressData:

class AddressData extends Data
{
    public ?int $id;

    public ?string $code;

    public ?string $name;

    public string $street;

    public string $number;

    public string $city;

    #[DataCollectionOf(ContactData::class)]
    public DataCollection $contacts;

    public static function attributes(...$args): array
    {
        return [
            'code' => 'code',
            'street' => 'straat',
            'number' => 'huisnummer',
            'zipcode' => 'postcode',
            'city' => 'plaats'
        ];
    }
}

The validation error returned for address.2.city is: Het addresses.2.city veld is verplicht. and not Het plaats veld is verplicht.
Also Address has a DataCollection of ContactData that also doens't work.

What I found was that ContactData attributes where not even added. Because of this line:

laravel-data/src/Resolvers/DataValidationMessagesAndAttributesResolver.php

Line 37 in 5b5b659

if (Arr::has($fullPayload, $propertyPath->get()) === false) {

Adding: !$dataProperty->type->isDataCollectable makes sure the attributes are added.
But they are still not resolved.

I stranded to find out where the resolving took place.

Anyone that had the same issue?

[rubenvanassche]

Could you please provide me a pest test like this:

it('tt', function (){
    class RelationData extends Data
    {
        public function __construct(
            public string      $name,

            #[DataCollectionOf(AddressData::class)]
            public DataCollection $addresses
        )
        {
        }

        public static function attributes(...$args): array
        {
            return [
                'name' => 'naam'
            ];
        }
    }

    class AddressData extends Data
    {
        public ?int $id;

        public ?string $code;

        public ?string $name;

        public string $street;

        public string $number;

        public string $city;

        #[DataCollectionOf(ContactData::class)]
        public DataCollection $contacts;

        public static function attributes(...$args): array
        {
            return [
                'code' => 'code',
                'street' => 'straat',
                'number' => 'huisnummer',
                'zipcode' => 'postcode',
                'city' => 'plaats'
            ];
        }
    }
});

With the whole example, including ContactData and a call creating the object? Assertions are not required, I just need a working example to debug further where you show me what's going on in code.

[wijzijnweb]

Hi @rubenvanassche,

This is the first Pest test I wrote. Might not be what you expected but it does the test it seems.
I'm testing if the validation error contains the custom attribute straat.

<?php

use Illuminate\Validation\ValidationException;
use Spatie\LaravelData\Attributes\DataCollectionOf;
use Spatie\LaravelData\Data;
use Spatie\LaravelData\DataCollection;
use function PHPUnit\Framework\assertStringContainsString;

it('has address validation error with custom attribute', function () {
    class RelationData extends Data
    {
        public function __construct(
            public string      $name,

            #[DataCollectionOf(AddressData::class)]
            public DataCollection $addresses
        )
        {
        }

        public static function attributes(...$args): array
        {
            return [
                'name' => 'naam'
            ];
        }
    }

    class AddressData extends Data
    {
        public ?int $id;

        public ?string $code;

        public ?string $name;

        public string $street;

        public string $number;

        public string $city;

        public static function attributes(...$args): array
        {
            return [
                'code' => 'code',
                'street' => 'straat',
                'number' => 'huisnummer',
                'zipcode' => 'postcode',
                'city' => 'plaats'
            ];
        }
    }

    $data = \json_decode('{"name":"test","addresses":[{"id":null,"street":null,"number":null,"city":null,"zipcode":null,"country":null,"default_delivery_time":"10:00","region_id":null,"is_billable":null,"is_delivery":null,"options":[],"days":[],"time_diff":[],"note":null,"order_contacts":[]}]}', true);

    try {
        RelationData::validateAndCreate($data);
    } catch (ValidationException $exception) {
        assertStringContainsString('straat', $exception->errors()['addresses.0.street'][0]);
    }
});

[wijzijnweb]

@rubenvanassche When you got the time, I love to hear if you can reproduce this.

[rubenvanassche]

Hi @wijzijnweb,

When I take a look at the attributes passed to the validator by laravel-data, these look like this:

Which seems correct to me?

[wijzijnweb]

Package updated to latest version 3.2.1.

@rubenvanassche Yes, I have the same and is correct I think, but the message is not correctly resolved using those attributes it seems. The actual error message that is returned is still "Het addresses.0.city veld is verplicht." instead of "Het plaats veld is verplicht."

Using the messages method does work.

public static function messages(...$args): array
  {

      return [
          'city.required' => 'Plaats is verplicht',
      ];

  }

This returns now an error of "Plaats is verplicht".

When I add the attribute in here, not using the asteriks, but the index it works as well.
So while I agree it should work with the asteriks, it doesn't but does with the index.

laravel-data/src/Resolvers/DataValidatorResolver.php

Line 37 in de7f02c

[wijzijnweb]

I think I found a related issue in livewire, it has to with collections.

livewire/livewire#1556

[wijzijnweb]

Or not, seems like it's already parsed to array

[rubenvanassche]

I think you should contact the people at Laravel, now I remember they're not supporting this. Even have a disabled test for it:

laravel-data/tests/ValidationTest.php

Line 1823 in 9465cb8

it('can manually set collected validation attributes ', function () {

[valh1996]

Do you know if this is supported by Laravel in the meantime? I can't find any information on this subject.
Do you have a workaround?

[edwinhuish]

For laravel validation, this method is not static, in this case, we can do something like that:

class NestRequest extends FormRequest
{
    public function rules(): array
    {
        return [
            'addresses.*.code' => 'code',
            'addresses.*.street' => 'straat',
            'addresses.*.number' => 'huisnummer',
            'addresses.*.zipcode' => 'postcode',
            'addresses.*.city' => 'plaats',
        ];
    }

    public function attributes()
    {
        $addresses = $this->attributes->get('addresses');

        $niceNames = [];

        foreach ($addresses as $idx => $address) {
            foreach ($address as $key => $val) {
                $rowIdx = $idx + 1;
                $niceNames["addresses.{$idx}.{$key}"] = "No.{$rowIdx}, {$key}";
            }
        }

        return $niceNames;
    }
}

How can we do something simillar in laravel data?

[rubenvanassche]

In the rules method we provide a ValidationContext which provides this kind of useful info, this is not yet the case with attributes and messages. But I'll accept a well tested and documented PR on this for sure!