Set the global filter value according to the URL + tests

Author: dvlpp

src/Exceptions/SharpInvalidFilterValueException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Code16\Sharp\Exceptions;
+
+use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
+
+class SharpInvalidFilterValueException extends SharpException implements HttpExceptionInterface
+{
+    public function getStatusCode(): int
+    {
+        return 404;
+    }
+}

src/Filters/GlobalRequiredFilter.php

@@ -2,6 +2,8 @@
 
 namespace Code16\Sharp\Filters;
 
+use Code16\Sharp\Exceptions\SharpInvalidFilterValueException;
+
 abstract class GlobalRequiredFilter extends SelectRequiredFilter
 {
     final public function currentValue(): mixed
@@ -29,7 +31,11 @@ final public function setCurrentValue(mixed $value): void
             ->where('id', $value)
             ->first();
 
-        session()->put($this->getSessionKey(), $formattedValue['id'] ?? null);
+        if (! $formattedValue) {
+            throw new SharpInvalidFilterValueException('['.$value.'] is not a valid value for this filter.');
+        }
+
+        session()->put($this->getSessionKey(), $formattedValue['id']);
     }
 
     private function getSessionKey(): string

src/Filters/SelectFilter.php

@@ -75,9 +75,7 @@ protected function formattedValues(): array
 
         if (! is_array(collect($values)->first())) {
             return collect($values)
-                ->map(function ($label, $id) {
-                    return compact('id', 'label');
-                })
+                ->map(fn ($label, $id) => compact('id', 'label'))
                 ->values()
                 ->all();
         }

src/Http/Context/SharpContext.php

@@ -26,10 +26,13 @@ public function globalFilterValue(string $handlerClassOrKey): array|string|null
     public function globalFilterUrlSegmentValue(): string
     {
         return collect(sharp()->config()->get('global_filters'))
-            ->map(fn ($globalFilterClassOrInstance) => is_string($globalFilterClassOrInstance) ? app($globalFilterClassOrInstance) : $globalFilterClassOrInstance)
+            ->map(fn ($globalFilterClassOrInstance) => is_string($globalFilterClassOrInstance)
+                ? app($globalFilterClassOrInstance)
+                : $globalFilterClassOrInstance
+            )
             ->map(fn (GlobalRequiredFilter $globalFilter) => $globalFilter->currentValue())
             ->filter()
-            ->implode('-') ?: GlobalFilters::$defaultKey;
+            ->implode(':') ?: GlobalFilters::$defaultKey;
     }
 
     public function retainedFilterValue(string $handlerClassOrKey): array|string|null

src/Http/Controllers/GlobalFilterController.php

@@ -2,6 +2,7 @@
 
 namespace Code16\Sharp\Http\Controllers;
 
+use Code16\Sharp\Exceptions\SharpInvalidFilterValueException;
 use Code16\Sharp\Filters\GlobalFilters\GlobalFilters;
 use Code16\Sharp\Filters\GlobalRequiredFilter;
 use Illuminate\Http\RedirectResponse;
@@ -14,7 +15,11 @@ public function update(string $filterKey, GlobalFilters $globalFilters): Redirec
 
         abort_if(! $handler instanceof GlobalRequiredFilter, 404);
 
-        $handler->setCurrentValue(request('value'));
+        try {
+            $handler->setCurrentValue(request('value'));
+        } catch (SharpInvalidFilterValueException) {
+            // Reset global filter to its previous value instead of showing an error
+        }
 
         return redirect()->route('code16.sharp.home');
     }

src/Http/Middleware/HandleGlobalFilters.php

@@ -3,14 +3,34 @@
 namespace Code16\Sharp\Http\Middleware;
 
 use Closure;
+use Code16\Sharp\Filters\GlobalRequiredFilter;
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\URL;
 
 class HandleGlobalFilters
 {
-    public function handle($request, Closure $next)
+    public function handle(Request $request, Closure $next)
     {
         URL::defaults(['filterKey' => sharp()->context()->globalFilterUrlSegmentValue()]);
 
+        if ($request->isMethod('GET') && ($filterKey = $request->route('filterKey'))) {
+            $filterKeys = explode(':', $filterKey);
+            $configuredGlobalFilters = collect(sharp()->config()->get('global_filters'))
+                ->map(fn ($globalFilterClassOrInstance) => is_string($globalFilterClassOrInstance)
+                    ? app($globalFilterClassOrInstance)
+                    : $globalFilterClassOrInstance
+                );
+
+            if (count($configuredGlobalFilters) != 0 && count($filterKeys) != count($configuredGlobalFilters)) {
+                return redirect()->route('code16.sharp.home');
+            }
+
+            $configuredGlobalFilters
+                ->each(fn (GlobalRequiredFilter $globalFilter, $index) => $globalFilter
+                    ->setCurrentValue($filterKeys[$index])
+                );
+        }
+
         return $next($request);
     }
 }

