Pause monitors without disabling them

app/Actions/DispatchMonitorCheck.php

@@ -4,6 +4,7 @@
 
 namespace App\Actions;
 
+use App\Enums\MonitorStatus;
 use App\Enums\MonitorType;
 use App\Jobs\RunCheckJob;
 use App\Models\Monitor;
@@ -17,6 +18,10 @@
 
     public function handle(Monitor $monitor, bool $saved = false): int
     {
+        if ($monitor->status === MonitorStatus::Paused) {
+            return 0;
+        }
+
         if ($saved && (! $monitor->enabled || ! $monitor->type->usesOutboundProbe())) {
             return 0;
         }

app/Actions/PauseMonitor.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use App\Enums\MonitorStatus;
+use App\Events\MonitorStatusUpdated;
+use App\Models\Monitor;
+use Illuminate\Broadcasting\BroadcastException;
+use ReturnEarly\ActionsPattern\Interfaces\ActionsPatternInterface;
+use ReturnEarly\ActionsPattern\Traits\ActionsPattern;
+
+final readonly class PauseMonitor implements ActionsPatternInterface
+{
+    use ActionsPattern;
+
+    public function handle(Monitor $monitor): Monitor
+    {
+        if ($monitor->status === MonitorStatus::Paused) {
+            return $monitor;
+        }
+
+        $previous = $monitor->status;
+        $monitor->status = MonitorStatus::Paused;
+        $monitor->last_status_changed_at = now();
+        $monitor->save();
+
+        $this->broadcast($monitor, $previous);
+
+        return $monitor;
+    }
+
+    private function broadcast(Monitor $monitor, MonitorStatus $previous): void
+    {
+        try {
+            MonitorStatusUpdated::dispatch($monitor, $previous);
+        } catch (BroadcastException $exception) {
+            report($exception);
+        }
+    }
+}

app/Actions/ReceiveHeartbeat.php

@@ -6,6 +6,7 @@
 
 use App\Checking\ProbeResult;
 use App\Enums\HeartbeatSignal;
+use App\Enums\MonitorStatus;
 use App\Models\CheckResult;
 use App\Models\Monitor;
 use ReturnEarly\ActionsPattern\Interfaces\ActionsPatternInterface;
@@ -21,6 +22,10 @@ public function __construct(
 
     public function handle(Monitor $monitor, HeartbeatSignal $signal = HeartbeatSignal::Finish, ?int $latencyMs = null): ?CheckResult
     {
+        if ($monitor->status === MonitorStatus::Paused) {
+            return null;
+        }
+
         if ($signal === HeartbeatSignal::Start) {
             $monitor->heartbeat_started_at = now();
             $monitor->scheduleNextCheck();

app/Actions/ResumeMonitor.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions;
+
+use App\Enums\MonitorStatus;
+use App\Events\MonitorStatusUpdated;
+use App\Models\Monitor;
+use Illuminate\Broadcasting\BroadcastException;
+use ReturnEarly\ActionsPattern\Interfaces\ActionsPatternInterface;
+use ReturnEarly\ActionsPattern\Traits\ActionsPattern;
+
+final readonly class ResumeMonitor implements ActionsPatternInterface
+{
+    use ActionsPattern;
+
+    public function handle(Monitor $monitor): Monitor
+    {
+        if ($monitor->status !== MonitorStatus::Paused) {
+            return $monitor;
+        }
+
+        $previous = $monitor->status;
+        $monitor->status = MonitorStatus::Pending;
+        $monitor->next_check_at = now();
+        $monitor->last_status_changed_at = now();
+        $monitor->save();
+
+        $this->broadcast($monitor, $previous);
+
+        return $monitor;
+    }
+
+    private function broadcast(Monitor $monitor, MonitorStatus $previous): void
+    {
+        try {
+            MonitorStatusUpdated::dispatch($monitor, $previous);
+        } catch (BroadcastException $exception) {
+            report($exception);
+        }
+    }
+}

app/Filament/Resources/Monitors/Pages/ViewMonitor.php

@@ -6,7 +6,10 @@
 
 use App\Actions\DispatchMonitorCheck;
 use App\Actions\EndMonitorMaintenance;
+use App\Actions\PauseMonitor;
+use App\Actions\ResumeMonitor;
 use App\Actions\StartMonitorMaintenance;
+use App\Enums\MonitorStatus;
 use App\Filament\Concerns\RefreshesOnMonitorBroadcasts;
 use App\Filament\Resources\Monitors\MonitorResource;
 use App\Filament\Widgets\MonitorHistoryWidget;
@@ -34,12 +37,39 @@ protected function getHeaderActions(): array
                 ->label('Check now')
                 ->icon(Heroicon::OutlinedPlay)
                 ->visible(function (): bool {
-                    /** @var Monitor $record */
-                    $record = $this->getRecord();
+                    $record = $this->monitor();
 
-                    return $record->type->usesOutboundProbe();
+                    return $record->type->usesOutboundProbe()
+                        && $record->status !== MonitorStatus::Paused;
                 })
                 ->action($this->queueCheck(...)),
+            Action::make('pause')
+                ->label('Pause')
+                ->icon(Heroicon::OutlinedPause)
+                ->visible(fn (): bool => $this->monitor()->status !== MonitorStatus::Paused)
+                ->requiresConfirmation()
+                ->action(function (): void {
+                    PauseMonitor::make()->handle($this->monitor());
+                    $this->refreshRecord();
+
+                    Notification::make()
+                        ->success()
+                        ->title('Monitor paused')
+                        ->send();
+                }),
+            Action::make('resume')
+                ->label('Resume')
+                ->icon(Heroicon::OutlinedPlay)
+                ->visible(fn (): bool => $this->monitor()->status === MonitorStatus::Paused)
+                ->action(function (): void {
+                    ResumeMonitor::make()->handle($this->monitor());
+                    $this->refreshRecord();
+
+                    Notification::make()
+                        ->success()
+                        ->title('Monitor resumed')
+                        ->send();
+                }),
             Action::make('startMaintenance')
                 ->label('Start maintenance')
                 ->icon(Heroicon::OutlinedWrenchScrewdriver)

app/GraphQL/Mutations/PauseMonitor.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\GraphQL\Mutations;
+
+use App\Actions\PauseMonitor as PauseMonitorAction;
+use App\Models\Monitor;
+
+final class PauseMonitor
+{
+    public function __construct(
+        private readonly PauseMonitorAction $pauseMonitor,
+    ) {}
+
+    /**
+     * @param  array{monitorId: string}  $args
+     */
+    public function __invoke(mixed $root, array $args): Monitor
+    {
+        $monitor = Monitor::query()->findOrFail($args['monitorId']);
+
+        return $this->pauseMonitor->handle($monitor);
+    }
+}

app/GraphQL/Mutations/ResumeMonitor.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\GraphQL\Mutations;
+
+use App\Actions\ResumeMonitor as ResumeMonitorAction;
+use App\Models\Monitor;
+
+final class ResumeMonitor
+{
+    public function __construct(
+        private readonly ResumeMonitorAction $resumeMonitor,
+    ) {}
+
+    /**
+     * @param  array{monitorId: string}  $args
+     */
+    public function __invoke(mixed $root, array $args): Monitor
+    {
+        $monitor = Monitor::query()->findOrFail($args['monitorId']);
+
+        return $this->resumeMonitor->handle($monitor);
+    }
+}

app/Http/Controllers/HeartbeatController.php

@@ -6,6 +6,7 @@
 
 use App\Actions\ReceiveHeartbeat;
 use App\Enums\HeartbeatSignal;
+use App\Enums\MonitorStatus;
 use App\Enums\MonitorType;
 use App\Models\Monitor;
 use Illuminate\Http\JsonResponse;
@@ -22,6 +23,13 @@ public function __invoke(Request $request, ReceiveHeartbeat $receive, string $to
 
         abort_unless($monitor->enabled, 404);
 
+        if ($monitor->status === MonitorStatus::Paused) {
+            return response()->json([
+                'ok' => true,
+                'paused' => true,
+            ]);
+        }
+
         $latency = $request->integer('latency');
 
         if ($latency === 0) {

app/Jobs/RunCheckJob.php

@@ -6,6 +6,7 @@
 
 use App\Actions\CheckMonitor;
 use App\Actions\RecordCheckResult;
+use App\Enums\MonitorStatus;
 use App\Models\Monitor;
 use App\Models\Probe;
 use Illuminate\Contracts\Queue\ShouldQueue;
@@ -27,7 +28,7 @@ public function handle(CheckMonitor $check, RecordCheckResult $recorder): void
         $monitor = Monitor::query()->with('conditions')->find($this->monitorId);
         $probe = $this->probeId === null ? null : Probe::query()->find($this->probeId);
 
-        if ($monitor === null || ! $monitor->enabled) {
+        if ($monitor === null || ! $monitor->enabled || $monitor->status === MonitorStatus::Paused) {
             return;
         }
 

graphql/schema.graphql

@@ -525,6 +525,8 @@ type Mutation @guard(with: ["sanctum"]) {
     deleteMaintenanceWindow(id: ID!): Boolean!
     startMonitorMaintenance(monitorId: ID!, title: String, message: String, endsAt: DateTime): MaintenanceWindow!
     endMonitorMaintenance(monitorId: ID!): Monitor!
+    pauseMonitor(monitorId: ID!): Monitor!
+    resumeMonitor(monitorId: ID!): Monitor!
     createStatusPage(input: CreateStatusPageInput!): StatusPage!
     updateStatusPage(id: ID!, input: UpdateStatusPageInput!): StatusPage!
     deleteStatusPage(id: ID!): Boolean!

tests/Feature/Actions/DispatchMonitorCheckTest.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use App\Actions\DispatchMonitorCheck;
+use App\Enums\MonitorStatus;
 use App\Jobs\RunCheckJob;
 use App\Models\Monitor;
 use App\Models\Probe;
@@ -63,6 +64,19 @@
     });
 });
 
+it('does not queue a check for a paused monitor', function () {
+    Queue::fake();
+
+    $monitor = Monitor::factory()->create(['status' => MonitorStatus::Paused]);
+    $probe = Probe::factory()->create(['queue' => 'checks.local']);
+    $monitor->probes()->attach($probe);
+
+    expect(DispatchMonitorCheck::make()->handle($monitor))->toBe(0)
+        ->and(DispatchMonitorCheck::make()->handle($monitor, saved: true))->toBe(0);
+
+    Queue::assertNothingPushed();
+});
+
 it('does not queue a check after saving a heartbeat or disabled monitor', function () {
     Queue::fake();