feature #18561 [FrameworkBundle] Fallback to default cache system in production for serializer (tgalopin)

nicolas-grekas · nicolas-grekas · commit 43a42c7147b1 · 2016-04-19T16:23:32.000+02:00
This PR was merged into the 3.1-dev branch. Discussion ---------- [FrameworkBundle] Fallback to default cache system in production for serializer | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - In the same idea as symfony/symfony#18544, this PR proposes a default fallback to filesystem cache for the serializer if the APC cache is not enabled in production. In other words, if the following part of `config_prod.yml` file is not uncommented, the filesystem will be used: ``` yaml #framework: # serializer: # cache: serializer.mapping.cache.doctrine.apc ``` Commits ------- 4f0b8be [FrameworkBundle] Fallback to default cache system in production for serializer
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -513,7 +513,7 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode)
                     ->canBeEnabled()
                     ->children()
                         ->booleanNode('enable_annotations')->defaultFalse()->end()
-                        ->scalarNode('cache')->end()
+                        ->scalarNode('cache')->defaultValue('serializer.mapping.cache.symfony')->end()
                         ->scalarNode('name_converter')->end()
                     ->end()
                 ->end()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -982,7 +982,7 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
 
         $chainLoader->replaceArgument(0, $serializerLoaders);
 
-        if (isset($config['cache']) && $config['cache']) {
+        if (!$container->getParameter('kernel.debug')) {
             $container->setParameter(
                 'serializer.mapping.cache.prefix',
                 'serializer_'.$this->getKernelRootHash($container)
diff --git a/Resources/config/cache_pools.xml b/Resources/config/cache_pools.xml
@@ -25,6 +25,10 @@
             <tag name="cache.pool" clearer="cache.default_pools_clearer" />
         </service>
 
+        <service id="cache.pool.serializer" parent="cache.adapter.local" public="false">
+            <tag name="cache.pool" clearer="cache.default_pools_clearer" />
+        </service>
+
         <service id="cache.adapter.apcu" class="Symfony\Component\Cache\Adapter\ApcuAdapter" abstract="true">
             <argument /> <!-- namespace -->
             <argument /> <!-- default lifetime -->
diff --git a/Resources/config/serializer.xml b/Resources/config/serializer.xml
@@ -38,6 +38,10 @@
         </service>
 
         <!-- Cache -->
+        <service id="serializer.mapping.cache.symfony" class="Symfony\Component\Cache\DoctrineProvider" public="false">
+            <argument type="service" id="cache.pool.serializer" />
+        </service>
+
         <service id="serializer.mapping.cache.doctrine.apc" class="Doctrine\Common\Cache\ApcCache" public="false">
             <call method="setNamespace">
                 <argument>%serializer.mapping.cache.prefix%</argument>
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -221,6 +221,7 @@ protected static function getBundleDefaultConfig()
             'serializer' => array(
                 'enabled' => false,
                 'enable_annotations' => false,
+                'cache' => 'serializer.mapping.cache.symfony',
             ),
             'property_access' => array(
                 'magic_call' => false,
diff --git a/Tests/DependencyInjection/Fixtures/php/full.php b/Tests/DependencyInjection/Fixtures/php/full.php
@@ -66,7 +66,7 @@
     'serializer' => array(
         'enabled' => true,
         'enable_annotations' => true,
-        'cache' => 'serializer.mapping.cache.apc',
+        'cache' => 'serializer.mapping.cache.doctrine.apc',
         'name_converter' => 'serializer.name_converter.camel_case_to_snake_case',
     ),
     'ide' => 'file%%link%%format',
diff --git a/Tests/DependencyInjection/Fixtures/xml/full.xml b/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -40,6 +40,6 @@
         </framework:translator>
         <framework:validation enabled="true" cache="validator.mapping.cache.doctrine.apc" />
         <framework:annotations cache="file" debug="true" file-cache-dir="%kernel.cache_dir%/annotations" />
-        <framework:serializer enabled="true" enable-annotations="true" cache="serializer.mapping.cache.apc" name-converter="serializer.name_converter.camel_case_to_snake_case" />
+        <framework:serializer enabled="true" enable-annotations="true" cache="serializer.mapping.cache.doctrine.apc" name-converter="serializer.name_converter.camel_case_to_snake_case" />
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/yml/full.yml b/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -52,7 +52,7 @@ framework:
     serializer:
          enabled:        true
          enable_annotations: true
-         cache:          serializer.mapping.cache.apc
+         cache:          serializer.mapping.cache.doctrine.apc
          name_converter: serializer.name_converter.camel_case_to_snake_case
     ide: file%%link%%format
     request:
diff --git a/Tests/DependencyInjection/FrameworkExtensionTest.php b/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -449,7 +449,7 @@ public function testSerializerEnabled()
 
         $this->assertCount(1, $argument);
         $this->assertEquals('Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader', $argument[0]->getClass());
-        $this->assertEquals(new Reference('serializer.mapping.cache.apc'), $container->getDefinition('serializer.mapping.class_metadata_factory')->getArgument(1));
+        $this->assertEquals(new Reference('serializer.mapping.cache.doctrine.apc'), $container->getDefinition('serializer.mapping.class_metadata_factory')->getArgument(1));
         $this->assertEquals(new Reference('serializer.name_converter.camel_case_to_snake_case'), $container->getDefinition('serializer.normalizer.object')->getArgument(1));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -449,7 +449,7 @@ public function testSerializerEnabled()`
`449`	`449`
`450`	`450`	`$this->assertCount(1, $argument);`
`451`	`451`	`$this->assertEquals('Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader', $argument[0]->getClass());`
`452`		`- $this->assertEquals(new Reference('serializer.mapping.cache.apc'), $container->getDefinition('serializer.mapping.class_metadata_factory')->getArgument(1));`
	`452`	`+ $this->assertEquals(new Reference('serializer.mapping.cache.doctrine.apc'), $container->getDefinition('serializer.mapping.class_metadata_factory')->getArgument(1));`
`453`	`453`	`$this->assertEquals(new Reference('serializer.name_converter.camel_case_to_snake_case'), $container->getDefinition('serializer.normalizer.object')->getArgument(1));`
`454`	`454`	`}`
`455`	`455`