Skip to content

[LiveComponent] Allow updates in arrays of DTOs #1990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2024
Merged

[LiveComponent] Allow updates in arrays of DTOs #1990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/LiveComponent/src/LiveComponentHydrator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ private function adjustPropertyPathForData(mixed $rawPropertyValue, string $prop
foreach ($parts as $part) {
if (\is_array($currentValue)) {
$finalPropertyPath .= \sprintf('[%s]', $part);
$currentValue = $this->propertyAccessor->getValue($rawPropertyValue, $finalPropertyPath);

continue;
}
Expand All @@ -379,6 +380,10 @@ private function adjustPropertyPathForData(mixed $rawPropertyValue, string $prop
}

$finalPropertyPath .= $part;

if (null !== $currentValue) {
$currentValue = $this->propertyAccessor->getValue($rawPropertyValue, $finalPropertyPath);
}
}

return $finalPropertyPath;
Expand Down
13 changes: 13 additions & 0 deletions src/LiveComponent/tests/Fixtures/Dto/HoldsArrayOfDtos.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

namespace Symfony\UX\LiveComponent\Tests\Fixtures\Dto;

final class HoldsArrayOfDtos
{
/**
* @var Address[] $addresses
*/
public array $addresses;
}
122 changes: 122 additions & 0 deletions src/LiveComponent/tests/Integration/LiveComponentHydratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\BlogPostWithSerializationContext;
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\CustomerDetails;
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Embeddable2;
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\HoldsArrayOfDtos;
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Money;
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\ParentDTO;
use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\SimpleDto;
Expand Down Expand Up @@ -968,6 +969,127 @@ public function mount()
});
}];

yield 'Array with DTOs: fully writable allows anything to change' => [function () {
$address1 = create(Address::class, ['address' => '17 Arcadia Road', 'city' => 'London'])->object();
$address2 = create(Address::class, ['address' => '4 Privet Drive', 'city' => 'Little Whinging'])->object();
$address3 = create(Address::class, ['address' => '124 Conch St.', 'city' => 'Bikini Bottom'])->object();
$address4 = create(Address::class, ['address' => '32 Windsor Gardens', 'city' => 'London'])->object();

return HydrationTest::create(new class() {
/**
* @var Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Address[]
*/
#[LiveProp(writable: true, useSerializerForHydration: true)]
public array $addresses = [];
})
->mountWith(['addresses' => [$address1, $address2]])
->assertDehydratesTo(['addresses' => [
[
'address' => '17 Arcadia Road',
'city' => 'London',
],
[
'address' => '4 Privet Drive',
'city' => 'Little Whinging',
],
]])
->userUpdatesProps(['addresses' => [$address3, $address4]])
->assertObjectAfterHydration(function (object $object) {
self::assertEquals([
create(Address::class, ['address' => '124 Conch St.', 'city' => 'Bikini Bottom'])->object(),
create(Address::class, ['address' => '32 Windsor Gardens', 'city' => 'London'])->object(),
], $object->addresses);
});
}];

yield 'Array with DTOs: fully writable allows partial changes' => [function () {
$address1 = create(Address::class, ['address' => '1600 Pennsylvania Avenue', 'city' => 'Washington DC'])->object();
$address2 = create(Address::class, ['address' => '221 B Baker St', 'city' => 'Birmingham'])->object();

return HydrationTest::create(new class() {
/**
* @var Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Address[]
*/
#[LiveProp(writable: true, useSerializerForHydration: true)]
public array $addresses = [];
})
->mountWith(['addresses' => [$address1, $address2]])
->assertDehydratesTo(['addresses' => [
[
'address' => '1600 Pennsylvania Avenue',
'city' => 'Washington DC',
],
[
'address' => '221 B Baker St',
'city' => 'Birmingham',
],
]])
->userUpdatesProps(['addresses.1.city' => 'London'])
->assertObjectAfterHydration(function (object $object) {
self::assertEquals([
create(Address::class, ['address' => '1600 Pennsylvania Avenue', 'city' => 'Washington DC'])->object(),
create(Address::class, ['address' => '221 B Baker St', 'city' => 'London'])->object(),
], $object->addresses);
});
}];

yield 'Array with DTOs: fully writable allows deep partial changes' => [function () {
return HydrationTest::create(new class() {
/**
* @var Symfony\UX\LiveComponent\Tests\Fixtures\Dto\HoldsArrayOfDtos[]
*/
#[LiveProp(writable: true, useSerializerForHydration: true)]
public array $dtos = [];
})
->mountWith(['dtos' => [
create(HoldsArrayOfDtos::class, ['addresses' => [
create(Address::class, ['address' => '742 Evergreen Terrace', 'city' => 'Boston'])->object(),
create(Address::class, ['address' => 'Apartment 5A, 129 West 81st Street', 'city' => 'New York'])->object(),
create(Address::class, ['address' => '52 Festive Road', 'city' => 'London'])->object(),
]])->object(),
create(HoldsArrayOfDtos::class, ['addresses' => [
create(Address::class, ['address' => '698 Sycamore Road', 'city' => 'San Pueblo'])->object(),
create(Address::class, ['address' => 'Madison Square Garden', 'city' => 'Chicago'])->object(),
]])->object(),
]])
->assertDehydratesTo(['dtos' => [
[
'addresses' => [
['address' => '742 Evergreen Terrace', 'city' => 'Boston'],
['address' => 'Apartment 5A, 129 West 81st Street', 'city' => 'New York'],
['address' => '52 Festive Road', 'city' => 'London'],
],
],
[
'addresses' => [
['address' => '698 Sycamore Road', 'city' => 'San Pueblo'],
['address' => 'Madison Square Garden', 'city' => 'Chicago'],
],
],
]])
->userUpdatesProps([
'dtos.0.addresses.0.city' => 'Springfield',
'dtos.1.addresses.1.address' => '1060 West Addison Street',
'dtos.1.addresses.1' => create(Address::class, ['address' => '10 Downing Street', 'city' => 'London'])->object(),
])
->assertObjectAfterHydration(function (object $object) {
self::assertEquals(
[
create(HoldsArrayOfDtos::class, ['addresses' => [
create(Address::class, ['address' => '742 Evergreen Terrace', 'city' => 'Springfield'])->object(),
create(Address::class, ['address' => 'Apartment 5A, 129 West 81st Street', 'city' => 'New York'])->object(),
create(Address::class, ['address' => '52 Festive Road', 'city' => 'London'])->object(),
]])->object(),
create(HoldsArrayOfDtos::class, ['addresses' => [
create(Address::class, ['address' => '698 Sycamore Road', 'city' => 'San Pueblo'])->object(),
create(Address::class, ['address' => '10 Downing Street', 'city' => 'London'])->object(),
]])->object(),
],
$object->dtos
);
});
}];

yield 'Object: (de)hydrates nested objects with phpdoc typehints' => [function () {
return HydrationTest::create(new class() {
#[LiveProp(writable: true)]
Expand Down