feat: cache (#107)

app/Concerns/ClearsCache.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Concerns;
+
+use Illuminate\Support\Facades\Cache;
+
+trait ClearsCache
+{
+    abstract public function getCacheTags(): array;
+
+    public static function bootClearsCache(): void
+    {
+        self::created(fn (self $model) => self::clearCache($model));
+        self::updated(fn (self $model) => self::clearCache($model));
+        self::deleted(fn (self $model) => self::clearCache($model));
+    }
+
+    private static function clearCache(self $model): void
+    {
+        Cache::tags($model->getCacheTags())->flush();
+    }
+}

app/Jobs/PersistTemporaryTableData.php

@@ -4,7 +4,6 @@
 
 namespace App\Jobs;
 
-use App\Contracts\ClearsCache;
 use App\Contracts\TemporaryTable;
 use App\Jobs\Middleware\RateLimitSchedulableJobMiddleware;
 use Exception;
@@ -65,10 +64,6 @@ public function handle(): void
                 ON DUPLICATE KEY UPDATE {$updateColumns};
             SQL);
         }
-
-        if ($model instanceof ClearsCache) {
-            $model->clearCache($this->electionId);
-        }
     }
 
     public function middleware(): array

app/Livewire/NewsFeed.php

@@ -6,7 +6,8 @@
 
 use App\Models\Article;
 use App\Models\Election;
-use Illuminate\Pagination\LengthAwarePaginator;
+use App\Services\CacheService;
+use Illuminate\Support\Collection;
 use Livewire\Attributes\Computed;
 use Livewire\Component;
 use Livewire\WithPagination;
@@ -28,13 +29,16 @@ public function reload(): void
     }
 
     #[Computed]
-    protected function articles(): LengthAwarePaginator
+    protected function articles(): Collection
     {
-        return Article::query()
-            ->whereBelongsTo($this->election)
-            ->with('author.media', 'media')
-            ->onlyPublished()
-            ->orderByDesc('published_at')
-            ->paginate(50);
+        return CacheService::make('articles', $this->election)
+            ->remember(
+                fn () => Article::query()
+                    ->whereBelongsTo($this->election)
+                    ->with('author.media', 'media')
+                    ->onlyPublished()
+                    ->orderByDesc('published_at')
+                    ->get()
+            );
     }
 }

app/Livewire/Pages/ElectionPage.php

@@ -9,6 +9,7 @@
 use App\Models\County;
 use App\Models\Election;
 use App\Models\Locality;
+use App\Services\CacheService;
 use ArchTech\SEO\SEOManager;
 use Filament\Forms\Components\Grid;
 use Filament\Forms\Components\Select;
