[Serializer] XML deserialization with MetadataAwareNameConverter and optional xml attributes fails if attributes are not present #32114

jlhernandez · 2019-06-20T09:49:19Z

Symfony version(s) affected: ^4.3

Description
I am using Symfony Serializer to deserialize complex XML documents into custom objects. Some XML nodes have optional attributes that may be present or not.

For example, the "price" node can have a "currency" attribute or not:
<price currency="EUR">66</price>
or
<price>55</price>
are both valid.

I am using MetadataAwareNameConverter to map our class attributes to xml attributes.
In the first case, the Price object is correctly created and both attributes are filled in, but in the second case the Price object is created by both attributes are left NULL.

How to reproduce
Our Price class is this one:

use Symfony\Component\Serializer\Annotation\SerializedName;

class Price {

    /**
     * @SerializedName("@currency")
     * @var string
     */
    private $currency;

    /**
     * @SerializedName("#")
     * @var string
     */
    private $amount;


    public function getCurrency() {
        return $this->currency;
    }
    public function setCurrency(string $currency) {
        $this->currency = $currency;
    }

    public function getAmount() {
        return $this->amount;
    }
    public function setAmount(string $amount) {
        $this->amount = $amount;
    }
}

This test case shows the correct behaviour when "currency" attribute is present:

    function testWorks() {

        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
        $metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory);

        $encoders = [new XmlEncoder()];
        $normalizers = [new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter)];  
        $serializer = new Serializer($normalizers, $encoders);
    
        $xml = '<price currency="EUR">55</price>';

        $object = $serializer->deserialize($xml, Price::class, 'xml');

        $this->assertEquals('EUR', $object->getCurrency());
        $this->assertEquals(55, $object->getAmount());
    }

but this test case fails (Amount is also NULL!):

    function testFails() {

        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
        $metadataAwareNameConverter = new MetadataAwareNameConverter($classMetadataFactory);

        $encoders = [new XmlEncoder()];
        $normalizers = [new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter)];  
        $serializer = new Serializer($normalizers, $encoders);
    
        $xml = '<price>55</price>';

        $object = $serializer->deserialize($xml, Price::class, 'xml');

        $this->assertNull($object->getCurrency());
        $this->assertEquals(55, $object->getAmount());
    }

Possible Solution

I have found that when denormalizing the attributes, the name converter receives an array with key '0' as property name. I have implemented a CustomMetadataAwareNameConverter that replaces the property name '0' by '#', and it works now..

This is the CustomMetadataAwareNameConverter class:

class CustomMetadataAwareNameConverter implements AdvancedNameConverterInterface {

    /**
     * The real MetadataAwareNameConverter
     * 
     * @var MetadataAwareNameConverter
     */
    private $converter;

    public function __construct(ClassMetadataFactoryInterface $metadataFactory, NameConverterInterface $fallbackNameConverter = null) {
        $this->converter = new MetadataAwareNameConverter($metadataFactory, $fallbackNameConverter);
    }

    public function normalize($propertyName, string $class = null, string $format = null, array $context = []) {
        return $this->converter->normalize($propertyName, $class, $format, $context);
    }

    public function denormalize($propertyName, string $class = null, string $format = null, array $context = []) {
        return $this->converter->denormalize($propertyName == '0' ? '#' : $propertyName, $class, $format, $context);
    }
}

and the test that previously failed works now:

    function testFixed() {

        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
        $metadataAwareNameConverter = new CustomMetadataAwareNameConverter($classMetadataFactory);

        $encoders = [new XmlEncoder()];
        $normalizers = [new ObjectNormalizer($classMetadataFactory, $metadataAwareNameConverter)];  
        $serializer = new Serializer($normalizers, $encoders);
    
        $xml = '<price>55</price>';

        $object = $serializer->deserialize($xml, Price::class, 'xml');

        $this->assertNull($object->getCurrency());
        $this->assertEquals(55, $object->getAmount());
    }

The text was updated successfully, but these errors were encountered:

mkrauser · 2019-09-20T11:14:28Z

I can confirm this exact issue

monteiro · 2019-11-25T09:18:35Z

