Only use attributes and decouple from Symfony\Component\HttpFoundation\Request

antograssiot · antograssiot · commit d8f6ea238bc2 · 2018-04-04T21:52:43.000+02:00
diff --git a/src/Api/FormatsProvider.php b/src/Api/FormatsProvider.php
@@ -15,8 +15,6 @@
 
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
-use ApiPlatform\Core\Util\RequestAttributesExtractor;
-use Symfony\Component\HttpFoundation\Request;
 
 /**
  * {@inheritdoc}
@@ -39,35 +37,25 @@ public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFa
     /**
      * Finds formats from a Resource class.
      */
-    public function fromRequest(Request $request): array
+    public function getFormatsFromAttributes(array $attributes): array
     {
-        if ($this->formats) {
-            return $this->formats;
-        }
-
-        if (!$attributes = RequestAttributesExtractor::extractAttributes($request)) {
-            $this->formats = $this->configuredFormats;
-
-            return $this->formats;
+        if (!$attributes) {
+            return $this->configuredFormats;
         }
 
         $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
 
         if (!$formats = (array) $resourceMetadata->getOperationAttribute($attributes, 'formats', [], true)) {
-            $this->formats = $this->configuredFormats;
-
-            return $this->formats;
+            return $this->configuredFormats;
         }
 
-        $this->populateFormats($formats);
-
-        return $this->formats;
+        return $this->getOperationFormats($formats);
     }
 
     /**
      * Filter and populate the acceptable formats.
      */
-    private function populateFormats(array $annotationFormats)
+    private function getOperationFormats(array $annotationFormats): array
     {
         $resourceFormats = [];
         foreach ($annotationFormats as $format => $value) {
@@ -82,6 +70,6 @@ private function populateFormats(array $annotationFormats)
             throw new InvalidArgumentException(sprintf("You either need to add the format '%s' to your project configuration or declare a mime type for it in your annotation.", $value));
         }
 
-        $this->formats = $resourceFormats;
+        return $resourceFormats;
     }
 }
diff --git a/src/Api/FormatsProviderInterface.php b/src/Api/FormatsProviderInterface.php
@@ -13,8 +13,6 @@
 
 namespace ApiPlatform\Core\Api;
 
-use Symfony\Component\HttpFoundation\Request;
-
 /**
  * Extracts formats for a given operation according to the retrieved Metadata.
  *
@@ -25,5 +23,5 @@ interface FormatsProviderInterface
     /**
      * Finds formats for an operation.
      */
-    public function fromRequest(Request $request): array;
+    public function getFormatsFromAttributes(array $attributes): array;
 }
diff --git a/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php b/src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php
@@ -18,6 +18,7 @@
 use ApiPlatform\Core\Exception\RuntimeException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Core\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
@@ -74,7 +75,7 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName
     public function __invoke(Request $request)
     {
         if (null !== $this->formatsProvider) {
-            $this->formats = $this->formatsProvider->fromRequest($request);
+            $this->formats = $this->formatsProvider->getFormatsFromAttributes(RequestAttributesExtractor::extractAttributes($request));
         }
 
         $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->title, $this->description, $this->version, $this->formats);
diff --git a/src/Documentation/Action/DocumentationAction.php b/src/Documentation/Action/DocumentationAction.php
@@ -16,6 +16,7 @@
 use ApiPlatform\Core\Api\FormatsProviderInterface;
 use ApiPlatform\Core\Documentation\Documentation;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Core\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
@@ -52,7 +53,7 @@ public function __invoke(Request $request = null): Documentation
             $request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + $context);
 
             if (null !== $this->formatsProvider) {
-                $this->formats = $this->formatsProvider->fromRequest($request);
+                $this->formats = $this->formatsProvider->getFormatsFromAttributes(RequestAttributesExtractor::extractAttributes($request));
             }
         }
 
diff --git a/src/EventListener/AddFormatListener.php b/src/EventListener/AddFormatListener.php
@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\EventListener;
 
 use ApiPlatform\Core\Api\FormatsProviderInterface;
+use ApiPlatform\Core\Util\RequestAttributesExtractor;
 use Negotiation\Negotiator;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
