Add Support for Slack Notifications via Webhook

app/Actions/Notifications/SendSlackTestNotification.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Actions\Notifications;
+
+use Filament\Notifications\Notification;
+use Lorisleiva\Actions\Concerns\AsAction;
+use Spatie\WebhookServer\WebhookCall;
+
+class SendSlackTestNotification
+{
+    use AsAction;
+
+    public function handle(array $webhooks)
+    {
+        if (! count($webhooks)) {
+            Notification::make()
+                ->title('You need to add Slack URLs!')
+                ->warning()
+                ->send();
+
+            return;
+        }
+
+        foreach ($webhooks as $webhook) {
+            WebhookCall::create()
+                ->url($webhook['url'])
+                ->payload(['text' => '👋 Testing the Slack notification channel.'])
+                ->doNotSign()
+                ->dispatch();
+        }
+
+        Notification::make()
+            ->title('Test Slack notification sent.')
+            ->success()
+            ->send();
+    }
+}

app/Filament/Pages/Settings/NotificationPage.php

@@ -6,6 +6,7 @@
 use App\Actions\Notifications\SendDiscordTestNotification;
 use App\Actions\Notifications\SendGotifyTestNotification;
 use App\Actions\Notifications\SendMailTestNotification;
+use App\Actions\Notifications\SendSlackTestNotification;
 use App\Actions\Notifications\SendTelegramTestNotification;
 use App\Actions\Notifications\SendWebhookTestNotification;
 use App\Settings\NotificationSettings;
@@ -173,6 +174,50 @@ public function form(Form $form): Form
                                         'md' => 2,
                                     ]),
 
