fix: authentication tests and PHPStan errors after Flux migration (#448)

Author: mckenziearts

app/Enums/UserRole.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Enums;
+
+enum UserRole: string
+{
+    case Admin = 'admin';
+
+    case Company = 'company';
+
+    case Moderator = 'moderator';
+
+    case User = 'user';
+}

app/Livewire/Forms/RegisterForm.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Livewire\Forms;
+
+use App\Enums\UserRole;
+use App\Models\User;
+use Illuminate\Auth\Events\Registered;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Validation\Rules\Password;
+use Livewire\Form;
+
+final class RegisterForm extends Form
+{
+    public string $name = '';
+
+    public string $email = '';
+
+    public string $password = '';
+
+    public string $username = '';
+
+    public function createUser(): void
+    {
+        $password = Hash::make($this->password);
+
+        $user = User::query()->create([
+            'password' => $password,
+            ...$this->only(['name', 'username', 'email']),
+        ]);
+
+        $user->assignRole(UserRole::User->value);
+
+        event(new Registered($user));
+    }
+
+    protected function rules(): array
+    {
+        $emailRules = ['required', 'string', 'lowercase', 'email:rfc', 'max:255', 'unique:users'];
+
+        if (! app()->environment('testing')) {
+            $emailRules = ['required', 'string', 'lowercase', 'email:rfc,dns', 'max:255', 'unique:users'];
+        }
+
+        return [
+            'name' => ['required', 'string', 'max:255'],
+            'email' => $emailRules,
+            'username' => ['required', 'string', 'max:30', 'unique:users', 'lowercase'],
+            'password' => [
+                'required',
+                'string',
+                Password::min(8)
+                    ->uncompromised()
+                    ->numbers()
+                    ->mixedCase(),
+            ],
+        ];
+    }
+}

app/Livewire/Pages/Auth/ForgotPassword.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Livewire\Pages\Auth;
+
+use Flux\Flux;
+use Illuminate\Contracts\View\View;
+use Illuminate\Support\Facades\Password;
+use Livewire\Attributes\Layout;
+use Livewire\Attributes\Validate;
+use Livewire\Component;
+
+#[Layout('layouts.base')]
+final class ForgotPassword extends Component
+{
+    #[Validate('required|string|email')]
+    public string $email = '';
+
+    public function sendPasswordResetLink(): void
+    {
+        $this->validate();
+
+        $status = Password::sendResetLink(
+            $this->only('email')
+        );
+
+        if ($status !== Password::RESET_LINK_SENT) {
+            $this->addError('email', __($status));
+
+            return;
+        }
+
+        $this->reset('email');
+
+        Flux::toast(text: __($status), variant: 'success');
+    }
+
+    public function render(): View
+    {
+        return view('livewire.pages.auth.forgot-password')
+            ->title(__('pages/auth.forgot.page_title'));
+    }
+}

app/Livewire/Pages/Auth/Login.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Livewire\Pages\Auth;
+
+use App\Livewire\Forms\LoginForm;
+use Illuminate\Contracts\View\View;
+use Illuminate\Support\Facades\Session;
+use Livewire\Attributes\Layout;
+use Livewire\Component;
+
+#[Layout('layouts.base')]
+final class Login extends Component
+{
+    public LoginForm $form;
+
+    public function login(): void
+    {
+        $this->validate();
+
+        $this->form->authenticate();
+
+        Session::regenerate();
+
+        $this->redirectIntended(default: route('dashboard', absolute: false), navigate: true);
+    }
+
+    public function render(): View
+    {
+        return view('livewire.pages.auth.login')
+            ->title(__('pages/auth.login.page_title'));
+    }
+}

app/Livewire/Pages/Auth/Register.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Livewire\Pages\Auth;
+
+use App\Livewire\Forms\RegisterForm;
+use App\Models\User;
+use Flux\Flux;
+use Illuminate\Contracts\View\View;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Support\Facades\Cache;
+use Livewire\Attributes\Computed;
+use Livewire\Attributes\Layout;
+use Livewire\Component;
+
+/**
+ * @property-read Collection<int, User> $users
+ */
+#[Layout('layouts.base')]
+final class Register extends Component
+{
+    public RegisterForm $form;
+
+    public function register(): void
+    {
+        $this->form->validate();
+
+        $this->form->createUser();
+
+        Flux::toast(
+            text: __('pages/auth.register.email_verification_status'),
+            heading: __('pages/auth.register.email_verification_title'),
+            variant: 'success'
+        );
+
+        $this->form->reset();
+    }
+
+    #[Computed(persist: true, seconds: 3600 * 7, cache: true, key: 'registration.users')]
+    public function users(): Collection
+    {
+        /** @var Collection<int, User> $users */
+        $users = Cache::remember(
+            key: 'avatars',
+            ttl: now()->addWeek(),
+            callback: fn (): Collection => User::query() // @phpstan-ignore-line
+                ->select('id', 'email_verified_at', 'username', 'avatar_type', 'name')
+                ->scopes('verifiedUsers')
+                ->inRandomOrder()
+                ->take(10)
+                ->get()
+        );
+
+        return $users;
+    }
+
+    public function render(): View
+    {
+        return view('livewire.pages.auth.register')
+            ->title(__('pages/auth.register.page_title'));
+    }
+}

app/Livewire/Pages/Auth/ResetPassword.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Livewire\Pages\Auth;
+
+use App\Models\User;
+use Flux\Flux;
+use Illuminate\Auth\Events\PasswordReset;
+use Illuminate\Contracts\View\View;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\Password;
+use Illuminate\Support\Str;
+use Illuminate\Validation\Rules\Password as PasswordRules;
+use Livewire\Attributes\Layout;
+use Livewire\Attributes\Locked;
+use Livewire\Component;
+
+#[Layout('layouts.base')]
+final class ResetPassword extends Component
+{
+    #[Locked]
+    public string $token = '';
+
+    public string $email = '';
+
+    public string $password = '';
+
+    public string $password_confirmation = '';
+
+    public function mount(string $token): void
+    {
+        $this->token = $token;
+        $this->email = (string) request()->string('email');
+    }
+
+    public function resetPassword(): void
+    {
+        $this->validate([
+            'token' => ['required'],
+            'email' => ['required', 'string', 'email'],
+            'password' => [
+                'required',
+                'string',
+                'confirmed',
+                PasswordRules::min(8)
+                    ->uncompromised()
+                    ->numbers()
+                    ->mixedCase(),
+            ],
+        ]);
+
+        /** @var string $status */
+        $status = Password::reset(
+            credentials: $this->only('email', 'password', 'password_confirmation', 'token'),
+            callback: function (User $user): void {
+                $user->forceFill([
+                    'password' => Hash::make($this->password),
+                    'remember_token' => Str::random(60),
+                ])->save();
+
+                event(new PasswordReset($user));
+            }
+        );
+
+        if ($status !== Password::PASSWORD_RESET) {
+            $this->addError('email', __($status));
+
+            return;
+        }
+
+        Flux::toast(text: __($status), variant: 'success');
+
+        $this->redirectRoute('login', navigate: true);
+    }
+
+    public function render(): View
+    {
+        return view('livewire.pages.auth.reset-password')
+            ->title(__('pages/auth.reset.page_title'));
+    }
+}

app/Livewire/Pages/Home.php

@@ -8,7 +8,7 @@
 use App\Models\Discussion;
 use App\Models\Thread;
 use Illuminate\Contracts\View\View;
-use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\Facades\Cache;
 use Livewire\Component;
 

app/Models/User.php

@@ -43,15 +43,15 @@
  * @property-read string $username
  * @property-read string $avatar_type
  * @property-read string $profile_photo_url
- * @property-read string|null $location
- * @property-read string|null $phone_number
- * @property-read string|null $github_profile
- * @property-read string|null $twitter_profile
- * @property-read string|null $linkedin_profile
- * @property-read string|null $bio
- * @property-read string|null $website
- * @property-read string|null $banned_reason
- * @property-read array<array-key, mixed>|null $settings
+ * @property-read ?string $location
+ * @property-read ?string $phone_number
+ * @property-read ?string $github_profile
+ * @property-read ?string $twitter_profile
+ * @property-read ?string $linkedin_profile
+ * @property-read ?string $bio
+ * @property-read ?string $website
+ * @property-read ?string $banned_reason
+ * @property-read array<string, mixed>|null $settings
  * @property-read CarbonInterface|null $email_verified_at
  * @property-read CarbonInterface|null $last_login_at
  * @property-read CarbonInterface|null $banned_at
@@ -92,9 +92,9 @@ final class User extends Authenticatable implements FilamentUser, HasAvatar, Has
         'last_active_at',
     ];
 
-    public static function findByEmailAddress(string $emailAddress): self
+    public static function findByEmailAddress(string $emailAddress): ?self
     {
-        return self::query()->where('email', $emailAddress)->firstOrFail();
+        return self::query()->where('email', $emailAddress)->first();
     }
 
     public static function findOrCreateSocialUserProvider(SocialUser $socialUser, string $provider, string $role = 'user'): self
@@ -152,11 +152,7 @@ public function isLoggedInUser(): bool
 
     public function canAccessPanel(Panel $panel): bool
     {
-        if (str_ends_with($this->email, '@laravel.cm')) {
-            return true;
-        }
-
-        if ($this->isModerator()) {
+        if (str_ends_with($this->email, '@laravel.cm') && $this->isModerator()) {
             return true;
         }
 
@@ -215,6 +211,9 @@ public function deleteReplies(): void
         }
     }
 
+    /**
+     * @return Collection<int, Article>
+     */
     public function latestArticles(int $amount = 10): Collection
     {
         return $this->articles()->latest()->limit($amount)->get();