@@ -55,7 +56,7 @@ public function onKernelRequest(GetResponseEvent $event)
         }
 
         if (null !== $this->formatsProvider) {
-            $this->formats = $this->formatsProvider->fromRequest($request);
+            $this->formats = $this->formatsProvider->getFormatsFromAttributes(RequestAttributesExtractor::extractAttributes($request));
         }
 
         $this->populateMimeTypes();
diff --git a/src/EventListener/DeserializeListener.php b/src/EventListener/DeserializeListener.php
@@ -60,7 +60,7 @@ public function onKernelRequest(GetResponseEvent $event)
             return;
         }
         if (null !== $this->formatsProvider) {
-            $this->formats = $this->formatsProvider->fromRequest($request);
+            $this->formats = $this->formatsProvider->getFormatsFromAttributes($attributes);
         }
 
         $format = $this->getFormat($request);
diff --git a/tests/Api/FormatsProviderTest.php b/tests/Api/FormatsProviderTest.php
@@ -17,7 +17,6 @@
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\HttpFoundation\Request;
 
 /**
  * @author Anthony GRASSIOT <antograssiot@free.fr>
@@ -26,48 +25,44 @@ class FormatsProviderTest extends TestCase
 {
     public function testNoResourceClass()
     {
-        $request = new Request();
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadataFactoryProphecy->create()->shouldNotBeCalled();
 
         $formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => 'application/ld+json']);
 
-        $this->assertSame(['jsonld' => 'application/ld+json'], $formatProvider->fromRequest($request));
+        $this->assertSame(['jsonld' => 'application/ld+json'], $formatProvider->getFormatsFromAttributes([]));
     }
 
     public function testResourceClassWithoutFilters()
     {
-        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadataFactoryProphecy->create('Foo')->willReturn(new ResourceMetadata())->shouldBeCalled();
 
         $formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json']]);
 
-        $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->fromRequest($request));
+        $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']));
     }
 
     public function testResourceClassWithFilters()
     {
-        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['formats' => 'jsonld']);
         $resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
 
         $formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json'], 'json' => ['application/json']]);
 
-        $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->fromRequest($request));
+        $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']));
     }
 
     public function testResourceClassWithFiltersOverRiddingMimeTypes()
     {
-        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['formats' => ['jsonld' => ['application/foo'], 'bar' => ['application/bar', 'application/baz'], 'buz' => 'application/fuz']]);
         $resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
 
         $formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json'], 'json' => ['application/json']]);
 
-        $this->assertSame(['jsonld' => ['application/foo'], 'bar' => ['application/bar', 'application/baz'], 'buz' => ['application/fuz']], $formatProvider->fromRequest($request));
+        $this->assertSame(['jsonld' => ['application/foo'], 'bar' => ['application/bar', 'application/baz'], 'buz' => ['application/fuz']], $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']));
     }
 
     /**
@@ -76,13 +71,12 @@ public function testResourceClassWithFiltersOverRiddingMimeTypes()
      */
     public function testBadFormatShortDeclaration()
     {
-        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['formats' => ['foo']]);
         $resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
 
         $formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json']]);
 
-        $formatProvider->fromRequest($request);
+        $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']);
     }
 }
diff --git a/tests/EventListener/AddFormatListenerTest.php b/tests/EventListener/AddFormatListenerTest.php
@@ -189,15 +189,15 @@ public function testInvalidRouteFormat()
 
     public function testResourceClassSupportedRequestFormat()
     {
-        $request = new Request([], [], ['_api_resource_class' => 'Foo']);
+        $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);
         $request->setRequestFormat('csv');
 
         $eventProphecy = $this->prophesize(GetResponseEvent::class);
         $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
         $event = $eventProphecy->reveal();
 
         $formatsProviderProphecy = $this->prophesize(FormatsProviderInterface::class);
-        $formatsProviderProphecy->fromRequest($request)->willReturn(['csv' => ['text/csv']])->shouldbeCalled();
+        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get', 'receive' => true])->willReturn(['csv' => ['text/csv']])->shouldbeCalled();
 
         $listener = new AddFormatListener(new Negotiator(), ['xml' => ['text/xml']], $formatsProviderProphecy->reveal());
         $listener->onKernelRequest($event);
