Improve coverage

Author: dunglas

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -89,16 +89,18 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('security.xml');
         }
 
+        $useDoctrine = isset($bundles['DoctrineBundle']) && class_exists(Version::class);
+
         $this->registerMetadataConfiguration($container, $loader, $bundles, $config['loader_paths']);
         $this->registerOAuthConfiguration($container, $config, $loader);
         $this->registerSwaggerConfiguration($container, $config, $loader);
         $this->registerJsonLdConfiguration($formats, $loader);
         $this->registerJsonHalConfiguration($formats, $loader);
         $this->registerJsonProblemConfiguration($errorFormats, $loader);
-        $this->registerBundlesConfiguration($bundles, $config, $loader);
+        $this->registerBundlesConfiguration($bundles, $config, $loader, $useDoctrine);
         $this->registerCacheConfiguration($container);
-        $this->registerDoctrineExtensionConfiguration($container, $config);
-        $this->registerHttpCache($container, $config, $loader);
+        $this->registerDoctrineExtensionConfiguration($container, $config, $useDoctrine);
+        $this->registerHttpCache($container, $config, $loader, $useDoctrine);
     }
 
     /**
@@ -316,11 +318,12 @@ private function registerJsonProblemConfiguration(array $errorFormats, XmlFileLo
      * @param string[]      $bundles
      * @param array         $config
      * @param XmlFileLoader $loader
+     * @param bool          $useDoctrine
      */
-    private function registerBundlesConfiguration(array $bundles, array $config, XmlFileLoader $loader)
+    private function registerBundlesConfiguration(array $bundles, array $config, XmlFileLoader $loader, bool $useDoctrine)
     {
         // Doctrine ORM support
-        if (isset($bundles['DoctrineBundle']) && class_exists(Version::class)) {
+        if ($useDoctrine) {
             $loader->load('doctrine_orm.xml');
         }
 
@@ -357,28 +360,32 @@ private function registerCacheConfiguration(ContainerBuilder $container)
      *
      * @param ContainerBuilder $container
      * @param array            $config
+     * @param bool             $useDoctrine
      */
-    private function registerDoctrineExtensionConfiguration(ContainerBuilder $container, array $config)
+    private function registerDoctrineExtensionConfiguration(ContainerBuilder $container, array $config, bool $useDoctrine)
     {
-        if (false === $config['eager_loading']['enabled']) {
-            $container->removeDefinition('api_platform.doctrine.orm.query_extension.eager_loading');
-            $container->removeDefinition('api_platform.doctrine.orm.query_extension.filter_eager_loading');
+        if (!$useDoctrine || $config['eager_loading']['enabled']) {
+            return;
         }
+
+        $container->removeDefinition('api_platform.doctrine.orm.query_extension.eager_loading');
+        $container->removeDefinition('api_platform.doctrine.orm.query_extension.filter_eager_loading');
     }
 
-    private function registerHttpCache(ContainerBuilder $container, array $config, XmlFileLoader $loader)
+    private function registerHttpCache(ContainerBuilder $container, array $config, XmlFileLoader $loader, bool $useDoctrine)
     {
         $loader->load('http_cache.xml');
 
-        if (true !== $config['http_cache']['invalidation']['enabled']) {
-            if ($container->has('api_platform.doctrine.listener.http_cache.purge')) {
-                $container->removeDefinition('api_platform.doctrine.listener.http_cache.purge');
-            }
-
+        if (!$config['http_cache']['invalidation']['enabled']) {
             return;
         }
 
+        if ($useDoctrine) {
+            $loader->load('doctrine_orm_http_cache_purger.xml');
+        }
+
         $loader->load('http_cache_tags.xml');
+
         if (!$config['http_cache']['invalidation']['varnish_urls']) {
             return;
         }

src/Bridge/Symfony/Bundle/Resources/config/doctrine_orm.xml

@@ -103,16 +103,6 @@
             <tag name="kernel.event_listener" event="kernel.view" method="onKernelView" priority="32" />
         </service>
 
-        <service id="api_platform.doctrine.listener.http_cache.purge" class="ApiPlatform\Core\Bridge\Doctrine\EventListener\PurgeHttpCacheListener">
-            <argument type="service" id="api_platform.http_cache.purger" />
-            <argument type="service" id="api_platform.iri_converter" />
-            <argument type="service" id="api_platform.resource_class_resolver" />
-
-            <tag name="doctrine.event_listener" event="preUpdate" />
-            <tag name="doctrine.event_listener" event="onFlush" />
-            <tag name="doctrine.event_listener" event="postFlush" />
-        </service>
-
         <!-- Doctrine Query extensions -->
 
         <service id="api_platform.doctrine.orm.query_extension.eager_loading" class="ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\EagerLoadingExtension" public="false">

src/Bridge/Symfony/Bundle/Resources/config/doctrine_orm_http_cache_purger.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+
+        <!-- Event listener -->
+
+        <service id="api_platform.doctrine.listener.http_cache.purge" class="ApiPlatform\Core\Bridge\Doctrine\EventListener\PurgeHttpCacheListener">
+            <argument type="service" id="api_platform.http_cache.purger" />
+            <argument type="service" id="api_platform.iri_converter" />
+            <argument type="service" id="api_platform.resource_class_resolver" />
+
+            <tag name="doctrine.event_listener" event="preUpdate" />
+            <tag name="doctrine.event_listener" event="onFlush" />
+            <tag name="doctrine.event_listener" event="postFlush" />
+        </service>
+
+    </services>
+
+</container>

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -45,6 +45,7 @@ class ApiPlatformExtensionTest extends \PHPUnit_Framework_TestCase
             'jsonld' => ['mime_types' => ['application/ld+json']],
             'jsonhal' => ['mime_types' => ['application/hal+json']],
         ],
+        'http_cache' => ['invalidation' => ['enabled' => true]],
     ]];
 
     private $extension;
@@ -189,7 +190,7 @@ public function testEnableNelmioApiDoc()
         $this->extension->load(array_merge_recursive(self::DEFAULT_CONFIG, ['api_platform' => ['enable_nelmio_api_doc' => true]]), $containerBuilder);
     }
 
-    public function testEnablSecurity()
+    public function testEnableSecurity()
     {
         $containerBuilderProphecy = $this->getContainerBuilderProphecy();
         $containerBuilderProphecy->getParameter('kernel.bundles')->willReturn([
@@ -400,6 +401,9 @@ private function getContainerBuilderProphecy()
             'api_platform.swagger.command.swagger_command',
             'api_platform.swagger.normalizer.documentation',
             'api_platform.http_cache.listener.response.configure',
+            'api_platform.http_cache.purger.varnish',
+            'api_platform.http_cache.purger.varnish_client',
+            'api_platform.http_cache.listener.response.add_tags',
         ];
 
         foreach ($definitions as $definition) {
@@ -430,7 +434,6 @@ private function getContainerBuilderProphecy()
 
         $containerBuilderProphecy->getParameter('kernel.debug')->willReturn(false);
         $containerBuilderProphecy->getParameter('api_platform.api_resources_directory')->willReturn('Entity');
-        $containerBuilderProphecy->has('api_platform.doctrine.listener.http_cache.purge')->shouldBeCalled();
 
         return $containerBuilderProphecy;
     }