@@ -46,6 +47,7 @@ abstract class ElectionPage extends Component implements HasForms
     public function mount()
     {
         $this->checkDefaultPage();
+
         $validation = Validator::make([
             'country' => $this->country,
             'county' => $this->county,
@@ -91,13 +93,17 @@ public function form(Form $form): Form
                             ->label(__('app.field.country'))
                             ->placeholder(__('app.field.country'))
                             ->hiddenLabel()
-                            ->options(
-                                fn () => Country::query()
-                                    ->whereHas($whereHasKey, function (Builder $query) {
-                                        $query->whereBelongsTo($this->election);
-                                    })
-                                    ->pluck('name', 'id')
-                            )
+                            ->options(function () use ($whereHasKey) {
+                                return CacheService::make(['countries', $whereHasKey], $this->election)
+                                    ->remember(
+                                        fn () => Country::query()
+                                            ->whereHas($whereHasKey, function (Builder $query) {
+                                                $query->whereBelongsTo($this->election)
+                                                    ->whereNotNull('country_id');
+                                            })
+                                            ->pluck('name', 'id')
+                                    );
+                            })
                             ->afterStateUpdated(function (Set $set) {
                                 $set('county', null);
                                 $set('locality', null);
@@ -110,13 +116,17 @@ public function form(Form $form): Form
                             ->label(__('app.field.county'))
                             ->placeholder(__('app.field.county'))
                             ->hiddenLabel()
-                            ->options(
-                                fn () => County::query()
-                                    ->whereHas($whereHasKey, function (Builder $query) {
-                                        $query->whereBelongsTo($this->election);
-                                    })
-                                    ->pluck('name', 'id')
-                            )
+                            ->options(function () use ($whereHasKey) {
+                                return CacheService::make(['counties', $whereHasKey], $this->election)
+                                    ->remember(
+                                        fn () => County::query()
+                                            ->whereHas($whereHasKey, function (Builder $query) use ($whereHasKey) {
+                                                $query->whereBelongsTo($this->election)
+                                                    ->whereNotNull("{$whereHasKey}.county_id");
+                                            })
+                                            ->pluck('name', 'id')
+                                    );
+                            })
                             ->afterStateUpdated(function (Set $set) {
                                 $set('locality', null);
                             })
@@ -128,15 +138,24 @@ public function form(Form $form): Form
                             ->label(__('app.field.locality'))
                             ->hiddenLabel()
                             ->placeholder(__('app.field.locality'))
-                            ->options(
-                                fn (Get $get) => Locality::query()
-                                    ->where('county_id', $get('county'))
-                                    ->whereHas($whereHasKey, function (Builder $query) {
-                                        $query->whereBelongsTo($this->election);
-                                    })
-                                    ->limit(1000)
-                                    ->pluck('name', 'id')
-                            )
+                            ->options(function (Get $get) use ($whereHasKey) {
+                                $county_id = $get('county');
+
+                                return CacheService::make(['localities', $whereHasKey], $this->election, county: $county_id)
+                                    ->remember(
+                                        fn () => Locality::query()
+                                            ->where('county_id', $county_id)
+                                            ->whereHas($whereHasKey, function (Builder $query) use ($county_id) {
+                                                $query->whereBelongsTo($this->election);
+
+                                                if ($county_id !== 403) {
+                                                    $query->whereNull('parent_id');
+                                                }
+                                            })
+                                            ->limit(150)
+                                            ->pluck('name', 'id')
+                                    );
+                            })
                             ->visible(fn (Get $get) => DataLevel::isValue($get('level'), DataLevel::NATIONAL) &&
                             ! \is_null($get('county')))
                             ->searchable()

app/Livewire/Pages/ElectionResults.php

@@ -4,7 +4,6 @@
 
 namespace App\Livewire\Pages;
 
-use App\Enums\Time;
 use App\Models\Candidate;
 use App\Models\Party;
 use App\Models\Vote;
@@ -34,7 +33,7 @@ public function render(): View
     #[Computed]
     public function parties(): Collection
     {
-        return Cache::remember("parties:{$this->election->id}", Time::DAY_IN_SECONDS->value, function () {
+        return Cache::remember("parties:{$this->election->id}", now()->addDay(), function () {
             return Party::query()
                 ->whereBelongsTo($this->election)
                 // ->whereHas('votes', function (Builder $query) {
@@ -48,7 +47,7 @@ public function parties(): Collection
     #[Computed]
     public function candidates(): Collection
     {
-        return Cache::remember("candidates:{$this->election->id}", Time::DAY_IN_SECONDS->value, function () {
+        return Cache::remember("candidates:{$this->election->id}", now()->addDay(), function () {
             return Candidate::query()
                 ->whereBelongsTo($this->election)
                 // ->whereHas('votes', function (Builder $query) {

app/Livewire/VoteMonitorStats.php

@@ -6,6 +6,7 @@
 
 use App\Models\Election;
 use App\Models\VoteMonitorStat;
+use App\Services\CacheService;
 use Livewire\Attributes\Computed;
 use Livewire\Component;
 
@@ -18,12 +19,15 @@ class VoteMonitorStats extends Component
     #[Computed]
     public function stats(): array
     {
-        return VoteMonitorStat::query()
-            ->whereBelongsTo($this->election)
-            ->where('enabled', true)
-            ->orderBy('order')
-            ->get()
-            ->toArray();
+        return CacheService::make('vote-monitor-stats', $this->election)
+            ->remember(
+                fn () => VoteMonitorStat::query()
+                    ->whereBelongsTo($this->election)
+                    ->where('enabled', true)
+                    ->orderBy('order')
+                    ->get()
+                    ->toArray()
+            );
     }
 
     #[Computed]

app/Models/Article.php

@@ -5,6 +5,7 @@
 namespace App\Models;
 
 use App\Concerns\BelongsToElection;
+use App\Concerns\ClearsCache;
 use App\Concerns\Publishable;
 use App\Enums\User\Role;
 use Database\Factories\ArticleFactory;
@@ -18,6 +19,7 @@
 
 class Article extends Model implements HasMedia
 {
+    use ClearsCache;
     use HasFactory;
     use BelongsToElection;
     use InteractsWithMedia;
@@ -74,4 +76,11 @@ public function registerMediaCollections(): void
                     ->optimize();
             });
     }
+
+    public function getCacheTags(): array
+    {
+        return [
+            "election:{$this->election_id}:articles",
+        ];
+    }
 }

app/Models/Candidate.php

@@ -5,6 +5,7 @@
 namespace App\Models;
 
 use App\Concerns\BelongsToElection;
+use App\Concerns\ClearsCache;
 use App\Contracts\HasDisplayName;
 use Database\Factories\CandidateFactory;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -19,6 +20,7 @@
 class Candidate extends Model implements HasMedia, HasDisplayName
 {
     use BelongsToElection;
+    use ClearsCache;
     /** @use HasFactory<CandidateFactory> */
     use HasFactory;
     use InteractsWithMedia;
@@ -74,4 +76,11 @@ public function getDisplayName(): string
     {
         return $this->display_name ?? $this->name;
     }
+
+    public function getCacheTags(): array
+    {
+        return [
+            "candidates:{$this->election_id}",
+        ];
+    }
 }

app/Models/Election.php

@@ -4,6 +4,7 @@
 
 namespace App\Models;
 
+use App\Concerns\ClearsCache;
 use App\Concerns\HasSlug;
 use App\Enums\ElectionType;
 use Database\Factories\ElectionFactory;
@@ -17,6 +18,7 @@
 
 class Election extends Model implements HasName, HasAvatar
 {
+    use ClearsCache;
     /** @use HasFactory<ElectionFactory> */
     use HasFactory;
     use HasSlug;
@@ -127,4 +129,9 @@ public function getFilamentAvatarUrl(): ?string
 
         return 'https://ui-avatars.com/api/?name=E';
     }
+
+    public function getCacheTags(): array
+    {
+        return ['elections'];
+    }
 }

app/Models/Menu.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use App\Concerns\ClearsCache;
+use Datlechin\FilamentMenuBuilder\Models\Menu as BaseMenu;
+
+class Menu extends BaseMenu
+{
+    use ClearsCache;
+
+    public function getCacheTags(): array
+    {
+        return ['menus'];
+    }
+}

app/Models/MenuItem.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use App\Concerns\ClearsCache;
+use Datlechin\FilamentMenuBuilder\Models\MenuItem as BaseMenuItem;
+
+class MenuItem extends BaseMenuItem
+{
+    use ClearsCache;
+
+    public function getCacheTags(): array
+    {
+        return ['menus'];
+    }
+}

app/Models/MenuLocation.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use App\Concerns\ClearsCache;
+use Datlechin\FilamentMenuBuilder\Models\MenuLocation as BaseMenuLocation;
+
+class MenuLocation extends BaseMenuLocation
+{
+    use ClearsCache;
+
+    public function getCacheTags(): array
+    {
+        return ['menus'];
+    }
+}