Merge pull request #2226 from paxal/fix/doctrine_deferred_explicit_2.3

Persist doctrine entities with DEFERRED_EXPLICIT change tracking policy

Author: soyuka

src/Bridge/Doctrine/Common/DataPersister.php

@@ -17,6 +17,7 @@
 use ApiPlatform\Core\Util\ClassInfoTrait;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\Common\Persistence\ObjectManager as DoctrineObjectManager;
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
 
 /**
  * Data persister for Doctrine.
@@ -51,7 +52,7 @@ public function persist($data)
             return $data;
         }
 
-        if (!$manager->contains($data)) {
+        if (!$manager->contains($data) || $this->isDeferredExplicit($manager, $data)) {
             $manager->persist($data);
         }
 
@@ -84,4 +85,19 @@ private function getManager($data)
     {
         return \is_object($data) ? $this->managerRegistry->getManagerForClass($this->getObjectClass($data)) : null;
     }
+
+    /**
+     * Checks if doctrine does not manage data automatically.
+     *
+     * @return bool
+     */
+    private function isDeferredExplicit(DoctrineObjectManager $manager, $data)
+    {
+        $classMetadata = $manager->getClassMetadata($this->getObjectClass($data));
+        if ($classMetadata instanceof ClassMetadataInfo && \method_exists($classMetadata, 'isChangeTrackingDeferredExplicit')) {
+            return $classMetadata->isChangeTrackingDeferredExplicit();
+        }
+
+        return false;
+    }
 }

tests/Bridge/Doctrine/Common/DataPersisterTest.php

@@ -18,7 +18,10 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\Common\Persistence\ObjectManager;
+use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Prediction\CallPrediction;
+use Prophecy\Prediction\NoCallsPrediction;
 
 /**
  * @author Baptiste Meyer <[email protected]>
@@ -69,6 +72,7 @@ public function testPersistIfEntityAlreadyManaged()
         $objectManagerProphecy->persist($dummy)->shouldNotBeCalled();
         $objectManagerProphecy->flush()->shouldBeCalled();
         $objectManagerProphecy->refresh($dummy)->shouldBeCalled();
+        $objectManagerProphecy->getClassMetadata(Dummy::class)->willReturn(null)->shouldBeCalled();
 
         $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
         $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn($objectManagerProphecy->reveal())->shouldBeCalled();
@@ -109,4 +113,36 @@ public function testRemoveWithNullManager()
 
         (new DataPersister($managerRegistryProphecy->reveal()))->remove(new Dummy());
     }
+
+    public function getTrackingPolicyParameters()
+    {
+        return [
+            'deferred explicit' => [true, true],
+            'deferred implicit' => [false, false],
+        ];
+    }
+
+    /**
+     * @dataProvider getTrackingPolicyParameters
+     */
+    public function testTrackingPolicy($deferredExplicit, $persisted)
+    {
+        $dummy = new Dummy();
+
+        $classMetadataInfo = $this->prophesize(ClassMetadataInfo::class);
+        $classMetadataInfo->isChangeTrackingDeferredExplicit()->willReturn($deferredExplicit)->shouldBeCalled();
+
+        $objectManagerProphecy = $this->prophesize(ObjectManager::class);
+        $objectManagerProphecy->getClassMetadata(Dummy::class)->willReturn($classMetadataInfo)->shouldBeCalled();
+        $objectManagerProphecy->contains($dummy)->willReturn(true);
+        $objectManagerProphecy->persist($dummy)->should($persisted ? new CallPrediction() : new NoCallsPrediction());
+        $objectManagerProphecy->flush()->shouldBeCalled();
+        $objectManagerProphecy->refresh($dummy)->shouldBeCalled();
+
+        $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
+        $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn($objectManagerProphecy)->shouldBeCalled();
+
+        $result = (new DataPersister($managerRegistryProphecy->reveal()))->persist($dummy);
+        $this->assertSame($dummy, $result);
+    }
 }