[Serializer] Throw exception when extra attributes are used during an object denor… #19958

juliendidier · 2016-09-17T15:00:04Z

Q	A
Branch?	"master"
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#19948
License	MIT
Doc PR	#6975

I will update the doc if you're ok with this PR.

dunglas · 2016-09-17T17:31:52Z

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

@@ -32,6 +33,7 @@

    private $propertyTypeExtractor;
    private $attributesCache = array();
+    private $extraAttributes = array();


A service should not have global states like this one. Here it is worst because it creates a bug: if the denormalize method fails one time because of an extra attribute, all successive calls will throw an error (even if there is no extra attribute) because $this->extraAttributes isn't reseted to an empty array.

Here I think that it's enough to use a local variable to store the list of extra attributes. If you want to make information available in nested denormalize calls, you should use the $context parameter.

Humm yes... sorry for that.

dunglas · 2016-09-17T17:34:05Z

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

@@ -183,6 +185,10 @@ public function denormalize($data, $class, $format = null, array $context = arra
            }

            if (($allowedAttributes !== false && !in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($class, $attribute, $format, $context)) {
+                if (isset($context['extra_attributes']) && !$context['extra_attributes']) {


The form component has a similar option called allow_extra_fields. I propose to rename the key to allow_extra_attributes for consistency.

I had a lot of hesitation. Updated.

dunglas · 2016-09-17T17:34:52Z

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

@@ -194,6 +200,10 @@ public function denormalize($data, $class, $format = null, array $context = arra
            }
        }

+        if (!empty($this->extraAttributes)) {
+            throw new ExtraAttributesException(sprintf('Extra attributes are not allowed ("%s" given).', implode('", "', $this->extraAttributes)));


Extra attributes are not allowed ("%s" are unknown).?

It's more simple with no plurial, but that's good for me. Updated.

dunglas · 2016-09-18T06:13:33Z

👍, travis error not related.

Status: reviewed

juliendidier · 2016-09-18T10:48:06Z

Doc PR added.
See #6975

fabpot · 2016-09-18T15:02:26Z

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

 use Symfony\Component\Serializer\Exception\LogicException;
 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
-use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
-use Symfony\Component\PropertyInfo\Type;


use statements reorganization should reverted.

Alright. done.

unkind · 2016-09-19T13:35:03Z

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php

@@ -194,6 +201,10 @@ public function denormalize($data, $class, $format = null, array $context = arra
            }
        }

+        if (!empty($extraAttributes)) {
+            throw new ExtraAttributesException(sprintf('Extra attributes are not allowed ("%s" are unknown).', implode('", "', $extraAttributes)));


Given you have specific exception type, it makes sense to put such logic into the exception, i.e. throw new ExtraAttributesException($extraAttributes) (see Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException for example).

I don't really like doing that. And it's not the current behavior for serializer exceptions (like the CircularReferenceException).

However, I pushed this change.

It makes exception API stricter. It is harder to misuse it, it decreases possible inconsistency between messages in different places if an exception has many usages in the code. It makes easier to unit test the exception if the message-forming logic becomes tricky.

…malization

juliendidier · 2016-09-22T09:17:48Z

Rebased from master to fix builds.

dunglas · 2016-11-11T14:58:05Z

I'll merge this PR in 3.3. Thanks @juliendidier

dunglas · 2016-12-05T12:56:35Z

Thanks @juliendidier for working on this feature, this is much appreciated.

… used during an object denor… (juliendidier) This PR was merged into the 3.3-dev branch. Discussion ---------- [Serializer] Throw exception when extra attributes are used during an object denor… | Q | A | | --- | --- | | Branch? | "master" | | Bug fix? | no | | New feature? | yes | | BC breaks? | no | | Deprecations? | no | | Tests pass? | yes | | Fixed tickets | #19948 | | License | MIT | | Doc PR | [#6975](symfony/symfony-docs#6975) | I will update the doc if you're ok with this PR. Commits ------- 565a984 throw exception when extra attributes are used during an object denormalization

juliendidier · 2016-12-06T13:35:13Z

@dunglas thx, don't forget the documentation ;) symfony/symfony-docs/pull/6975

dunglas · 2016-12-06T13:42:34Z

I cannot merge the doc but I'm sure that the @symfony/team-symfony-docs will handle it soon!

…juliendidier) This PR was merged into the master branch. Discussion ---------- [Serializer] documentation for allow_extra_attributes Doc PR for [symfony/symfony#19958](symfony/symfony#19958) Commits ------- 28dcc94 [Serializer] documentation for allow_extra_attributes

carsonbot added Status: Needs Review Serializer Feature labels Sep 17, 2016

dunglas requested changes Sep 17, 2016

View reviewed changes

juliendidier force-pushed the serializer-extra-attributes branch 2 times, most recently from 4cd4e13 to 8444b21 Compare September 17, 2016 19:20

dunglas approved these changes Sep 18, 2016

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 18, 2016

juliendidier mentioned this pull request Sep 18, 2016

[Serializer] documentation for allow_extra_attributes symfony/symfony-docs#6975

Merged

fabpot reviewed Sep 18, 2016

View reviewed changes

juliendidier force-pushed the serializer-extra-attributes branch 2 times, most recently from 8430c61 to dca221b Compare September 18, 2016 20:29

unkind reviewed Sep 19, 2016

View reviewed changes

juliendidier force-pushed the serializer-extra-attributes branch 3 times, most recently from d485036 to 313fca9 Compare September 20, 2016 22:59

throw exception when extra attributes are used during an object denor…

565a984

…malization

juliendidier force-pushed the serializer-extra-attributes branch from 313fca9 to 565a984 Compare September 21, 2016 23:37

dunglas merged commit 565a984 into symfony:master Dec 5, 2016

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

enumag mentioned this pull request Nov 1, 2017

[Serializer] Example from documentation does not work #24783

Closed

juliendidier deleted the serializer-extra-attributes branch December 4, 2018 19:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Throw exception when extra attributes are used during an object denor… #19958

[Serializer] Throw exception when extra attributes are used during an object denor… #19958

juliendidier commented Sep 17, 2016 •

edited

Loading

dunglas Sep 17, 2016 •

edited

Loading

juliendidier Sep 17, 2016

dunglas Sep 17, 2016

juliendidier Sep 17, 2016

dunglas Sep 17, 2016

juliendidier Sep 17, 2016

dunglas commented Sep 18, 2016

juliendidier commented Sep 18, 2016

fabpot Sep 18, 2016

juliendidier Sep 18, 2016

unkind Sep 19, 2016

juliendidier Sep 19, 2016

unkind Sep 19, 2016 •

edited

Loading

juliendidier commented Sep 22, 2016

dunglas commented Nov 11, 2016

dunglas commented Dec 5, 2016

juliendidier commented Dec 6, 2016

dunglas commented Dec 6, 2016

[Serializer] Throw exception when extra attributes are used during an object denor… #19958

[Serializer] Throw exception when extra attributes are used during an object denor… #19958

Conversation

juliendidier commented Sep 17, 2016 • edited Loading

dunglas Sep 17, 2016 • edited Loading

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

Choose a reason for hiding this comment

dunglas commented Sep 18, 2016

juliendidier commented Sep 18, 2016

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

unkind Sep 19, 2016 • edited Loading

Choose a reason for hiding this comment

juliendidier commented Sep 22, 2016

dunglas commented Nov 11, 2016

dunglas commented Dec 5, 2016

juliendidier commented Dec 6, 2016

dunglas commented Dec 6, 2016

juliendidier commented Sep 17, 2016 •

edited

Loading

dunglas Sep 17, 2016 •

edited

Loading

unkind Sep 19, 2016 •

edited

Loading