+                                Forms\Components\Section::make('Slack')
+                                    ->schema([
+                                        Forms\Components\Toggle::make('slack_enabled')
+                                            ->label('Enable Slack webhook notifications')
+                                            ->reactive()
+                                            ->columnSpanFull(),
+                                        Forms\Components\Grid::make([
+                                            'default' => 1,
+                                        ])
+                                            ->hidden(fn (Forms\Get $get) => $get('slack_enabled') !== true)
+                                            ->schema([
+                                                Forms\Components\Fieldset::make('Triggers')
+                                                    ->schema([
+                                                        Forms\Components\Toggle::make('slack_on_speedtest_run')
+                                                            ->label('Notify on every speedtest run')
+                                                            ->columnSpanFull(),
+                                                        Forms\Components\Toggle::make('slack_on_threshold_failure')
+                                                            ->label('Notify on threshold failures')
+                                                            ->columnSpanFull(),
+                                                    ]),
+                                                Forms\Components\Repeater::make('slack_webhooks')
+                                                    ->label('Webhooks')
+                                                    ->schema([
+                                                        Forms\Components\TextInput::make('url')
+                                                            ->placeholder('https://hooks.slack.com/services/abc/xyz')
+                                                            ->maxLength(2000)
+                                                            ->required()
+                                                            ->url(),
+                                                    ])
+                                                    ->columnSpanFull(),
+                                                Forms\Components\Actions::make([
+                                                    Forms\Components\Actions\Action::make('test Slack')
+                                                        ->label('Test slack webhook')
+                                                        ->action(fn (Forms\Get $get) => SendSlackTestNotification::run(webhooks: $get('slack_webhooks')))
+                                                        ->hidden(fn (Forms\Get $get) => ! count($get('slack_webhooks'))),
+                                                ]),
+                                            ]),
+                                    ])
+                                    ->compact()
+                                    ->columns([
+                                        'default' => 1,
+                                        'md' => 2,
+                                    ]),
+
                                 Forms\Components\Section::make('Mail')
                                     ->schema([
                                         Forms\Components\Toggle::make('mail_enabled')

app/Listeners/Slack/SendSpeedtestCompletedNotification.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace App\Listeners\Slack;
+
+use App\Events\SpeedtestCompleted;
+use App\Helpers\Number;
+use App\Settings\NotificationSettings;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Str;
+use Spatie\WebhookServer\WebhookCall;
+
+class SendSpeedtestCompletedNotification
+{
+    /**
+     * Handle the event.
+     */
+    public function handle(SpeedtestCompleted $event): void
+    {
+        $notificationSettings = new NotificationSettings();
+
+        if (! $notificationSettings->slack_enabled) {
+            return;
+        }
+
+        if (! $notificationSettings->slack_on_speedtest_run) {
+            return;
+        }
+
+        if (! count($notificationSettings->slack_webhooks)) {
+            Log::warning('Slack URLs not found, check Slack notification channel settings.');
+
+            return;
+        }
+
+        $payload = [
+            'text' => view('slack.speedtest-completed', [
+                'id' => $event->result->id,
+                'service' => Str::title($event->result->service),
+                'serverName' => $event->result->server_name,
+                'serverId' => $event->result->server_id,
+                'isp' => $event->result->isp,
+                'ping' => round($event->result->ping).' ms',
+                'download' => Number::toBitRate(bits: $event->result->download_bits, precision: 2),
+                'upload' => Number::toBitRate(bits: $event->result->upload_bits, precision: 2),
+                'packetLoss' => $event->result->packet_loss,
+                'url' => url('/admin/results'),
+            ])->render(),
+        ];
+
+        foreach ($notificationSettings->slack_webhooks as $url) {
+            WebhookCall::create()
+                ->url($url['url'])
+                ->payload($payload)
+                ->doNotSign()
+                ->dispatch();
+        }
+    }
+}

app/Listeners/Slack/SendSpeedtestThresholdNotification.php

@@ -0,0 +1,132 @@
+<?php
+
+namespace App\Listeners\Slack;
+
+use App\Events\SpeedtestCompleted;
+use App\Helpers\Number;
+use App\Settings\NotificationSettings;
+use App\Settings\ThresholdSettings;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Str;
+use Spatie\WebhookServer\WebhookCall;
+
+class SendSpeedtestThresholdNotification
+{
+    /**
+     * Handle the event.
+     */
+    public function handle(SpeedtestCompleted $event): void
+    {
+        $notificationSettings = new NotificationSettings();
+
+        if (! $notificationSettings->slack_enabled) {
+            return;
+        }
+
+        if (! $notificationSettings->slack_on_threshold_failure) {
+            return;
+        }
+
+        if (! count($notificationSettings->slack_webhooks)) {
+            Log::warning('Slack urls not found, check Slack notification channel settings.');
+
+            return;
+        }
+
+        $thresholdSettings = new ThresholdSettings();
+
+        if (! $thresholdSettings->absolute_enabled) {
+            return;
+        }
+
+        $failed = [];
+
+        if ($thresholdSettings->absolute_download > 0) {
+            array_push($failed, $this->absoluteDownloadThreshold(event: $event, thresholdSettings: $thresholdSettings));
+        }
+
+        if ($thresholdSettings->absolute_upload > 0) {
+            array_push($failed, $this->absoluteUploadThreshold(event: $event, thresholdSettings: $thresholdSettings));
+        }
+
+        if ($thresholdSettings->absolute_ping > 0) {
+            array_push($failed, $this->absolutePingThreshold(event: $event, thresholdSettings: $thresholdSettings));
+        }
+
+        $failed = array_filter($failed);
+
+        if (! count($failed)) {
+            Log::warning('Failed Slack thresholds not found, won\'t send notification.');
+
+            return;
+        }
+
+        $payload = [
+            'text' => view('slack.speedtest-threshold', [
+                'id' => $event->result->id,
+                'service' => Str::title($event->result->service),
+                'serverName' => $event->result->server_name,
+                'serverId' => $event->result->server_id,
+                'isp' => $event->result->isp,
+                'metrics' => $failed,
+                'url' => url('/admin/results'),
+            ])->render(),
+        ];
+
+        foreach ($notificationSettings->slack_webhooks as $url) {
+            WebhookCall::create()
+                ->url($url['url'])
+                ->payload($payload)
+                ->doNotSign()
+                ->dispatch();
+        }
+    }
+
+    /**
+     * Build Slack notification if absolute download threshold is breached.
+     */
+    protected function absoluteDownloadThreshold(SpeedtestCompleted $event, ThresholdSettings $thresholdSettings): bool|array
+    {
+        if (! absoluteDownloadThresholdFailed($thresholdSettings->absolute_download, $event->result->download)) {
+            return false;
+        }
+
+        return [
+            'name' => 'Download',
+            'threshold' => $thresholdSettings->absolute_download.' Mbps',
+            'value' => Number::toBitRate(bits: $event->result->download_bits, precision: 2),
+        ];
+    }
+
+    /**
+     * Build Slack notification if absolute upload threshold is breached.
+     */
+    protected function absoluteUploadThreshold(SpeedtestCompleted $event, ThresholdSettings $thresholdSettings): bool|array
+    {
+        if (! absoluteUploadThresholdFailed($thresholdSettings->absolute_upload, $event->result->upload)) {
+            return false;
+        }
+
+        return [
+            'name' => 'Upload',
+            'threshold' => $thresholdSettings->absolute_upload.' Mbps',
+            'value' => Number::toBitRate(bits: $event->result->upload_bits, precision: 2),
+        ];
+    }
+
+    /**
+     * Build Slack notification if absolute ping threshold is breached.
+     */
+    protected function absolutePingThreshold(SpeedtestCompleted $event, ThresholdSettings $thresholdSettings): bool|array
+    {
+        if (! absolutePingThresholdFailed($thresholdSettings->absolute_ping, $event->result->ping)) {
+            return false;
+        }
+
+        return [
+            'name' => 'Ping',
+            'threshold' => $thresholdSettings->absolute_ping.' ms',
+            'value' => round($event->result->ping, 2).' ms',
+        ];
+    }
+}

app/Settings/NotificationSettings.php

@@ -46,6 +46,14 @@ class NotificationSettings extends Settings
 
     public ?array $discord_webhooks;
 
+    public bool $slack_enabled;
+
+    public bool $slack_on_speedtest_run;
+
+    public bool $slack_on_threshold_failure;
+
+    public ?array $slack_webhooks;
+
     public bool $gotify_enabled;
 
     public bool $gotify_on_speedtest_run;

database/settings/2024_02_22_144650_create_slack_notification_settings.php

@@ -0,0 +1,14 @@
+<?php
+
+use Spatie\LaravelSettings\Migrations\SettingsMigration;
+
+return new class extends SettingsMigration
+{
+    public function up(): void
+    {
+        $this->migrator->add('notification.slack_enabled', false);
+        $this->migrator->add('notification.slack_on_speedtest_run', false);
+        $this->migrator->add('notification.slack_on_threshold_failure', false);
+        $this->migrator->add('notification.slack_webhooks', null);
+    }
+};

resources/views/slack/speedtest-completed.blade.php

@@ -0,0 +1,12 @@
+*Speedtest Completed - #{{ $id }}*
+
+A new speedtest was completed using *{{ $service }}*.
+
+- *Server name:* {{ $serverName }}
+- *Server ID:* {{ $serverId }}
+- *ISP:* {{ $isp }}
+- *Ping:* {{ $ping }}
+- *Download:* {{ $download }}
+- *Upload:* {{ $upload }}
+- *Packet Loss:* {{ $packetLoss }} *%*
+- *URL:* {{ $url }}

resources/views/slack/speedtest-threshold.blade.php

@@ -0,0 +1,8 @@
+**Speedtest Threshold Breached - #{{ $id }}**
+
+A new speedtest was completed using **{{ $service }}** on **{{ $isp }}** but a threshold was breached.
+
+@foreach ($metrics as $item)
+- **{{ $item['name'] }}** {{ $item['threshold'] }}: {{ $item['value'] }}
+@endforeach
+- **URL:** {{ $url }}