Merge pull request ecamp#5365 from usu/chore/doctrine-orm-3

chore: upgrade to doctrine/orm 3

Author: BacLuc

.github/workflows/continuous-integration-optional.yml

@@ -136,5 +136,5 @@ jobs:
       - run: php bin/console doctrine:migrations:migrate --no-interaction -e test
         working-directory: api
 
-      - run: php bin/console doctrine:schema:validate -v -e test
+      - run: php bin/console doctrine:schema:validate --skip-sync -e test && php bin/console doctrine:migrations:up-to-date -e test && ! php bin/console doctrine:migrations:diff -e test --namespace DoctrineMigrations
         working-directory: api

api/composer.json

@@ -10,7 +10,7 @@
         "cweagans/composer-patches": "1.7.3",
         "doctrine/doctrine-bundle": "2.13.1",
         "doctrine/doctrine-migrations-bundle": "3.3.1",
-        "doctrine/orm": "2.20.0",
+        "doctrine/orm": "3.2.0",
         "exercise/htmlpurifier-bundle": "5.0",
         "friendsofsymfony/http-cache": "3.1.0",
         "friendsofsymfony/http-cache-bundle": "3.0.2",
@@ -53,7 +53,7 @@
     "require-dev": {
         "brianium/paratest": "v7.7.0",
         "friendsofphp/php-cs-fixer": "3.66.0",
-        "hautelook/alice-bundle": "2.13.0",
+        "hautelook/alice-bundle": "2.14.0",
         "justinrainbow/json-schema": "6.0.0",
         "php-coveralls/php-coveralls": "2.7.0",
         "phpspec/prophecy-phpunit": "2.3.0",

api/composer.lock

@@ -33,7 +33,7 @@
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\ORM\Mapping\AssociationMapping;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\PersistentCollection;
 use FOS\HttpCacheBundle\CacheManager;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@@ -53,7 +53,7 @@ public function __construct(private readonly IriConverterInterface|LegacyIriConv
      */
     public function preUpdate(PreUpdateEventArgs $eventArgs): void {
         $changeSet = $eventArgs->getEntityChangeSet();
-        $objectManager = method_exists($eventArgs, 'getObjectManager') ? $eventArgs->getObjectManager() : $eventArgs->getEntityManager();
+        $objectManager = $eventArgs->getObjectManager();
         $associationMappings = $objectManager->getClassMetadata(ClassUtils::getClass($eventArgs->getObject()))->getAssociationMappings();
 
         foreach ($changeSet as $key => $value) {
@@ -76,7 +76,12 @@ public function preUpdate(PreUpdateEventArgs $eventArgs): void {
      */
     public function onFlush(OnFlushEventArgs $eventArgs): void {
         /** @var EntityManagerInterface */
-        $em = method_exists($eventArgs, 'getObjectManager') ? $eventArgs->getObjectManager() : $eventArgs->getEntityManager();
+        $em = $eventArgs->getObjectManager();
+
+        if (!$em instanceof EntityManagerInterface) {
+            return;
+        }
+
         $uow = $em->getUnitOfWork();
 
         foreach ($uow->getScheduledEntityInsertions() as $entity) {
@@ -118,7 +123,7 @@ public function postFlush(): void {
     private function addTagsForManyToManyRelations($collection, $entities) {
         $associationMapping = $collection->getMapping();
 
-        if (ClassMetadataInfo::MANY_TO_MANY !== $associationMapping['type']) {
+        if (ClassMetadata::MANY_TO_MANY !== $associationMapping['type']) {
             return;
         }
 
@@ -222,15 +227,7 @@ private function gatherRelationTags(EntityManagerInterface $em, object $entity):
         $associationMappings = $em->getClassMetadata(ClassUtils::getClass($entity))->getAssociationMappings();
 
         foreach ($associationMappings as $property => $associationMapping) {
-            // @phpstan-ignore-next-line
-            if (class_exists(AssociationMapping::class) && $associationMapping instanceof AssociationMapping && ($associationMapping->targetEntity ?? null) && !$this->resourceClassResolver->isResourceClass($associationMapping->targetEntity)) {
-                return;
-            }
-
-            // @phpstan-ignore-next-line
-            if (\is_array($associationMapping)
-                && \array_key_exists('targetEntity', $associationMapping)
-                && !$this->resourceClassResolver->isResourceClass($associationMapping['targetEntity'])) {
+            if ($associationMapping instanceof AssociationMapping && ($associationMapping->targetEntity ?? null) && !$this->resourceClassResolver->isResourceClass($associationMapping->targetEntity)) {
                 return;
             }
 

api/src/HttpCache/PurgeHttpCacheListener.php

@@ -32,16 +32,16 @@ public function upgradePassword(PasswordAuthenticatedUserInterface $user, string
         }
 
         $user->password = $newHashedPassword;
-        $this->_em->persist($user);
-        $this->_em->flush();
+        $this->getEntityManager()->persist($user);
+        $this->getEntityManager()->flush();
     }
 
     /**
      * @throws NonUniqueResultException
      * @throws NoResultException
      */
     public function loadUserByIdentifier(string $identifier): ?User {
-        $queryBuilder = $this->_em->createQueryBuilder();
+        $queryBuilder = $this->getEntityManager()->createQueryBuilder();
         $queryBuilder->select('user');
         $queryBuilder->from(User::class, 'user');
         $queryBuilder->join('user.profile', 'profile');

api/src/Repository/UserRepository.php

@@ -16,9 +16,11 @@
 use App\Metadata\Resource\OperationHelper;
 use App\Util\ClassInfoTrait;
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\AssociationMapping;
+use Doctrine\ORM\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\InverseSideMapping;
 use Doctrine\ORM\Mapping\MappingException;
-use Doctrine\Persistence\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\OwningSideMapping;
 use Rize\UriTemplate;
 use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@@ -168,8 +170,8 @@ protected function getRelatedCollectionHref($object, $rel, array $context, &$hre
         try {
             $classMetadata = $this->getClassMetadata($resourceClass);
 
-            if (!$classMetadata instanceof ClassMetadataInfo) {
-                throw new \RuntimeException("The class metadata for {$resourceClass} must be an instance of ClassMetadataInfo.");
+            if (!$classMetadata instanceof ClassMetadata) {
+                throw new \RuntimeException("The class metadata for {$resourceClass} must be an instance of ClassMetadata.");
             }
 
             $relationMetadata = $classMetadata->getAssociationMapping($rel);
@@ -178,10 +180,8 @@ protected function getRelatedCollectionHref($object, $rel, array $context, &$hre
             return false;
         }
 
-        $relatedResourceClass = $relationMetadata['targetEntity'];
-
-        $relatedFilterName = $relationMetadata['mappedBy'];
-        $relatedFilterName ??= $relationMetadata['inversedBy'];
+        $relatedResourceClass = $relationMetadata->targetEntity;
+        $relatedFilterName = $this->getRelatedProperty($relationMetadata);
 
         if (empty($relatedResourceClass) || empty($relatedFilterName)) {
             // The $resourceClass # $rel relation does not have both a targetEntity and a mappedBy or inversedBy property
@@ -282,4 +282,16 @@ private function exactSearchFilterExists(string $resourceClass, mixed $propertyN
                 && 'exact' === $filterDescription[$propertyName]['strategy'];
         }));
     }
+
+    private function getRelatedProperty(AssociationMapping $mapping): ?string {
+        if ($mapping instanceof InverseSideMapping) {
+            return $mapping->mappedBy ?? null;
+        }
+
+        if ($mapping instanceof OwningSideMapping) {
+            return $mapping->inversedBy ?? null;
+        }
+
+        return null;
+    }
 }