[Feature] Refactor manual and scheduled speedtest process (alexjustesen#1804)

* cache external ip address response for 30s

* removed ping url config

* case result service to enum

* refactored scheduled speedtest process

* use new speedtest process when triggering a manual test

* removed old jobs

* set run speedtest job timeout

* removed color from result service enum

* default skip ips to an empty string

* fixed service enum label

* log an error when a job in the speedtest batch fails

* prune batches and failed jobs

* moved parsing cli exception message to a helper

* removed unused tests

Author: alexjustesen

app/Actions/CheckForScheduledSpeedtests.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace App\Actions;
+
+use App\Actions\Ookla\StartSpeedtest;
+use Cron\CronExpression;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class CheckForScheduledSpeedtests
+{
+    use AsAction;
+
+    public function handle(): void
+    {
+        $schedule = config('speedtest.schedule');
+
+        if (blank($schedule) || $schedule === false) {
+            return;
+        }
+
+        StartSpeedtest::runIf(
+            $this->isSpeedtestDue(schedule: $schedule),
+            scheduled: true,
+        );
+    }
+
+    /**
+     * Assess if a speedtest is due to run based on the schedule.
+     */
+    private function isSpeedtestDue(string $schedule): bool
+    {
+        $cron = new CronExpression($schedule);
+
+        return $cron->isDue(
+            currentTime: now(),
+            timeZone: config('app.display_timezone')
+        );
+    }
+}

app/Actions/GetExternalIpAddress.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Actions;
+
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Str;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class GetExternalIpAddress
+{
+    use AsAction;
+
+    public function handle(): bool|string
+    {
+        $externalIp = Cache::remember('external_ip', 30, function (): bool|string {
+            $response = Http::retry(3, 100)
+                ->get('https://icanhazip.com/');
+
+            if ($response->failed()) {
+                $message = sprintf('Failed to fetch external IP address, %d', $response->status());
+
+                Log::warning($message);
+
+                return false;
+            }
+
+            return Str::trim($response->body());
+        });
+
+        return $externalIp;
+    }
+}

app/Actions/Helpers/GetExternalIpAddress.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Actions\Ookla;
+
+use Illuminate\Support\Arr;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class SelectSpeedtestServer
+{
+    use AsAction;
+
+    public function handle(): string
+    {
+        $servers = config('speedtest.servers');
+
+        if (blank($servers)) {
+            return '';
+        }
+
+        $servers = array_filter(
+            array_map(
+                'trim',
+                explode(',', $servers),
+            ),
+        );
+
+        if (count($servers) < 1) {
+            return '';
+        }
+
+        return Arr::random($servers);
+    }
+}

app/Actions/Ookla/SelectSpeedtestServer.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Actions\Ookla;
+
+use App\Enums\ResultService;
+use App\Enums\ResultStatus;
+use App\Events\SpeedtestStarted;
+use App\Jobs\Ookla\ProcessSpeedtestBatch;
+use App\Models\Result;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class StartSpeedtest
+{
+    use AsAction;
+
+    public function handle(bool $scheduled = false): void
+    {
+        $result = Result::create([
+            'service' => ResultService::Ookla,
+            'status' => ResultStatus::Started,
+            'scheduled' => $scheduled,
+        ]);
+
+        $serverId = SelectSpeedtestServer::run();
+
+        if (! blank($serverId)) {
+            $result->update([
+                'data->server->id' => $serverId,
+            ]);
+        }
+
+        ProcessSpeedtestBatch::dispatch(
+            result: $result,
+        );
+
+        SpeedtestStarted::dispatch($result);
+    }
+}

app/Actions/Ookla/StartSpeedtest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Enums;
+
+use Filament\Support\Contracts\HasLabel;
+use Illuminate\Support\Str;
+
+enum ResultService: string implements HasLabel
+{
+    case Ookla = 'ookla';
+
+    public function getLabel(): ?string
+    {
+        return Str::title($this->name);
+    }
+}

app/Actions/Speedtests/RunOoklaSpeedtest.php

@@ -42,7 +42,10 @@ public static function getColumns(): array
                     return $record->server_location;
                 })
                 ->enabledByDefault(false),
-            ExportColumn::make('service'),
+            ExportColumn::make('service')
+                ->state(function (Result $record) {
+                    return $record->service->getLabel();
+                }),
             ExportColumn::make('server_id')
                 ->label('Server ID')
                 ->state(function (Result $record): ?string {
@@ -107,7 +110,10 @@ public static function getColumns(): array
                 }),
             ExportColumn::make('comments')
                 ->enabledByDefault(false),
-            // ExportColumn::make('status'), // TODO: enable status when upgrading to PHP v8.3: https://php.watch/versions/8.3/dynamic-class-const-enum-member-syntax-support
+            ExportColumn::make('status')
+                ->state(function (Result $record) {
+                    return $record->status->getLabel();
+                }),
             ExportColumn::make('scheduled')
                 ->state(function (Result $record): string {
                     return $record->scheduled ? 'Yes' : 'No';

app/Actions/Speedtests/RunScheduledSpeedtests.php

@@ -2,7 +2,7 @@
 
 namespace App\Filament\Pages;
 
-use App\Actions\Speedtests\RunOoklaSpeedtest;
+use App\Actions\Ookla\StartSpeedtest;
 use App\Filament\Widgets\RecentDownloadChartWidget;
 use App\Filament\Widgets\RecentDownloadLatencyChartWidget;
 use App\Filament\Widgets\RecentJitterChartWidget;
@@ -17,7 +17,6 @@
 use Filament\Notifications\Notification;
 use Filament\Pages\Dashboard as BasePage;
 use Filament\Support\Enums\IconPosition;
-use Illuminate\Support\Arr;
 
 class Dashboard extends BasePage
 {
@@ -27,11 +26,13 @@ class Dashboard extends BasePage
 
     public function getSubheading(): ?string
     {
-        if (blank(config('speedtest.schedule'))) {
+        $schedule = config('speedtest.schedule');
+
+        if (blank($schedule) || $schedule === false) {
             return __('No speedtests scheduled.');
         }
 
-        $cronExpression = new CronExpression(config('speedtest.schedule'));
+        $cronExpression = new CronExpression($schedule);
 
         $nextRunDate = Carbon::parse($cronExpression->getNextRunDate(timeZone: config('app.display_timezone')))->format(config('app.datetime_format'));
 
@@ -51,17 +52,7 @@ protected function getHeaderActions(): array
             ActionGroup::make([
                 Action::make('ookla speedtest')
                     ->action(function () {
-                        $servers = array_filter(
-                            explode(',', config('speedtest.servers'))
-                        );
-
-                        $serverId = null;
-
-                        if (count($servers)) {
-                            $serverId = Arr::random($servers);
-                        }
-
-                        RunOoklaSpeedtest::run(serverId: $serverId);
+                        StartSpeedtest::run();
 
                         Notification::make()
                             ->title('Ookla speedtest started')