Merge pull request #1780 from bendavies/serializer-listener-performance

Serializer listener performance - anonymous class not serializable

Author: meyerbaptiste

src/EventListener/SerializeListener.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\EventListener;
 
 use ApiPlatform\Core\Exception\RuntimeException;
+use ApiPlatform\Core\Serializer\ResourceList;
 use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
 use ApiPlatform\Core\Util\RequestAttributesExtractor;
 use Symfony\Component\HttpFoundation\Request;
@@ -59,11 +60,7 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
         }
 
         $context = $this->serializerContextBuilder->createFromRequest($request, true, $attributes);
-        $resources = new class() extends \ArrayObject {
-            public function serialize()
-            {
-            }
-        };
+        $resources = new ResourceList();
         $context['resources'] = &$resources;
         $request->attributes->set('_api_normalization_context', $context);
 

src/Serializer/ResourceList.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Serializer;
+
+/**
+ * @internal
+ */
+class ResourceList extends \ArrayObject
+{
+    public function serialize()
+    {
+    }
+}

tests/EventListener/SerializeListenerTest.php

@@ -14,6 +14,7 @@
 namespace ApiPlatform\Core\Tests\EventListener;
 
 use ApiPlatform\Core\EventListener\SerializeListener;
+use ApiPlatform\Core\Serializer\ResourceList;
 use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
@@ -105,11 +106,22 @@ public function testSerializeCollectionOperation()
     {
         $expectedContext = ['request_uri' => '', 'resource_class' => 'Foo', 'collection_operation_name' => 'get'];
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize(Argument::any(), 'xml', Argument::that(function ($context) use ($expectedContext) {
-            unset($context['resources']);
 
-            return $context === $expectedContext;
-        }))->willReturn('bar')->shouldBeCalled();
+        $serializerProphecy
+            ->serialize(
+                Argument::any(),
+                'xml',
+                Argument::allOf(
+                    Argument::that(function (array $context) {
+                        return $context['resources'] instanceof ResourceList;
+                    }),
+                    Argument::withEntry('request_uri', ''),
+                    Argument::withEntry('resource_class', 'Foo'),
+                    Argument::withEntry('collection_operation_name', 'get')
+                )
+            )
+            ->willReturn('bar')
+            ->shouldBeCalled();
 
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'get']);
         $request->setRequestFormat('xml');
@@ -130,11 +142,21 @@ public function testSerializeItemOperation()
     {
         $expectedContext = ['request_uri' => '', 'resource_class' => 'Foo', 'item_operation_name' => 'get'];
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize(Argument::any(), 'xml', Argument::that(function ($context) use ($expectedContext) {
-            unset($context['resources']);
-
-            return $context === $expectedContext;
-        }))->willReturn('bar')->shouldBeCalled();
+        $serializerProphecy
+            ->serialize(
+                Argument::any(),
+                'xml',
+                Argument::allOf(
+                    Argument::that(function (array $context) {
+                        return $context['resources'] instanceof ResourceList;
+                    }),
+                    Argument::withEntry('request_uri', ''),
+                    Argument::withEntry('resource_class', 'Foo'),
+                    Argument::withEntry('item_operation_name', 'get')
+                )
+            )
+            ->willReturn('bar')
+            ->shouldBeCalled();
 
         $request = new Request([], [], ['_api_resource_class' => 'Foo', '_api_item_operation_name' => 'get']);
         $request->setRequestFormat('xml');

tests/Serializer/ResourceListTest.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Serializer;
+
+use ApiPlatform\Core\Serializer\ResourceList;
+use PHPUnit\Framework\TestCase;
+
+class ResourceListTest extends TestCase
+{
+    /**
+     * @var ResourceList
+     */
+    private $resourceList;
+
+    public function setUp()
+    {
+        $this->resourceList = new ResourceList();
+    }
+
+    public function testImplementsArrayObject()
+    {
+        $this->assertInstanceOf(\ArrayObject::class, $this->resourceList);
+    }
+
+    public function testSerialize()
+    {
+        $this->resourceList['foo'] = 'bar';
+
+        $this->assertEquals('N;', \serialize($this->resourceList));
+    }
+}