bug #39880 [DoctrineBridge] Add username to UserNameNotFoundException (qurben)

derrabus · derrabus · commit 35c19c876b32 · 2021-01-19T21:45:16.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [DoctrineBridge] Add username to UserNameNotFoundException | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #39878  | License | MIT | Doc PR |   Adds username to UserNameNotFoundException when thrown from EntityUserProvider. In other places there are no tests for this and I am not sure if the current setup even allows asserting if exceptions contain fields, besides the default ones. Commits ------- ee5b51a bug #39878 [doctrine-bridge] Add username to UserNameNotFoundException
diff --git a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php
@@ -62,7 +62,10 @@ public function loadUserByUsername($username)
         }
 
         if (null === $user) {
-            throw new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
+            $e = new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
+            $e->setUsername($username);
+
+            throw $e;
         }
 
         return $user;
@@ -92,7 +95,10 @@ public function refreshUser(UserInterface $user)
 
             $refreshedUser = $repository->find($id);
             if (null === $refreshedUser) {
-                throw new UsernameNotFoundException('User with id '.json_encode($id).' not found.');
+                $e = new UsernameNotFoundException('User with id '.json_encode($id).' not found.');
+                $e->setUsername(json_encode($id));
+
+                throw $e;
             }
         }
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/SecuredPageBundle/Security/Core/User/ArrayUserProvider.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/SecuredPageBundle/Security/Core/User/ArrayUserProvider.php
@@ -34,7 +34,10 @@ public function loadUserByUsername($username)
         $user = $this->getUser($username);
 
         if (null === $user) {
-            throw new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
+            $e = new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
+            $e->setUsername($username);
+
+            throw $e;
         }
 
         return $user;
diff --git a/src/Symfony/Component/Ldap/Security/LdapUserProvider.php b/src/Symfony/Component/Ldap/Security/LdapUserProvider.php
@@ -73,18 +73,27 @@ public function loadUserByUsername($username)
             $query = str_replace('{username}', $username, $this->defaultSearch);
             $search = $this->ldap->query($this->baseDn, $query);
         } catch (ConnectionException $e) {
-            throw new UsernameNotFoundException(sprintf('User "%s" not found.', $username), 0, $e);
+            $e = new UsernameNotFoundException(sprintf('User "%s" not found.', $username), 0, $e);
+            $e->setUsername($username);
+
+            throw $e;
         }
 
         $entries = $search->execute();
         $count = \count($entries);
 
         if (!$count) {
-            throw new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
+            $e = new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
+            $e->setUsername($username);
+
+            throw $e;
         }
 
         if ($count > 1) {
-            throw new UsernameNotFoundException('More than one user found.');
+            $e = new UsernameNotFoundException('More than one user found.');
+            $e->setUsername($username);
+
+            throw $e;
         }
 
         $entry = $entries[0];
diff --git a/src/Symfony/Component/Security/Guard/Provider/GuardAuthenticationProvider.php b/src/Symfony/Component/Security/Guard/Provider/GuardAuthenticationProvider.php
@@ -105,7 +105,10 @@ private function authenticateViaGuard(AuthenticatorInterface $guardAuthenticator
         $user = $guardAuthenticator->getUser($token->getCredentials(), $this->userProvider);
 
         if (null === $user) {
-            throw new UsernameNotFoundException(sprintf('Null returned from "%s::getUser()".', \get_class($guardAuthenticator)));
+            $e = new UsernameNotFoundException(sprintf('Null returned from "%s::getUser()".', \get_class($guardAuthenticator)));
+            $e->setUsername($token->getUsername());
+
+            throw $e;
         }
 
         if (!$user instanceof UserInterface) {

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,10 @@ public function loadUserByUsername($username)`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`if (null === $user) {`
`65`		`- throw new UsernameNotFoundException(sprintf('User "%s" not found.', $username));`
	`65`	`+ $e = new UsernameNotFoundException(sprintf('User "%s" not found.', $username));`
	`66`	`+ $e->setUsername($username);`
	`67`	`+`
	`68`	`+ throw $e;`
`66`	`69`	`}`
`67`	`70`
`68`	`71`	`return $user;`
`@@ -92,7 +95,10 @@ public function refreshUser(UserInterface $user)`
`92`	`95`
`93`	`96`	`$refreshedUser = $repository->find($id);`
`94`	`97`	`if (null === $refreshedUser) {`
`95`		`- throw new UsernameNotFoundException('User with id '.json_encode($id).' not found.');`
	`98`	`+ $e = new UsernameNotFoundException('User with id '.json_encode($id).' not found.');`
	`99`	`+ $e->setUsername(json_encode($id));`
	`100`	`+`
	`101`	`+ throw $e;`
`96`	`102`	`}`
`97`	`103`	`}`
`98`	`104`