Do not try do retrieve object in ItemNormalizer $context['resource_class'] is not defined (#2326)

* Do not try do retrieve object in ItemNormalizer $context['resource_class'] is not defined

We store some document in Elasticsearch and we hydrate them with the Serializer.
But the `ItemNormalizer` raise an error because the `resource_class` is not defined.

* Added some log when the $context['resource_class'] is missing in ItemNormalizer

Author: lyrixx

src/Serializer/ItemNormalizer.php

@@ -13,7 +13,17 @@
 
 namespace ApiPlatform\Core\Serializer;
 
+use ApiPlatform\Core\Api\IriConverterInterface;
+use ApiPlatform\Core\Api\ResourceClassResolverInterface;
+use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
+use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
+use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
  * Generic item normalizer.
@@ -24,6 +34,15 @@
  */
 class ItemNormalizer extends AbstractItemNormalizer
 {
+    private $logger;
+
+    public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, IriConverterInterface $iriConverter, ResourceClassResolverInterface $resourceClassResolver, PropertyAccessorInterface $propertyAccessor = null, NameConverterInterface $nameConverter = null, ClassMetadataFactoryInterface $classMetadataFactory = null, ItemDataProviderInterface $itemDataProvider = null, bool $allowPlainIdentifiers = false, LoggerInterface $logger = null)
+    {
+        parent::__construct($propertyNameCollectionFactory, $propertyMetadataFactory, $iriConverter, $resourceClassResolver, $propertyAccessor, $nameConverter, $classMetadataFactory, $itemDataProvider, $allowPlainIdentifiers);
+
+        $this->logger = $logger ?: new NullLogger();
+    }
+
     /**
      * {@inheritdoc}
      *
@@ -37,7 +56,14 @@ public function denormalize($data, $class, $format = null, array $context = [])
                 throw new InvalidArgumentException('Update is not allowed for this operation.');
             }
 
-            $this->updateObjectToPopulate($data, $context);
+            if (isset($context['resource_class'])) {
+                $this->updateObjectToPopulate($data, $context);
+            } else {
+                // See https://github.com/api-platform/core/pull/2326 to understand this message.
+                $this->logger->warning('The "resource_class" key is missing from the context.', [
+                    'context' => $context,
+                ]);
+            }
         }
 
         return parent::denormalize($data, $class, $format, $context);

tests/Serializer/ItemNormalizerTest.php

@@ -186,4 +186,38 @@ public function testDenormalizeWithIdAndUpdateNotAllowed()
         $normalizer->setSerializer($serializerProphecy->reveal());
         $normalizer->denormalize(['id' => '12', 'name' => 'hello'], Dummy::class, null, $context);
     }
+
+    public function testDenormalizeWithIdAndNoResourceClass()
+    {
+        $context = [];
+
+        $propertyNameCollection = new PropertyNameCollection(['id', 'name']);
+        $propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);
+        $propertyNameCollectionFactoryProphecy->create(Dummy::class, [])->willReturn($propertyNameCollection)->shouldBeCalled();
+
+        $propertyMetadataFactory = new PropertyMetadata(null, null, true, true);
+        $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
+        $propertyMetadataFactoryProphecy->create(Dummy::class, 'id', [])->willReturn($propertyMetadataFactory)->shouldBeCalled();
+        $propertyMetadataFactoryProphecy->create(Dummy::class, 'name', [])->willReturn($propertyMetadataFactory)->shouldBeCalled();
+
+        $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
+
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
+
+        $serializerProphecy = $this->prophesize(SerializerInterface::class);
+        $serializerProphecy->willImplement(DenormalizerInterface::class);
+
+        $normalizer = new ItemNormalizer(
+            $propertyNameCollectionFactoryProphecy->reveal(),
+            $propertyMetadataFactoryProphecy->reveal(),
+            $iriConverterProphecy->reveal(),
+            $resourceClassResolverProphecy->reveal()
+        );
+        $normalizer->setSerializer($serializerProphecy->reveal());
+
+        $object = $normalizer->denormalize(['id' => '42', 'name' => 'hello'], Dummy::class, null, $context);
+        $this->assertInstanceOf(Dummy::class, $object);
+        $this->assertSame('42', $object->getId());
+        $this->assertSame('hello', $object->getName());
+    }
 }