Merge branch '2.1'

Author: dunglas

CHANGELOG.md

@@ -31,7 +31,7 @@
 * Fix the Doctrine query generated to retrieve nested subresources
 * Fix several bugs in the automatic eager loading support
 * Fix a bug occurring when passing nor an IRI nor an array in an embedded relation
-* Allow to pass request `0` items per page in collections
+* Allow to request `0` items per page in collections
 * Also copy the `Host` from the Symfony Router
 * `Paginator::getLastPage()` now always returns a `float`
 * Minor performance improvements

src/Bridge/Doctrine/Orm/Extension/OrderExtension.php

@@ -59,7 +59,9 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
                         $field = $order;
                         $order = 'ASC';
                     }
-                    if (false === ($pos = strpos($field, '.'))) {
+
+                    if (false === ($pos = \strpos($field, '.'))
+                        || isset($classMetaData->embeddedClasses[\substr($field, 0, $pos)])) {
                         // Configure default filter with property
                         $field = "{$rootAlias}.{$field}";
                     } else {

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

@@ -197,6 +197,12 @@ private function registerMetadataConfiguration(ContainerBuilder $container, arra
 
         list($xmlResources, $yamlResources) = $this->getResourcesToWatch($container, $config['mapping']['paths']);
 
+        if (isset($config['resource_class_directories']) && $config['resource_class_directories']) {
+            $container->setParameter('api_platform.resource_class_directories', array_merge(
+                $config['resource_class_directories'], $container->getParameter('api_platform.resource_class_directories')
+            ));
+        }
+
         $container->getDefinition('api_platform.metadata.extractor.xml')->addArgument($xmlResources);
 
         if (class_exists(Annotation::class)) {

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

@@ -187,6 +187,10 @@ public function getConfigTreeBuilder()
                     ->end()
                 ->end()
 
+                ->arrayNode('resource_class_directories')
+                    ->prototype('scalar')->end()
+                ->end()
+
                 ->arrayNode('http_cache')
                     ->addDefaultsIfNotSet()
                     ->children()
@@ -258,7 +262,7 @@ private function addExceptionToStatusSection(ArrayNodeDefinition $rootNode)
                                 }
 
                                 if (\defined($httpStatusCodeConstant = sprintf('%s::%s', Response::class, $httpStatusCode))) {
-                                    @trigger_error(sprintf('Using a string "%s" as a constant of the "%s" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony\'s custom YAML extension for PHP constants instead (i.e. "!php/const %s").', $httpStatusCode, Response::class, $httpStatusCodeConstant), E_USER_DEPRECATED);
+                                    @trigger_error(sprintf('Using a string "%s" as a constant of the "%s" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony\'s custom YAML extension for PHP constants instead (i.e. "!php/const:%s").', $httpStatusCode, Response::class, $httpStatusCodeConstant), E_USER_DEPRECATED);
 
                                     $httpStatusCode = \constant($httpStatusCodeConstant);
                                 }

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

@@ -44,6 +44,8 @@
             <tag name="routing.loader" />
         </service>
 
+        <service id="ApiPlatform\Core\Api\UrlGeneratorInterface" alias="api_platform.router" />
+
         <service id="api_platform.router" class="ApiPlatform\Core\Bridge\Symfony\Routing\Router" public="false">
             <argument type="service" id="router" />
         </service>

src/Documentation/Action/DocumentationAction.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Documentation\Documentation;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Generates the API documentation.
@@ -38,8 +39,10 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName
         $this->formats = $formats;
     }
 
-    public function __invoke(): Documentation
+    public function __invoke(Request $request): Documentation
     {
+        $request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + ['base_url' => $request->getBaseUrl()]);
+
         return new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);
     }
 }

src/EventListener/SerializeListener.php

@@ -91,7 +91,7 @@ private function serializeRawData(GetResponseForControllerResultEvent $event, Re
         }
 
         if (\is_object($controllerResult)) {
-            $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat()));
+            $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat(), $request->attributes->get('_api_normalization_context', [])));
 
             return;
         }

tests/Bridge/Doctrine/Orm/Extension/OrderExtensionTest.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddedDummy;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\QueryBuilder;
@@ -139,4 +140,27 @@ public function testApplyToCollectionWithOrderOverriddenWithAssociation()
         $orderExtensionTest = new OrderExtension('asc', $resourceMetadataFactoryProphecy->reveal());
         $orderExtensionTest->applyToCollection($queryBuilder, new QueryNameGenerator(), Dummy::class);
     }
+
+    public function testApplyToCollectionWithOrderOverriddenWithEmbeddedAssociation()
+    {
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $queryBuilderProphecy = $this->prophesize(QueryBuilder::class);
+        $queryBuilderProphecy->getRootAliases()->willReturn(['o']);
+        $queryBuilderProphecy->addOrderBy('o.embeddedDummy.dummyName', 'DESC')->shouldBeCalled();
+
+        $classMetadataProphecy = $this->prophesize(ClassMetadata::class);
+        $classMetadataProphecy->getIdentifier()->shouldBeCalled()->willReturn(['id']);
+        $classMetadataProphecy->embeddedClasses = ['embeddedDummy' => []];
+
+        $resourceMetadataFactoryProphecy->create(EmbeddedDummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['embeddedDummy.dummyName' => 'DESC']]));
+
+        $emProphecy = $this->prophesize(EntityManager::class);
+        $emProphecy->getClassMetadata(EmbeddedDummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
+
+        $queryBuilderProphecy->getEntityManager()->shouldBeCalled()->willReturn($emProphecy->reveal());
+
+        $queryBuilder = $queryBuilderProphecy->reveal();
+        $orderExtensionTest = new OrderExtension('asc', $resourceMetadataFactoryProphecy->reveal());
+        $orderExtensionTest->applyToCollection($queryBuilder, new QueryNameGenerator(), EmbeddedDummy::class);
+    }
 }

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

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Api\FilterInterface;
 use ApiPlatform\Core\Api\IriConverterInterface;
