Resolve duplicate github usernames

Author: digitlimit

app/Console/Commands/RemoveDuplicateGithubUsernames.php renamed to app/Console/Commands/ResolveDuplicateGithubUsernames.php

@@ -5,81 +5,73 @@
 use Illuminate\Console\Command;
 use App\Models\User;
 use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Support\Facades\Http;
+use App\Social\GithubUserApi;
 
-class RemoveDuplicateGithubUsernames extends Command
+class ResolveDuplicateGithubUsernames extends Command
 {
-    protected $signature = 'lio:remove-duplicate-github-usernames';
+    protected $signature = 'lio:resolve-duplicate-github-usernames';
 
-    protected $description = 'Removes duplicate Github usernames from the database';
+    protected $description = 'Resolve duplicate GitHub usernames from the database';
+
+    public function __construct(
+        private readonly GithubUserApi $github
+    ){
+        parent::__construct();
+    }
 
     public function handle(): void
     {
-        $this->info('Removing duplicate Github usernames...');
+        $this->info('Resolving duplicate Github usernames...');
 
-        $this->removeDuplicates();
+        $this->resolveDuplicates();
 
-        $this->info('Duplicate Github usernames removed!');
+        $this->info('Duplicate Github usernames resolved!');
     }
 
-    private function removeDuplicates(): void
+    /**
+     * Resolve duplicate github_username
+     */
+    private function resolveDuplicates(): void
     {
         $this
             ->duplicates()
             ->groupBy('github_username')
-            ->each(function (Collection $duplicates) {
+            ->each(function (Collection $users) {
 
                 $uniqueUsernames = [];
 
-                foreach($duplicates as $user) {
+                // order from the latest user to the oldest
+                $users = $users->sortByDesc('created_at');
 
-                    // set github_username to null if the user has no github_id
-                    if (! $user->github_id) {
-                        $user->update(['github_username' => null]);
-                        continue;
-                    }
+                // resolve each user with the same github_username
+                foreach($users as $user) {
 
-                    // fetch the user from GitHub
-                    $githubUser = $this->fetchFromGithub($user);
+                    // fetch the user from GitHub API
+                    $githubUser = $this->github->find($user->github_id);
 
-                    // if the user doesn't exist on GitHub, set github_username to null
+                    // if the user doesn't exist on GitHub
                     if (! $githubUser || ! $githubUser->login) {
-                        $user->update(['github_username' => null, 'github_id' => null]);
+                        $user->update(['github_username' => null]);
                         continue;
                     }
 
-                    // if the user's github_username marked as unique, set github_username to null
+                    // if the user's github_username marked as unique
                     if (in_array($githubUser->login, $uniqueUsernames)) {
-                        //TODO: delete user?
-                        $user->update(['github_username' => null, 'github_id' => null]);
+                        $user->update(['github_username' => null]);
                         continue;
                     }
 
                     // if the user exists on GitHub, update the user's github_username
                     $user->update(['github_username' => $githubUser->login]);
 
-                    // add the user's github_username to the uniqueUsernames array
+                    // mark the user's github_username as unique
                     $uniqueUsernames[] = $githubUser->login;
                 }
             });
     }
 
     /**
-     * @param User $user
-     * @return object|null
-     */
-    private function fetchFromGithub(User $user): ?object
-    {
-        $response = Http::get("https://api.github.com/user/{$user->github_id}");
-
-        if ($response->failed()) {
-            return null;
-        }
-
-        return $response->object();
-    }
-
-    /**
+     * Get all users with duplicate github_username
      * @return Collection
      */
     private function duplicates(): Collection

app/Http/Requests/RegisterRequest.php

@@ -26,7 +26,6 @@ public function rules(): array
             'name' => 'required|max:255',
             'email' => 'required|email|max:255|unique:users',
             'username' => 'required|alpha_dash|max:40|unique:users',
-            'github_username' => 'nullable|max:40|unique:users',
             'rules' => 'accepted',
             'terms' => 'accepted',
             'github_id' => ['required', new UniqueGitHubUser],

app/Listeners/FixDuplicateGithubUsername.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Listeners;
+
+use App\Models\User;
+use App\Social\GithubUserApi;
+use Illuminate\Auth\Events\Registered;
+
+final class FixDuplicateGithubUsername
+{
+    public function __construct(
+        private readonly GithubUserApi $github
+    ){
+    }
+
+    public function handle(Registered $event): void
+    {
+        $users = User::query()
+            ->whereGithubUsername($event->user->github_username)
+            ->where('id', '!=', $event->user->id)
+            ->get();
+
+        $users->each(function (User $user) use ($event) {
+            $githubUser = $this->github->find($user->github_id);
+
+            if (! $githubUser) {
+                $user->update(['github_username' => null]);
+                return;
+            }
+
+            $user->update(['github_username' => $githubUser->login]);
+        });
+    }
+}

app/Providers/EventServiceProvider.php

@@ -18,6 +18,7 @@
 use App\Listeners\SendNewSpamNotification;
 use App\Listeners\SubscribeUsersMentionedInReply;
 use App\Listeners\SubscribeUsersMentionedInThread;
+use App\Listeners\FixDuplicateGithubUsername;
 use App\Models\User;
 use App\Observers\UserObserver;
 use Illuminate\Auth\Events\Registered;
@@ -43,6 +44,7 @@ class EventServiceProvider extends ServiceProvider
         ],
         Registered::class => [
             SendEmailVerificationNotification::class,
+            FixDuplicateGithubUsername::class
         ],
         ReplyWasCreated::class => [
             MarkLastActivity::class,

app/Social/GithubUserApi.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Social;
+
+use Illuminate\Support\Facades\Http;
+
+class GithubUserApi
+{
+    private string $api = 'https://api.github.com/users';
+
+    /**
+     * @param int $id GitHub user id
+     * @return object|null
+     */
+    public function find(int $id): ?object
+    {
+        $response = Http::get($this->api . '/' . $id);
+
+        if ($response->failed()) {
+            return null;
+        }
+
+        return $response->object();
+    }
+}