feat: add compatibility with doctrine/orm 3.0

api-platform · Mar 1, 2024 · e6e8c22 · e6e8c22
1 parent 42215cf
commit e6e8c22
Show file tree

Hide file tree

Showing 16 changed files with 128 additions and 86 deletions.
diff --git a/composer.json b/composer.json
@@ -46,7 +46,7 @@
         "doctrine/doctrine-bundle": "^1.12 || ^2.0",
         "doctrine/mongodb-odm": "^2.2",
         "doctrine/mongodb-odm-bundle": "^4.0 || ^5.0",
-        "doctrine/orm": "^2.14",
+        "doctrine/orm": "^2.14 || ^3.0",
         "elasticsearch/elasticsearch": "^7.11 || ^8.4",
         "friends-of-behat/mink-browserkit-driver": "^1.3.1",
         "friends-of-behat/mink-extension": "^2.2",

diff --git a/src/Doctrine/Common/Tests/State/PersistProcessorTest.php b/src/Doctrine/Common/Tests/State/PersistProcessorTest.php
@@ -18,7 +18,7 @@
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\State\ProcessorInterface;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata as ORMClassMetadata;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\ObjectManager;
 use PHPUnit\Framework\TestCase;
@@ -84,8 +84,8 @@ public function testPersistWithNullManager(): void
     public static function getTrackingPolicyParameters(): array
     {
         return [
-            'deferred explicit ORM' => [ClassMetadataInfo::class, true, true],
-            'deferred implicit ORM' => [ClassMetadataInfo::class, false, false],
+            'deferred explicit ORM' => [ORMClassMetadata::class, true, true],
+            'deferred implicit ORM' => [ORMClassMetadata::class, false, false],
             'deferred explicit ODM' => [ClassMetadata::class, true, true],
             'deferred implicit ODM' => [ClassMetadata::class, false, false],
         ];
@@ -98,15 +98,15 @@ public function testTrackingPolicy(string $metadataClass, bool $deferredExplicit
     {
         $dummy = new Dummy();
 
-        $classMetadataInfo = $this->prophesize($metadataClass);
+        $classMetadata = $this->prophesize($metadataClass);
         if (method_exists($metadataClass, 'isChangeTrackingDeferredExplicit')) {
-            $classMetadataInfo->isChangeTrackingDeferredExplicit()->willReturn($deferredExplicit)->shouldBeCalled();
+            $classMetadata->isChangeTrackingDeferredExplicit()->willReturn($deferredExplicit)->shouldBeCalled();
         } else {
             $persisted = false;
         }
 
         $objectManagerProphecy = $this->prophesize(ObjectManager::class);
-        $objectManagerProphecy->getClassMetadata(Dummy::class)->willReturn($classMetadataInfo)->shouldBeCalled();
+        $objectManagerProphecy->getClassMetadata(Dummy::class)->willReturn($classMetadata)->shouldBeCalled();
         $objectManagerProphecy->contains($dummy)->willReturn(true);
         $objectManagerProphecy->persist($dummy)->should($persisted ? new CallPrediction() : new NoCallsPrediction());
         $objectManagerProphecy->flush()->shouldBeCalled();

diff --git a/src/Doctrine/Orm/Extension/EagerLoadingExtension.php b/src/Doctrine/Orm/Extension/EagerLoadingExtension.php
@@ -23,7 +23,6 @@
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\Query\Expr\Select;
 use Doctrine\ORM\QueryBuilder;
@@ -137,9 +136,9 @@ private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInt
 
             if (
                 // Always skip extra lazy associations
-                ClassMetadataInfo::FETCH_EXTRA_LAZY === $mapping['fetch']
+                ClassMetadata::FETCH_EXTRA_LAZY === $mapping['fetch']
                 // We don't want to interfere with doctrine on this association
-                || (false === $forceEager && ClassMetadataInfo::FETCH_EAGER !== $mapping['fetch'])
+                || (false === $forceEager && ClassMetadata::FETCH_EAGER !== $mapping['fetch'])
             ) {
                 continue;
             }

diff --git a/src/Doctrine/Orm/Extension/FilterEagerLoadingExtension.php b/src/Doctrine/Orm/Extension/FilterEagerLoadingExtension.php
@@ -19,7 +19,7 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\QueryBuilder;
 
@@ -111,12 +111,12 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
      *
      * @param array $checked array cache of tested metadata classes
      */
-    private function hasFetchEagerAssociation(EntityManagerInterface $em, ClassMetadataInfo $classMetadata, array &$checked = []): bool
+    private function hasFetchEagerAssociation(EntityManagerInterface $em, ClassMetadata $classMetadata, array &$checked = []): bool
     {
         $checked[] = $classMetadata->name;
 
         foreach ($classMetadata->getAssociationMappings() as $mapping) {
-            if (ClassMetadataInfo::FETCH_EAGER === $mapping['fetch']) {
+            if (ClassMetadata::FETCH_EAGER === $mapping['fetch']) {
                 return true;
             }
 

diff --git a/src/Doctrine/Orm/Filter/ExistsFilter.php b/src/Doctrine/Orm/Filter/ExistsFilter.php
@@ -18,7 +18,7 @@
 use ApiPlatform\Doctrine\Orm\Util\QueryBuilderHelper;
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Metadata\Operation;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\Persistence\ManagerRegistry;
@@ -199,7 +199,7 @@ protected function isNullableField(string $property, string $resourceClass): boo
 
         if ($metadata->hasAssociation($field)) {
             if ($metadata->isSingleValuedAssociation($field)) {
-                if (!($metadata instanceof ClassMetadataInfo)) {
+                if (!($metadata instanceof ClassMetadata)) {
                     return false;
                 }
 
@@ -211,7 +211,7 @@ protected function isNullableField(string $property, string $resourceClass): boo
             return true;
         }
 
-        if ($metadata instanceof ClassMetadataInfo && $metadata->hasField($field)) {
+        if ($metadata instanceof ClassMetadata && $metadata->hasField($field)) {
             return $metadata->isNullable($field);
         }
 

diff --git a/src/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactory.php b/src/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactory.php
@@ -15,7 +15,7 @@
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
@@ -55,7 +55,7 @@ public function create(string $resourceClass, string $property, array $options =
                     break;
                 }
 
-                if ($doctrineClassMetadata instanceof ClassMetadataInfo) {
+                if ($doctrineClassMetadata instanceof ClassMetadata) {
                     $writable = $doctrineClassMetadata->isIdentifierNatural();
                 } else {
                     $writable = false;
@@ -67,7 +67,7 @@ public function create(string $resourceClass, string $property, array $options =
             }
         }
 
-        if ($doctrineClassMetadata instanceof ClassMetadataInfo && \in_array($property, $doctrineClassMetadata->getFieldNames(), true)) {
+        if ($doctrineClassMetadata instanceof ClassMetadata && \in_array($property, $doctrineClassMetadata->getFieldNames(), true)) {
             /** @var mixed[] */
             $fieldMapping = $doctrineClassMetadata->getFieldMapping($property);
             $propertyMetadata = $propertyMetadata->withDefault($fieldMapping['options']['default'] ?? $propertyMetadata->getDefault());

diff --git a/src/Doctrine/Orm/Metadata/Resource/DoctrineOrmLinkFactory.php b/src/Doctrine/Orm/Metadata/Resource/DoctrineOrmLinkFactory.php
@@ -21,6 +21,7 @@
 use ApiPlatform\Metadata\Resource\Factory\PropertyLinkFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Mapping\InverseSideMapping;
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
@@ -66,8 +67,20 @@ public function createLinksFromRelations(Metadata $operation): array
                 continue;
             }
 
+            if (class_exists(InverseSideMapping::class)) {
+                // Doctrine throws on getAssociationMappedByTargetField, we want to avoid catching exceptions in this hot path
+                $assoc = $doctrineMetadata->getAssociationMapping($property);
+                if (!$assoc instanceof InverseSideMapping) {
+                    continue;
+                }
+            }
+
+            if (!($mappedBy = $doctrineMetadata->getAssociationMappedByTargetField($property) ?? null)) {
+                continue;
+            }
+
             $relationClass = $doctrineMetadata->getAssociationTargetClass($property);
-            if (!($mappedBy = $doctrineMetadata->getAssociationMappedByTargetField($property)) || !$this->resourceClassResolver->isResourceClass($relationClass)) {
+            if (!$this->resourceClassResolver->isResourceClass($relationClass)) {
                 continue;
             }
 

diff --git a/src/Doctrine/Orm/State/LinksHandlerTrait.php b/src/Doctrine/Orm/State/LinksHandlerTrait.php
@@ -17,7 +17,7 @@
 use ApiPlatform\Doctrine\Orm\Util\QueryNameGenerator;
 use ApiPlatform\Metadata\Link;
 use ApiPlatform\Metadata\Operation;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\QueryBuilder;
 
 /**
@@ -83,7 +83,7 @@ private function handleLinks(QueryBuilder $queryBuilder, array $identifiers, Que
                 $associationMapping = $fromClassMetadata->getAssociationMapping($link->getFromProperty()); // @phpstan-ignore-line
                 $relationType = $associationMapping['type'];
 
-                if ($relationType & ClassMetadataInfo::TO_MANY) {
+                if ($relationType & ClassMetadata::TO_MANY) {
                     $nextAlias = $queryNameGenerator->generateJoinAlias($alias);
                     $whereClause = [];
                     foreach ($identifierProperties as $identifierProperty) {
@@ -100,7 +100,7 @@ private function handleLinks(QueryBuilder $queryBuilder, array $identifiers, Que
                 }
 
                 // A single-valued association path expression to an inverse side is not supported in DQL queries.
-                if ($relationType & ClassMetadataInfo::TO_ONE && !($associationMapping['isOwningSide'] ?? true)) {
+                if ($relationType & ClassMetadata::TO_ONE && !($associationMapping['isOwningSide'] ?? true)) {
                     $queryBuilder->innerJoin("$previousAlias.".$associationMapping['mappedBy'], $joinAlias);
                 } else {
                     $queryBuilder->join(