Remove deprecated handling of custom ObjectRepository implementations (#9634)

Author: derrabus

UPGRADE.md

@@ -1,13 +1,19 @@
 # Upgrade to 3.0
 
-## Removed: support for entity namespace alias
+## BC BREAK: Repository classes have to extend `EntityRepository`
+
+Although undocumented, it was possible to configure a custom repository
+class that implements `ObjectRepository` but does not extend the
+`EntityRepository` base class. Repository classes have to extend
+`EntityRepository` now.
+
+## BC BREAK: Removed support for entity namespace alias
 
 - `EntityManager::getRepository()` no longer accepts the entity namespace alias
   notation.
 - `Configuration::addEntityNamespace()` and
   `Configuration::getEntityNamespace()` have been removed.
 
-
 ## BC BREAK: Remove helper methods from `AbstractCollectionPersister`
 
 The following protected methods of

lib/Doctrine/ORM/Configuration.php

@@ -5,7 +5,6 @@
 namespace Doctrine\ORM;
 
 use Doctrine\Common\Proxy\AbstractProxyFactory;
-use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\Cache\CacheConfiguration;
 use Doctrine\ORM\Exception\InvalidEntityRepository;
 use Doctrine\ORM\Internal\Hydration\AbstractHydrator;
@@ -21,7 +20,6 @@
 use Doctrine\ORM\Repository\DefaultRepositoryFactory;
 use Doctrine\ORM\Repository\RepositoryFactory;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
-use Doctrine\Persistence\ObjectRepository;
 use Psr\Cache\CacheItemPoolInterface;
 
 use function class_exists;
@@ -456,20 +454,10 @@ public function getFilterClassName($name)
      */
     public function setDefaultRepositoryClassName($className)
     {
-        if (! class_exists($className) || ! is_a($className, ObjectRepository::class, true)) {
+        if (! class_exists($className) || ! is_a($className, EntityRepository::class, true)) {
             throw InvalidEntityRepository::fromClassName($className);
         }
 
-        if (! is_a($className, EntityRepository::class, true)) {
-            Deprecation::trigger(
-                'doctrine/orm',
-                'https://github.com/doctrine/orm/pull/9533',
-                'Configuring %s as default repository class is deprecated because it does not extend %s.',
-                $className,
-                EntityRepository::class
-            );
-        }
-
         $this->_attributes['defaultRepositoryClassName'] = $className;
     }
 

lib/Doctrine/ORM/Repository/DefaultRepositoryFactory.php

@@ -4,7 +4,6 @@
 
 namespace Doctrine\ORM\Repository;
 
-use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\Persistence\ObjectRepository;
@@ -20,22 +19,15 @@ final class DefaultRepositoryFactory implements RepositoryFactory
      * The list of EntityRepository instances.
      *
      * @var ObjectRepository[]
-     * @psalm-var array<string, ObjectRepository>
+     * @psalm-var array<string, EntityRepository>
      */
-    private $repositoryList = [];
+    private array $repositoryList = [];
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getRepository(EntityManagerInterface $entityManager, $entityName): ObjectRepository
+    public function getRepository(EntityManagerInterface $entityManager, string $entityName): EntityRepository
     {
         $repositoryHash = $entityManager->getClassMetadata($entityName)->getName() . spl_object_id($entityManager);
 
-        if (isset($this->repositoryList[$repositoryHash])) {
-            return $this->repositoryList[$repositoryHash];
-        }
-
-        return $this->repositoryList[$repositoryHash] = $this->createRepository($entityManager, $entityName);
+        return $this->repositoryList[$repositoryHash] ??= $this->createRepository($entityManager, $entityName);
     }
 
     /**
@@ -47,22 +39,11 @@ public function getRepository(EntityManagerInterface $entityManager, $entityName
     private function createRepository(
         EntityManagerInterface $entityManager,
         string $entityName
-    ): ObjectRepository {
+    ): EntityRepository {
         $metadata            = $entityManager->getClassMetadata($entityName);
         $repositoryClassName = $metadata->customRepositoryClassName
             ?: $entityManager->getConfiguration()->getDefaultRepositoryClassName();
 
-        $repository = new $repositoryClassName($entityManager, $metadata);
-        if (! $repository instanceof EntityRepository) {
-            Deprecation::trigger(
-                'doctrine/orm',
-                'https://github.com/doctrine/orm/pull/9533',
-                'Configuring %s as repository class is deprecated because it does not extend %s.',
-                $repositoryClassName,
-                EntityRepository::class
-            );
-        }
-
-        return $repository;
+        return new $repositoryClassName($entityManager, $metadata);
     }
 }

lib/Doctrine/ORM/Repository/RepositoryFactory.php

@@ -5,7 +5,7 @@
 namespace Doctrine\ORM\Repository;
 
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\Persistence\ObjectRepository;
+use Doctrine\ORM\EntityRepository;
 
 /**
  * Interface for entity repository factory.
@@ -18,9 +18,9 @@ interface RepositoryFactory
      * @param EntityManagerInterface $entityManager The EntityManager instance.
      * @param class-string<T>        $entityName    The name of the entity.
      *
-     * @return ObjectRepository<T> This type will change to {@see EntityRepository} in 3.0.
+     * @return EntityRepository<T>
      *
      * @template T of object
      */
-    public function getRepository(EntityManagerInterface $entityManager, $entityName);
+    public function getRepository(EntityManagerInterface $entityManager, string $entityName): EntityRepository;
 }

psalm-baseline.xml

@@ -205,12 +205,6 @@
       <code>ClassMetadataFactory</code>
       <code>Mapping\ClassMetadata</code>
     </InvalidReturnType>
-    <LessSpecificReturnStatement occurrences="1">
-      <code>$this-&gt;repositoryFactory-&gt;getRepository($this, $entityName)</code>
-    </LessSpecificReturnStatement>
-    <MoreSpecificReturnType occurrences="1">
-      <code>EntityRepository&lt;T&gt;</code>
-    </MoreSpecificReturnType>
     <ParamNameMismatch occurrences="6">
       <code>$entity</code>
       <code>$entity</code>
@@ -2324,9 +2318,12 @@
     </PossiblyNullArgument>
   </file>
   <file src="lib/Doctrine/ORM/Repository/DefaultRepositoryFactory.php">
-    <TypeDoesNotContainType occurrences="1">
-      <code>$repository instanceof EntityRepository</code>
-    </TypeDoesNotContainType>
+    <InvalidReturnStatement occurrences="1">
+      <code>$this-&gt;repositoryList[$repositoryHash] ??= $this-&gt;createRepository($entityManager, $entityName)</code>
+    </InvalidReturnStatement>
+    <InvalidReturnType occurrences="1">
+      <code>EntityRepository</code>
+    </InvalidReturnType>
     <UnsafeInstantiation occurrences="1">
       <code>new $repositoryClassName($entityManager, $metadata)</code>
     </UnsafeInstantiation>

tests/Doctrine/Tests/ORM/ConfigurationTest.php

@@ -13,14 +13,11 @@
 use Doctrine\ORM\Mapping as AnnotationNamespace;
 use Doctrine\ORM\Mapping\EntityListenerResolver;
 use Doctrine\ORM\Mapping\NamingStrategy;
-use Doctrine\ORM\Mapping\PrePersist;
 use Doctrine\ORM\Mapping\QuoteStrategy;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
-use Doctrine\Persistence\ObjectRepository;
 use Doctrine\Tests\DoctrineTestCase;
 use Doctrine\Tests\Models\DDC753\DDC753CustomRepository;
 use Psr\Cache\CacheItemPoolInterface;
-use stdClass;
 
 /**
  * Tests for the Configuration object
@@ -171,14 +168,6 @@ public function setDefaultRepositoryClassName(): void
         $this->configuration->setDefaultRepositoryClassName(self::class);
     }
 
-    public function testSetDeprecatedDefaultRepositoryClassName(): void
-    {
-        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/pull/9533');
-
-        $this->configuration->setDefaultRepositoryClassName(DeprecatedRepository::class);
-        self::assertSame(DeprecatedRepository::class, $this->configuration->getDefaultRepositoryClassName());
-    }
-
     public function testSetGetNamingStrategy(): void
     {
         self::assertInstanceOf(NamingStrategy::class, $this->configuration->getNamingStrategy());
@@ -219,50 +208,3 @@ public function testSetGetSecondLevelCacheConfig(): void
         self::assertEquals($mockClass, $this->configuration->getSecondLevelCacheConfiguration());
     }
 }
-
-class ConfigurationTestAnnotationReaderChecker
-{
-    /** @PrePersist */
-    public function simpleAnnotationMethod(): void
-    {
-    }
-
-    /** @AnnotationNamespace\PrePersist */
-    public function namespacedAnnotationMethod(): void
-    {
-    }
-}
-
-class DeprecatedRepository implements ObjectRepository
-{
-    /**
-     * {@inheritdoc}
-     */
-    public function find($id)
-    {
-        return null;
-    }
-
-    public function findAll(): array
-    {
-        return [];
-    }
-
-    public function findBy(array $criteria, ?array $orderBy = null, $limit = null, $offset = null): array
-    {
-        return [];
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function findOneBy(array $criteria)
-    {
-        return null;
-    }
-
-    public function getClassName(): string
-    {
-        return stdClass::class;
-    }
-}