Feat/horizon (#74)

* fix: Styling issues

* feat: Implement Horizon

* feat: Send package approved notification email via background process

* feat: Delegate Og image generation to background job

* feat: Restrict horizon access to admin users

* feat: Schedule horizon snapshots

* feat: Start the implementation of failed jobs notifications

Author: thefeqy

app/Actions/GeneratePackageOgImageAction.php

@@ -20,20 +20,20 @@ public function handle(Package $package): void
             $storagePath = storage_path('app/public/package-og-images');
             $this->ensureDir($storagePath);
 
-            $filename = Str::slug($package->name) . '-' . Str::random(8) . '.jpg';
-            $fullPath = $storagePath . '/' . $filename;
+            $filename = Str::slug($package->name).'-'.Str::random(8).'.jpg';
+            $fullPath = $storagePath.'/'.$filename;
 
             // Binaries
             $nodePath = $this->which('node') ?? '/usr/bin/node';
-            $npmPath  = $this->which('npm')  ?? '/usr/bin/npm';
+            $npmPath = $this->which('npm') ?? '/usr/bin/npm';
 
             // Writable Chrome profile/cache dir
             $userDataDir = rtrim((string) env('BROWSERSHOT_USER_DATA_DIR', '/var/www/browsershot-cache'), '/');
             $this->ensureDir($userDataDir);
 
             // Ensure the env seen by the child process points to our writable dir
             foreach (['HOME', 'XDG_CONFIG_HOME', 'XDG_CACHE_HOME'] as $var) {
-                putenv($var . '=' . $userDataDir);
+                putenv($var.'='.$userDataDir);
                 $_ENV[$var] = $userDataDir;
                 $_SERVER[$var] = $userDataDir;
             }
@@ -79,12 +79,12 @@ public function handle(Package $package): void
                     ->usingFileName($filename)
                     ->toMediaCollection('og-images', 'package-og-images');
 
-                Log::info('OG Image Generated: ' . $package->getFirstMediaUrl('og-images'));
+                Log::info('OG Image Generated: '.$package->getFirstMediaUrl('og-images'));
             } else {
                 Log::error('OG image file missing after save', ['path' => $fullPath]);
             }
         } catch (\Throwable $e) {
-            Log::error('OG Image Generation Error: ' . $e->getMessage(), ['exception' => $e]);
+            Log::error('OG Image Generation Error: '.$e->getMessage(), ['exception' => $e]);
             throw $e;
         }
     }
@@ -99,6 +99,7 @@ private function ensureDir(string $dir): void
     private function which(string $bin): ?string
     {
         $path = @exec(sprintf('command -v %s', escapeshellarg($bin)));
+
         return $path ?: null;
     }
 

app/Http/Controllers/PackageController.php

@@ -2,15 +2,14 @@
 
 namespace App\Http\Controllers;
 
-use App\Actions\GeneratePackageOgImageAction;
 use App\Http\Resources\Admin\CategoryResource;
 use App\Http\Resources\PackageResource;
+use App\Jobs\GenerateOgImageForPackageJob;
 use App\Models\Category;
 use App\Models\Package;
 use App\Queries\PackageQuery;
 use App\Services\GitHubService;
 use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Log;
 use Inertia\Inertia;
 
 class PackageController extends Controller
@@ -50,16 +49,7 @@ public function show(string $slug)
             ->firstOrFail();
 
         if (! $package->hasMedia('og-images')) {
-            try {
-                app(GeneratePackageOgImageAction::class)->handle($package);
-
-                $package->load('media');
-            } catch (\Exception $e) {
-                Log::error('Failed to generate OG image in controller', [
-                    'package_id' => $package->id,
-                    'error' => $e->getMessage(),
-                ]);
-            }
+            GenerateOgImageForPackageJob::dispatch($package);
         }
 
         return Inertia::render('Package', [

app/Jobs/GenerateOgImageForPackageJob.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Jobs;
+
+use App\Actions\GeneratePackageOgImageAction;
+use App\Models\Package;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Queue\Queueable;
+use Illuminate\Support\Facades\Log;
+
+class GenerateOgImageForPackageJob implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct(public readonly Package $package) {}
+
+    /**
+     * Execute the job.
+     */
+    public function handle(): void
+    {
+        try {
+            app(GeneratePackageOgImageAction::class)->handle($this->package);
+
+            $this->package->load('media');
+        } catch (\Exception $e) {
+            Log::error('Failed to generate OG image in controller', [
+                'package_id' => $this->package->id,
+                'error' => $e->getMessage(),
+            ]);
+        }
+    }
+
+    public function tags()
+    {
+        return [
+            'OgImageGeneration',
+            'Package:'.$this->package->id,
+        ];
+    }
+}

app/Models/Package.php

@@ -32,6 +32,7 @@
 class Package extends Model implements HasMedia
 {
     use Filterable;
+
     // TODO: Fix admin detector in laravel model status package
     use HasActiveScope;
     use HasSlug;

app/Notifications/PackageApprovedNotification.php

@@ -4,10 +4,11 @@
 
 use App\Models\PackageSubmission;
 use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
 
-class PackageApprovedNotification extends Notification
+class PackageApprovedNotification extends Notification implements ShouldQueue
 {
     use Queueable;
 
@@ -42,16 +43,4 @@ public function toMail(object $notifiable): MailMessage
             ->line('Thank you for contributing to the Laravel community!')
             ->salutation('The Laravel Hub Team');
     }
-
-    /**
-     * Get the array representation of the notification.
-     *
-     * @return array<string, mixed>
-     */
-    public function toArray(object $notifiable): array
-    {
-        return [
-            //
-        ];
-    }
 }

app/Providers/AppServiceProvider.php

@@ -7,6 +7,8 @@
 use Illuminate\Cache\RateLimiting\Limit;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Queue\Events\JobFailed;
+use Illuminate\Support\Facades\Queue;
 use Illuminate\Support\Facades\RateLimiter;
 use Illuminate\Support\Facades\Request;
 use Illuminate\Support\Facades\URL;
@@ -40,6 +42,10 @@ public function boot(): void
 
         $this->configurePasswordRateLimiting();
 
+        Queue::failing(function (JobFailed $job) {
+            // TODO: Send email
+        });
+
     }
 
     protected function configurePasswordRateLimiting(): void

