-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Fix form/data mapping for typehinted properties #36492
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.
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
Conversation
e2b7a16
to
aa11c41
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$form->setData($this->propertyAccessor->getValue($data, $propertyPath)); | ||
try { | ||
$form->setData($this->propertyAccessor->getValue($data, $propertyPath)); | ||
} catch (AccessException $e) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should either target 3.4 and/or catch the new UninitializedPropertyException
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed the target branch to 3.4.
I'm not sure if catching UninitializedPropertyException
provides an advantage over the broader AccessException
here. Is there a scenario in which catching the other possible AccessExceptions is harmful in the light of a flexible implementation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The advantage is that the AccessException
can be used internally by the PropertyAccess component for a "broader" usage, which should not be covered here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And yes it could lead to bug because the form should break as misconfigured so the dev can fix it, because a property is not readable/writable as it should.
That's why I think we really should consider master instead and consider this a new feature unlocked by the new exception (that was my original intent, but I'm glad you opened that PR :)).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another solution for targeting 3.4 would be to check the exception message to ensure the catch is legit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do you think about this?
if (!$e instanceof UninitializedPropertyException
// For versions without UninitializedPropertyException check the exception message
&& (\class_exists(UninitializedPropertyException::class) || false === \strpos($e->getMessage(), 'You should initialize it'))
) {
throw $e;
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We would only need to check the message in 3.4 and then when merging branches up, use the type check in master instead. No need for more complexity here in your patch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For 3.4 the type is never available with the current dependency constraint.
For 4.4, 5.0 and master it might be available.
I think we need to keep both checks in place until that dependency is bumped.
9a8fda1
to
aa11c41
Compare
aa11c41
to
39b4abe
Compare
753ba6d
to
19679dc
Compare
src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/PropertyPathMapperTest.php
Outdated
Show resolved
Hide resolved
d17bdc7
to
19679dc
Compare
{ | ||
try { | ||
return $this->propertyAccessor->getValue($data, $propertyPath); | ||
} catch (AccessException $e) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't we apply the same logic as above to not blindly silence all exceptions that could be thrown here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think there should be any exception for failed reading of a property when trying to write it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there cannot be any exceptions, we shouldn't add the catch
here to not hide any bugs IMO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem is that the implementation tries to check for the current value before calling setValue.
class Foo1 {
public int $bar;
}
One should be able to map a form with bar=123
to Foo1
, but it will fail with UninitializedPropertyException
.
class Foo2 {
private $bar;
public function setBaz($value) {
$this->bar = $value * 2;
}
}
One should be able to map a form with baz=123
to Foo2
, but it will fail with a NoSuchPropertyException
.
It is at least confusing and IMO a bug, that setting a value fails because reading it is not possible.
I decided against catching Throwable
here, because e.g. RuntimeException
thrown by PropertyAccessor
points to bugs in the implementation with which one can not expect the consecutive setValue()
to work.
Maybe @HeahDude can give further insight, but as I understood the current implementation the AccessException
types point to errors in a specific read or write access, while the other exeptions point to wrong usage of PropertyAccessor
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not against ignoring errors caused by uninitialized properties. I just think that ignoring any other errors that might happen is not the desired solution. I suggest to update the new method like this:
private function getPropertyValue($data, $propertyPath)
{
try {
return $this->propertyAccessor->getValue($data, $propertyPath);
} catch (AccessException $exception) {
// Skip unitialized properties on $data
// For versions without UninitializedPropertyException check the exception message
if (!$e instanceof UninitializedPropertyException && (class_exists(UninitializedPropertyException::class) || false === strpos($e->getMessage(), 'You should initialize it'))) {
throw $e;
}
}
}
We can then reuse this method in the setData()
call above like this:
$form->setData($this->getPropertyValue($data, $propertyPath));
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But to move this foward: Will this get an approval, if I change and comment the code here and make the full request again for the master?
I don't know. I guess I would rather open an issue first and gather some feedback.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ph-fritsche Do you still like to finish the PR though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, of course. I was just waiting for the feedback in #36754.
We can then reuse this method in the
setData()
call above like this:$form->setData($this->getPropertyValue($data, $propertyPath));
That would replace the old bug by a new one as it sets data that is not there.
class Foo { public string $bar; public string $baz; } // this should be the same $foo = new Foo(); $foo->bar = 'bar'; $propertyPathMapper->mapDataToForm($foo, [$someForm]); // as this $propertyPathMapper->mapDataToForm(['bar' => 'bar'], [$someForm]);
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am afraid I do not understand. What exactly would be the new bug you are talking about?
As far as I can see #36754 would be a new feature affecting master
only. So I do not really see how that would affect this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Mapper should transfer data from one representation to the other.
It should fail if it either can not do its job or if it can not guarantee a certain behavior.
The previous implementation introduced restrictions that are neither documented nor are intended. (They could not be, as the pivotal problem leading to this PR came through type hinted properties that didn't exist when the implementation was written.)
Now you could argue that supporting those new concepts is by itself a new feature - then one should close this PR and constrain the dependency to PHP<7.4
.
If one supports those, one should do it right. And that means that
class Foo {
// this
public string $bar;
// is different than this
public string $baz = null;
}
// and this should never map null to someForm['bar']
$propertyPathMapper->mapDataToForm($foo, [$someForm]);
I committed another change that disables using mapFormToData()
with setters when the getter is missing, as you considered this a new feature.
(Funny side note: mapDataToForm()
works, if the setter is missing.)
1e5cab1
to
db718c0
Compare
@ph-fritsche The changes look good now. I had some minor remarks, but found it easier to send a PR to your fork (see ph-fritsche#1). Feel free to simply copy the changes if you agree with them (no need to reuse my commit I mean). |
What is the current status of this issue? This is really a problem to make all getters nullable only because of this. |
That's nothing that is going to be changed here. You have a few solutions to your problem:
|
Thank you for starting the work on this @ph-fritsche. I have finished the PR in #37520. |
…ng data to forms (ph-fritsche) This PR was merged into the 3.4 branch. Discussion ---------- [Form] silently ignore uninitialized properties when mapping data to forms | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | #36492 | License | MIT | Doc PR | Commits ------- b4616c8 silently ignore uninitialized properties when mapping data to forms
Mapping to unitialized properties
PropertyPathMapper
usesPropertyAccessor
to retrieve a property value for comparison before setting that property.This led to
AccessException
for getting an unitialized property when setting such property perPropertyPathMapper::mapFormsToData()
.The proposed changes fix that by treating those unitialized properties as null for comparison.
Mapping from unitialized properties
When mapping objects to a form
PropertyPathMapper
is flexible to deal with different strategies (getter, hasser, ...) for providing entity properties.For typehinted properties however mapping fails with
AccessException
for providing partial data per entity class.This one is not necessarily to be considered a bug, but I would expect a flexible implementation to only map
bar
even ifbaz
is part ofFooType
.The proposed changes lead to ignoring those uninitialized properties like non-existing keys in an array.
Fix tests
The modified tests provided false negatives.
The implementation did not check for the tested features.