inline and add deprecation notice

Author: Rodrigue Villetard

src/Bridge/Doctrine/EventListener/WriteListener.php

@@ -58,9 +58,7 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
 
         switch ($request->getMethod()) {
             case 'POST':
-                $event->setControllerResult(
-                    $objectManager->persist($controllerResult) ?? $controllerResult
-                );
+                $objectManager->persist($controllerResult);
                 break;
             case 'DELETE':
                 $objectManager->remove($controllerResult);

src/EventListener/WriteListener.php

@@ -50,10 +50,13 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
             case 'PUT':
             case 'PATCH':
             case 'POST':
-                $event->setControllerResult(
-                    $this->dataPersister->persist($controllerResult)
-                    ?? $controllerResult
-                );
+                $persistResult = $this->dataPersister->persist($controllerResult);
+
+                if (null === $persistResult) {
+                    @trigger_error(sprintf('Returning void from %s::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3, an object should always be returned.', DataPersisterInterface::class), E_USER_DEPRECATED);
+                }
+
+                $event->setControllerResult($persistResult ?? $controllerResult);
                 break;
             case 'DELETE':
                 $this->dataPersister->remove($controllerResult);

src/GraphQl/Resolver/Factory/ItemMutationResolverFactory.php

@@ -93,9 +93,13 @@ public function __invoke(string $resourceClass = null, string $rootClass = null,
                     $context += $resourceMetadata->getGraphqlAttribute($operationName, 'denormalization_context', [], true);
                     $item = $this->normalizer->denormalize($args['input'], $resourceClass, ItemNormalizer::FORMAT, $context);
                     $this->validate($item, $info, $resourceMetadata, $operationName);
-                    $persistResult = $this->dataPersister->persist($item) ?? $item;
+                    $persistResult = $this->dataPersister->persist($item);
 
-                    return $this->normalizer->normalize($persistResult, ItemNormalizer::FORMAT, $normalizationContext) + $data;
+                    if (null === $persistResult) {
+                        @trigger_error(sprintf('Returning void from %s::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3, an object should always be returned.', DataPersisterInterface::class), E_USER_DEPRECATED);
+                    }
+
+                    return $this->normalizer->normalize($persistResult ?? $item, ItemNormalizer::FORMAT, $normalizationContext) + $data;
                 case 'delete':
                     if ($item) {
                         $this->dataPersister->remove($item);

tests/EventListener/WriteListenerTest.php

@@ -31,6 +31,37 @@ public function testOnKernelViewWithControllerResultAndPersist()
         $dummy = new Dummy();
         $dummy->setName('Dummyrino');
 
+        $dataPersisterProphecy = $this->prophesize(DataPersisterInterface::class);
+        $dataPersisterProphecy->supports($dummy)->willReturn(true)->shouldBeCalled();
+        $dataPersisterProphecy->persist($dummy)->willReturn($dummy)->shouldBeCalled();
+
+        $request = new Request();
+        $request->attributes->set('_api_resource_class', Dummy::class);
+
+        $event = new GetResponseForControllerResultEvent(
+            $this->prophesize(HttpKernelInterface::class)->reveal(),
+            $request,
+            HttpKernelInterface::MASTER_REQUEST,
+            $dummy
+        );
+
+        foreach (['PATCH', 'PUT', 'POST'] as $httpMethod) {
+            $request->setMethod($httpMethod);
+
+            (new WriteListener($dataPersisterProphecy->reveal()))->onKernelView($event);
+            $this->assertSame($dummy, $event->getControllerResult());
+        }
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation Returning void from ApiPlatform\Core\DataPersister\DataPersisterInterface::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3, an object should always be returned.
+     */
+    public function testOnKernelViewWithControllerResultAndPersistReturningVoid()
+    {
+        $dummy = new Dummy();
+        $dummy->setName('Dummyrino');
+
         $dataPersisterProphecy = $this->prophesize(DataPersisterInterface::class);
         $dataPersisterProphecy->supports($dummy)->willReturn(true)->shouldBeCalled();
         $dataPersisterProphecy->persist($dummy)->shouldBeCalled();