I have create an issue to cover both cases without using the SerializedName annotation. The solution is just a name converter that is passed to the ObjectNormalizer. The name converter converts extra attributes (that are prefixed with @) and node value ( using #) returned from the XmlEncoder.

Can this be useful for you?

tacman · 2020-04-09T12:03:42Z

I think this is related, but perhaps not. I'm trying to deserialize XML into a Property entity with a name and value, e.g.

<property name="length">4110</property>

serialization.yaml is configured so that the attribute and value are generated properly.

App\Entity\Property:
  attributes:
    name:
      serialized_name: '@name'
      groups: ['xml']
    value:
      serialized_name: '#'
      groups: ['xml']

And works as expected.

        $property = (new Property())->setName('length')->setValue(4110);
        $context = [
            'xml_root_node_name' => 'property',
            'groups' => ['xml']
        ];

        $xml = $serializer->serialize($property, 'xml', $context);   
       //         $xml is now '<property name="length">4110</property>' as expected

        $xml = '<property name="length">4110</property>';
    
       // but serializing to Property doesn't work.
        $data = $serializer->deserialize($xml, Property::class, 'xml');
        // neither name or value is set.
        dd($data);

Does the serialized_name property (or @SerializedName annotation) work in the deserialization process? Or should I be calling this differently?

nicolas-grekas · 2021-01-23T18:34:07Z

Help wanted.

carsonbot · 2021-07-24T13:02:35Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

tacman · 2021-07-24T20:30:36Z

My workaround was to use a regex to rewrite the attributes as node elements, then rewrite my parsing accordingly. Of course, my solution is a classic definition of "hack" -- functional, but certainly not the "right" way.

monteiro · 2021-07-24T21:30:52Z

Did something related here: #35087

carsonbot · 2022-01-25T13:03:09Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2022-02-09T13:40:36Z

Could I get a reply or should I close this?

tacman · 2022-02-09T16:04:35Z

@nicolas-grekas Do you know if any tests have been added for this?

nicolas-grekas · 2022-02-09T16:13:09Z

I don't remember sorry. Please have a look if you can.

tacman · 2022-02-10T02:41:52Z

I can confirm that I still have the issue.

I've create a repo that shows example, trivial (2 entities, serialization.yaml, and a Command).

git clone git@github.com:tacman/xml-serializer-demo.git
cd xml-serializer-demo && composer install
bin/console app:bug

The serializations works, but not the deserialization:

$product = (new Product())
    ->setDescription("Wool sweater");
$product
    ->addProperty((new Property())->setName('color')->setValue('blue'))
    ->addProperty((new Property())->setName('size')->setValue('small'))
    ;

$context = [
    'xml_root_node_name' => 'product',
    'groups' => ['xml'],
    'xml_standalone' => false,
    'xml_format_output' => true,
];
$xml = $this->serializer->serialize($product, 'xml', $context);

// works!

        /** @var Product $product2 */
        $product2 = $this->serializer->deserialize($xml, Product::class, 'xml');

        dump($product2); // nothing is set :-(

carsonbot · 2022-08-28T14:46:32Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2022-10-29T14:00:57Z

Could I get a reply or should I close this?

tacman · 2022-10-29T14:05:28Z

I'll try again.

tacman · 2022-10-29T14:09:01Z

I bumped the example repo to Symfony 6.1 and it still fails.

git clone git@github.com:tacman/xml-serializer-demo.git
cd xml-serializer-demo && composer install
bin/console app:bug

carsonbot · 2023-05-03T13:04:13Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2023-07-04T09:56:05Z

Could I get a reply or should I close this?

tacman · 2023-07-04T16:29:25Z

I guess not many people use XML deserialization. It continues to be an issue.

carsonbot · 2024-01-05T13:03:43Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2024-01-19T13:05:59Z

Could I get a reply or should I close this?

tacman · 2024-01-19T13:14:25Z

I think this PR will fix it: b70032c

but shouldn't it be on all Symfony releases, not just 5.4?

xabbuh · 2024-01-19T13:20:30Z

@tacman We regularly merge the 5.4 up into all other maintained branches. So if the linked PR is merged into the 5.4 branch, the patch will eventually land in all maintained Symfony versions.

…rld) This PR was merged into the 5.4 branch. Discussion ---------- [Serializer] Fix XML scalar to object denormalization | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #32114 #34579 | License | MIT Another approach to #34825 Commits ------- 6fe892f [Serializer] Fix XML scalar to object denormalization

