[Serializer] Instantiator - Add an interface and default implementation to instantiate objects #38487

Korbeil · 2020-10-08T18:18:35Z

Q	A
Branch?	5.x
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	#30818
License	MIT
Doc PR	symfony/symfony-docs#...

Related to #30818, Replace #30925

This add a new interface and default implementation to instantiate objects

OBJECT_TO_POPULATE was not keep here, as i don't think it should be the responsability of an instantiator to handle that. And if we want to have this responsability we can always add a new implementation with a decoration system.

I try to look at var exporter instantiator also and unfortunetaly @nicolas-grekas i cannot use this, since the behavior of this component is to not use the constructor, in the serializer we want to use it, or at least it used to do that and we cannot change this behavior.

But we can use var exporter implementation in a future PR (will not be the default however just another way of doing it) here if someone does not want to call the constructor.

PS: This PR is following #30956 after main branch moved from master to 5.x

TODO

@Nyholm review [Serializer] Instantiator - Add an interface and default implementation to instantiate objects #30956 (review)

src/Symfony/Component/Serializer/Context/ChildContextFactory.php

src/Symfony/Component/Serializer/Instantiator/InstantiatorResult.php

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

src/Symfony/Component/Serializer/Normalizer/Factory/GetSetMethodNormalizerFactory.php

src/Symfony/Component/Serializer/Normalizer/Factory/ObjectNormalizerFactory.php

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

Korbeil · 2020-10-11T17:47:36Z

I fixed all tests related to this PR, last errors are related to 5.x branch errors.
Ready for review 😉

…on to instantiate objects

…on to instantiate objects symfony#30956

src/Symfony/Component/Serializer/Tests/Normalizer/AbstractNormalizerTest.php

Korbeil · 2020-10-16T16:48:58Z

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

+    public function setDenormalizer(DenormalizerInterface $denormalizer)
+    {
+        $this->denormalizer = $denormalizer;
+
+        // Because we need a denormalizer in the Instantiator and we create it in the construct method, it won't get it.
+        // So we are obliged to overwrite this method in order to give the denormalizer to the Instantiator.
+        $this->instantiator->setDenormalizer($denormalizer);
    }


This is the strange part. Instantiator needs a denormalizer to work, this is why this class has the DenormalizerAwareInterface interface. But since the Instantiator can be created in the __construct so it will never receive a denormalizer (the DenormalizerAwareInterface will be catch either by the Serializer or by the DIC, here none of them will be triggered).
So in order to still get that denormalizer, we overwrite the setDenormalizer method here and give the denormalizer to the Instantiator.

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

Korbeil · 2020-10-16T16:50:47Z

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

+        if (!\array_key_exists(Instantiator::INSTANTIATOR_CONSTRUCTOR, $context)) {
+            $context[Instantiator::INSTANTIATOR_CONSTRUCTOR] = \Closure::fromCallable([$this, 'getConstructor']);
        }


Compatibility layer for the old getConstructor function

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

…on to instantiate objects symfony#30956

theofidry · 2021-01-13T11:35:36Z

@Korbeil I've had a quick look at the PR, I think the idea behind is good but I have some concerns about the actual implementation (e.g. the instantiator implementing the normalizer interface). I had to tweak a lot the object normalizer for a project at our company and hope to back-port some of it. I'll try to come up with a PoC for it and maybe we can combine our efforts there (although this will probably be later in the month)

Korbeil · 2021-01-13T12:48:15Z

@Korbeil I've had a quick look at the PR, I think the idea behind is good but I have some concerns about the actual implementation (e.g. the instantiator implementing the normalizer interface). I had to tweak a lot the object normalizer for a project at our company and hope to back-port some of it. I'll try to come up with a PoC for it and maybe we can combine our efforts there (although this will probably be later in the month)

Hey @theofidry, glad to have some feedback on this PR.
Actually we talked a lot about it with @dunglas and came to the conclusion that the idea is good but it should be made more step by step to avoid the BC this PR introduce. I didn't had time to work on this (more focus on Jane's AutoMapper actually 😅).
But I'll be glad to talk about it and try to make this move foward, the efforts to make all Serializer concepts extendable is really needed (you can look related issue for more details about what needs to be done).

theofidry · 2021-01-13T22:41:30Z

@Korbeil agreed;

Checked this on my side, based on our needs I think what is lacking in this PR (although could be introduced progressively) is the extension points for everything the instantiator does:

validating & denormalizing a param for a given type
validating & denormalizing parameters
collecting parameters
instantiating the object

But I think the main issue here is that things are so inter-dependent at the moment, it requires more elements to be extracted first (e.g. creating of a default context, child context, extracting attributes...) without which you end up with an instantiator-normalizer like you came up with but which in the end is as bloated.

fabpot · 2023-09-13T08:27:43Z