tests/Http/GlobalFilterControllerTest.php

@@ -58,11 +58,12 @@ public function defaultValue(): mixed
     $this->assertEquals(2, sharp()->context()->globalFilterValue('test'));
 });
 
-it('the current value of the global filter is sent with every inertia request', function () {
+it('sends the current value of the global filter with every inertia request', function () {
     sharp()->config()->declareEntity(PersonEntity::class);
 
     $this
-        ->get('/sharp/root/s-list/person')
+        ->followingRedirects()
+        ->get('/sharp/s-list/person')
         ->assertInertia(fn (Assert $page) => $page
             ->has('globalFilters.config.filters._root.0', fn (Assert $filter) => $filter
                 ->where('key', 'test')
@@ -77,7 +78,8 @@ public function defaultValue(): mixed
         ->post(route('code16.sharp.filters.update', 'test'), ['value' => 3]);
 
     $this
-        ->get('/sharp/root/s-list/person')
+        ->followingRedirects()
+        ->get('/sharp/s-list/person')
         ->assertInertia(fn (Assert $page) => $page
             ->has('globalFilters.config.filters._root.0', fn (Assert $filter) => $filter
                 ->where('key', 'test')

tests/Http/GlobalFilterRoutesTest.php

@@ -0,0 +1,95 @@
+<?php
+
+use Code16\Sharp\Filters\GlobalRequiredFilter;
+use Code16\Sharp\Tests\Fixtures\Entities\DashboardEntity;
+use Code16\Sharp\Tests\Fixtures\Entities\PersonEntity;
+use Code16\Sharp\Tests\Fixtures\Entities\SinglePersonEntity;
+
+beforeEach(function () {
+    sharp()->config()->declareEntity(PersonEntity::class);
+    login();
+});
+
+it('redirects to route with default filterKey when missing', function () {
+    sharp()->config()
+        ->declareEntity(DashboardEntity::class)
+        ->declareEntity(SinglePersonEntity::class);
+
+    $this->get('/sharp/s-list/person')
+        ->assertRedirect('/sharp/root/s-list/person');
+
+    $this->get('/sharp/s-list/person/s-show/person/1')
+        ->assertRedirect('/sharp/root/s-list/person/s-show/person/1');
+
+    $this->get('/sharp/s-list/person/s-show/person/1/s-form/person/1')
+        ->assertRedirect('/sharp/root/s-list/person/s-show/person/1/s-form/person/1');
+
+    $this->get('/sharp/s-list/person/s-show/person/1/s-show/person/2/s-form/person/2')
+        ->assertRedirect('/sharp/root/s-list/person/s-show/person/1/s-show/person/2/s-form/person/2');
+
+    $this->get('/sharp/s-dashboard/dashboard')
+        ->assertRedirect('/sharp/root/s-dashboard/dashboard');
+
+    $this->get('/sharp/s-show/single-person')
+        ->assertRedirect('/sharp/root/s-show/single-person');
+});
+
+it('redirects to route with correct filterKey when missing and global filters are defined', function () {
+    fakeGlobalFilter();
+
+    $this->get('/sharp/s-list/person')
+        ->assertRedirect('/sharp/two/s-list/person');
+
+    $this->post(route('code16.sharp.filters.update', 'test'), ['value' => 'three']);
+
+    $this->get('/sharp/s-list/person/s-show/person/1')
+        ->assertRedirect('/sharp/three/s-list/person/s-show/person/1');
+});
+
+it('sets the current filterKey according to the URL', function () {
+    fakeGlobalFilter();
+
+    $this->post(route('code16.sharp.filters.update', 'test'), ['value' => 'three']);
+    $this->get('/sharp/one/s-list/person/s-show/person/1')
+        ->assertOk();
+
+    expect(sharp()->context()->globalFilterValue('test'))->toEqual('one');
+});
+
+it('wont set an invalid value of the current filterKey according to the URL', function () {
+    fakeGlobalFilter();
+
+    $this->get('/sharp/five/s-list/person/s-show/person/1')
+        ->assertNotFound();
+
+    expect(sharp()->context()->globalFilterValue('test'))->toEqual('two');
+});
+
+// TODO test multiple filters
+
+function fakeGlobalFilter(): void
+{
+    sharp()->config()->addGlobalFilter(
+        new class() extends GlobalRequiredFilter
+        {
+            public function buildFilterConfig(): void
+            {
+                $this->configureKey('test');
+            }
+
+            public function values(): array
+            {
+                return [
+                    'one' => 'Company One',
+                    'two' => 'Company Two',
+                    'three' => 'Company Three',
+                ];
+            }
+
+            public function defaultValue(): mixed
+            {
+                return 'two';
+            }
+        }
+    );
+}