[Security] Rename UserInterface::getUsername() to getUserIdentifier()

Author: wouterj

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 5.3
 ---
 
+ * Deprecate `UserLoaderInterface::loadUserByUsername()` in favor of `UserLoaderInterface::loadUserByIdentifier()
  * Deprecate `DoctrineTestHelper` and `TestRepositoryFactory`
  * [BC BREAK] Remove `UuidV*Generator` classes
  * Add `UuidGenerator`

Security/RememberMe/DoctrineTokenProvider.php

@@ -119,7 +119,8 @@ public function createNewToken(PersistentTokenInterface $token)
             .' VALUES (:class, :username, :series, :value, :lastUsed)';
         $paramValues = [
             'class' => $token->getClass(),
-            'username' => $token->getUsername(),
+            // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+            'username' => method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername(),
             'series' => $token->getSeries(),
             'value' => $token->getTokenValue(),
             'lastUsed' => $token->getLastUsed(),

Security/User/EntityUserProvider.php

@@ -16,7 +16,7 @@
 use Doctrine\Persistence\ObjectManager;
 use Doctrine\Persistence\ObjectRepository;
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
-use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\UserNotFoundException;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -50,21 +50,35 @@ public function __construct(ManagerRegistry $registry, string $classOrAlias, str
      * {@inheritdoc}
      */
     public function loadUserByUsername(string $username)
+    {
+        trigger_deprecation('symfony/doctrine-bridge', '5.3', 'Method "%s()" is deprecated, use loadUserByIdentifier() instead.', __METHOD__);
+
+        return $this->loadUserByIdentifier($username);
+    }
+
+    public function loadUserByIdentifier(string $identifier): UserInterface
     {
         $repository = $this->getRepository();
         if (null !== $this->property) {
-            $user = $repository->findOneBy([$this->property => $username]);
+            $user = $repository->findOneBy([$this->property => $identifier]);
         } else {
             if (!$repository instanceof UserLoaderInterface) {
                 throw new \InvalidArgumentException(sprintf('You must either make the "%s" entity Doctrine Repository ("%s") implement "Symfony\Bridge\Doctrine\Security\User\UserLoaderInterface" or set the "property" option in the corresponding entity provider configuration.', $this->classOrAlias, get_debug_type($repository)));
             }
 
-            $user = $repository->loadUserByUsername($username);
+            // @deprecated since 5.3, change to $repository->loadUserByIdentifier() in 6.0
+            if (method_exists($repository, 'loadUserByIdentifier')) {
+                $user = $repository->loadUserByIdentifier($identifier);
+            } else {
+                trigger_deprecation('symfony/doctrine-bridge', '5.3', 'Not implementing method "loadUserByIdentifier()" in user loader "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($repository));
+
+                $user = $repository->loadUserByUsername($identifier);
+            }
         }
 
         if (null === $user) {
-            $e = new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
-            $e->setUsername($username);
+            $e = new UserNotFoundException(sprintf('User "%s" not found.', $identifier));
+            $e->setUserIdentifier($identifier);
 
             throw $e;
         }
@@ -96,8 +110,8 @@ public function refreshUser(UserInterface $user)
 
             $refreshedUser = $repository->find($id);
             if (null === $refreshedUser) {
-                $e = new UsernameNotFoundException('User with id '.json_encode($id).' not found.');
-                $e->setUsername(json_encode($id));
+                $e = new UserNotFoundException('User with id '.json_encode($id).' not found.');
+                $e->setUserIdentifier(json_encode($id));
 
                 throw $e;
             }

Security/User/UserLoaderInterface.php

@@ -22,16 +22,11 @@
  *
  * @see UserInterface
  *
+ * @method UserInterface|null loadUserByIdentifier(string $identifier) loads the user for the given user identifier (e.g. username or email).
+ *                                                                     This method must return null if the user is not found.
+ *
  * @author Michal Trojanowski <[email protected]>
  */
 interface UserLoaderInterface
 {
-    /**
-     * Loads the user for the given username.
-     *
-     * This method must return null if the user is not found.
-     *
-     * @return UserInterface|null
-     */
-    public function loadUserByUsername(string $username);
 }

Tests/Fixtures/BaseUser.php

@@ -37,4 +37,9 @@ public function getUsername(): string
     {
         return $this->username;
     }
+
+    public function getUserIdentifier(): string
+    {
+        return $this->username;
+    }
 }

Tests/Fixtures/User.php

@@ -53,6 +53,11 @@ public function getUsername(): string
         return $this->name;
     }
 
+    public function getUserIdentifier(): string
+    {
+        return $this->name;
+    }
+
     public function eraseCredentials()
     {
     }

Tests/Security/User/EntityUserProviderTest.php

@@ -21,7 +21,7 @@
 use Symfony\Bridge\Doctrine\Security\User\UserLoaderInterface;
 use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\User;
-use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\UserNotFoundException;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -60,7 +60,7 @@ public function testLoadUserByUsername()
 
         $provider = new EntityUserProvider($this->getManager($em), 'Symfony\Bridge\Doctrine\Tests\Fixtures\User', 'name');
 
-        $this->assertSame($user, $provider->loadUserByUsername('user1'));
+        $this->assertSame($user, $provider->loadUserByIdentifier('user1'));
     }
 
     public function testLoadUserByUsernameWithUserLoaderRepositoryAndWithoutProperty()
@@ -70,7 +70,7 @@ public function testLoadUserByUsernameWithUserLoaderRepositoryAndWithoutProperty
         $repository = $this->createMock(UserLoaderRepository::class);
         $repository
             ->expects($this->once())
-            ->method('loadUserByUsername')
+            ->method('loadUserByIdentifier')
             ->with('user1')
             ->willReturn($user);
 
@@ -82,7 +82,7 @@ public function testLoadUserByUsernameWithUserLoaderRepositoryAndWithoutProperty
             ->willReturn($repository);
 
         $provider = new EntityUserProvider($this->getManager($em), 'Symfony\Bridge\Doctrine\Tests\Fixtures\User');
-        $this->assertSame($user, $provider->loadUserByUsername('user1'));
+        $this->assertSame($user, $provider->loadUserByIdentifier('user1'));
     }
 
     public function testLoadUserByUsernameWithNonUserLoaderRepositoryAndWithoutProperty()
@@ -98,7 +98,7 @@ public function testLoadUserByUsernameWithNonUserLoaderRepositoryAndWithoutPrope
         $em->flush();
 
         $provider = new EntityUserProvider($this->getManager($em), 'Symfony\Bridge\Doctrine\Tests\Fixtures\User');
-        $provider->loadUserByUsername('user1');
+        $provider->loadUserByIdentifier('user1');
     }
 
     public function testRefreshUserRequiresId()
@@ -126,7 +126,7 @@ public function testRefreshInvalidUser()
         $provider = new EntityUserProvider($this->getManager($em), 'Symfony\Bridge\Doctrine\Tests\Fixtures\User', 'name');
 
         $user2 = new User(1, 2, 'user2');
-        $this->expectException(UsernameNotFoundException::class);
+        $this->expectException(UserNotFoundException::class);
         $this->expectExceptionMessage('User with id {"id1":1,"id2":2} not found');
 
         $provider->refreshUser($user2);
@@ -153,7 +153,7 @@ public function testLoadUserByUserNameShouldLoadUserWhenProperInterfaceProvided(
     {
         $repository = $this->createMock(UserLoaderRepository::class);
         $repository->expects($this->once())
-            ->method('loadUserByUsername')
+            ->method('loadUserByIdentifier')
             ->with('name')
             ->willReturn(
                 $this->createMock(UserInterface::class)
@@ -164,7 +164,7 @@ public function testLoadUserByUserNameShouldLoadUserWhenProperInterfaceProvided(
             'Symfony\Bridge\Doctrine\Tests\Fixtures\User'
         );
 
-        $provider->loadUserByUsername('name');
+        $provider->loadUserByIdentifier('name');
     }
 
     public function testLoadUserByUserNameShouldDeclineInvalidInterface()
@@ -177,7 +177,7 @@ public function testLoadUserByUserNameShouldDeclineInvalidInterface()
             'Symfony\Bridge\Doctrine\Tests\Fixtures\User'
         );
 
-        $provider->loadUserByUsername('name');
+        $provider->loadUserByIdentifier('name');
     }
 
     public function testPasswordUpgrades()
@@ -231,6 +231,7 @@ private function createSchema($em)
 
 abstract class UserLoaderRepository implements ObjectRepository, UserLoaderInterface
 {
+    abstract public function loadUserByIdentifier(string $identifier): ?UserInterface;
 }
 
 abstract class PasswordUpgraderRepository implements ObjectRepository, PasswordUpgraderInterface