diff --git a/tests/EventListener/DeserializeListenerTest.php b/tests/EventListener/DeserializeListenerTest.php
@@ -148,7 +148,7 @@ public function testDeserializeResourceClassSupportedFormat(string $method, bool
         $serializerContextBuilderProphecy->createFromRequest(Argument::type(Request::class), false, Argument::type('array'))->willReturn([])->shouldBeCalled();
 
         $formatsProviderProphecy = $this->prophesize(FormatsProviderInterface::class);
-        $formatsProviderProphecy->fromRequest($request)->willReturn(self::FORMATS)->shouldbeCalled();
+        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true])->willReturn(self::FORMATS)->shouldbeCalled();
 
         $listener = new DeserializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal(), ['xml' => ['text/xml']], $formatsProviderProphecy->reveal());
 

Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,6 @@`
`13`	`13`
`14`	`14`	`namespace ApiPlatform\Core\Api;`
`15`	`15`
`16`		`-use Symfony\Component\HttpFoundation\Request;`
`17`		`-`
`18`	`16`	`/**`
`19`	`17`	`* Extracts formats for a given operation according to the retrieved Metadata.`
`20`	`18`	`*`
`@@ -25,5 +23,5 @@ interface FormatsProviderInterface`
`25`	`23`	`/**`
`26`	`24`	`* Finds formats for an operation.`
`27`	`25`	`*/`
`28`		`- public function fromRequest(Request $request): array;`
	`26`	`+ public function getFormatsFromAttributes(array $attributes): array;`
`29`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`use ApiPlatform\Core\Api\FormatsProviderInterface;`
`17`	`17`	`use ApiPlatform\Core\Documentation\Documentation;`
`18`	`18`	`use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;`
	`19`	`+use ApiPlatform\Core\Util\RequestAttributesExtractor;`
`19`	`20`	`use Symfony\Component\HttpFoundation\Request;`
`20`	`21`
`21`	`22`	`/**`
`@@ -52,7 +53,7 @@ public function __invoke(Request $request = null): Documentation`
`52`	`53`	`$request->attributes->set('_api_normalization_context', $request->attributes->get('_api_normalization_context', []) + $context);`
`53`	`54`
`54`	`55`	`if (null !== $this->formatsProvider) {`
`55`		`- $this->formats = $this->formatsProvider->fromRequest($request);`
	`56`	`+ $this->formats = $this->formatsProvider->getFormatsFromAttributes(RequestAttributesExtractor::extractAttributes($request));`
`56`	`57`	`}`
`57`	`58`	`}`
`58`	`59`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`namespace ApiPlatform\Core\EventListener;`
`15`	`15`
`16`	`16`	`use ApiPlatform\Core\Api\FormatsProviderInterface;`
	`17`	`+use ApiPlatform\Core\Util\RequestAttributesExtractor;`
`17`	`18`	`use Negotiation\Negotiator;`
`18`	`19`	`use Symfony\Component\HttpFoundation\Request;`
`19`	`20`	`use Symfony\Component\HttpKernel\Event\GetResponseEvent;`
`@@ -55,7 +56,7 @@ public function onKernelRequest(GetResponseEvent $event)`
`55`	`56`	`}`
`56`	`57`
`57`	`58`	`if (null !== $this->formatsProvider) {`
`58`		`- $this->formats = $this->formatsProvider->fromRequest($request);`
	`59`	`+ $this->formats = $this->formatsProvider->getFormatsFromAttributes(RequestAttributesExtractor::extractAttributes($request));`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`$this->populateMimeTypes();`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public function onKernelRequest(GetResponseEvent $event)`
`60`	`60`	`return;`
`61`	`61`	`}`
`62`	`62`	`if (null !== $this->formatsProvider) {`
`63`		`- $this->formats = $this->formatsProvider->fromRequest($request);`
	`63`	`+ $this->formats = $this->formatsProvider->getFormatsFromAttributes($attributes);`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`$format = $this->getFormat($request);`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,6 @@`
`17`	`17`	`use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;`
`18`	`18`	`use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;`
`19`	`19`	`use PHPUnit\Framework\TestCase;`
`20`		`-use Symfony\Component\HttpFoundation\Request;`
`21`	`20`
`22`	`21`	`/**`
`23`	`22`	`* @author Anthony GRASSIOT <antograssiot@free.fr>`
`@@ -26,48 +25,44 @@ class FormatsProviderTest extends TestCase`
`26`	`25`	`{`
`27`	`26`	`public function testNoResourceClass()`
`28`	`27`	`{`
`29`		`- $request = new Request();`
`30`	`28`	`$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);`
`31`	`29`	`$resourceMetadataFactoryProphecy->create()->shouldNotBeCalled();`
`32`	`30`
`33`	`31`	`$formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => 'application/ld+json']);`
`34`	`32`
`35`		`- $this->assertSame(['jsonld' => 'application/ld+json'], $formatProvider->fromRequest($request));`
	`33`	`+ $this->assertSame(['jsonld' => 'application/ld+json'], $formatProvider->getFormatsFromAttributes([]));`
`36`	`34`	`}`
`37`	`35`
`38`	`36`	`public function testResourceClassWithoutFilters()`
`39`	`37`	`{`
`40`		`- $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);`
`41`	`38`	`$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);`
`42`	`39`	`$resourceMetadataFactoryProphecy->create('Foo')->willReturn(new ResourceMetadata())->shouldBeCalled();`
`43`	`40`
`44`	`41`	`$formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json']]);`
`45`	`42`
`46`		`- $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->fromRequest($request));`
	`43`	`+ $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']));`
`47`	`44`	`}`
`48`	`45`
`49`	`46`	`public function testResourceClassWithFilters()`
`50`	`47`	`{`
`51`		`- $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);`
`52`	`48`	`$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);`
`53`	`49`	`$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['formats' => 'jsonld']);`
`54`	`50`	`$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();`
`55`	`51`
`56`	`52`	`$formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json'], 'json' => ['application/json']]);`
`57`	`53`
`58`		`- $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->fromRequest($request));`
	`54`	`+ $this->assertSame(['jsonld' => ['application/ld+json']], $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']));`
`59`	`55`	`}`
`60`	`56`
`61`	`57`	`public function testResourceClassWithFiltersOverRiddingMimeTypes()`
`62`	`58`	`{`
`63`		`- $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);`
`64`	`59`	`$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);`
`65`	`60`	`$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['formats' => ['jsonld' => ['application/foo'], 'bar' => ['application/bar', 'application/baz'], 'buz' => 'application/fuz']]);`
`66`	`61`	`$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();`
`67`	`62`
`68`	`63`	`$formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json'], 'json' => ['application/json']]);`
`69`	`64`
`70`		`- $this->assertSame(['jsonld' => ['application/foo'], 'bar' => ['application/bar', 'application/baz'], 'buz' => ['application/fuz']], $formatProvider->fromRequest($request));`
	`65`	`+ $this->assertSame(['jsonld' => ['application/foo'], 'bar' => ['application/bar', 'application/baz'], 'buz' => ['application/fuz']], $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']));`
`71`	`66`	`}`
`72`	`67`
`73`	`68`	`/**`
`@@ -76,13 +71,12 @@ public function testResourceClassWithFiltersOverRiddingMimeTypes()`
`76`	`71`	`*/`
`77`	`72`	`public function testBadFormatShortDeclaration()`
`78`	`73`	`{`
`79`		`- $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);`
`80`	`74`	`$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);`
`81`	`75`	`$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['formats' => ['foo']]);`
`82`	`76`	`$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();`
`83`	`77`
`84`	`78`	`$formatProvider = new FormatsProvider($resourceMetadataFactoryProphecy->reveal(), ['jsonld' => ['application/ld+json']]);`
`85`	`79`
`86`		`- $formatProvider->fromRequest($request);`
	`80`	`+ $formatProvider->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get']);`
`87`	`81`	`}`
`88`	`82`	`}`