SimpleObjectHydrator: skip unsuit custom type before convert it

Sergey Naumov · Sergey Naumov · commit 2e499d87dd53 · 2021-04-19T16:09:47.000+03:00
SimpleObjectHydrator tries to convert the value, and only then checks if we need it.
This results in an error if our custom type does not get expected data to initialize php value.
diff --git a/lib/Doctrine/ORM/Internal/Hydration/SimpleObjectHydrator.php b/lib/Doctrine/ORM/Internal/Hydration/SimpleObjectHydrator.php
@@ -133,6 +133,11 @@ protected function hydrateRowData(array $row, array &$result)
                 continue;
             }
 
+            // If we have inheritance in resultset, make sure the field belongs to the correct class
+            if (isset($cacheKeyInfo['discriminatorValues']) && ! in_array((string) $discrColumnValue, $cacheKeyInfo['discriminatorValues'], true)) {
+                continue;
+            }
+
             // Check if value is null before conversion (because some types convert null to something else)
             $valueIsNull = $value === null;
 
@@ -146,11 +151,6 @@ protected function hydrateRowData(array $row, array &$result)
 
             // Prevent overwrite in case of inherit classes using same property name (See AbstractHydrator)
             if (! isset($data[$fieldName]) || ! $valueIsNull) {
-                // If we have inheritance in resultset, make sure the field belongs to the correct class
-                if (isset($cacheKeyInfo['discriminatorValues']) && ! in_array((string) $discrColumnValue, $cacheKeyInfo['discriminatorValues'], true)) {
-                    continue;
-                }
-
                 $data[$fieldName] = $value;
             }
         }
diff --git a/tests/Doctrine/Tests/DbalTypes/GH8565EmployeePayloadType.php b/tests/Doctrine/Tests/DbalTypes/GH8565EmployeePayloadType.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\DbalTypes;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\JsonType;
+use Exception;
+
+class GH8565EmployeePayloadType extends JsonType
+{
+    public const NAME = 'GH8565EmployeePayloadType';
+
+    public function convertToPHPValue($value, AbstractPlatform $platform): string
+    {
+        if (! isset($value['GH8565EmployeePayloadRequiredField'])) {
+            throw new Exception('GH8565EmployeePayloadType cannot be initialized without required field');
+        }
+
+        return $value['GH8565EmployeePayloadRequiredField'];
+    }
+}
diff --git a/tests/Doctrine/Tests/DbalTypes/GH8565ManagerPayloadType.php b/tests/Doctrine/Tests/DbalTypes/GH8565ManagerPayloadType.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\DbalTypes;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\JsonType;
+
+class GH8565ManagerPayloadType extends JsonType
+{
+    public const NAME = 'GH8565ManagerPayloadType';
+
+    public function convertToPHPValue($value, AbstractPlatform $platform): string
+    {
+        return $value;
+    }
+}
diff --git a/tests/Doctrine/Tests/Models/GH8565/GH8565Employee.php b/tests/Doctrine/Tests/Models/GH8565/GH8565Employee.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\Models\GH8565;
+
+use Doctrine\Tests\DbalTypes\GH8565EmployeePayloadType;
+
+/**
+ * @Entity
+ * @Table(name="gh8565_employees")
+ */
+class GH8565Employee extends GH8565Person
+{
+    /**
+     * @Column(type="GH8565EmployeePayloadType", nullable=false)
+     * @var GH8565EmployeePayloadType
+     */
+    public $type;
+}
diff --git a/tests/Doctrine/Tests/Models/GH8565/GH8565Manager.php b/tests/Doctrine/Tests/Models/GH8565/GH8565Manager.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\Models\GH8565;
+
+use Doctrine\Tests\DbalTypes\GH8565ManagerPayloadType;
+
+/**
+ * @Entity
+ * @Table(name="gh8565_managers")
+ */
+class GH8565Manager extends GH8565Person
+{
+    /**
+     * @Column(type="GH8565ManagerPayloadType", nullable=false)
+     * @var GH8565ManagerPayloadType
+     */
+    public $type;
+}
diff --git a/tests/Doctrine/Tests/Models/GH8565/GH8565Person.php b/tests/Doctrine/Tests/Models/GH8565/GH8565Person.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\Models\GH8565;
+
+/**
+ * @Entity
+ * @Table(name="gh8565_persons")
+ * @InheritanceType("JOINED")
+ * @DiscriminatorColumn(name="discr", type="string")
+ * @DiscriminatorMap({
+ *      "person"    = "GH8565Person",
+ *      "manager"   = "GH8565Manager",
+ *      "employee"  = "GH8565Employee"
+ * })
+ */
+class GH8565Person
+{
+    /**
+     * @var int
+     * @Id
+     * @Column(type="integer")
+     * @GeneratedValue
+     */
+    public $id;
+}
diff --git a/tests/Doctrine/Tests/ORM/Hydration/SimpleObjectHydratorTest.php b/tests/Doctrine/Tests/ORM/Hydration/SimpleObjectHydratorTest.php
@@ -4,11 +4,17 @@
 
 namespace Doctrine\Tests\ORM\Hydration;
 
