[Serialized] allow configuring the serialized name of properties through metadata #28505

fbourigault · 2018-09-18T20:29:13Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#15171
License	MIT
Doc PR	symfony/symfony-docs#10422

This leverage the new AdvancedNameConverterInterface interface (#27021) to implement a name converter that relies on metadata. The name to use is configured per property using a @SerializedName annotation or the serialized-name XML attribute or the serialized_name key for YAML.

This was exposed by @dunglas in #19374 (comment).

Framework integration

For FramworkBundle integration, a ChainNameConverter could be added to allow users to use this name converter with a custom one.

To do

Nyholm

This is great. Thank you for working on #19374.

I did a quick review and I found some minor things.

Nyholm · 2018-09-18T20:54:35Z

src/Symfony/Component/Serializer/Annotation/SerializedName.php

+class SerializedName
+{
+    /**
+     * @var int


should be string

Nyholm · 2018-09-18T20:55:39Z

src/Symfony/Component/Serializer/Annotation/SerializedName.php

+        $this->serializedName = $data['value'];
+    }
+
+    public function getSerializedName()


src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php

dunglas

Awesome!

dunglas · 2018-09-18T21:02:17Z

src/Symfony/Component/Serializer/Annotation/SerializedName.php

+ *
+ * @author Fabien Bourigault <[email protected]>
+ */
+class SerializedName


dunglas · 2018-09-18T21:03:27Z

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php

+    /**
+     * {@inheritdoc}
+     */
+    public function setSerializedName($serializedName)


setSerializedName(string $serializedName = null)

dunglas · 2018-09-18T21:03:39Z

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php

+    /**
+     * {@inheritdoc}
+     */
+    public function getSerializedName()


getSerializedName(): string

getSerializedName(): ?string?

dunglas · 2018-09-18T21:04:28Z

src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php

+     *
+     * @param string|null $serializedName
+     */
+    public function setSerializedName($serializedName);


setSerializedName(string $serializedName = null);

dunglas · 2018-09-18T21:06:18Z

src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php

+final class MetadataAwareNameConverter implements AdvancedNameConverterInterface
+{
+    /**
+     * @var ClassMetadataFactoryInterface


Can be removed (IDE will infer it from the constructor's typehint)

src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php

dunglas · 2018-09-18T21:11:44Z

src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php

+
+        $attributesMetadata = $classMetadata->getAttributesMetadata();
+
+        foreach ($attributesMetadata as $name => $metadata) {


Can you cache this in a private static property to avoid looping for every property?

src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php

dunglas · 2018-09-18T21:14:11Z

I think you can add the FrameworkBundle integration in the same PR (but another one is ok too).

fbourigault · 2018-09-24T20:49:41Z

I would like to start documenting this feature but I don't know where to start. Can someone help me to write it?

Nyholm · 2018-09-24T20:56:02Z

How about adding it on a new subsection to https://symfony.com/doc/current/components/serializer.html#converting-property-names-when-serializing-and-deserializing

dunglas

Awesome new feature! Just a few remaining comments, then 👍 on my side.

dunglas · 2018-10-03T20:37:08Z

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

@@ -119,6 +119,11 @@
        <!-- Name converter -->
        <service id="serializer.name_converter.camel_case_to_snake_case" class="Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter" />

+        <service id="serializer.name_converter.metadata" class="Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter" >


Wouldn't serializer.name_converter.metadata_aware be more explicit?

dunglas · 2018-10-03T20:37:34Z

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

@@ -119,6 +119,11 @@
        <!-- Name converter -->
        <service id="serializer.name_converter.camel_case_to_snake_case" class="Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter" />

+        <service id="serializer.name_converter.metadata" class="Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter" >
+            <argument type="service" id="serializer.mapping.class_metadata_factory"/>
+            <argument>null</argument> <!-- fallback name converter -->


As it's the last one, it can be omitted.

dunglas · 2018-10-03T20:38:34Z

src/Symfony/Bundle/FrameworkBundle/composer.json

@@ -45,7 +45,7 @@
        "symfony/process": "~3.4|~4.0",
        "symfony/security-core": "~3.4|~4.0",
        "symfony/security-csrf": "~3.4|~4.0",
-        "symfony/serializer": "^4.1",
+        "symfony/serializer": "^4.2",


Personally, I'm ok to bump this dependency. But feature detection may be used to support both versions. WDYT @symfony/deciders?

dunglas · 2018-10-03T20:40:03Z

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php

+     *           class' serialized representation. Do not access it. Use
+     *           {@link getSerializedName()} instead.
+     */
+    public $serializedName;


Is it still really necessary to make this property public? We do that everywhere in validator (and I copied this behavior in Serializer), but I'm not sure that it's still accurate.
Anyway, keep it here for consistency.

dunglas · 2018-10-03T20:46:37Z

src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php

+        return null;
+    }
+
+    private function denormalizeFallback(string $propertyName, string $class = null, string $format = null, array $context = array())


: string?

nicolas-grekas · 2018-10-03T21:00:24Z

src/Symfony/Component/Serializer/Mapping/AttributeMetadataInterface.php

+    /**
+     * Sets the serialization name for this attribute.
+     */
+    public function setSerializedName(string $serializedName = null);


BC break? why not otherwise?

OK, internal interface.

…ugh metadata

dunglas · 2018-10-05T07:44:30Z

Thanks for your work on this new feature!

@dunglas

…properties through metadata (fbourigault) This PR was squashed before being merged into the 4.2-dev branch (closes #28505). Discussion ---------- [Serialized] allow configuring the serialized name of properties through metadata | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #15171 | License | MIT | Doc PR | symfony/symfony-docs#10422 This leverage the new `AdvancedNameConverterInterface` interface (#27021) to implement a name converter that relies on metadata. The name to use is configured per property using a `@SerializedName` annotation or the `serialized-name` XML attribute or the `serialized_name` key for YAML. This was exposed by @dunglas in #19374 (comment). # Framework integration For FramworkBundle integration, a ChainNameConverter could be added to allow users to use this name converter with a custom one. # To do - [x] add a CHANGELOG.md entry. - [x] add a fallback. - [x] add framework integration. - [x] add local caching to `MetadataAwareNameConverter`. - [x] add a doc PR. Commits ------- d1d1ceb [Serialized] allow configuring the serialized name of properties through metadata

This PR was merged into the master branch. Discussion ---------- Document metadata aware name conversion Documentation for symfony/symfony#28505. I wrote this section with strong inspiration from the discriminator section. # To do - [ ] Add an introduction Commits ------- 9d50c77 document metadata aware name conversion

jperovic · 2019-12-05T12:32:48Z

Just found myself in a scenario where I could use it, but keep wondering if this is indeed applicable for deserialization.

For example:

{
"id": 123, 
"name": "Jovan"
}

And I have my Person class with following fields: id, name and naturalId. My use-case requires me to map incoming id to naturalId and leave id to NULL.

For me, it did not work, though, I am still unsure if I initialized the serializer service properly.

jperovic · 2019-12-06T12:52:06Z

Oh, scratch that. Indeed, this was a misconfiguration on my part. (I was missing @Groups() annotation)

carsonbot added Status: Needs Review Feature labels Sep 18, 2018

Nyholm reviewed Sep 18, 2018

View reviewed changes

fbourigault requested a review from dunglas as a code owner September 18, 2018 21:10

dunglas requested changes Sep 18, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Sep 18, 2018

nicolas-grekas added this to the next milestone Sep 19, 2018

fbourigault mentioned this pull request Oct 1, 2018

Document metadata aware name conversion symfony/symfony-docs#10422

Merged

1 task

dunglas approved these changes Oct 3, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Oct 3, 2018

nicolas-grekas reviewed Oct 3, 2018

View reviewed changes

nicolas-grekas changed the title ~~[Serialized] Serialized name~~ [Serialized] allow configuring the serialized name of properties through metadata Oct 3, 2018

nicolas-grekas approved these changes Oct 3, 2018

View reviewed changes

[Serialized] allow configuring the serialized name of properties thro…

d1d1ceb

…ugh metadata

dunglas merged commit d1d1ceb into symfony:master Oct 5, 2018

fbourigault deleted the serialized-name branch October 5, 2018 07:47

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

dunglas mentioned this pull request Nov 15, 2018

Property alias api-platform/core#2332

Closed

soullivaneuh mentioned this pull request Nov 21, 2018

The new SerializedName annotation is ignored by the documentation generator api-platform/core#2343

Closed

fbourigault mentioned this pull request Jan 9, 2019

[Serializer] Alias for attributes #15171

Closed

antograssiot mentioned this pull request Oct 20, 2019

[Serializer] Fix property name usage for denormalization #34035

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serialized] allow configuring the serialized name of properties through metadata #28505

[Serialized] allow configuring the serialized name of properties through metadata #28505

fbourigault commented Sep 18, 2018 •

edited

Loading

Nyholm left a comment

Nyholm Sep 18, 2018

Nyholm Sep 18, 2018

dunglas left a comment

dunglas Sep 18, 2018

dunglas Sep 18, 2018

dunglas Sep 18, 2018

fbourigault Sep 18, 2018

dunglas Sep 18, 2018

dunglas Sep 18, 2018

dunglas Sep 18, 2018

dunglas Sep 18, 2018

dunglas commented Sep 18, 2018

fbourigault commented Sep 24, 2018

Nyholm commented Sep 24, 2018

dunglas left a comment

dunglas Oct 3, 2018

dunglas Oct 3, 2018

dunglas Oct 3, 2018

dunglas Oct 3, 2018

dunglas Oct 3, 2018

nicolas-grekas Oct 3, 2018

nicolas-grekas Oct 3, 2018

dunglas commented Oct 5, 2018

jperovic commented Dec 5, 2019

jperovic commented Dec 6, 2019


		$attributesMetadata = $classMetadata->getAttributesMetadata();

		foreach ($attributesMetadata as $name => $metadata) {

[Serialized] allow configuring the serialized name of properties through metadata #28505

[Serialized] allow configuring the serialized name of properties through metadata #28505

Conversation

fbourigault commented Sep 18, 2018 • edited Loading

Framework integration

To do

Nyholm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas left a 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

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, 2018

fbourigault commented Sep 24, 2018

Nyholm commented Sep 24, 2018

dunglas left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Oct 5, 2018

jperovic commented Dec 5, 2019

jperovic commented Dec 6, 2019

fbourigault commented Sep 18, 2018 •

edited

Loading