feature #37847 [Serializer][Mime] Fix Mime message serialization (fabpot)

This PR was merged into the 5.2-dev branch.

Discussion
----------

[Serializer][Mime] Fix Mime message serialization

| Q             | A
| ------------- | ---
| Branch?       | master <!-- see below -->
| Bug fix?      | yes
| New feature?  | yes <!-- please update src/**/CHANGELOG.md files -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tickets       | Fix #37414, Fix #37324 <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead -->
| License       | MIT
| Doc PR        | n/a

Symfony serialization is used by Messenger to serialize Emails. By Email messages are data objects with some logic to prepare emails to be sent. Without configuration, the Symfony Serializer serializes Emails with too many data (and triggers some unneeded validation).

This PR aims to fix the above issue and at the same time makes serialized emails as small as possible and as readable as possible.

Commits
-------

9d869b1ece Fix Mime message serialization

Author: fabpot

Resources/config/serializer.php

@@ -39,9 +39,11 @@
 use Symfony\Component\Serializer\Normalizer\DateTimeZoneNormalizer;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer;
+use Symfony\Component\Serializer\Normalizer\MimeMessageNormalizer;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Normalizer\ProblemNormalizer;
+use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
 use Symfony\Component\Serializer\Normalizer\UnwrappingDenormalizer;
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Serializer\SerializerInterface;
@@ -76,6 +78,10 @@
             ->args([[], service('serializer.name_converter.metadata_aware')])
             ->tag('serializer.normalizer', ['priority' => -915])
 
+        ->set('serializer.normalizer.mime_message', MimeMessageNormalizer::class)
+            ->args([service('serializer.normalizer.property')])
+            ->tag('serializer.normalizer', ['priority' => -915])
+
         ->set('serializer.normalizer.datetimezone', DateTimeZoneNormalizer::class)
             ->tag('serializer.normalizer', ['priority' => -915])
 
@@ -114,6 +120,18 @@
 
         ->alias(ObjectNormalizer::class, 'serializer.normalizer.object')
 
+        ->set('serializer.normalizer.property', PropertyNormalizer::class)
+            ->args([
+                service('serializer.mapping.class_metadata_factory'),
+                service('serializer.name_converter.metadata_aware'),
+                service('property_info')->ignoreOnInvalid(),
+                service('serializer.mapping.class_discriminator_resolver')->ignoreOnInvalid(),
+                null,
+                [],
+            ])
+
+        ->alias(PropertyNormalizer::class, 'serializer.normalizer.property')
+
         ->set('serializer.denormalizer.array', ArrayDenormalizer::class)
             ->tag('serializer.normalizer', ['priority' => -990])
 

composer.json

@@ -52,7 +52,7 @@
         "symfony/security-bundle": "^5.1",
         "symfony/security-csrf": "^4.4|^5.0",
         "symfony/security-http": "^4.4|^5.0",
-        "symfony/serializer": "^4.4|^5.0",
+        "symfony/serializer": "^5.2",
         "symfony/stopwatch": "^4.4|^5.0",
         "symfony/string": "^5.0",
         "symfony/translation": "^5.0",
@@ -62,7 +62,7 @@
         "symfony/yaml": "^4.4|^5.0",
         "symfony/property-info": "^4.4|^5.0",
         "symfony/web-link": "^4.4|^5.0",
-        "phpdocumentor/reflection-docblock": "^3.0|^4.0",
+        "phpdocumentor/reflection-docblock": "^3.0|^4.0|^5.0",
         "paragonie/sodium_compat": "^1.8",
         "twig/twig": "^2.10|^3.0"
     },