xabbuh added Bug Serializer labels Jun 20, 2019

carsonbot added the Status: Needs Review label Jun 20, 2019

monteiro mentioned this issue Nov 25, 2019

[Serializer] Extra attributes name converter for XML when using ObjectNormalizer #34579

Closed

mkrauser mentioned this issue Dec 4, 2019

[Serializer] fix denormalization of xml-values to objects when no xml-attributes are specified #34825

Closed

nicolas-grekas added the Help wanted Issues and PRs which are looking for volunteers to complete them. label Jan 23, 2021

carsonbot added the Stalled label Jul 24, 2021

carsonbot removed the Stalled label Jul 24, 2021

carsonbot added the Stalled label Jan 25, 2022

carsonbot removed the Stalled label Feb 9, 2022

carsonbot added the Stalled label Aug 28, 2022

carsonbot removed the Stalled label Oct 29, 2022

carsonbot added the Stalled label May 3, 2023

carsonbot removed the Stalled label Jul 4, 2023

mtarld mentioned this issue Nov 23, 2023

[Serializer] Fix XML scalar to object denormalization #52698

Merged

carsonbot added the Stalled label Jan 5, 2024

carsonbot removed the Stalled label Jan 19, 2024

fabpot closed this as completed Apr 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] XML deserialization with MetadataAwareNameConverter and optional xml attributes fails if attributes are not present #32114

[Serializer] XML deserialization with MetadataAwareNameConverter and optional xml attributes fails if attributes are not present #32114

jlhernandez commented Jun 20, 2019

mkrauser commented Sep 20, 2019

monteiro commented Nov 25, 2019

tacman commented Apr 9, 2020

nicolas-grekas commented Jan 23, 2021

carsonbot commented Jul 24, 2021

tacman commented Jul 24, 2021

monteiro commented Jul 24, 2021

carsonbot commented Jan 25, 2022

carsonbot commented Feb 9, 2022

tacman commented Feb 9, 2022

nicolas-grekas commented Feb 9, 2022

tacman commented Feb 10, 2022

carsonbot commented Aug 28, 2022

carsonbot commented Oct 29, 2022

tacman commented Oct 29, 2022

tacman commented Oct 29, 2022

carsonbot commented May 3, 2023

carsonbot commented Jul 4, 2023

tacman commented Jul 4, 2023

carsonbot commented Jan 5, 2024

carsonbot commented Jan 19, 2024

tacman commented Jan 19, 2024

xabbuh commented Jan 19, 2024

[Serializer] XML deserialization with MetadataAwareNameConverter and optional xml attributes fails if attributes are not present #32114

[Serializer] XML deserialization with MetadataAwareNameConverter and optional xml attributes fails if attributes are not present #32114

Comments

jlhernandez commented Jun 20, 2019

mkrauser commented Sep 20, 2019

monteiro commented Nov 25, 2019

tacman commented Apr 9, 2020

nicolas-grekas commented Jan 23, 2021

carsonbot commented Jul 24, 2021

tacman commented Jul 24, 2021

monteiro commented Jul 24, 2021

carsonbot commented Jan 25, 2022

carsonbot commented Feb 9, 2022

tacman commented Feb 9, 2022

nicolas-grekas commented Feb 9, 2022

tacman commented Feb 10, 2022

carsonbot commented Aug 28, 2022

carsonbot commented Oct 29, 2022

tacman commented Oct 29, 2022

tacman commented Oct 29, 2022

carsonbot commented May 3, 2023

carsonbot commented Jul 4, 2023

tacman commented Jul 4, 2023

carsonbot commented Jan 5, 2024

carsonbot commented Jan 19, 2024

tacman commented Jan 19, 2024

xabbuh commented Jan 19, 2024