Log in using GitHub #680

carlos-granados · 2024-09-30T17:10:58Z

Given that users can connect their GitHub account to their Pinkary account, this PR allows them to log in using their GitHub account. We show a new "log in using GitHub" link in the login page.

If you have already linked your GitHub account to your Pinkary account, when clicking this link you will be automatically logged in.
If you have not linked your GitHub account to your Pinkary account but there is a Pinkary account linked to your GitHub email, when clicking this link you will be automatically logged in and your GitHub account will be linked to your Pinkary account
If there is no Pinkary account that matches your GitHub email, you will be redirected to the "Register" page with the email pre-filled with your GitHub account and you will be able to fill in the rest of your details. Once you submit your registration, your GitHub account will also be linked to your PInkary Account

NOTE: Given that when setting up the application in GitHub you cannot list more than one callback URL and given that now we need to redirect the GitHub login to two different endpoints depending on whether you are logged in or not, we need to modify the URL listed in the application to only list the prefix that is common to both URLs, because GitHub will accept any callback URL that matches the prefix listed in the app definition. So instead of listing the callback URL as :
https://pinkary.com/profile/connect/github/update
It needs to be listed as:
https://pinkary.com/profile/connect/github
This will also accept the new URL:
https://pinkary.com/profile/connect/github/login/callback
This change can be done in advance, before deploying this new version and it will continue to work with the old version

NOTE: My experience with Laravel is quite limited. I have tried to follow the same principles and architecture as in the existing code but there may be cases where things could have been done in a better way. If that is the case, let me know and I will update the code

See the PR comments for more info

carlos-granados · 2024-09-30T17:11:54Z

.env.example

@@ -65,7 +65,6 @@ LEMON_SQUEEZY_PATH=
 GITHUB_PERSONAL_ACCESS_TOKEN=
 GITHUB_CLIENT_ID=
 GITHUB_CLIENT_SECRET=
-GITHUB_REDIRECT_URI=


Given that there are now two different callbacks, the redirect URL is not loaded from the config, it is set up dynamically in each of the redirecting endpoints

carlos-granados · 2024-09-30T17:12:51Z

app/Http/Controllers/Auth/GitHubLoginController.php

+    /**
+     * Handles the GitHub login redirect.
+     */
+    public function index(): RedirectResponse


This is the endpoint called from the "Log in using github" in the login page, it redirects you to GitHub's authentication page, setting the right callback url

carlos-granados · 2024-09-30T17:13:50Z

app/Http/Controllers/Auth/GitHubLoginController.php

+
+        $user = User::where('email', $githubUser->getEmail())->first();
+        if (! $user instanceof User) {
+            session([


If there is no user with the email sent back by GitHub, we redirect the user to the "register" page, and we save in the session the github email and the username so that they can be used in that page

carlos-granados · 2024-09-30T17:14:31Z

app/Http/Controllers/Auth/GitHubLoginController.php

+            return to_route('register');
+        }
+        if ($user->github_username === null) {
+            $errors = $github->linkGitHubUser($githubUser->getNickname(), $user, $request);


If the user with the GitHub email is not yet linked to this GitHub account, we try to link it

carlos-granados · 2024-09-30T17:16:06Z

app/Http/Controllers/Auth/GitHubLoginController.php

+        if ($user->github_username === null) {
+            $errors = $github->linkGitHubUser($githubUser->getNickname(), $user, $request);
+
+            if ($errors !== []) {


This error will only happen in a very unusual situation: if there is already a user linked to this GitHub account but the email in the Pinkary account does not match the email in the GitHub account. In this case we cannot link the user or log them in, so we redirect back to login with an error

carlos-granados · 2024-09-30T17:26:13Z

resources/views/auth/register.blade.php

@@ -61,11 +72,12 @@ class="mt-2"
            />
            <x-text-input
                id="email"
-                class="mt-1 block w-full"
+                class="mt-1 block w-full {{ $githubEmail !== null ? 'text-slate-500' : '' }}"


If we received the email from GitHub we mark it as readonly and with a lighter colour

carlos-granados · 2024-09-30T17:26:42Z

resources/views/auth/register.blade.php

@@ -162,6 +174,15 @@ class="mt-2"
            />
        @endif

+        @if ($githubUsername)
+            <x-text-input


We add a hidden field to be able to send back the GitHub username back to the registration controller

carlos-granados · 2024-09-30T17:27:06Z

routes/auth.php

@@ -47,6 +48,15 @@
        ->middleware('throttle:two-factor');
 });

+Route::prefix('/profile/connect/github')->group(function () {


The new routes for the GitHub login. They don't need authorization

carlos-granados · 2024-09-30T17:27:34Z

tests/Http/Profile/Connect/GitHub/IndexTest.php

@@ -17,4 +17,5 @@

    $response->assertStatus(302);
    $response->assertRedirectContains('https://github.com/login/oauth/authorize');
+    $response->assertRedirectContains('update');


We test that both callback URLs are different

carlos-granados · 2024-09-30T17:27:57Z

tests/Http/Register/CreateTest.php

    ], absolute: false));
+
+    expect($user->email_verified_at)->toBeNull();


If you register normally, your email won't be verified

carlos-granados · 2024-11-07T17:04:56Z

@nunomaduro any interest on this? Just wondering if I need to keep it updated. Thanks!!

carlos-granados commented Sep 30, 2024

View reviewed changes

Log in using GitHub

b74957a

carlos-granados force-pushed the github-login branch from 5a72056 to b74957a Compare October 9, 2024 14:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Log in using GitHub #680

Log in using GitHub #680

carlos-granados commented Sep 30, 2024 •

edited

Loading

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados Sep 30, 2024

carlos-granados commented Nov 7, 2024

		], absolute: false));

		expect($user->email_verified_at)->toBeNull();

Log in using GitHub #680

Are you sure you want to change the base?

Log in using GitHub #680

Conversation

carlos-granados commented Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlos-granados commented Nov 7, 2024

carlos-granados commented Sep 30, 2024 •

edited

Loading