[Serializer] Add normalizer / denormalizer awarness #17545

joelwurtz · 2016-01-26T13:05:26Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR

SerializerAwareInterface is not really usable in a decode -> normalize context, as if we need to transform a subproperty with another class, we only have the context of a serialize however the data is already decoded so it will fail.

This interfaces allow a normalizer / denormalizer to have a sub normalization / denormalization process context and not the whole context with serializer.

I have also add a AwareNormalizer which is an abstract class implementing the 3 aware interfaces like it was done with the SerializerAwareNormalizer, since it's a standard way to implement this interfaces.

This is needed for #17516, other solution would be to have a RawDecoder which don't decode and return the input as it is, but really not a fan of this solution.

fabpot · 2016-01-26T13:46:20Z

ping @dunglas

dunglas · 2016-01-26T14:39:16Z

Why not just creating two separate classes? A normalizer class and a denormalizer class? It will be easier and respectful of SOLID principles.

dunglas · 2016-01-26T14:41:09Z

Forget my previous comment, I need to dive deeper into this PR.

joelwurtz · 2016-01-26T18:53:04Z

Hum actually your comment makes me wonder if we could provides the 3 implementations as a Trait instead of an abstract class, so we would have better composition, WDYT ?

dunglas · 2016-01-27T21:10:08Z

src/Symfony/Component/Serializer/Tests/SerializerTest.php

@@ -11,7 +11,12 @@

 namespace Symfony\Component\Serializer\Tests;

+use Prophecy\Argument;


Sadly (IMO) we don't use Prophecy in Symfony.

Not allowed ? Or phpunit version can be too small for it ?

Not allowed for consistency. We still use the old mock system.

dunglas · 2016-01-27T21:19:21Z

I don't understand why this is not doable with the current system? Can you be more precise about the use case?

Isn't tests like this one https://github.com/dunglas/DunglasApiBundle/blob/1.x/JsonLd/Serializer/ItemNormalizer.php#L102-L104 enough?
For recursive normalization/denormalization, see #17193

joelwurtz · 2016-01-27T21:32:02Z

Use case is for recursivity like #17193,

IMO SerializerAwareInterface does not make sense in the SerializerAwareNormalizer (interface make sense, but not the abstract class, unless you went to double encode / decode something, but never seen it).

This is mainly to avoid the check of a NormalizerInterface / DenormalizerInterface each time and for each class,

Another way to do this would be to transform the SerializerAwareNormalizer to depend on the Serializer Class (not the interface).

dunglas · 2016-01-27T21:49:00Z

IMO it introduces a lot of complexity (with crossed circular references) and can be hard to debug (what if the user sets different objects in $normalizer, $serializer and $denormalizer) for no real gain.

As the default Serializer implements the NormalizerInterface and the DenormalizerInterface interface, having some instanceof checks doesn't hurt.

joelwurtz · 2016-01-27T21:54:31Z

Having the check of NormalizerInterface / DenormalizerInterface over a class which is expected to be a SerializerInterface feel hackish IMO

What about having a trait for each of the 3 aware interface and deprecate the SerializerAwareNormalizer ?

joelwurtz · 2016-01-27T21:57:45Z

Also having the check on the current SerializerAwareNormalizer force users to use the Serializer class (or anything implementing the SerializerInterface), having this would better decouple the Normalizer part from the Serializer.

dunglas · 2016-01-27T22:01:45Z

👍 for the traits.

They can solve some issues in API Platform too.

joelwurtz · 2016-01-27T22:50:00Z

Done with traits and deprecated the SerializerAwareNormalizer

dunglas · 2016-01-28T07:12:46Z

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

 use Symfony\Component\Serializer\SerializerAwareInterface;

 /**
 * SerializerAware Normalizer implementation.
 *
 * @author Jordi Boggiano <[email protected]>
+ *
+ * @deprecated since version 3.1, to be removed in 4.0. Use the SerializerAwareTrait instead.


You must trigger a deprecation error like this one: @trigger_error(sprintf('The class "%s" is deprecated. It will be removed in Symfony 4.0. Use the "Symfony\Component\Serializer\SerializerAwareTrait" trait instead.', __CLASS__), E_USER_DEPRECATED);

You should also adapt existing normalizers in Symfony to avoid using this deprecated class. But if you do that... It will be a small BC break (ObjectNormalizer will not inherit from the SerializerAwareNormalizer type anymore - but as there is a corresponding interface, the BC break should be very limited). What do you think @symfony/deciders?

You must trigger a deprecation error

Since there is no more code / method in this class i don't think it's possible, i have done this deprecated feature in the same way it was done for the ContainerAwareTrait in 2.8 https://github.com/symfony/symfony/blob/2.8/src/Symfony/Component/DependencyInjection/ContainerAware.php

You should also adapt existing normalizers in Symfony to avoid using this deprecated class

It's already done, but maybe i have miss some implementations ?

dunglas · 2016-02-01T14:16:24Z

👍 ping @symfony/deciders

joelwurtz · 2016-02-19T10:49:09Z

rebased

dunglas · 2016-02-22T07:38:09Z

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

…oelwurtz) This PR was merged into the 3.1-dev branch. Discussion ---------- [Serializer] Add normalizer / denormalizer awarness | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | SerializerAwareInterface is not really usable in a decode -> normalize context, as if we need to transform a subproperty with another class, we only have the context of a serialize however the data is already decoded so it will fail. This interfaces allow a normalizer / denormalizer to have a sub normalization / denormalization process context and not the whole context with serializer. I have also add a `AwareNormalizer` which is an abstract class implementing the 3 aware interfaces like it was done with the SerializerAwareNormalizer, since it's a standard way to implement this interfaces. This is needed for #17516, other solution would be to have a RawDecoder which don't decode and return the input as it is, but really not a fan of this solution. Commits ------- 790fb6e Add normalizer / denormalizer awarness

kbond · 2016-03-18T19:02:56Z

@joelwurtz what happened to the AwareNormalizer you describe in the description for this PR?

joelwurtz · 2016-03-19T13:53:24Z

It was removed in favor of having 3 traits, one for each possiblity

xabbuh · 2016-03-31T07:45:17Z

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


 /**
 * Normalizer implementation.
 *
 * @author Kévin Dunglas <[email protected]>
 */
