Avoid returning null from EntityManager::getReference() and `getPar…

…tialReference()`
doctrine · Aug 1, 2023 · 5599b3f · 5599b3f
1 parent 2dc19e6
commit 5599b3f
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 9 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -601,6 +601,10 @@ following classes and methods:
 
 Use `toIterable()` instead.
 
+## BC BREAK: `Doctrine\ORM\EntityManagerInterface#getReference()` and `getPartialReference()` does not return `null` anymore
+
+Method `Doctrine\ORM\EntityManagerInterface#getReference()` and `getPartialReference()` throws `InstanceOfTheWrongTypeEncountered` in 3.0 when different entity type is found in inheritance hierachy.
+
 # Upgrade to 2.16
 
 ## Changing the way how reflection-based mapping drivers report fields, deprecated the "old" mode

diff --git a/lib/Doctrine/ORM/EntityManager.php b/lib/Doctrine/ORM/EntityManager.php
@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\LockMode;
 use Doctrine\ORM\Exception\EntityManagerClosed;
+use Doctrine\ORM\Exception\InstanceOfTheWrongTypeEncountered;
 use Doctrine\ORM\Exception\InvalidHydrationMode;
 use Doctrine\ORM\Exception\MissingIdentifierField;
 use Doctrine\ORM\Exception\MissingMappingDriverImplementation;
@@ -386,7 +387,11 @@ public function getReference(string $entityName, mixed $id): object|null
 
         // Check identity map first, if its already in there just return it.
         if ($entity !== false) {
-            return $entity instanceof $class->name ? $entity : null;
+            if (! $entity instanceof $class->name) {
+                throw InstanceOfTheWrongTypeEncountered::forInstance($entity);
+            }
+
+            return $entity;
         }
 
         if ($class->subClasses) {
@@ -408,7 +413,11 @@ public function getPartialReference(string $entityName, mixed $identifier): obje
 
         // Check identity map first, if its already in there just return it.
         if ($entity !== false) {
-            return $entity instanceof $class->name ? $entity : null;
+            if (! $entity instanceof $class->name) {
+                throw InstanceOfTheWrongTypeEncountered::forInstance($entity);
+            }
+
+            return $entity;
         }
 
         if (! is_array($identifier)) {

diff --git a/lib/Doctrine/ORM/EntityManagerInterface.php b/lib/Doctrine/ORM/EntityManagerInterface.php
@@ -155,7 +155,7 @@ public function refresh(object $object, LockMode|int|null $lockMode = null): voi
      * @param mixed  $id         The entity identifier.
      * @psalm-param class-string<T> $entityName
      *
-     * @psalm-return T|null
+     * @psalm-return T
      *
      * @throws ORMException
      *
@@ -182,7 +182,7 @@ public function getReference(string $entityName, mixed $id): object|null;
      * @param mixed  $identifier The entity identifier.
      * @psalm-param class-string<T> $entityName
      *
-     * @psalm-return T|null
+     * @psalm-return T
      *
      * @template T of object
      */

diff --git a/lib/Doctrine/ORM/Exception/InstanceOfTheWrongTypeEncountered.php b/lib/Doctrine/ORM/Exception/InstanceOfTheWrongTypeEncountered.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ORM\Exception;
+
+use LogicException;
+
+use function get_debug_type;
+
+final class InstanceOfTheWrongTypeEncountered extends LogicException implements ORMException
+{
+    /** @param object $instance */
+    public static function forInstance($instance): self
+    {
+        return new self('Instance of the wrong type (' . get_debug_type($instance) . ') was retrieved in inheritance hierachy.' .
+                        'This happens because identity map aggregates instances by rootEntityName ');
+    }
+}
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -176,8 +176,8 @@
       <code>$entity</code>
       <code>$entity</code>
       <code>$entity</code>
-      <code><![CDATA[$entity instanceof $class->name ? $entity : null]]></code>
-      <code><![CDATA[$entity instanceof $class->name ? $entity : null]]></code>
+      <code><![CDATA[$entity]]></code>
+      <code><![CDATA[$entity]]></code>
       <code><![CDATA[$persister->load($sortedId, null, null, [], $lockMode)]]></code>
       <code><![CDATA[$persister->loadById($sortedId)]]></code>
       <code><![CDATA[$this->metadataFactory]]></code>

diff --git a/tests/Doctrine/Tests/ORM/Functional/Ticket/DDC1041Test.php b/tests/Doctrine/Tests/ORM/Functional/Ticket/DDC1041Test.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\Tests\ORM\Functional\Ticket;
 
+use Doctrine\ORM\Exception\InstanceOfTheWrongTypeEncountered;
 use Doctrine\Tests\Models\Company\CompanyFixContract;
 use Doctrine\Tests\Models\Company\CompanyFlexContract;
 use Doctrine\Tests\OrmFunctionalTestCase;
@@ -19,7 +20,7 @@ protected function setUp(): void
         parent::setUp();
     }
 
-    public function testGrabWrongSubtypeReturnsNull(): void
+    public function testGrabWrongSubtypeReturnsNullOrThrows(): void
     {
         $fix = new CompanyFixContract();
         $fix->setFixPrice(2000);
@@ -30,7 +31,15 @@ public function testGrabWrongSubtypeReturnsNull(): void
         $id = $fix->getId();
 
         self::assertNull($this->_em->find(CompanyFlexContract::class, $id));
-        self::assertNull($this->_em->getReference(CompanyFlexContract::class, $id));
-        self::assertNull($this->_em->getPartialReference(CompanyFlexContract::class, $id));
+
+        try {
+            $this->_em->getReference(CompanyFlexContract::class, $id);
+        } catch (InstanceOfTheWrongTypeEncountered) {
+        }
+
+        try {
+            $this->_em->getPartialReference(CompanyFlexContract::class, $id);
+        } catch (InstanceOfTheWrongTypeEncountered) {
+        }
     }
 }