+use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\EagerLoadingExtension;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\FilterEagerLoadingExtension;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\FilterExtension;
@@ -274,6 +275,28 @@ public function testEnableSecurity()
         $this->extension->load(self::DEFAULT_CONFIG, $containerBuilder);
     }
 
+    public function testAddResourceClassDirectories()
+    {
+        $containerBuilderProphecy = $this->getBaseContainerBuilderProphecy();
+        $containerBuilderProphecy->getParameter('api_platform.resource_class_directories')->shouldBeCalled()->willReturn([]);
+        $i = 0;
+        // it's called once from getResourcesToWatch and then if the configuration exists
+        $containerBuilderProphecy->setParameter('api_platform.resource_class_directories', Argument::that(function ($arg) use ($i) {
+            if (0 === $i++) {
+                return $arg;
+            }
+
+            if (!in_array('foobar', $arg, true)) {
+                throw new \Exception('"foobar" should be in "resource_class_directories"');
+            }
+
+            return $arg;
+        }))->shouldBeCalled();
+        $containerBuilder = $containerBuilderProphecy->reveal();
+
+        $this->extension->load(array_merge_recursive(self::DEFAULT_CONFIG, ['api_platform' => ['resource_class_directories' => ['foobar']]]), $containerBuilder);
+    }
+
     /**
      * @expectedException \ApiPlatform\Core\Exception\RuntimeException
      * @expectedExceptionMessageRegExp /Unsupported mapping type in ".+", supported types are XML & Yaml\./
@@ -509,6 +532,7 @@ private function getPartialContainerBuilderProphecy($test = false)
             'api_platform.property_info' => 'property_info',
             'api_platform.serializer' => 'serializer',
             IriConverterInterface::class => 'api_platform.iri_converter',
+            UrlGeneratorInterface::class => 'api_platform.router',
             SerializerContextBuilderInterface::class => 'api_platform.serializer.context_builder',
             CollectionDataProviderInterface::class => 'api_platform.collection_data_provider',
             ItemDataProviderInterface::class => 'api_platform.item_data_provider',

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

@@ -134,12 +134,13 @@ public function testDefaultConfig()
                 'public' => null,
             ],
             'allow_plain_identifiers' => false,
+            'resource_class_directories' => [],
         ], $config);
     }
 
     /**
      * @group legacy
-     * @expectedDeprecation Using a string "HTTP_INTERNAL_SERVER_ERROR" as a constant of the "Symfony\Component\HttpFoundation\Response" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony's custom YAML extension for PHP constants instead (i.e. "!php/const Symfony\Component\HttpFoundation\Response::HTTP_INTERNAL_SERVER_ERROR").
+     * @expectedDeprecation Using a string "HTTP_INTERNAL_SERVER_ERROR" as a constant of the "Symfony\Component\HttpFoundation\Response" class is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3. Use the Symfony's custom YAML extension for PHP constants instead (i.e. "!php/const:Symfony\Component\HttpFoundation\Response::HTTP_INTERNAL_SERVER_ERROR").
      */
     public function testLegacyExceptionToStatusConfig()
     {

tests/Documentation/Action/DocumentationActionTest.php

@@ -18,6 +18,8 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceNameCollection;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * @author Amrouche Hamza <[email protected]>
@@ -26,9 +28,15 @@ class DocumentationActionTest extends TestCase
 {
     public function testDocumentationAction()
     {
+        $requestProphecy = $this->prophesize(Request::class);
+        $attributesProphecy = $this->prophesize(ParameterBagInterface::class);
         $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
         $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection(['dummies']));
+        $requestProphecy->attributes = $attributesProphecy->reveal();
+        $requestProphecy->getBaseUrl()->willReturn('/api')->shouldBeCalledTimes(1);
+        $attributesProphecy->get('_api_normalization_context', [])->willReturn(['foo' => 'bar'])->shouldBeCalledTimes(1);
+        $attributesProphecy->set('_api_normalization_context', ['foo' => 'bar', 'base_url' => '/api'])->shouldBeCalledTimes(1);
         $documentation = new DocumentationAction($resourceNameCollectionFactoryProphecy->reveal(), 'My happy hippie api', 'lots of chocolate', '1.0.0', ['formats' => ['jsonld' => 'application/ld+json']]);
-        $this->assertEquals(new Documentation(new ResourceNameCollection(['dummies']), 'My happy hippie api', 'lots of chocolate', '1.0.0', ['formats' => ['jsonld' => 'application/ld+json']]), $documentation());
+        $this->assertEquals(new Documentation(new ResourceNameCollection(['dummies']), 'My happy hippie api', 'lots of chocolate', '1.0.0', ['formats' => ['jsonld' => 'application/ld+json']]), $documentation($requestProphecy->reveal()));
     }
 }