app/Providers/HorizonServiceProvider.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Gate;
+use Laravel\Horizon\Horizon;
+use Laravel\Horizon\HorizonApplicationServiceProvider;
+
+class HorizonServiceProvider extends HorizonApplicationServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     */
+    public function boot(): void
+    {
+        parent::boot();
+
+        // Horizon::routeSmsNotificationsTo('15556667777');
+        Horizon::routeMailNotificationsTo('[email protected]');
+        // Horizon::routeSlackNotificationsTo('slack-webhook-url', '#channel');
+    }
+
+    /**
+     * Register the Horizon gate.
+     *
+     * This gate determines who can access Horizon in non-local environments.
+     */
+    protected function gate(): void
+    {
+        Gate::define('viewHorizon', function ($user = null) {
+            return Auth::check() && Auth::user()->is_admin;
+        });
+    }
+}

bootstrap/app.php

@@ -30,6 +30,7 @@
     ->withSchedule(function (Schedule $schedule) {
         $schedule->command('app:publish-scheduled-posts')->hourly();
         $schedule->command('disposable:update')->weekly();
+        $schedule->command('horizon:snapshot')->everyFiveMinutes();
     })
     ->withExceptions(function (Exceptions $exceptions) {
         Integration::handles($exceptions);

bootstrap/providers.php

@@ -3,4 +3,5 @@
 return [
     App\Providers\AppServiceProvider::class,
     App\Providers\Filament\AdminPanelProvider::class,
+    App\Providers\HorizonServiceProvider::class,
 ];

composer.json

@@ -18,6 +18,7 @@
         "filament/spatie-laravel-settings-plugin": "^3.2",
         "inertiajs/inertia-laravel": "^2.0",
         "laravel/framework": "^12.0",
+        "laravel/horizon": "^5.33",
         "laravel/octane": "^2.8",
         "laravel/sanctum": "^4.0",
         "laravel/scout": "^10.13",
@@ -79,12 +80,12 @@
         ],
         "dev": [
             "Composer\\Config::disableProcessTimeout",
-            "npx concurrently -c \"#93c5fd,#c4b5fd,#fb7185,#fdba74\" \"php artisan serve\" \"php artisan queue:listen --tries=1\" \"php artisan pail --timeout=0\" \"npm run dev\" --names=server,queue,logs,vite"
+            "npx concurrently -c \"#93c5fd,#c4b5fd,#fb7185,#fdba74\" \"php artisan serve\" \"php artisan horizon\" \"php artisan pail --timeout=0\" \"npm run dev\" --names=server,horizon,logs,vite"
         ],
         "dev:ssr": [
             "npm run build:ssr",
             "Composer\\Config::disableProcessTimeout",
-            "npx concurrently -c \"#93c5fd,#c4b5fd,#fb7185,#fdba74\" \"php artisan serve\" \"php artisan queue:listen --tries=1\" \"php artisan pail --timeout=0\" \"php artisan inertia:start-ssr\" --names=server,queue,logs,ssr"
+            "npx concurrently -c \"#93c5fd,#c4b5fd,#fb7185,#fdba74\" \"php artisan serve\" \"php artisan horizon\" \"php artisan pail --timeout=0\" \"php artisan inertia:start-ssr\" --names=server,horizon,logs,ssr"
         ],
         "format": [
             "@pint",