SerializedName based on Groups #37903

jsamouh · 2020-08-21T01:01:36Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
Deprecations?	yes
Tickets	Fix #30483
License	MIT
Doc PR	symfony/symfony-docs#...

New Feature: Serialized Name based on Groups

/**
 * @SerializedName("bar")                       <-- Applied only when no groups are provided
 * @SerializedName("baz", groups={"a", "b"})    <-- Applied if group is a or b
 * @SerializedName("bat", groups="c")           <-- Applied if group is c
 */
$foo

// YAML 
  attributes:
    foo:
      serialized_names:
         bar: ~
         baz: ['a', 'b']
         bat: ['c']

//XML
        <attribute name="foo" serialized-name="bar" />
        <attribute name="foo" serialized-name="baz">
             <group>a</group>
             <group>b</group>
       </attribute>
        <attribute name="foo" serialized-name="bat">
             <group>c</group>
       </attribute>

dunglas · 2020-08-24T12:45:57Z

What do you think about using the following signature:

/**
 * @SerializedName("bar")                       <-- Applied only when no groups are provided
 * @SerializedName("baz", groups={"a", "b"})    <-- Applied if group is a or b
 * @SerializedName("bat", groups="c")           <-- Applied if group is c
 */
$foo;

If find this easier to read and write.

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

jvasseur · 2020-08-25T07:18:10Z

The doctrine annotation reader is capable of handling the same annotation multiple time on a property so this shouldn't be a problem.

jsamouh · 2020-08-26T02:38:00Z

cc @dunglas or other people for review

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

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

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

src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php

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

fabpot · 2020-09-02T14:11:11Z

@jsamouh Can you squash your commits?

ro0NL · 2020-09-02T14:36:55Z

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