-abstract class AbstractNormalizer extends SerializerAwareNormalizer implements NormalizerInterface, DenormalizerInterface
+abstract class AbstractNormalizer implements NormalizerInterface, DenormalizerInterface, SerializerAwareInterface


This is a BC break for anyone having a type hint on the SerializerAwareNormalizer class.

Should we readd the extends and override the methods ? Or is this an acceptable BC break ?

So according to this : http://symfony.com/doc/current/contributing/code/bc.html#id10 it is not something acceptable, will do a PR to readd this class

Yeah, sorry I was on a mobile when writing the comment and forgot to add a reference to that later.

xabbuh · 2016-03-31T07:49:33Z

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

+     *
+     * @param NormalizerInterface $normalizer A NormalizerInterface instance
+     */
+    public function setSerializer(NormalizerInterface $normalizer)


setNormalizer

…ace (joelwurtz) This PR was merged into the 3.1-dev branch. Discussion ---------- Fix the wrong method name given the corresponding interface | Q | A | ------------- | --- | Branch? | "master" | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #17545 Follow up | License | MIT | Doc PR | This a follow up of #17545 as i introduce bad methods name in the traits sorry :/ ![](http://vomzi.com/wp-content/uploads/2016/02/sorry-gif-847.gif) Commits ------- 231819e Fix the wrong method name given the corresponding interface

This PR was merged into the 3.1-dev branch. Discussion ---------- [Serializer] fix parent class of AbstractNormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #17545 (comment) | License | MIT | Doc PR | We must maintain the parent class to not break BC. Commits ------- 45b9ed9 fix parent class of AbstractNormalizer

This PR was merged into the 3.1-dev branch. Discussion ---------- [Serializer] fix parent class of AbstractNormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#17545 (comment) | License | MIT | Doc PR | We must maintain the parent class to not break BC. Commits ------- 45b9ed9 fix parent class of AbstractNormalizer

carsonbot added the Status: Needs Review label Jan 26, 2016

joelwurtz mentioned this pull request Jan 26, 2016

[AstGenerator] [WIP] New Component, add normalizer generator #17516

Closed

7 tasks

dunglas reviewed Jan 27, 2016
View reviewed changes

joelwurtz force-pushed the feature/NormalizerAware branch 4 times, most recently from e6905cd to 53cf61c Compare January 27, 2016 22:49

dunglas reviewed Jan 28, 2016
View reviewed changes

Add normalizer / denormalizer awarness

790fb6e

joelwurtz force-pushed the feature/NormalizerAware branch from 53cf61c to 790fb6e Compare February 19, 2016 10:49

dunglas merged commit 790fb6e into symfony:master Feb 22, 2016

xabbuh reviewed Mar 31, 2016
View reviewed changes

joelwurtz deleted the feature/NormalizerAware branch April 13, 2016 22:38

joelwurtz mentioned this pull request Apr 13, 2016

Fix the wrong method name given the corresponding interface #18536

Merged

xabbuh mentioned this pull request Apr 19, 2016

[Serializer] fix parent class of AbstractNormalizer #18589

Merged

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Add normalizer / denormalizer awarness #17545

[Serializer] Add normalizer / denormalizer awarness #17545

joelwurtz commented Jan 26, 2016

fabpot commented Jan 26, 2016

dunglas commented Jan 26, 2016

dunglas commented Jan 26, 2016

joelwurtz commented Jan 26, 2016

dunglas Jan 27, 2016

joelwurtz Jan 27, 2016

dunglas Jan 27, 2016

dunglas commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

dunglas commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

dunglas commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

dunglas Jan 28, 2016

joelwurtz Jan 28, 2016

dunglas commented Feb 1, 2016

joelwurtz commented Feb 19, 2016

dunglas commented Feb 22, 2016

kbond commented Mar 18, 2016

joelwurtz commented Mar 19, 2016

xabbuh Mar 31, 2016

joelwurtz Apr 13, 2016

joelwurtz Apr 14, 2016

xabbuh Apr 14, 2016

xabbuh Mar 31, 2016

joelwurtz Apr 13, 2016

		@@ -11,7 +11,12 @@

		namespace Symfony\Component\Serializer\Tests;

		use Prophecy\Argument;

[Serializer] Add normalizer / denormalizer awarness #17545

[Serializer] Add normalizer / denormalizer awarness #17545

Conversation

joelwurtz commented Jan 26, 2016

fabpot commented Jan 26, 2016

dunglas commented Jan 26, 2016

dunglas commented Jan 26, 2016

joelwurtz commented Jan 26, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

dunglas commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

dunglas commented Jan 27, 2016

joelwurtz commented Jan 27, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Feb 1, 2016

joelwurtz commented Feb 19, 2016

dunglas commented Feb 22, 2016

kbond commented Mar 18, 2016

joelwurtz commented Mar 19, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment