Make sure to always use the persistResult for follow-up actions

Not using the persistResult could cause issues in generating the IRI for
new resources because the ID was not set on the controllerResult but
only on the persistResult for example.

Author: Tjeerd

src/EventListener/WriteListener.php

@@ -61,10 +61,11 @@ public function onKernelView(GetResponseForControllerResultEvent $event): void
 
                 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);
+                } else {
+                    $controllerResult = $persistResult;
+                    $event->setControllerResult($controllerResult);
                 }
 
-                $event->setControllerResult($persistResult ?? $controllerResult);
-
                 if (null === $this->iriConverter) {
                     return;
                 }

tests/EventListener/WriteListenerTest.php

@@ -95,25 +95,25 @@ public function testOnKernelViewWithControllerResultAndPersistReturningVoid()
 
     /**
      * @see https://github.com/api-platform/core/issues/1799
+     * @see https://github.com/api-platform/core/issues/2692
      */
     public function testOnKernelViewWithControllerResultAndPersistWithImmutableResource()
     {
         $dummy = new Dummy();
         $dummy->setName('Dummyrino');
 
         $dummy2 = new Dummy();
+        $dummy2->setId(2);
         $dummy2->setName('Dummyferoce');
 
         $dataPersisterProphecy = $this->prophesize(DataPersisterInterface::class);
-        $dataPersisterProphecy->supports($dummy, Argument::type('array'))->willReturn(true)->shouldBeCalled();
+        $dataPersisterProphecy->supports($dummy, Argument::type('array'))->willReturn(true);
+        $dataPersisterProphecy->persist($dummy, Argument::type('array'))->willReturn($dummy2);
 
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
-        $iriConverterProphecy->getIriFromItem($dummy)->willReturn('/dummy/1')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($dummy2)->willReturn('/dummy/2');
 
-        $dataPersisterProphecy
-            ->persist($dummy, Argument::type('array'))
-            ->willReturn($dummy2) // Persist is not mutating $dummy, but return a brand new technically unrelated object instead
-            ->shouldBeCalled();
+        $writeListener = new WriteListener($dataPersisterProphecy->reveal(), $iriConverterProphecy->reveal());
 
         $request = new Request([], [], ['_api_resource_class' => Dummy::class]);
 
@@ -128,10 +128,10 @@ public function testOnKernelViewWithControllerResultAndPersistWithImmutableResou
             $request->setMethod($httpMethod);
             $request->attributes->set(sprintf('_api_%s_operation_name', 'POST' === $httpMethod ? 'collection' : 'item'), strtolower($httpMethod));
 
-            (new WriteListener($dataPersisterProphecy->reveal(), $iriConverterProphecy->reveal()))->onKernelView($event);
+            $writeListener->onKernelView($event);
 
             $this->assertSame($dummy2, $event->getControllerResult());
-            $this->assertEquals('/dummy/1', $request->attributes->get('_api_write_item_iri'));
+            $this->assertEquals('/dummy/2', $request->attributes->get('_api_write_item_iri'));
         }
     }