Implement forward compatibility with Persistence 3

Author: greg0ire

composer.json

@@ -32,7 +32,7 @@
         "doctrine/inflector": "^1.4 || ^2.0",
         "doctrine/instantiator": "^1.3",
         "doctrine/lexer": "^1.0",
-        "doctrine/persistence": "^2.2",
+        "doctrine/persistence": "3.0.x-dev as 2.2.0",
         "psr/cache": "^1 || ^2 || ^3",
         "symfony/console": "^3.0 || ^4.0 || ^5.0 || ^6.0",
         "symfony/polyfill-php72": "^1.23",

lib/Doctrine/ORM/Decorator/EntityManagerDecorator.php

@@ -43,6 +43,22 @@ public function getExpressionBuilder()
         return $this->wrapped->getExpressionBuilder();
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getRepository($className)
+    {
+        return parent::getRepository($className);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getClassMetadata($className)
+    {
+        return parent::getClassMetadata($className);
+    }
+
     /**
      * {@inheritdoc}
      */

tests/Doctrine/Tests/Models/Company/CompanyFlexContract.php

@@ -11,6 +11,8 @@
 use Doctrine\ORM\Mapping\Entity;
 use Doctrine\ORM\Mapping\EntityResult;
 use Doctrine\ORM\Mapping\FieldResult;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
 use Doctrine\ORM\Mapping\JoinColumn;
 use Doctrine\ORM\Mapping\JoinTable;
 use Doctrine\ORM\Mapping\ManyToMany;
@@ -65,6 +67,14 @@
 #[ORM\Entity]
 class CompanyFlexContract extends CompanyContract
 {
+    /**
+     * @Id
+     * @GeneratedValue
+     * @Column(type="integer")
+     * @var int
+     */
+    public $id;
+
     /**
      * @Column(type="integer")
      * @var int

tests/Doctrine/Tests/ORM/Decorator/EntityManagerDecoratorTest.php

@@ -7,13 +7,18 @@
 use Doctrine\ORM\Decorator\EntityManagerDecorator;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Query\ResultSetMapping;
+use Generator;
+use LogicException;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use ReflectionClass;
 use ReflectionMethod;
+use ReflectionNamedType;
+use stdClass;
 
-use function array_fill;
+use function assert;
 use function in_array;
+use function sprintf;
 
 class EntityManagerDecoratorTest extends TestCase
 {
@@ -40,21 +45,18 @@ protected function setUp(): void
         $this->wrapped = $this->createMock(EntityManagerInterface::class);
     }
 
-    /** @psalm-return array<string, mixed[]> */
-    public function getMethodParameters(): array
+    /** @psalm-return Generator<string, mixed[]> */
+    public function getMethodParameters(): Generator
     {
-        $class   = new ReflectionClass(EntityManagerInterface::class);
-        $methods = [];
+        $class = new ReflectionClass(EntityManagerInterface::class);
 
         foreach ($class->getMethods() as $method) {
             if ($method->isConstructor() || $method->isStatic() || ! $method->isPublic()) {
                 continue;
             }
 
-            $methods[$method->getName()] = $this->getParameters($method);
+            yield $method->getName() => $this->getParameters($method);
         }
-
-        return $methods;
     }
 
     /**
@@ -77,19 +79,34 @@ static function (): void {
             ];
         }
 
-        if ($method->getNumberOfRequiredParameters() === 0) {
-            return [$method->getName(), []];
-        }
+        $parameters = [];
 
-        if ($method->getNumberOfRequiredParameters() > 0) {
-            return [$method->getName(), array_fill(0, $method->getNumberOfRequiredParameters(), 'req') ?: []];
-        }
+        foreach ($method->getParameters() as $parameter) {
+            if ($parameter->getType() === null) {
+                $parameters[] = 'mixed';
+                continue;
+            }
 
-        if ($method->getNumberOfParameters() !== $method->getNumberOfRequiredParameters()) {
-            return [$method->getName(), array_fill(0, $method->getNumberOfParameters(), 'all') ?: []];
+            $type = $parameter->getType();
+            assert($type instanceof ReflectionNamedType);
+            switch ($type->getName()) {
+                case 'string':
+                    $parameters[] = 'parameter';
+                    break;
+
+                case 'object':
+                    $parameters[] = new stdClass();
+                    break;
+
+                default:
+                    throw new LogicException(sprintf(
+                        'Type %s is not handled yet',
+                        (string) $parameter->getType()
+                    ));
+            }
         }
 
-        return [];
+        return [$method->getName(), $parameters];
     }
 
     /**

tests/Doctrine/Tests/ORM/Functional/PersistentCollectionTest.php

@@ -7,7 +7,6 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Collections\Criteria;
-use Doctrine\Common\Persistence\PersistentObject;
 use Doctrine\ORM\Mapping\Column;
 use Doctrine\ORM\Mapping\Entity;
 use Doctrine\ORM\Mapping\GeneratedValue;
@@ -24,24 +23,23 @@ protected function setUp(): void
             PersistentCollectionHolder::class,
             PersistentCollectionContent::class
         );
-
-        PersistentObject::setObjectManager($this->_em);
     }
 
     public function testPersist(): void
     {
-        $collectionHolder = new PersistentCollectionHolder();
-        $content          = new PersistentCollectionContent('first element');
+        $collectionHolder = new PersistentCollectionHolder(1);
+        $content          = new PersistentCollectionContent(1);
         $collectionHolder->addElement($content);
 
         $this->_em->persist($collectionHolder);
         $this->_em->flush();
         $this->_em->clear();
 
         $collectionHolder = $this->_em->find(PersistentCollectionHolder::class, $collectionHolder->getId());
+        self::assertNotNull($collectionHolder);
         $collectionHolder->getCollection();
 
-        $content = new PersistentCollectionContent('second element');
+        $content = new PersistentCollectionContent(2);
         $collectionHolder->addElement($content);
 
         self::assertEquals(2, $collectionHolder->getCollection()->count());
@@ -52,19 +50,20 @@ public function testPersist(): void
      */
     public function testExtraLazyIsEmptyDoesNotInitializeCollection(): void
     {
-        $collectionHolder = new PersistentCollectionHolder();
+        $collectionHolder = new PersistentCollectionHolder(1);
 
         $this->_em->persist($collectionHolder);
         $this->_em->flush();
         $this->_em->clear();
 
         $collectionHolder = $this->_em->find(PersistentCollectionHolder::class, $collectionHolder->getId());
-        $collection       = $collectionHolder->getRawCollection();
+        self::assertNotNull($collectionHolder);
+        $collection = $collectionHolder->getRawCollection();
 
         self::assertTrue($collection->isEmpty());
         self::assertFalse($collection->isInitialized());
 
-        $collectionHolder->addElement(new PersistentCollectionContent());
+        $collectionHolder->addElement(new PersistentCollectionContent(1));
 
         $this->_em->flush();
         $this->_em->clear();
@@ -82,7 +81,7 @@ public function testExtraLazyIsEmptyDoesNotInitializeCollection(): void
      */
     public function testMatchingDoesNotModifyTheGivenCriteria(): void
     {
-        $collectionHolder = new PersistentCollectionHolder();
+        $collectionHolder = new PersistentCollectionHolder(1);
 
         $this->_em->persist($collectionHolder);
         $this->_em->flush();
@@ -91,6 +90,7 @@ public function testMatchingDoesNotModifyTheGivenCriteria(): void
         $criteria = new Criteria();
 
         $collectionHolder = $this->_em->find(PersistentCollectionHolder::class, $collectionHolder->getId());
+        self::assertNotNull($collectionHolder);
         $collectionHolder->getCollection()->matching($criteria);
 
         self::assertEmpty($criteria->getWhereExpression());
@@ -103,42 +103,48 @@ public function testMatchingDoesNotModifyTheGivenCriteria(): void
 /**
  * @Entity
  */
-class PersistentCollectionHolder extends PersistentObject
+class PersistentCollectionHolder
 {
     /**
      * @Id
      * @Column(type="integer")
      * @GeneratedValue
      * @var int
      */
-    protected $id;
+    private $id;
 
     /**
-     * @var Collection
+     * @var Collection<int, PersistentCollectionContent>
      * @ManyToMany(targetEntity="PersistentCollectionContent", cascade={"all"}, fetch="EXTRA_LAZY")
      */
-    protected $collection;
+    private $collection;
 
-    public function __construct()
+    public function __construct(int $id)
     {
+        $this->id         = $id;
         $this->collection = new ArrayCollection();
     }
 
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
     public function addElement(PersistentCollectionContent $element): void
     {
         $this->collection->add($element);
     }
 
     /**
-     * @return Collection
+     * @return Collection<int, PersistentCollectionContent>
      */
     public function getCollection(): Collection
     {
         return clone $this->collection;
     }
 
     /**
-     * @return Collection
+     * @return Collection<int, PersistentCollectionContent>
      */
     public function getRawCollection(): Collection
     {
@@ -149,13 +155,23 @@ public function getRawCollection(): Collection
 /**
  * @Entity
  */
-class PersistentCollectionContent extends PersistentObject
+class PersistentCollectionContent
 {
     /**
      * @Id
      * @Column(type="integer")
      * @GeneratedValue
      * @var int
      */
-    protected $id;
+    private $id;
+
+    public function __construct(int $id)
+    {
+        $this->id = $id;
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
 }

tests/Doctrine/Tests/ORM/Functional/PersistentEntity.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional;
+
+/**
+ * @Entity
+ */
+class PersistentEntity extends PersistentObject
+{
+    /**
+     * @Id
+     * @Column(type="integer")
+     * @GeneratedValue
+     * @var int
+     */
+    protected $id;
+
+    /**
+     * @Column(type="string")
+     * @var string
+     */
+    protected $name;
+
+    /**
+     * @ManyToOne(targetEntity="PersistentEntity")
+     * @var PersistentEntity
+     */
+    protected $parent;
+}

tests/Doctrine/Tests/ORM/Functional/PersistentObjectTest.php

@@ -5,13 +5,10 @@
 namespace Doctrine\Tests\ORM\Functional;
 
 use Doctrine\Common\Persistence\PersistentObject;
-use Doctrine\ORM\Mapping\Column;
-use Doctrine\ORM\Mapping\Entity;
-use Doctrine\ORM\Mapping\GeneratedValue;
-use Doctrine\ORM\Mapping\Id;
-use Doctrine\ORM\Mapping\ManyToOne;
 use Doctrine\Tests\OrmFunctionalTestCase;
 
+use function class_exists;
+
 /**
  * Test that Doctrine ORM correctly works with the ObjectManagerAware and PersistentObject
  * classes from Common.
@@ -22,6 +19,10 @@ class PersistentObjectTest extends OrmFunctionalTestCase
 {
     protected function setUp(): void
     {
+        if (! class_exists(PersistentObject::class)) {
+            $this->markTestSkipped('This tests requires doctrine/persistence 2.');
+        }
+
         parent::setUp();
 
         $this->createSchemaForModels(PersistentEntity::class);
@@ -85,29 +86,3 @@ public function testSetAssociation(): void
         self::assertSame($entity, $entity->getParent());
     }
 }
-
-/**
- * @Entity
- */
-class PersistentEntity extends PersistentObject
-{
-    /**
-     * @Id
-     * @Column(type="integer")
-     * @GeneratedValue
-     * @var int
-     */
-    protected $id;
-
-    /**
-     * @Column(type="string")
-     * @var string
-     */
-    protected $name;
-
-    /**
-     * @ManyToOne(targetEntity="PersistentEntity")
-     * @var PersistentEntity
-     */
-    protected $parent;
-}