+use Doctrine\DBAL\Types\Type as DBALType;
 use Doctrine\ORM\Internal\Hydration\SimpleObjectHydrator;
 use Doctrine\ORM\Query\ResultSetMapping;
+use Doctrine\Tests\DbalTypes\GH8565EmployeePayloadType;
+use Doctrine\Tests\DbalTypes\GH8565ManagerPayloadType;
 use Doctrine\Tests\Mocks\HydratorMockStatement;
 use Doctrine\Tests\Models\CMS\CmsAddress;
 use Doctrine\Tests\Models\Company\CompanyPerson;
+use Doctrine\Tests\Models\GH8565\GH8565Employee;
+use Doctrine\Tests\Models\GH8565\GH8565Manager;
+use Doctrine\Tests\Models\GH8565\GH8565Person;
 use Doctrine\Tests\Models\Issue5989\Issue5989Employee;
 use Doctrine\Tests\Models\Issue5989\Issue5989Manager;
 use Doctrine\Tests\Models\Issue5989\Issue5989Person;
@@ -122,4 +128,36 @@ public function testNullValueShouldNotOverwriteFieldWithSameNameInJoinedInherita
         $result   = $hydrator->hydrateAll($stmt, $rsm);
         $this->assertEquals($result[0], $expectedEntity);
     }
+
+    public function testWrongValuesShouldNotBeConvertedToPhpValue(): void
+    {
+        DBALType::addType(GH8565EmployeePayloadType::NAME, GH8565EmployeePayloadType::class);
+        DBALType::addType(GH8565ManagerPayloadType::NAME, GH8565ManagerPayloadType::class);
+
+        $rsm = new ResultSetMapping();
+        $rsm->addEntityResult(GH8565Person::class, 'p');
+        $rsm->addFieldResult('p', 'p__id', 'id');
+        $rsm->addFieldResult('p', 'm__type', 'type', GH8565Manager::class);
+        $rsm->addFieldResult('p', 'e__type', 'type', GH8565Employee::class);
+        $rsm->addMetaResult('p', 'discr', 'discr', false, 'string');
+        $rsm->setDiscriminatorColumn('p', 'type');
+        $resultSet = [
+            [
+                'p__id'   => '1',
+                'm__type' => 'type field',
+                'e__type' => 'type field',
+                'e__tags' => null,
+                'discr'   => 'manager',
+            ],
+        ];
+
+        $expectedEntity       = new GH8565Manager();
+        $expectedEntity->id   = 1;
+        $expectedEntity->type = 'type field';
+
+        $stmt     = new HydratorMockStatement($resultSet);
+        $hydrator = new SimpleObjectHydrator($this->entityManager);
+        $result   = $hydrator->hydrateAll($stmt, $rsm);
+        $this->assertEquals($result[0], $expectedEntity);
+    }
 }
