[Chore] Refactored executing Ookla speedtests and added new events (alexjustesen#1264)

Author: alexjustesen

app/Actions/Speedtests/RunOoklaSpeedtest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Actions\Speedtests;
+
+use App\Enums\ResultStatus;
+use App\Events\SpeedtestStarted;
+use App\Jobs\Speedtests\ExecuteOoklaSpeedtest;
+use App\Models\Result;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class RunOoklaSpeedtest
+{
+    use AsAction;
+
+    public function handle(?int $serverId = null, bool $scheduled = false): void
+    {
+        $result = Result::create([
+            'service' => 'ookla',
+            'status' => ResultStatus::Started,
+            'scheduled' => $scheduled,
+        ]);
+
+        SpeedtestStarted::dispatch($result);
+
+        ExecuteOoklaSpeedtest::dispatch(result: $result, serverId: $serverId);
+    }
+}

app/Actions/Speedtests/RunScheduledSpeedtests.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Actions\Speedtests;
+
+use App\Settings\GeneralSettings;
+use Cron\CronExpression;
+use Illuminate\Support\Arr;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class RunScheduledSpeedtests
+{
+    use AsAction;
+
+    public function handle()
+    {
+        $settings = new GeneralSettings();
+
+        /**
+         * Ookla service
+         */
+        $cronExpression = new CronExpression($settings->speedtest_schedule);
+
+        if ($cronExpression->isDue(now()->timezone($settings->timezone ?? 'UTC'))) {
+            $serverId = null;
+
+            if (is_array($settings->speedtest_server) && count($settings->speedtest_server)) {
+                $serverId = Arr::random($settings->speedtest_server);
+            }
+
+            RunOoklaSpeedtest::run(serverId: $serverId, scheduled: true);
+        }
+    }
+}

app/Console/Commands/RunOoklaSpeedtest.php

@@ -2,12 +2,11 @@
 
 namespace App\Console;
 
-use App\Console\Commands\RunOoklaSpeedtest;
+use App\Actions\Speedtests\RunScheduledSpeedtests;
 use App\Console\Commands\SystemMaintenance;
 use App\Console\Commands\VersionChecker;
 use App\Models\Result;
 use App\Settings\GeneralSettings;
-use Cron\CronExpression;
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
 
@@ -44,17 +43,14 @@ protected function schedule(Schedule $schedule): void
             ->timezone($settings->timezone ?? 'UTC');
 
         /**
-         * Check if an Ookla Speedtest needs to run.
+         * Action to run scheduled speedtests.
          */
-        $schedule->command(RunOoklaSpeedtest::class, ['--scheduled'])->everyMinute()
-            ->timezone($settings->timezone ?? 'UTC')
+        $schedule->call(function () {
+            RunScheduledSpeedtests::run();
+        })
+            ->everyMinute()
             ->when(function () use ($settings) {
-                if (blank($settings->speedtest_schedule)) {
-                    return false;
-                }
-
-                return (new CronExpression($settings->speedtest_schedule))
-                    ->isDue(now()->timezone($settings->timezone ?? 'UTC'));
+                return ! blank($settings->speedtest_schedule);
             });
     }
 

app/Console/Kernel.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\Result;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class SpeedtestCompleted
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Result $result,
+    ) {
+    }
+}

app/Events/ResultCreated.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\Result;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class SpeedtestFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Result $result,
+    ) {
+    }
+}

app/Events/SpeedtestCompleted.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\Result;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class SpeedtestStarted
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Result $result,
+    ) {
+    }
+}

app/Events/SpeedtestFailed.php

@@ -2,50 +2,55 @@
 
 namespace App\Filament\Pages;
 
-use App\Console\Commands\RunOoklaSpeedtest;
+use App\Actions\Speedtests\RunOoklaSpeedtest;
 use App\Filament\Widgets\RecentDownloadChartWidget;
 use App\Filament\Widgets\RecentJitterChartWidget;
 use App\Filament\Widgets\RecentPingChartWidget;
 use App\Filament\Widgets\RecentUploadChartWidget;
 use App\Filament\Widgets\StatsOverviewWidget;
 use App\Settings\GeneralSettings;
 use Filament\Actions\Action;
+use Filament\Actions\ActionGroup;
 use Filament\Notifications\Notification;
 use Filament\Pages\Dashboard as BasePage;
-use Illuminate\Support\Facades\Artisan;
+use Filament\Support\Enums\ActionSize;
+use Filament\Support\Enums\IconPosition;
 
 class Dashboard extends BasePage
 {
-    public bool $publicDashboard = false;
-
-    protected static ?string $pollingInterval = null;
-
     protected static ?string $navigationIcon = 'heroicon-o-chart-bar';
 
     protected static ?int $navigationSort = 1;
 
     protected static string $view = 'filament.pages.dashboard';
 
-    public function mount()
-    {
-        $settings = new GeneralSettings();
-
-        $this->publicDashboard = $settings->public_dashboard_enabled;
-    }
-
     protected function getHeaderActions(): array
     {
         return [
             Action::make('home')
                 ->label('Public Dashboard')
                 ->color('gray')
-                ->hidden(! $this->publicDashboard)
+                ->hidden(fn (GeneralSettings $settings): bool => ! $settings->public_dashboard_enabled)
                 ->url('/'),
-            Action::make('speedtest')
-                ->label('Queue Speedtest')
+            ActionGroup::make([
+                Action::make('ookla speedtest')
+                    ->action(function () {
+                        RunOoklaSpeedtest::run();
+
+                        Notification::make()
+                            ->title('Ookla speedtest started')
+                            ->success()
+                            ->send();
+                    }),
+            ])
+                ->button()
                 ->color('primary')
-                ->action('queueSpeedtest')
-                ->hidden(fn (): bool => ! auth()->user()->is_admin && ! auth()->user()->is_user),
+                ->dropdownPlacement('bottom-end')
+                ->label('Run Speedtest')
+                ->icon('heroicon-o-rocket-launch')
+                ->iconPosition(IconPosition::After)
+                ->hidden(! auth()->user()->is_admin)
+                ->size(ActionSize::Small),
         ];
     }
 
@@ -59,24 +64,4 @@ protected function getHeaderWidgets(): array
             RecentJitterChartWidget::make(),
         ];
     }
-
-    public function queueSpeedtest(): void
-    {
-        try {
-            Artisan::call(RunOoklaSpeedtest::class);
-        } catch (\Throwable $th) {
-            Notification::make()
-                ->title('Manual speedtest failed!')
-                ->body('The starting a manual speedtest failed, check the logs.')
-                ->warning()
-                ->sendToDatabase(auth()->user());
-
-            return;
-        }
-
-        Notification::make()
-            ->title('Speedtest added to the queue')
-            ->success()
-            ->send();
-    }
 }