Fix possible notice when no user is set #17624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sgiehl
added
c: Tests & QA
diosmosis
reviewed
May 26, 2021
| @@ -176,7 +176,7 @@ public static function getRandomTitle() | |||
| public static function getCurrentUserEmail() | |||
| { | |||
| $user = APIUsersManager::getInstance()->getUser(Piwik::getCurrentUserLogin()); | |||
| return $user['email']; | |||
There was a problem hiding this comment.
I think the phpdocs need to be changed here too. And do we need to mention in the developer changelog that the value can be empty now? I guess it might always have been possible if the user was anonymous...
There was a problem hiding this comment.
The phpdocs now actually would fit. Before it could maybe have returned null if the user array was empty.
Don't think we need to mention it in the developer docs. The change actually only avoids a possible warning in this case.
mattab
added
the
not-in-changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Especially in tests it might be possible that a user is actually not set. If for any reason
Piwik::getCurrentUserEmail()is then called a notice might be triggered causing a test to fail.In theory there might also be other use cases where that could happen. Like using a custom login plugin, that actually does not use the users stored in database.
Review