[Serializer] Add a normalizer that support JsonSerializable objects #17603

mcfedr · 2016-01-29T16:04:13Z

This normalizer makes it easier to start to combine using JsonSerializable objects with the Symfony serializer. I have implemented it in a number of projects and #13496 shows that others are doing so as well. So it seemed like it would be useful to include it in the Serializer component.

It handles circular references in the same way as the other normalizers.

Because groups and max depth are based on property annotations it doesn't make sense to apply them here.

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

dosten · 2016-01-29T16:24:50Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml

@@ -26,6 +26,12 @@
            <tag name="serializer.normalizer" priority="-1000" />
        </service>

+        <!-- Json Normalizer -->
+        <service id="serializer.normalizer.json" class="Symfony\Component\Serializer\Normalizer\JsonNormalizer" public="false">


Should be Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer or even better: rename the class to JsonNormalizer

I felt like it could be confusing to shorten it as any normalizer could be making json.

dunglas · 2016-01-31T13:49:11Z

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

+    public function normalize($object, $format = null, array $context = [])
+    {
+        if (!$object instanceof \JsonSerializable) {
+            throw new InvalidArgumentException('The object must implement "\JsonSerializable".');


Use \JsonSerializable::class constant instead.

dunglas · 2016-01-31T13:51:49Z

I left some minor comments but 👍. It's a good improvement to the Serializer component.

Do you think it's possible to add support to normalization groups, max depth and circular references handling (extending AbstractObjectNormalizer?).

mcfedr · 2016-02-01T07:49:24Z

Not sure how groups would work, the interface for JsonSerializable is basic, it would only work if you started removing keys from whatever jsonSerialize returns (it doesn't have to be an array, it could be an integer for example), and if you start doing its probably easier to convert to using the ObjectNormalizer.

Max depth and circular should be do able.

mcfedr · 2016-02-01T13:57:38Z

I've added handling of circular references, but as i updated in the description, because groups and max depth are based on property annotations I don't think it makes sense to apply them to this normalizer.

dunglas · 2016-02-01T14:14:15Z

Fair enough. 👍 ping @symfony/deciders

xabbuh · 2016-02-01T17:03:51Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml

@@ -26,6 +26,12 @@
            <tag name="serializer.normalizer" priority="-1000" />
        </service>

+        <!-- Json Normalizer -->
+        <service id="serializer.normalizer.json" class="Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer" public="false">
+            <!-- Run after all custom serializers, but before the ObjectNormalizer -->


Shouldn't this be "all custom normalizers"?

xabbuh · 2016-02-01T17:04:45Z

should also be added to the component's changelog

mcfedr · 2016-02-02T08:18:58Z

I am sort of assuming the tests not working is nothing to do with me, but could it be? I have run the same tests locally, with no fails...

xabbuh · 2016-02-02T09:09:53Z

@mcfedr That's not your fault. Our test suite is currently broken for the 3.0 and master branch.

xabbuh · 2016-02-02T09:15:22Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml

@@ -26,6 +26,12 @@
            <tag name="serializer.normalizer" priority="-1000" />
        </service>

+        <!-- Json Normalizer -->
+        <service id="serializer.normalizer.json" class="Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer" public="false">


How can we handle the case that someones uses the FrameworkBundle with an older version of the Serializer component that doesn't contain this class?

I guess the obvious answer is to add the service in the FrameworkBundle::registerSerializerConfiguration method after a check to see if the class exists, something similar seems to happen with some other parts of the configuration.
Alternatively there doesnt seem to be an issue with just adding the ObjectNormalizer to the config when it was added

We can also add something like "conflict": {"symfony/serializer": "<3.1"} in the composer.json of FrameworkBundle.

Could add conflict, i think thats a good idea, means we don't need any extra code for legacy reasons.
I notice that symfony/serializer isn't in the require-dev section either which it probably should be.

Added conflict, also added a require-dev on symfony/serializer which was missing

I would say that we should handle it in PHP code instead of using Composer rules here (@dunglas did a similar approach for new normalizers).

fabpot · 2016-02-15T08:30:27Z

@nicolas-grekas Can you have a look at the composer constraint changes?

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

An alternative is to register this normalizer conditionally as in #17631.

mcfedr · 2016-02-25T07:38:08Z

src/Symfony/Bundle/FrameworkBundle/composer.json

@@ -46,6 +46,7 @@
        "symfony/form": "~2.8|~3.0",
        "symfony/expression-language": "~2.8|~3.0",
        "symfony/process": "~2.8|~3.0",
+        "symfony/serializer": "~2.8|^3.1",


I have left this addition for dev requirement. It would appear that is was completely missing before.

Because of how it is registered now, you can safely use ~2.8|~3.0 like for other components.

mcfedr · 2016-02-25T07:38:44Z

Updated to use the same style as @dunglas - checking for existing classes

dunglas · 2016-02-25T18:59:36Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -914,6 +915,13 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
            $definition->addTag('serializer.normalizer', array('priority' => -910));
        }

+        if (class_exists('Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer')) {
+            // Run before serializer.normalizer.object
+            $definition = $container->register('serializer.normalizer.json', JsonSerializableNormalizer::class);


serializer.normalizer.json_serializable? Nitpicking but it looks more explicit to me.

See what you mean, I've changed it

dunglas · 2016-02-25T19:03:34Z

Except minor comments I left, 👍 for me.

Status: Reviewed

Handles circular references

fabpot · 2016-02-26T04:29:03Z

Thank you @mcfedr.

…zable objects (mcfedr) This PR was merged into the 3.1-dev branch. Discussion ---------- [Serializer] Add a normalizer that support JsonSerializable objects This normalizer makes it easier to start to combine using `JsonSerializable` objects with the Symfony serializer. I have implemented it in a number of projects and #13496 shows that others are doing so as well. So it seemed like it would be useful to include it in the Serializer component. It handles circular references in the same way as the other normalizers. Because groups and max depth are based on property annotations it doesn't make sense to apply them here. | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #13496 | License | MIT | Doc PR | Commits ------- a678881 Add a normalizer that support JsonSerializable objects

…r (dunglas) This PR was merged into the 3.1-dev branch. Discussion ---------- [FrameworkBundle] Fix test for JsonSerializableNormalizer | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Fix a test failure introduced by #17603 Commits ------- a696107 [FrameworkBundle] Fix test for JsonSerializableNormalizer

This PR was squashed before being merged into the master branch (closes #6314). Discussion ---------- New normalizers | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes symfony/symfony#17603 symfony/symfony#17411 symfony/symfony#16164 | Applies to | 3.1 | Fixed tickets | Commits ------- 4ff3a28 New normalizers

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

mcfedr force-pushed the add-json-serializer branch from 5591e41 to dffc5d0 Compare January 29, 2016 16:05

dosten reviewed Jan 29, 2016
View reviewed changes

mcfedr force-pushed the add-json-serializer branch from dffc5d0 to ce41542 Compare January 30, 2016 17:37

dunglas reviewed Jan 31, 2016
View reviewed changes

mcfedr force-pushed the add-json-serializer branch 4 times, most recently from cb51790 to 9592289 Compare February 1, 2016 13:56

mcfedr force-pushed the add-json-serializer branch from 9592289 to ede4e41 Compare February 1, 2016 13:59

mcfedr force-pushed the add-json-serializer branch from ede4e41 to 9ed5b96 Compare February 1, 2016 14:20

xabbuh reviewed Feb 1, 2016
View reviewed changes

mcfedr force-pushed the add-json-serializer branch 4 times, most recently from 38ee770 to 6fb0978 Compare February 1, 2016 17:43

This was referenced Feb 1, 2016

[FrameworkBundle] [DX] Add Controller::json method to make it easy to send json #17642

Merged

[FrameworkBundle] Register the DateTimeNormalizer #17630

Closed

mcfedr closed this Feb 2, 2016

mcfedr reopened this Feb 2, 2016

xabbuh reviewed Feb 2, 2016
View reviewed changes

mcfedr force-pushed the add-json-serializer branch 2 times, most recently from 90a8818 to 43daf71 Compare February 5, 2016 08:06

mcfedr mentioned this pull request Feb 22, 2016

[FrameworkBundle] Register the DataUriNormalizer #17631

Closed

mcfedr force-pushed the add-json-serializer branch from 43daf71 to 8752cba Compare February 25, 2016 07:35

mcfedr reviewed Feb 25, 2016
View reviewed changes

dunglas reviewed Feb 25, 2016
View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Feb 25, 2016

Add a normalizer that support JsonSerializable objects

a678881

Handles circular references

mcfedr force-pushed the add-json-serializer branch from 8752cba to a678881 Compare February 25, 2016 19:06

fabpot merged commit a678881 into symfony:master Feb 26, 2016

mcfedr deleted the add-json-serializer branch February 26, 2016 09:26

dunglas mentioned this pull request Feb 26, 2016

[FrameworkBundle] Fix test for JsonSerializableNormalizer #17936

Merged

mcfedr mentioned this pull request Mar 1, 2016

New normalizers symfony/symfony-docs#6314

Closed

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 a normalizer that support JsonSerializable objects #17603

[Serializer] Add a normalizer that support JsonSerializable objects #17603

mcfedr commented Jan 29, 2016

dosten Jan 29, 2016

mcfedr Jan 30, 2016

dunglas Jan 31, 2016

dunglas commented Jan 31, 2016

mcfedr commented Feb 1, 2016

mcfedr commented Feb 1, 2016

dunglas commented Feb 1, 2016

xabbuh Feb 1, 2016

xabbuh commented Feb 1, 2016

mcfedr commented Feb 2, 2016

xabbuh commented Feb 2, 2016

xabbuh Feb 2, 2016

mcfedr Feb 2, 2016

dunglas Feb 2, 2016

mcfedr Feb 2, 2016

mcfedr Feb 5, 2016

xabbuh Feb 22, 2016

fabpot commented Feb 15, 2016

dunglas commented Feb 22, 2016

mcfedr Feb 25, 2016

dunglas Feb 25, 2016

mcfedr commented Feb 25, 2016

dunglas Feb 25, 2016

mcfedr Feb 25, 2016

dunglas commented Feb 25, 2016

fabpot commented Feb 26, 2016

[Serializer] Add a normalizer that support JsonSerializable objects #17603

[Serializer] Add a normalizer that support JsonSerializable objects #17603

Conversation

mcfedr commented Jan 29, 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 31, 2016

mcfedr commented Feb 1, 2016

mcfedr commented Feb 1, 2016

dunglas commented Feb 1, 2016

Choose a reason for hiding this comment

xabbuh commented Feb 1, 2016

mcfedr commented Feb 2, 2016

xabbuh commented Feb 2, 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

fabpot commented Feb 15, 2016

dunglas commented Feb 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcfedr commented Feb 25, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Feb 25, 2016

fabpot commented Feb 26, 2016