@@ -111,15 +109,51 @@ public function getMaxDepth()
     */
    public function setSerializedName(string $serializedName = null)
    {
-        $this->serializedName = $serializedName;
+        $this->addSerializedName($serializedName);


you cannot pass null here.

ro0NL · 2020-09-02T14:39:06Z

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

+     * Adds the serialization name for this attribute.
+     */
+    public function addSerializedName(string $serializedName, array $groups = []);
+
    /**
     * Gets the serialization name for this attribute.
     */
    public function getSerializedName(): ?string;


id remove/deprecate this one

ro0NL · 2020-09-02T14:42:39Z

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

+
+        foreach ($this->serializedNames as $serializedName => $groupsForSerializedName) {
+            if (!$groupsForSerializedName) {
+                $defaultSerializedName = $serializedName;


i dont think you can make this assumption :/ any name without groups could be considered default

ro0NL · 2020-09-02T14:49:17Z

i think we should also validate that there can only be 1 default name (no groups)

as well as validating no overlap, e.g. 2 names with the same groups.

jsamouh · 2020-09-02T14:56:51Z

i think we should also validate that there can only be 1 default name (no groups)

as well as validating no overlap, e.g. 2 names with the same groups.

I understand your point... I m shared between let the behavior like this and be strict on it. Need a second thought on that cc @dunglas @fabpot

Thanks for your feedback

fabpot · 2020-09-02T14:58:44Z

I tend to agree with @ro0NL

ro0NL · 2020-09-02T16:50:02Z

...dle/FrameworkBundle/Tests/Functional/Bundle/LegacyBundle/Resources/config/serialization.yaml

-            serialized_name: 'full_name'
+            serialized_names: 'full_name'


seems to break user configs, thus BC

IMHO we can keep supporting 2 formats:

ser_name: 'some' ser_names: some: ~ other: [grp1, grp2]

ro0NL · 2020-09-02T16:50:51Z

src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php

+                        }
+                        $attributeMetadata->addSerializedName($data['serialized_names']);
+                    } elseif (\is_array($data['serialized_names'])) {
+                        if (empty($data['serialized_names'])) {


if (!$data['serialized_names']) {

ro0NL · 2020-09-02T16:51:14Z

src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php

+                            throw new MappingException(sprintf('The "serialized_names" value must be a non-empty array of serialized name/groups in "%s" for the attribute "%s" of the class "%s".', $this->file, $attribute, $classMetadata->getName()));
+                        }
+                        foreach ($data['serialized_names'] as $serializedName => $groups) {
+                            if (!\is_string($serializedName) || empty($serializedName)) {


|| '' === trim($serializedName)

ro0NL · 2020-09-02T16:55:19Z

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

+    /**
+     * Adds the serialization name for this attribute.
+     */
+    public function addSerializedName(string $serializedName, array $groups = []);


IMHO should this one should be setSerializedNames (no need for an adder) - which simplifies resetting

setSerializedName(null) previous, vs setSerializedNames([]) now

jsamouh · 2020-09-04T16:08:54Z

Thanks for your comments @ro0NL ,

To prevent back and forth, and because some of your comments are the opposite from previous comments suggested, I m waiting @dunglas to review...

fabpot · 2020-10-07T15:50:44Z

We've just moved away from master as the main branch to use 5.x instead. Unfortunately, I cannot reopen the PR and change the target branch to 5.x. Can you open a new PR referencing this one to not loose the discussion? Thank you for your understanding and for your help.

hafkenscheid · 2021-06-23T17:49:30Z

Is there already a new PR for this?

derrabus · 2021-06-23T17:58:00Z

I don't think so.

jsamouh · 2021-09-17T20:19:41Z

will dot it next week

janvernieuwe · 2022-03-16T11:44:24Z

This would still be immensely useful for refactoring/versioning things.

jsamouh requested a review from dunglas as a code owner August 21, 2020 01:01

carsonbot added Status: Needs Review Feature labels Aug 21, 2020

jsamouh changed the title ~~First try Serialized based on groups on Annotation~~ First try SerializedName based on groups on Annotation Aug 21, 2020

jsamouh marked this pull request as draft August 21, 2020 01:19

jsamouh changed the title ~~First try SerializedName based on groups on Annotation~~ [Draft] SerializedName based on Groups Aug 21, 2020

fabpot added this to the next milestone Aug 23, 2020

dunglas requested changes Aug 24, 2020

View reviewed changes

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Aug 24, 2020

jsamouh force-pushed the issue-30483-serialized-name-based-on-groups branch from 1d61e0f to 9620fe8 Compare August 26, 2020 02:35

jsamouh changed the title ~~[Draft] SerializedName based on Groups~~ SerializedName based on Groups Aug 26, 2020

jsamouh marked this pull request as ready for review August 26, 2020 16:09

fabpot requested a review from dunglas August 26, 2020 16:42

carsonbot added Status: Needs Review and removed Status: Needs Work labels Aug 26, 2020

fabpot requested changes Aug 26, 2020

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Aug 26, 2020

ogizanagi added the Deprecation label Aug 26, 2020

jsamouh force-pushed the issue-30483-serialized-name-based-on-groups branch from 04c47ef to 3c24e9f Compare August 26, 2020 19:23

stloyd reviewed Aug 29, 2020

View reviewed changes

src/Symfony/Component/Serializer/Mapping/AttributeMetadata.php Outdated Show resolved Hide resolved

stloyd reviewed Aug 29, 2020

View reviewed changes

src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php Outdated Show resolved Hide resolved

stloyd reviewed Aug 29, 2020

View reviewed changes

src/Symfony/Component/Serializer/Mapping/Loader/YamlFileLoader.php Outdated Show resolved Hide resolved

stloyd reviewed Aug 29, 2020

View reviewed changes

src/Symfony/Component/Serializer/NameConverter/MetadataAwareNameConverter.php Outdated Show resolved Hide resolved

jsamouh requested a review from fabpot September 1, 2020 12:43

carsonbot removed the Status: Needs Work label Sep 1, 2020

carsonbot added Status: Reviewed and removed Status: Needs Work labels Sep 2, 2020

jsamouh force-pushed the issue-30483-serialized-name-based-on-groups branch 2 times, most recently from 56b6f1c to d77f3d0 Compare September 2, 2020 14:24

ISSUE-30483 : Serialized name based on groups

14beaec

jsamouh force-pushed the issue-30483-serialized-name-based-on-groups branch from d77f3d0 to 14beaec Compare September 2, 2020 14:33

ro0NL reviewed Sep 2, 2020

View reviewed changes

Jordan Samouh added 2 commits September 2, 2020 11:15

Fix unit test

985f2a6

Fix unit test

b42281a

ro0NL reviewed Sep 2, 2020

View reviewed changes

fabpot closed this Oct 7, 2020

nicolas-grekas added the for 5.x label Oct 7, 2020

nicolas-grekas modified the milestones: 5.x, 5.2 Oct 14, 2020

ro0NL mentioned this pull request Nov 10, 2020

[Serializer] Add a way to provide a context in mapping #39039

Closed

alamirault mentioned this pull request May 21, 2022

[Serializer] Allow to add groups to SerializedName annotation/attribute #46432

Open

Uh oh!

SerializedName based on Groups #37903

SerializedName based on Groups #37903

Uh oh!

Conversation

jsamouh commented Aug 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dunglas commented Aug 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jvasseur commented Aug 25, 2020

Uh oh!

jsamouh commented Aug 26, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabpot commented Sep 2, 2020

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

ro0NL commented Sep 2, 2020

Uh oh!

jsamouh commented Sep 2, 2020

Uh oh!

fabpot commented Sep 2, 2020

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

jsamouh commented Sep 4, 2020

Uh oh!

fabpot commented Oct 7, 2020

Uh oh!

hafkenscheid commented Jun 23, 2021

Uh oh!

derrabus commented Jun 23, 2021

Uh oh!

jsamouh commented Sep 17, 2021

Uh oh!

janvernieuwe commented Mar 16, 2022

Uh oh!

Uh oh!

jsamouh commented Aug 21, 2020 •

edited

Loading

dunglas commented Aug 24, 2020 •

edited

Loading