Refactoring EntityUserProvider::__construct() so that it doesn't do any work

weaverryan · weaverryan · commit 43a8c73333b3 · 2015-12-01T11:15:51.000-05:00
This helps break a dependency chain during cache warmup, that includes having
Doctrine load metadata, which will fail if there is no database on new Doctrine versions.
diff --git a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php
@@ -27,22 +27,17 @@
  */
 class EntityUserProvider implements UserProviderInterface
 {
+    private $registry;
+    private $managerName;
+    private $classOrAlias;
     private $class;
-    private $repository;
     private $property;
-    private $metadata;
 
-    public function __construct(ManagerRegistry $registry, $class, $property = null, $managerName = null)
+    public function __construct(ManagerRegistry $registry, $classOrAlias, $property = null, $managerName = null)
     {
-        $em = $registry->getManager($managerName);
-        $this->class = $class;
-        $this->metadata = $em->getClassMetadata($class);
-
-        if (false !== strpos($this->class, ':')) {
-            $this->class = $this->metadata->getName();
-        }
-
-        $this->repository = $em->getRepository($class);
+        $this->registry = $registry;
+        $this->managerName = $managerName;
+        $this->classOrAlias = $classOrAlias;
         $this->property = $property;
     }
 
@@ -51,14 +46,15 @@ public function __construct(ManagerRegistry $registry, $class, $property = null,
      */
     public function loadUserByUsername($username)
     {
+        $repository = $this->getRepository();
         if (null !== $this->property) {
-            $user = $this->repository->findOneBy(array($this->property => $username));
+            $user = $repository->findOneBy(array($this->property => $username));
         } else {
-            if (!$this->repository instanceof UserProviderInterface) {
-                throw new \InvalidArgumentException(sprintf('The Doctrine repository "%s" must implement UserProviderInterface.', get_class($this->repository)));
+            if (!$repository instanceof UserProviderInterface) {
+                throw new \InvalidArgumentException(sprintf('The Doctrine repository "%s" must implement UserProviderInterface.', get_class($repository)));
             }
 
-            $user = $this->repository->loadUserByUsername($username);
+            $user = $repository->loadUserByUsername($username);
         }
 
         if (null === $user) {
@@ -73,26 +69,28 @@ public function loadUserByUsername($username)
      */
     public function refreshUser(UserInterface $user)
     {
-        if (!$user instanceof $this->class) {
+        $class = $this->getClass();
+        if (!$user instanceof $class) {
             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_class($user)));
         }
 
-        if ($this->repository instanceof UserProviderInterface) {
-            $refreshedUser = $this->repository->refreshUser($user);
+        $repository = $this->getRepository();
+        if ($repository instanceof UserProviderInterface) {
+            $refreshedUser = $repository->refreshUser($user);
         } else {
             // The user must be reloaded via the primary key as all other data
             // might have changed without proper persistence in the database.
             // That's the case when the user has been changed by a form with
             // validation errors.
-            if (!$id = $this->metadata->getIdentifierValues($user)) {
+            if (!$id = $this->getClassMetadata()->getIdentifierValues($user)) {
                 throw new \InvalidArgumentException('You cannot refresh a user '.
                     'from the EntityUserProvider that does not contain an identifier. '.
                     'The user object has to be serialized with its own identifier '.
                     'mapped by Doctrine.'
                 );
             }
 
-            $refreshedUser = $this->repository->find($id);
+            $refreshedUser = $repository->find($id);
             if (null === $refreshedUser) {
                 throw new UsernameNotFoundException(sprintf('User with id %s not found', json_encode($id)));
             }
@@ -106,6 +104,36 @@ public function refreshUser(UserInterface $user)
      */
     public function supportsClass($class)
     {
-        return $class === $this->class || is_subclass_of($class, $this->class);
+        return $class === $this->getClass() || is_subclass_of($class, $this->getClass());
+    }
+
+    private function getEntityManager()
+    {
+        return $this->registry->getManager($this->managerName);
+    }
+
+    private function getRepository()
+    {
+        return $this->getEntityManager()->getRepository($this->getClass());
+    }
+
+    private function getClass()
+    {
+        if (null === $this->class) {
+            $class = $this->classOrAlias;
+
+            if (false !== strpos($class, ':')) {
+                $class = $this->getClassMetadata()->getName();
+            }
+
+            $this->class = $class;
+        }
+
+        return $this->class;
+    }
+
+    private function getClassMetadata()
+    {
+        return $this->getEntityManager()->getClassMetadata($this->getClass());
     }
 }
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php b/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php
@@ -92,7 +92,7 @@ public function testSupportProxy()
     private function getManager($em, $name = null)
     {
         $manager = $this->getMock('Doctrine\Common\Persistence\ManagerRegistry');
-        $manager->expects($this->once())
+        $manager->expects($this->any())
             ->method('getManager')
             ->with($this->equalTo($name))
             ->will($this->returnValue($em));

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public function testSupportProxy()`
`92`	`92`	`private function getManager($em, $name = null)`
`93`	`93`	`{`
`94`	`94`	`$manager = $this->getMock('Doctrine\Common\Persistence\ManagerRegistry');`
`95`		`- $manager->expects($this->once())`
	`95`	`+ $manager->expects($this->any())`
`96`	`96`	`->method('getManager')`
`97`	`97`	`->with($this->equalTo($name))`
`98`	`98`	`->will($this->returnValue($em));`