Merge pull request #5 from DutchCodingCompany/add-switch-to-button

bramr94 · web-flow · commit f58e9b17e183 · 2024-05-03T11:51:34.000+02:00
Add switch to button when logged in
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -6,7 +6,9 @@ on:
       - '**.php'
       - '.github/workflows/phpstan.yml'
       - 'phpstan.neon.dist'
-    pull_request:
+  pull_request:
+    branches:
+      - '**'
 
 jobs:
   phpstan:
diff --git a/.github/workflows/run-test.yml b/.github/workflows/run-test.yml
@@ -9,6 +9,8 @@ on:
       - 'composer.json'
       - 'composer.lock'
   pull_request:
+    branches:
+      - '**'
 
 jobs:
   test:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to `dutchcodingcompany/developer-logins` will be documented in this file.
 
+## 1.1.0 - 2024-05-03
+
+- Added a "Switch to" button to the top right of the page when you are logged in. This button allows you to switch to another user without having to log out first.
+
 ## 1.0.0 - 2024-04-25
 
 - initial release
diff --git a/README.md b/README.md
@@ -51,6 +51,19 @@ FilamentDeveloperLoginsPlugin::make()
     ->enabled(app()->environment('local'))
 ```
 
+### switchable()
+
+By default, a "Switch to" button is shown in the top right corner of the screen, so you can easily switch between the provided users. 
+If you want to disable this feature, you can use the switchable() method.
+
+```php
+// ...
+FilamentDeveloperLoginsPlugin::make()
+    ->switchable(false) // This also accepts a closure.
+```
+
+![example-screenshot.png](docs-assets/screenshots/switchable-screenshot.png)
+
 ### column()
 
 By default, the user column is set to `email`. If you want to use a different column, you can use the column() method.
diff --git a/docs-assets/screenshots/switchable-screenshot.png b/docs-assets/screenshots/switchable-screenshot.png
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -13,7 +13,12 @@ parameters:
 		-
 			message: "#^Call to an undefined method object\\:\\:where\\(\\)\\.$#"
 			count: 1
-			path: src/Http/Controllers/DeveloperLoginsController.php
+			path: src/FilamentDevelopersLogin.php
+
+		-
+			message: "#^Call to an undefined method Livewire\\\\Features\\\\SupportTesting\\\\Testable\\:\\:test\\(\\)\\.$#"
+			count: 3
+			path: tests/Feature/MenuLoginsTest.php
 
 		-
 			message: "#^Access to an undefined property DutchCodingCompany\\\\FilamentDeveloperLogins\\\\Tests\\\\Fixtures\\\\TestUser\\:\\:\\$is_admin\\.$#"
diff --git a/resources/lang/en/auth.php b/resources/lang/en/auth.php
@@ -2,6 +2,7 @@
 
 return [
     'login-as' => 'Login as',
+    'switch-to' => 'Switch to',
 
     'messages' => [
         'failed' => 'Login failed, check if the user is allowed to access the panel.',
diff --git a/resources/views/components/developer-logins.blade.php b/resources/views/components/developer-logins.blade.php
@@ -1,4 +1,4 @@
-@foreach ($users as $label => $email)
+@foreach ($users as $label => $credentials)
     @if ($loop->first)
         <div class="flex flex-col gap-y-6">
             <div class="relative flex items-center justify-center text-center">
@@ -22,10 +22,10 @@
             @csrf
 
             <input type="hidden" name="panel_id" value="{{ \Filament\Facades\Filament::getId() }}">
-            <input type="hidden" name="credentials" value="{{ $email }}">
+            <input type="hidden" name="credentials" value="{{ $credentials }}">
 
             <x-filament::button class="w-full" color="gray" outlined="true" type="submit">
-                {{ "$label ($email)" }}
+                {{ "$label ($credentials)" }}
             </x-filament::button>
         </form>
     @if ($loop->first)
diff --git a/resources/views/livewire/menu-logins.blade.php b/resources/views/livewire/menu-logins.blade.php
@@ -0,0 +1,22 @@
+@if (filled($users))
+    <div>
+        <x-filament::dropdown>
+            <x-slot name="trigger">
+                <x-filament::button icon="heroicon-o-user" color="gray" outlined="false">
+                    {{ __('filament-developer-logins::auth.switch-to') }}
+                </x-filament::button>
+            </x-slot>
+
+            <x-filament::dropdown.list>
+                @foreach ($users as $label => $credentials)
+                    <x-filament::dropdown.list.item
+                        wire:click="loginAs('{{ $credentials }}')"
+                        color="{{ $credentials === $current ? 'primary' : 'gray' }}"
+                    >
+                        {{ "$label ($credentials)" }}
+                    </x-filament::dropdown.list.item>
+                @endforeach
+            </x-filament::dropdown.list>
+        </x-filament::dropdown>
+    </div>
+@endif
diff --git a/src/Facades/FilamentDevelopersLogin.php b/src/Facades/FilamentDevelopersLogin.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace DutchCodingCompany\FilamentDeveloperLogins\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @mixin \DutchCodingCompany\FilamentDeveloperLogins\FilamentDevelopersLogin
+ */
+class FilamentDevelopersLogin extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return 'filament-developers-login';
+    }
+}
diff --git a/src/FilamentDeveloperLoginsPlugin.php b/src/FilamentDeveloperLoginsPlugin.php
@@ -8,12 +8,17 @@
 use Filament\Contracts\Plugin;
 use Filament\Facades\Filament;
 use Filament\Panel;
+use Filament\Support\Concerns\EvaluatesClosures;
 use Illuminate\Contracts\Auth\Authenticatable;
 
 class FilamentDeveloperLoginsPlugin implements Plugin
 {
+    use EvaluatesClosures;
+
     public Closure | bool $enabled = false;
 
+    public Closure | bool $switchable = true;
+
     /**
      * @var array<string, string>
      */
@@ -78,9 +83,21 @@ public function enabled(Closure | bool $value = true): static
         return $this;
     }
 
-    public function getEnabled(): Closure | bool
+    public function getEnabled(): bool
+    {
+        return $this->evaluate($this->enabled);
+    }
+
+    public function switchable(Closure | bool $value): static
+    {
+        $this->switchable = $value;
+
+        return $this;
+    }
+
+    public function getSwitchable(): bool
     {
-        return $this->enabled;
+        return $this->evaluate($this->switchable);
     }
 
     /**
diff --git a/src/FilamentDeveloperLoginsServiceProvider.php b/src/FilamentDeveloperLoginsServiceProvider.php
@@ -2,12 +2,14 @@
 
 namespace DutchCodingCompany\FilamentDeveloperLogins;
 
+use DutchCodingCompany\FilamentDeveloperLogins\Livewire\MenuLogins;
 use DutchCodingCompany\FilamentDeveloperLogins\View\Components\DeveloperLogins;
 use Filament\Facades\Filament;
 use Filament\Support\Concerns\EvaluatesClosures;
 use Filament\Support\Facades\FilamentView;
 use Filament\View\PanelsRenderHook;
 use Illuminate\Support\Facades\Blade;
+use Livewire\Livewire;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -25,29 +27,50 @@ public function configurePackage(Package $package): void
             ->hasTranslations();
     }
 
+    public function packageRegistered(): void
+    {
+        $this->app->singleton(FilamentDevelopersLogin::class);
+        $this->app->bind('filament-developers-login', FilamentDevelopersLogin::class);
+    }
+
     public function packageBooted(): void
     {
         Blade::componentNamespace('DutchCodingCompany\FilamentDeveloperLogins\View\Components', 'filament-developer-logins');
         Blade::component('developer-logins', DeveloperLogins::class);
+        Livewire::component('menu-logins', MenuLogins::class);
+
+        $this->registerRenderHooks();
+    }
+
+    protected static function registerRenderHooks(): void
+    {
+        $panel = Filament::getCurrentPanel();
+        if (is_null($panel) || ! $panel->hasPlugin('filament-developer-logins')) {
+            return;
+        }
+
+        /** @var FilamentDeveloperLoginsPlugin $plugin */
+        $plugin = $panel->getPlugin('filament-developer-logins');
 
         FilamentView::registerRenderHook(
             PanelsRenderHook::AUTH_LOGIN_FORM_AFTER,
-            static function (): ?string {
-                $panel = Filament::getCurrentPanel();
-                if (! $panel->hasPlugin('filament-developer-logins')) {
+            static function () use ($plugin) : ?string {
+                if (! $plugin->getEnabled()) {
                     return null;
                 }
 
-                /** @var FilamentDeveloperLoginsPlugin $plugin */
-                $plugin = $panel->getPlugin('filament-developer-logins');
-                if (is_bool($plugin->getEnabled())
-                    ? ! $plugin->getEnabled()
-                    : ! call_user_func($plugin->getEnabled())
-                ) {
+                return Blade::render('<x-filament-developer-logins::developer-logins />');
+            },
+        );
+
+        FilamentView::registerRenderHook(
+            PanelsRenderHook::GLOBAL_SEARCH_AFTER,
+            static function () use ($plugin) : ?string {
+                if (! $plugin->getEnabled() || ! $plugin->getSwitchable()) {
                     return null;
                 }
 
-                return Blade::render('<x-filament-developer-logins::developer-logins />');
+                return Blade::render('@livewire(\'menu-logins\')');
             },
         );
     }
diff --git a/src/FilamentDevelopersLogin.php b/src/FilamentDevelopersLogin.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace DutchCodingCompany\FilamentDeveloperLogins;
+
+use DutchCodingCompany\FilamentDeveloperLogins\Exceptions\ImplementationException;
+use Filament\Models\Contracts\FilamentUser;
+use Filament\Panel;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Validation\ValidationException;
+use Livewire\Features\SupportRedirects\Redirector;
+
+class FilamentDevelopersLogin
+{
+    public function login(Panel $panel, FilamentDeveloperLoginsPlugin $plugin, string $credentials): RedirectResponse | Redirector
+    {
+        if (! in_array($credentials, $plugin->getUsers())) {
+            throw new ImplementationException('The user is not found in the defined users, please check the configuration of the plugin.');
+        }
+
+        if ($panel->auth()->check()) {
+            $panel->auth()->logout();
+        }
+
+        $model = (new ($plugin->getModelClass()))
+            ->where($plugin->getColumn(), $credentials)
+            ->firstOrFail();
+
+        $panel->auth()->login($model);
+
+        if (
+            ($model instanceof FilamentUser) &&
+            (! $model->canAccessPanel($panel))
+        ) {
+            $panel->auth()->logout();
+
+            throw ValidationException::withMessages([
+                'developer-logins-failed' => __('filament-developer-logins::auth.messages.failed'),
+            ]);
+        }
+
+        session()->regenerate();
+
+        return redirect()
+            ->to(
+                $plugin->getRedirectTo() ?? $panel->getUrl()
+            );
+    }
+}
diff --git a/src/Http/Controllers/DeveloperLoginsController.php b/src/Http/Controllers/DeveloperLoginsController.php
@@ -3,62 +3,25 @@
 namespace DutchCodingCompany\FilamentDeveloperLogins\Http\Controllers;
 
 use DutchCodingCompany\FilamentDeveloperLogins\Exceptions\ImplementationException;
+use DutchCodingCompany\FilamentDeveloperLogins\Facades\FilamentDevelopersLogin;
 use DutchCodingCompany\FilamentDeveloperLogins\FilamentDeveloperLoginsPlugin;
 use DutchCodingCompany\FilamentDeveloperLogins\Http\Requests\LoginAsRequest;
 use Filament\Facades\Filament;
-use Filament\Models\Contracts\FilamentUser;
-use Filament\Panel;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Routing\Controller;
-use Illuminate\Support\Facades\Auth;
-use Illuminate\Validation\ValidationException;
+use Livewire\Features\SupportRedirects\Redirector;
 
 class DeveloperLoginsController extends Controller
 {
-    protected Panel $panel;
-
-    protected FilamentDeveloperLoginsPlugin $plugin;
-
     /**
      * @throws ImplementationException
      */
-    public function loginAs(LoginAsRequest $request): RedirectResponse
+    public function loginAs(LoginAsRequest $request): RedirectResponse | Redirector
     {
-        $this->initiate($request);
-
+        $panel = Filament::getPanel($request->validated('panel_id'));
+        $plugin = FilamentDeveloperLoginsPlugin::getById($request->validated('panel_id'));
         $credentials = $request->validated('credentials');
-        if (! in_array($credentials, $this->plugin->getUsers())) {
-            throw new ImplementationException('The user is not found in the defined users, please check the configuration of the plugin.');
-        }
-
-        $model = (new ($this->plugin->getModelClass()))
-            ->where($this->plugin->getColumn(), $credentials)->firstOrFail();
-
-        Filament::auth()->login($model);
-
-        if (
-            ($model instanceof FilamentUser) &&
-            (! $model->canAccessPanel($this->panel))
-        ) {
-            Auth::logout();
-
-            throw ValidationException::withMessages([
-                'developer-logins-failed' => __('filament-developer-logins::auth.messages.failed'),
-            ]);
-        }
-
-        session()->regenerate();
-
-        return redirect()
-            ->to(
-                $this->plugin->getRedirectTo() ?? $this->panel->getUrl()
-            );
-    }
-
-    protected function initiate(LoginAsRequest $request): void
-    {
-        $this->panel = Filament::getPanel($request->validated('panel_id'));
 
-        $this->plugin = FilamentDeveloperLoginsPlugin::getById($request->validated('panel_id'));
+        return FilamentDevelopersLogin::login($panel, $plugin, $credentials);
     }
 }
diff --git a/src/Http/Requests/LoginAsRequest.php b/src/Http/Requests/LoginAsRequest.php
@@ -3,14 +3,10 @@
 namespace DutchCodingCompany\FilamentDeveloperLogins\Http\Requests;
 
 use DutchCodingCompany\FilamentDeveloperLogins\FilamentDeveloperLoginsPlugin;
-use Filament\Facades\Filament;
 use Illuminate\Foundation\Http\FormRequest;
-use Illuminate\Validation\Rule;
 
 class LoginAsRequest extends FormRequest
 {
-    protected ?FilamentDeveloperLoginsPlugin $plugin = null;
-
     /**
      * @return array<string, mixed>
      */
@@ -24,13 +20,6 @@ public function rules(): array
 
     public function authorize(): bool
     {
-        return is_bool($this->plugin()->getEnabled())
-            ? $this->plugin()->getEnabled()
-            : call_user_func($this->plugin()->getEnabled());
-    }
-
-    protected function plugin(): FilamentDeveloperLoginsPlugin
-    {
-        return $this->plugin ??= FilamentDeveloperLoginsPlugin::getById($this->get('panel_id'));
+        return FilamentDeveloperLoginsPlugin::getById($this->get('panel_id'))->getEnabled();
     }
 }
diff --git a/src/Livewire/MenuLogins.php b/src/Livewire/MenuLogins.php
diff --git a/tests/Feature/MenuLoginsTest.php b/tests/Feature/MenuLoginsTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,12 @@ parameters:`
`13`	`13`	`-`
`14`	`14`	`message: "#^Call to an undefined method object\\:\\:where\\(\\)\\.$#"`
`15`	`15`	`count: 1`
`16`		`- path: src/Http/Controllers/DeveloperLoginsController.php`
	`16`	`+ path: src/FilamentDevelopersLogin.php`
	`17`	`+`
	`18`	`+ -`
	`19`	`+ message: "#^Call to an undefined method Livewire\\\\Features\\\\SupportTesting\\\\Testable\\:\\:test\\(\\)\\.$#"`
	`20`	`+ count: 3`
	`21`	`+ path: tests/Feature/MenuLoginsTest.php`
`17`	`22`
`18`	`23`	`-`
`19`	`24`	`message: "#^Access to an undefined property DutchCodingCompany\\\\FilamentDeveloperLogins\\\\Tests\\\\Fixtures\\\\TestUser\\:\\:\\$is_admin\\.$#"`