[LiveComponent] Fix issue with onUpdated not triggered on nested array proprety #2013

TheDutchScorpion · 2024-07-30T12:24:55Z

Q	A
Bug fix?	no
New feature?	yes
Issues
License	MIT

When modifying a array property the onUpdated hook is only triggered when the exact key is specified.

#[LiveProp(writable: true, onUpdated: [‘firstname’ => ‘onUpdated’, ‘lastname’ => ‘onUpdated’]]

This PR will add the ability to use wildcards within the key.

#[LiveProp(writable: true, onUpdated: [‘*’ => ‘onUpdated’]]

Or

#[LiveProp(writable: true, onUpdated: [‘values.*’ => ‘onUpdated’]]

smnandre · 2024-07-30T19:51:49Z

Hi @TheDutchScorpion: thanks for this PR.

Could you add some test here?

(especially one with something that did not work before and now would work?)

smnandre · 2024-07-31T20:30:36Z

src/LiveComponent/src/LiveComponentHydrator.php

            if (LiveProp::IDENTITY === $propName) {
-                if (!$dehydratedUpdatedProps->hasPropValue($frontendName)) {
+                if (!$dehydratedUpdatedProps->hasPropValue($frontendName)
+                    && !$dehydratedUpdatedProps->hasNestedPathsForProperty($frontendName)) {
                    continue;


I'm not sure this is the right place... for a LiveProp IDENTITY the only thing that can change is... the prop itself no ? Is this not something we should do line 680+ ?

I don't think thats the best place either to check if there are changes to a array property. My intention was to tigger the onUpdated whenever there is a change within the array without providing a specific nested path.

Maybe I'm wrong, but it's also strange that if the $propMetadata->onUpdated() is a string, the update hook only triggers if the property has been completely changed to another property and not if part of it has been modified.

I get that, but i fear doing so here will have side effects .. wdyt ?

smnandre · 2024-08-02T19:01:44Z

I just saw you changed a bit your PR :)

Could you update your first message with a basic case scenario, describing what you wanted todo, what did not work and what will after your PR ?

It's easier for everyone to review and understand the PR :)

kevinmade · 2024-11-05T15:13:02Z

Could this branch be reviewed and merged?

kevinmade · 2024-11-11T08:27:41Z

@smnandre

smnandre · 2024-11-12T01:49:28Z

I'd like to get the real use case behind this, as i don't see right now how a map can be mapped to a form (without it being a collection)

Then i'd like to see is before/after for

basic list of scalars (ints, strings)
nested arrays
free map (like this one)
collection of objects

I think we need to restrict this syntax to "*" => "method", or that does not make a lot of sense to me.

At core, this is a callback when a props is updated, triggered because the value will change. That does not feels logical to call multiple times the same function.

Other comments regarding code :)

smnandre · 2024-11-12T01:50:40Z

src/LiveComponent/src/LiveComponentHydrator.php

-            $this->ensureOnUpdatedMethodExists($component, $funcName);
-            $propertyOldValue = $dehydratedOriginalProps->getPropValue($key);
-            $component->{$funcName}($propertyOldValue);
+            foreach ($fullPaths as $fullPath) {


This loop concern one callback for a prop. It should not be called multiple times. I this you could "just" replace the prevous "hasPropValue" to some "matchPropValue" or something like this and let the rest flow.

smnandre · 2024-11-12T01:51:08Z

src/LiveComponent/src/LiveComponentHydrator.php

+                $this->ensureOnUpdatedMethodExists($component, $funcName);
+                $propertyOldValue = $dehydratedOriginalProps->getPropValue($fullPath);


Let's not compute this every loop

smnandre · 2024-11-12T01:51:59Z

src/LiveComponent/src/LiveComponentHydrator.php

+            foreach ($fullPaths as $fullPath) {
+                $this->ensureOnUpdatedMethodExists($component, $funcName);
+                $propertyOldValue = $dehydratedOriginalProps->getPropValue($fullPath);
+                $component->{$funcName}($propertyOldValue);


Here the receiving callable as no way to get what is "old value". If a "*" is used, we should pass the full prop

smnandre · 2024-11-12T01:52:37Z

src/LiveComponent/src/Util/DehydratedProps.php

@@ -113,6 +113,13 @@ public function getNestedPathsForProperty(string $prop): array
        return $nestedPaths;
    }

+    public function searchFullPathsForProperty(string $prop): array


Let's add some tests if possible (with failing / problematic cases, not just happy path)

smnandre · 2024-11-12T01:53:39Z

src/LiveComponent/src/LiveComponentHydrator.php

-            if (!$dehydratedUpdatedProps->hasPropValue($key)) {
-                continue;
-            }
+            $fullPaths = $dehydratedUpdatedProps->searchFullPathsForProperty($key);


Let's do this only under conditions, and keep previous code if no "*"

smnandre · 2024-11-12T11:28:28Z

Upon rereading my message, I realize it came across more strongly than I intended—apologies for that. Sorry as well for the delayed response, and thank you for your contribution @TheDutchScorpion and for the poke @kevinmade

Fix issue with onUpdated not triggered on nested array proprety

0b0e7bb

carsonbot added LiveComponent Status: Needs Review Needs to be reviewed labels Jul 30, 2024

Add onUpdated with array test to LiveComponentHydratorTest

b968810

smnandre reviewed Jul 31, 2024

View reviewed changes

TheDutchScorpion added 2 commits August 1, 2024 14:35

Merge branch 'symfony:2.x' into feature/nested-property-on-updated

0ea98bc

Add support for wildcard to onUpdated

6c46e0c

smnandre reviewed Nov 12, 2024

View reviewed changes

smnandre added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Nov 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[LiveComponent] Fix issue with onUpdated not triggered on nested array proprety #2013

[LiveComponent] Fix issue with onUpdated not triggered on nested array proprety #2013

TheDutchScorpion commented Jul 30, 2024 •

edited

Loading

smnandre commented Jul 30, 2024

smnandre Jul 31, 2024

TheDutchScorpion Jul 31, 2024 •

edited

Loading

TheDutchScorpion Jul 31, 2024

smnandre Jul 31, 2024

smnandre commented Aug 2, 2024

kevinmade commented Nov 5, 2024 •

edited

Loading

kevinmade commented Nov 11, 2024

smnandre commented Nov 12, 2024

smnandre Nov 12, 2024

smnandre Nov 12, 2024

smnandre Nov 12, 2024

smnandre Nov 12, 2024

smnandre Nov 12, 2024

smnandre commented Nov 12, 2024

		$this->ensureOnUpdatedMethodExists($component, $funcName);
		$propertyOldValue = $dehydratedOriginalProps->getPropValue($fullPath);

[LiveComponent] Fix issue with onUpdated not triggered on nested array proprety #2013

Are you sure you want to change the base?

[LiveComponent] Fix issue with onUpdated not triggered on nested array proprety #2013

Conversation

TheDutchScorpion commented Jul 30, 2024 • edited Loading

smnandre commented Jul 30, 2024

Choose a reason for hiding this comment

TheDutchScorpion Jul 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smnandre commented Aug 2, 2024

kevinmade commented Nov 5, 2024 • edited Loading

kevinmade commented Nov 11, 2024

smnandre commented Nov 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smnandre commented Nov 12, 2024

TheDutchScorpion commented Jul 30, 2024 •

edited

Loading

TheDutchScorpion Jul 31, 2024 •

edited

Loading

kevinmade commented Nov 5, 2024 •

edited

Loading