PHPStan improvements

.github/workflows/phpstan.yml

@@ -1,7 +1,7 @@
 name: PHPStan
 
 on:
-  push:
+  pull_request:
     paths:
       - '**.php'
       - 'phpstan.neon.dist'
@@ -16,11 +16,11 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.1'
+          php-version: '8.2'
           coverage: none
 
       - name: Install composer dependencies
         uses: ramsey/composer-install@v3
 
       - name: Run PHPStan
-        run: ./vendor/bin/phpstan analyse --error-format=github --no-parallel
+        run: ./vendor/bin/phpstan analyse --error-format=github --debug

phpstan.neon.dist

@@ -2,11 +2,12 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 8
     paths:
         - src
         - config
         - database
+        - tests/PHPStan
     tmpDir: build/phpstan
     parallel:
         maximumNumberOfProcesses: 1
@@ -15,4 +16,4 @@ services:
     -
         class: Vormkracht10\TwoFactorAuth\Tests\PHPStan\UserPropertiesClassReflectionExtension
         tags:
-            - phpstan.broker.propertiesClassReflectionExtension
+            - phpstan.broker.propertiesClassReflectionExtension

src/Enums/TwoFactorType.php

@@ -13,6 +13,11 @@ enum TwoFactorType: string implements HasLabel
     case email = 'email';
     case phone = 'phone';
 
+    /**
+     * Get the values of the enum.
+     *
+     * @return array<int, string|null>
+     */
     public static function values(): array
     {
         return array_map(fn ($type) => $type->getLabel(), self::cases());

src/Http/Livewire/Auth/Login.php

@@ -21,6 +21,7 @@
 use Laravel\Fortify\Actions\PrepareAuthenticatedSession;
 use Laravel\Fortify\Features;
 use Laravel\Fortify\Fortify;
+use Livewire\Features\SupportRedirects\Redirector;
 use Vormkracht10\TwoFactorAuth\Http\Middleware\RedirectIfTwoFactorAuthenticatable;
 use Vormkracht10\TwoFactorAuth\Http\Responses\LoginResponse;
 
@@ -30,13 +31,13 @@ class Login extends BaseLogin
 
     protected static string $view = 'filament-two-factor-auth::auth.login';
 
-    public $email = '';
+    public string $email = '';
 
-    public $password = '';
+    public string $password = '';
 
-    public $resetPasswordEnabled = false;
+    public bool $resetPasswordEnabled = false;
 
-    public $registrationEnabled = false;
+    public bool $registrationEnabled = false;
 
     public function mount(): void
     {
@@ -73,22 +74,24 @@ protected function getFormSchema(): array
         ];
     }
 
-    public function loginWithFortify()
+    public function loginWithFortify(): LoginResponse | Redirector | null
     {
-        session()->put('panel', Filament::getCurrentPanel()->getId());
+        session()->put('panel', Filament::getCurrentPanel()?->getId() ?? null);
 
         try {
             $this->rateLimit(5);
         } catch (TooManyRequestsException $exception) {
+            $notificationBody = __('filament-panels::pages/auth/login.notifications.throttled.body', [
+                'seconds' => $exception->secondsUntilAvailable,
+                'minutes' => ceil($exception->secondsUntilAvailable / 60),
+            ]);
+
             Notification::make()
                 ->title(__('filament-panels::pages/auth/login.notifications.throttled.title', [
                     'seconds' => $exception->secondsUntilAvailable,
                     'minutes' => ceil($exception->secondsUntilAvailable / 60),
                 ]))
-                ->body(array_key_exists('body', __('filament-panels::pages/auth/login.notifications.throttled') ?: []) ? __('filament-panels::pages/auth/login.notifications.throttled.body', [
-                    'seconds' => $exception->secondsUntilAvailable,
-                    'minutes' => ceil($exception->secondsUntilAvailable / 60),
-                ]) : null)
+                ->body(is_array($notificationBody) ? null : $notificationBody)
                 ->danger()
                 ->send();
 
@@ -107,6 +110,12 @@ public function loginWithFortify()
 
             $user = Filament::auth()->user();
 
+            if (! Filament::getCurrentPanel()) {
+                Filament::auth()->logout();
+
+                throw new \Exception('Current panel is not set.');
+            }
+
             if (
                 ($user instanceof FilamentUser) &&
                 (! $user->canAccessPanel(Filament::getCurrentPanel()))
@@ -122,7 +131,7 @@ public function loginWithFortify()
         });
     }
 
-    protected function loginPipeline(Request $request)
+    protected function loginPipeline(Request $request): Pipeline
     {
         if (Fortify::$authenticateThroughCallback) {
             return (new Pipeline(app()))->send($request)->through(array_filter(
@@ -149,9 +158,9 @@ protected function getPasswordFormComponent(): Component
     {
         return TextInput::make('password')
             ->label(__('filament-panels::pages/auth/login.form.password.label'))
-            ->hint(filament()->hasPasswordReset() ? new HtmlString(Blade::render('<x-filament::link href="/forgot-password"> {{ __(\'filament-panels::pages/auth/login.actions.request_password_reset.label\') }}</x-filament::link>')) : null)
+            ->hint(Filament::hasPasswordReset() ? new HtmlString(Blade::render('<x-filament::link href="/forgot-password"> {{ __(\'filament-panels::pages/auth/login.actions.request_password_reset.label\') }}</x-filament::link>')) : null)
             ->password()
-            ->revealable(filament()->arePasswordsRevealable())
+            ->revealable(Filament::arePasswordsRevealable())
             ->autocomplete('current-password')
             ->required()
             ->extraInputAttributes(['tabindex' => 2]);

src/Http/Livewire/Auth/LoginTwoFactor.php

@@ -27,7 +27,7 @@ class LoginTwoFactor extends Page implements HasActions, HasForms
 
     protected static bool $shouldRegisterNavigation = false;
 
-    public ?object $challengedUser = null;
+    public mixed $challengedUser = null;
 
     public function mount(TwoFactorLoginRequest $request): void
     {
@@ -68,15 +68,19 @@ private function throttle(): bool
 
             return true;
         } catch (TooManyRequestsException $exception) {
+            $translation = __('filament-panels::pages/auth/email-verification/email-verification-prompt.notifications.notification_resend_throttled');
+            $translationArray = is_array($translation) ? $translation : [];
+
             Notification::make()
                 ->title(__('filament-panels::pages/auth/email-verification/email-verification-prompt.notifications.notification_resend_throttled.title', [
                     'seconds' => $exception->secondsUntilAvailable,
                     'minutes' => $exception->minutesUntilAvailable,
                 ]))
-                ->body(array_key_exists('body', __('filament-panels::pages/auth/email-verification/email-verification-prompt.notifications.notification_resend_throttled') ?: []) ? __('filament-panels::pages/auth/email-verification/email-verification-prompt.notifications.notification_resend_throttled.body', [
-                    'seconds' => $exception->secondsUntilAvailable,
-                    'minutes' => $exception->minutesUntilAvailable,
-                ]) : null)
+                ->body(array_key_exists('body', $translationArray) ?
+                    __('filament-panels::pages/auth/email-verification/email-verification-prompt.notifications.notification_resend_throttled.body', [
+                        'seconds' => $exception->secondsUntilAvailable,
+                        'minutes' => $exception->minutesUntilAvailable,
+                    ]) : [])
                 ->danger()
                 ->send();
 

src/Http/Livewire/Auth/PasswordConfirmation.php

@@ -2,7 +2,6 @@
 
 namespace Vormkracht10\TwoFactorAuth\Http\Livewire\Auth;
 
-use Filament\Forms\Components\TextInput;
 use Filament\Forms\Concerns\InteractsWithForms;
 use Filament\Forms\Contracts\HasForms;
 use Filament\Notifications\Notification;
@@ -23,10 +22,15 @@ public function mount(): void
         }
     }
 
+    /**
+     * Get the form schema.
+     *
+     * @return array<int, \Filament\Forms\Components\TextInput>
+     */
     protected function getFormSchema(): array
     {
         return [
-            TextInput::make('password')
+            \Filament\Forms\Components\TextInput::make('password')
                 ->extraInputAttributes(['name' => 'password'])
                 ->label(__('Password'))
                 ->password()

src/Http/Livewire/Auth/PasswordReset.php

@@ -26,7 +26,7 @@ class PasswordReset extends Page implements HasForms
     public function mount(): void
     {
         if (Filament::auth()->check()) {
-            redirect()->intended(Filament::getCurrentPanel()->getUrl());
+            redirect()->intended(Filament::getCurrentPanel()?->getUrl() ?? config('fortify.home'));
         }
 
         if (session('status')) {

src/Http/Livewire/Auth/RequestPasswordReset.php

@@ -21,7 +21,7 @@ class RequestPasswordReset extends Page implements HasForms
     public function mount(): void
     {
         if (Filament::auth()->check()) {
-            redirect()->intended(Filament::getCurrentPanel()->getUrl());
+            redirect()->intended(Filament::getCurrentPanel()?->getUrl() ?? config('fortify.home'));
         }
 
         if (session('status')) {

src/Http/Responses/LoginResponse.php

@@ -17,6 +17,6 @@ public function toResponse($request)
     {
         return $request->wantsJson()
             ? response()->json(['two_factor' => false])
-            : redirect()->intended(Filament::getCurrentPanel()->getUrl());
+            : redirect()->intended(Filament::getCurrentPanel()?->getUrl() ?? config('fortify.home'));
     }
 }

src/Http/Responses/TwoFactorChallengeViewResponse.php

@@ -15,6 +15,6 @@ class TwoFactorChallengeViewResponse implements LoginResponseContract
      */
     public function toResponse($request)
     {
-        return redirect()->intended(Filament::getCurrentPanel()->getUrl());
+        return redirect()->intended(Filament::getCurrentPanel()?->getUrl() ?? config('fortify.home'));
     }
 }

src/Listeners/SendTwoFactorCodeListener.php

@@ -21,7 +21,7 @@ public function __construct()
      */
     public function handle(TwoFactorAuthenticationChallenged | TwoFactorAuthenticationEnabled $event): void
     {
-        /** @var object $user */
+        /** @var mixed $user */
         $user = $event->user;
         $user->notify(app(SendOTP::class));
     }

src/Notifications/SendOTP.php

@@ -30,7 +30,7 @@ public function __construct()
      *
      * @return array<int, string>
      */
-    public function via(object $notifiable): array
+    public function via(mixed $notifiable): array
     {
         if ($notifiable->two_factor_type === TwoFactorType::email) {
             return ['mail'];
@@ -49,8 +49,12 @@ public function via(object $notifiable): array
     /**
      * Get the mail representation of the notification.
      */
-    public function toMail(object $notifiable): Mailable
+    public function toMail(mixed $notifiable): Mailable
     {
+        if (! $notifiable->two_factor_secret) {
+            throw new \Exception('User does not have a two factor secret.');
+        }
+
         return (new TwoFactorCodeMail($this->getTwoFactorCode($notifiable)))
             ->to($notifiable->email);
     }
@@ -60,7 +64,7 @@ public function toMail(object $notifiable): Mailable
      *
      * @return array<string, mixed>
      */
-    public function toArray(object $notifiable): array
+    public function toArray(mixed $notifiable): array
     {
         return [
             //
@@ -72,12 +76,8 @@ public function toArray(object $notifiable): array
      * @throws SecretKeyTooShortException
      * @throws InvalidCharactersException
      */
-    public function getTwoFactorCode(object $notifiable): ?string
+    public function getTwoFactorCode(mixed $notifiable): string
     {
-        if (! $notifiable->two_factor_secret) {
-            return null;
-        }
-
         return GenerateOTP::for(
             decrypt($notifiable->two_factor_secret)
         );