Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[DoctrineBridge] Add username to UserNameNotFoundException #39880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 19, 2021

Conversation

qurben
Copy link
Contributor

@qurben qurben commented Jan 18, 2021

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.

@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 5.x branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@carsonbot carsonbot changed the title bug symfony/symfony#39878 [doctrine-bridge] Add username to UserNameNotFoundException [DoctrineBridge] bug symfony/symfony#39878 [doctrine-bridge] Add username to UserNameNotFoundException Jan 18, 2021
@xabbuh
Copy link
Member

xabbuh commented Jan 18, 2021

This exception is thrown in other places as well. Can you update them too?

@qurben
Copy link
Contributor Author

qurben commented Jan 18, 2021

@xabbuh I updated all other cases. There are some cases where the username is set on this exception after the fact such as in the following line:

I am not sure if these are still needed (they probably are)

@xabbuh
Copy link
Member

xabbuh commented Jan 19, 2021

Looks like we could update the Symfony\Component\Security\Guard\Provider\GuardAuthenticationProvider class as well.

@qurben qurben force-pushed the 4.4 branch 2 times, most recently from 4e23273 to 073a4b0 Compare January 19, 2021 09:12
@qurben
Copy link
Contributor Author

qurben commented Jan 19, 2021

I added the other two cases

@derrabus derrabus changed the title [DoctrineBridge] bug symfony/symfony#39878 [doctrine-bridge] Add username to UserNameNotFoundException [DoctrineBridge] Add username to UserNameNotFoundException Jan 19, 2021
@@ -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.');
$ex = new UsernameNotFoundException('User with id '.json_encode($id).' not found.');
$ex->setUsername(json_encode($id));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why json_encoding here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See for example

$this->expectExceptionMessage('User with id {"id1":1,"id2":2} not found');

Here $id is not a string or even string like, while the username field is documented to be a string. I guess UsernameNotFoundException does not convey what the exact error is, because $id is not a username.

@@ -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.');
$ex = new UsernameNotFoundException('User with id '.json_encode($id).' not found.');
$ex->setUsername(json_encode($id));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why json_encoding here?

@derrabus
Copy link
Member

Thank you @qurben.

@derrabus derrabus merged commit 35c19c8 into symfony:4.4 Jan 19, 2021
This was referenced Jan 27, 2021
@fabpot fabpot mentioned this pull request Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants