Retrieve mandatory email address from Github #129
Conversation
The /user API returns only the data the user explicitly set as public and null for those he didn't. If the user did not set the email address public (me for example), the email address being mandatory for the process, the authentication fails returning an error message. By using the /user/emails API in conjunction, it is possible to retrieve all the email addresses the user set in Github, regardless if they are set public or not, and select one of those (ex: primary one), for the login process to complete successfully.
…-Github The /user API returns only the data the user explicitly set as public and null for those he didn't. If the user did not set the email address public (me for example), the email address being mandatory for the process, the authentication fails returning an error message. By using the /user/emails API in conjunction, it is possible to retrieve all the email addresses the user set in Github, regardless if they are set public or not, and select one of those (ex: primary one), for the login process to complete successfully.
WalkthroughThe updates to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- src/Libraries/GithubOAuth.php (2 hunks)
Additional comments not posted (3)
src/Libraries/GithubOAuth.php (3)
107-124: LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
fetchUserEmailsWithTokenare correctly handled.Verification successful
LGTM! But verify the function usage in the codebase.
The code changes are approved.
The function
fetchUserEmailsWithTokenis used correctly within the same file and is properly handled by thegetUserPrimaryEmailmethod. No further issues were found.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `fetchUserEmailsWithToken` are correctly handled. # Test: Search for the function usage. Expect: Proper handling of the function calls. rg --type php -A 5 $'fetchUserEmailsWithToken'Length of output: 773
Script:
#!/bin/bash # Description: Verify all function calls to `getUserPrimaryEmail` are correctly handled. # Test: Search for the function usage. Expect: Proper handling of the function calls. rg --type php -A 5 $'getUserPrimaryEmail'Length of output: 963
129-135: LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
getUserPrimaryEmailare correctly handled.Verification successful
Verify the implementation of
$this->fetchUserEmailsWithToken()and the$userInfoobject.The function
getUserPrimaryEmailis used to assign the primary email address to$userInfo->email. To ensure proper handling, verify the implementation of$this->fetchUserEmailsWithToken()and the$userInfoobject.
Verification successful: Proper handling of
getUserPrimaryEmailfunction usage.The function
getUserPrimaryEmailis correctly handled in the codebase. The implementation offetchUserEmailsWithTokenand the handling of the$userInfoobject are appropriate and ensure the correct functionality.
- The
fetchUserEmailsWithTokenfunction is implemented to retrieve user emails from an API.- The
$userInfoobject is properly utilized to handle user information, including setting the primary email.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `getUserPrimaryEmail` are correctly handled. # Test: Search for the function usage. Expect: Proper handling of the function calls. rg --type php -A 5 $'getUserPrimaryEmail'Length of output: 963
Script:
#!/bin/bash # Description: Verify the implementation of fetchUserEmailsWithToken and the userInfo object. # Test: Search for the implementation of fetchUserEmailsWithToken. Expect: Proper implementation. rg --type php -A 5 $'fetchUserEmailsWithToken' # Test: Search for the definition and usage of $userInfo. Expect: Proper handling of the object. rg --type php -A 5 $'userInfo'Length of output: 9906
94-101: LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
fetchUserInfoWithTokenare correctly handled.Verification successful
To ensure that the function
fetchUserInfoWithTokenis correctly handled across the codebase, we need to verify its usage in theAbstractOAuth.phpclass and how it is overridden inGithubOAuth.phpandGoogleOAuth.php.
To ensure the changes in
GithubOAuth.phpare correctly handled, we need to retrieve the full method inAbstractOAuth.phpthat callsfetchUserInfoWithToken.
To retrieve the full method in
AbstractOAuth.phpthat callsfetchUserInfoWithToken, we will usergto search for the method definition and its surrounding context.
To ensure that the changes in
GithubOAuth.phpare correctly integrated, we need to confirm that thegetUserInfomethod inAbstractOAuth.phpis used correctly in the codebase.
Function usage is correctly handled.
The changes in
GithubOAuth.phpensure that a valid email address is always retrieved, which is critical for the logic inOAuthController.php. This confirms that the changes are correctly integrated and handled in the codebase.
OAuthController.php: ThegetUserInfomethod is used to retrieve user information, which includes the mandatory email address.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `fetchUserInfoWithToken` are correctly handled. # Test: Search for the function usage. Expect: Proper handling of the function calls. rg --type php -A 5 $'fetchUserInfoWithToken'Length of output: 2158
Script:
#!/bin/bash # Verify the context in AbstractOAuth.php where fetchUserInfoWithToken is called rg --type php -A 10 $'fetchUserInfoWithToken' src/Libraries/Basic/AbstractOAuth.php # Check how fetchUserInfoWithToken is overridden in GithubOAuth.php and GoogleOAuth.php rg --type php -A 10 $'fetchUserInfoWithToken' src/Libraries/GithubOAuth.php rg --type php -A 10 $'fetchUserInfoWithToken' src/Libraries/GoogleOAuth.phpLength of output: 1743
Script:
#!/bin/bash # Retrieve the full method in AbstractOAuth.php that calls fetchUserInfoWithToken ast-grep --lang php --pattern $'abstract class AbstractOAuth { $$$ protected function $_($_) { $$$ return $this->fetchUserInfoWithToken(); $$$ } $$$ }' src/Libraries/Basic/AbstractOAuth.phpLength of output: 317
Script:
#!/bin/bash # Retrieve the full method in AbstractOAuth.php that calls fetchUserInfoWithToken rg --type php -A 20 $'fetchUserInfoWithToken' src/Libraries/Basic/AbstractOAuth.phpLength of output: 760
Script:
#!/bin/bash # Verify the usage of getUserInfo method in the codebase rg --type php -A 10 $'getUserInfo' src/Length of output: 1590
The /user API returns only the data the user explicitly set as public and null for those he didn't.
If the user did not set the email address public (me for example), the email address being mandatory for the process, the authentication fails returning an error message.
By using the /user/emails API in conjunction, it is possible to retrieve all the email addresses the user set in Github, regardless if they are set public or not, and select one of those (ex: primary one), for the login process to complete successfully.
Summary by CodeRabbit
New Features
Improvements