@Korbeil I've had a quick look at the PR, I think the idea behind is good but I have some concerns about the actual implementation (e.g. the instantiator implementing the normalizer interface). I had to tweak a lot the object normalizer for a project at our company and hope to back-port some of it. I'll try to come up with a PoC for it and maybe we can combine our efforts there (although this will probably be later in the month)

Hey @theofidry, glad to have some feedback on this PR. Actually we talked a lot about it with @dunglas and came to the conclusion that the idea is good but it should be made more step by step to avoid the BC this PR introduce. I didn't had time to work on this (more focus on Jane's AutoMapper actually 😅). But I'll be glad to talk about it and try to make this move foward, the efforts to make all Serializer concepts extendable is really needed (you can look related issue for more details about what needs to be done).

Based on the latest comment here, I think it's time to close this PR.

Korbeil requested a review from dunglas as a code owner October 8, 2020 18:18

carsonbot added Status: Needs Review Serializer Feature labels Oct 8, 2020

Korbeil force-pushed the feature/instantiator branch 7 times, most recently from 8f60a0a to 8f36f2a Compare October 8, 2020 19:25

dunglas requested changes Oct 8, 2020

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 8, 2020

Korbeil force-pushed the feature/instantiator branch 2 times, most recently from 0c3913b to a572179 Compare October 9, 2020 14:13

Korbeil commented Oct 9, 2020

View reviewed changes

src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php Outdated Show resolved Hide resolved

Korbeil force-pushed the feature/instantiator branch from a572179 to fd03ce5 Compare October 11, 2020 17:16

nicolas-grekas added this to the 5.x milestone Oct 12, 2020

jewome62 and others added 2 commits October 12, 2020 22:06

[Serializer] Instantiator - Add an interface and default implementati…

9308914

…on to instantiate objects

[Serializer] Instantiator - Add an interface and default implementati…

30d6658

…on to instantiate objects symfony#30956

Korbeil force-pushed the feature/instantiator branch 2 times, most recently from f9e4d11 to 847de48 Compare October 12, 2020 20:07

dunglas reviewed Oct 14, 2020

View reviewed changes

src/Symfony/Component/Serializer/Tests/Normalizer/AbstractNormalizerTest.php Outdated Show resolved Hide resolved

Korbeil force-pushed the feature/instantiator branch 3 times, most recently from 460e883 to 701cd0f Compare October 16, 2020 16:47

Korbeil commented Oct 16, 2020

View reviewed changes

Korbeil force-pushed the feature/instantiator branch from 701cd0f to 224c8c6 Compare October 17, 2020 09:20

Korbeil force-pushed the feature/instantiator branch 3 times, most recently from 2301613 to 093ce3a Compare October 20, 2020 17:57

[Serializer] Instantiator - Add an interface and default implementati…

f6fc79d

…on to instantiate objects symfony#30956

Korbeil force-pushed the feature/instantiator branch from 093ce3a to f6fc79d Compare October 20, 2020 17:58

julienfalque mentioned this pull request Dec 20, 2020

[Serializer] Allow to provide a "normalizer" callable to normalize a property during denormalization #27933

Open

fabpot modified the milestones: 5.4, 6.1 Oct 30, 2021

dunglas mentioned this pull request Apr 19, 2022

[Serializer] Allow to denormalize objects that have constructor checks without using constructor #45508

Open

fabpot modified the milestones: 6.1, 6.2 May 20, 2022

nicolas-grekas modified the milestones: 6.2, 6.3 Nov 5, 2022

nicolas-grekas modified the milestones: 6.3, 6.4 May 23, 2023

fabpot closed this Sep 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] Instantiator - Add an interface and default implementation to instantiate objects #38487

[Serializer] Instantiator - Add an interface and default implementation to instantiate objects #38487

Korbeil commented Oct 8, 2020 •

edited

Loading

Korbeil commented Oct 11, 2020

Korbeil Oct 16, 2020

Korbeil Oct 16, 2020

theofidry commented Jan 13, 2021

Korbeil commented Jan 13, 2021

theofidry commented Jan 13, 2021

fabpot commented Sep 13, 2023

[Serializer] Instantiator - Add an interface and default implementation to instantiate objects #38487

[Serializer] Instantiator - Add an interface and default implementation to instantiate objects #38487

Conversation

Korbeil commented Oct 8, 2020 • edited Loading

TODO

Korbeil commented Oct 11, 2020

Korbeil Oct 16, 2020

Choose a reason for hiding this comment

Korbeil Oct 16, 2020

Choose a reason for hiding this comment

theofidry commented Jan 13, 2021

Korbeil commented Jan 13, 2021

theofidry commented Jan 13, 2021

fabpot commented Sep 13, 2023

Korbeil commented Oct 8, 2020 •

edited

Loading