feature #38542 [FrameworkBundle][Serializer] Allow serializer default context configuration (soyuka)

fabpot · fabpot · commit aa5d3d0bbd92 · 2021-10-27T11:08:28.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [FrameworkBundle][Serializer] Allow serializer default context configuration | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes  | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | todo if we go with it  This allow to configure the `context` for normalizer's on a high level: ```yaml serializer: default_context: enable_max_depth: true ``` This feature was asked in api-platform/core#1764 (comment) and I thought it could be in symfony instead. The messenger component has the same configuration. This re-opens symfony/symfony#28927 (for discussion). I'm still unsure about the discussion in symfony/symfony#28927 (comment) and what solution I should implement. Please let me know if you come to an agreement. Commits ------- 43d1ca5f86 Allow serializer default context configuration
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ CHANGELOG
  * Add support for resetting container services after each messenger message
  * Add `configureContainer()`, `configureRoutes()`, `getConfigDir()` and `getBundlesPath()` to `MicroKernelTrait`
  * Add support for configuring log level, and status code by exception class
+ * Bind the `default_context` parameter onto serializer's encoders and normalizers
 
 5.3
 ---
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -1005,6 +1005,12 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode, callable $e
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('default_context')
+                            ->normalizeKeys(false)
+                            ->useAttributeAsKey('name')
+                            ->defaultValue([])
+                            ->prototype('variable')->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -1813,6 +1813,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
             $defaultContext += ['max_depth_handler' => new Reference($config['max_depth_handler'])];
             $container->getDefinition('serializer.normalizer.object')->replaceArgument(6, $defaultContext);
         }
+
+        if (isset($config['default_context']) && $config['default_context']) {
+            $container->setParameter('serializer.default_context', $config['default_context']);
+        }
     }
 
     private function registerPropertyInfoConfiguration(ContainerBuilder $container, PhpFileLoader $loader)
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -266,6 +266,7 @@
     <xsd:complexType name="serializer">
         <xsd:choice minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="mapping" type="file_mapping" />
+            <xsd:element name="default-context" type="metadata" minOccurs="0" maxOccurs="1" />
         </xsd:choice>
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="enable-annotations" type="xsd:boolean" />
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -446,6 +446,7 @@ protected static function getBundleDefaultConfig()
                 'enabled' => true,
             ],
             'serializer' => [
+                'default_context' => [],
                 'enabled' => !class_exists(FullStack::class),
                 'enable_annotations' => !class_exists(FullStack::class),
                 'mapping' => ['paths' => []],
diff --git a/Tests/DependencyInjection/Fixtures/php/full.php b/Tests/DependencyInjection/Fixtures/php/full.php
@@ -67,6 +67,7 @@
         'name_converter' => 'serializer.name_converter.camel_case_to_snake_case',
         'circular_reference_handler' => 'my.circular.reference.handler',
         'max_depth_handler' => 'my.max.depth.handler',
+        'default_context' => ['enable_max_depth' => true],
     ],
     'property_info' => true,
     'ide' => 'file%%link%%format',
diff --git a/Tests/DependencyInjection/Fixtures/xml/full.xml b/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -33,7 +33,11 @@
         </framework:translator>
         <framework:validation enabled="true" />
         <framework:annotations cache="file" debug="true" file-cache-dir="%kernel.cache_dir%/annotations" />
-        <framework:serializer enabled="true" enable-annotations="true" name-converter="serializer.name_converter.camel_case_to_snake_case" circular-reference-handler="my.circular.reference.handler" max-depth-handler="my.max.depth.handler" />
+        <framework:serializer enabled="true" enable-annotations="true" name-converter="serializer.name_converter.camel_case_to_snake_case" circular-reference-handler="my.circular.reference.handler" max-depth-handler="my.max.depth.handler">
+            <framework:default-context>
+                <framework:enable_max_depth>true</framework:enable_max_depth>
+            </framework:default-context>
+        </framework:serializer>
         <framework:property-info />
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/yml/full.yml b/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -55,6 +55,8 @@ framework:
          name_converter:             serializer.name_converter.camel_case_to_snake_case
          circular_reference_handler: my.circular.reference.handler
          max_depth_handler:          my.max.depth.handler
+         default_context:
+             enable_max_depth: true
     property_info: ~
     ide: file%%link%%format
     request:

Original file line number	Diff line number	Diff line change
`@@ -1813,6 +1813,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder`
`1813`	`1813`	`$defaultContext += ['max_depth_handler' => new Reference($config['max_depth_handler'])];`
`1814`	`1814`	`$container->getDefinition('serializer.normalizer.object')->replaceArgument(6, $defaultContext);`
`1815`	`1815`	`}`
	`1816`	`+`
	`1817`	`+ if (isset($config['default_context']) && $config['default_context']) {`
	`1818`	`+ $container->setParameter('serializer.default_context', $config['default_context']);`
	`1819`	`+ }`
`1816`	`1820`	`}`
`1817`	`1821`
`1818`	`1822`	`private function registerPropertyInfoConfiguration(ContainerBuilder $container, PhpFileLoader $loader)`