✨ Health Checks for Links

app/Console/Commands/LinkHealthChecks.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Link;
+use App\Services\Shaark\Shaark;
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\RequestException;
+use Illuminate\Console\Command;
+
+class LinkHealthChecks extends Command
+{
+    protected $signature = 'shaark:link_health_check {--all}';
+    protected $description = 'Run health checks on links';
+
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    public function handle()
+    {
+        Link::where('is_health_check_enabled', 1)
+            ->where(function ($query) {
+                return $query->where('http_checked_at', '<', now()->subDays(app(Shaark::class)->getLinkHealthChecksAge()))
+                    ->orWhereNull('http_checked_at');
+            })
+            ->orderBy('http_checked_at', 'ASC')
+            ->when(! $this->option('all'), function($query) {
+                return $query->limit(20);
+            })
+            ->get()
+            ->each(function (Link $link) {
+                try {
+                    $response = (new Client())->request('GET', $link->getUrlAttribute(), [
+                        'headers' => [
+                            'User-Agent' => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.106 Safari/537.36',
+                        ],
+                        'http_errors' => false,
+                        'timeout' => 5,
+                    ]);
+
+                    $link->http_status = $response->getStatusCode();
+                } catch (RequestException $exception) {
+                    // Might happen when the domain has expired
+                    $link->http_status = 500;
+                } finally {
+                    $link->http_checked_at = now();
+                    $link->save();
+                }
+            });
+    }
+}

app/Console/Kernel.php

@@ -30,6 +30,9 @@ protected function schedule(Schedule $schedule)
 
         // Make backup
         $this->scheduleBackup($schedule);
+
+        // Link health checks
+        $this->scheduleLinkHealthChecks($schedule);
     }
 
     protected function scheduleBackup(Schedule $schedule): self
@@ -54,4 +57,15 @@ protected function scheduleBackup(Schedule $schedule): self
 
         return $this;
     }
+
+    protected function scheduleLinkHealthChecks(Schedule $schedule): self
+    {
+        $shaark = app(Shaark::class);
+
+        if (false === $shaark->getLinkHealthChecksEnabled()) {
+            return $this;
+        }
+
+        $schedule->command('shaark:link_health_check')->everyTenMinutes();
+    }
 }

app/Http/Controllers/Api/LinkController.php

@@ -41,6 +41,7 @@ public function store(StoreLinkRequest $request)
             'title',
             'content',
             'url',
+            'is_health_check_enabled',
         ])->toArray());
 
         $link->updatePreview();
@@ -69,7 +70,7 @@ public function update(StoreLinkRequest $request, int $id)
         $link = Link::findOrFail($id);
         $data = collect($request->validated());
 
-        $link->fill($data->only('title', 'content', 'url')->toArray());
+        $link->fill($data->only('title', 'content', 'url', 'is_health_check_enabled')->toArray());
         $link->updatePreview();
 
         $link->post->is_pinned = $data->get('is_pinned', $link->post->is_pinned);

app/Http/Controllers/Manage/LinksController.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace App\Http\Controllers\Manage;
+
+use App\Http\Controllers\Controller;
+use App\Link;
+use App\Services\HealthCheckStats;
+use App\Services\Shaark\Shaark;
+
+class LinksController extends Controller
+{
+    public function __construct()
+    {
+        $this->middleware('auth');
+
+        $this->middleware('demo')->except('view');
+    }
+
+    public function view()
+    {
+        return view('manage.links')->with([
+            'page_title' => __('Links'),
+            'stats' => new HealthCheckStats(),
+        ]);
+    }
+
+    public function viewDead()
+    {
+        return view('manage.links_dead')->with([
+            'page_title' => __('Dead Links'),
+            'stats' => new HealthCheckStats(),
+            'dead_links' => Link::whereBetween('http_status', [400, 499])->orderBy('http_checked_at', 'DESC')->paginate(10),
+        ]);
+    }
+
+    public function viewOther()
+    {
+        return view('manage.links_other')->with([
+            'page_title' => __('Other Status Links'),
+            'stats' => new HealthCheckStats(),
+            'other_links' => Link::whereBetween('http_status', [300, 399])
+                ->orWhereBetween('http_status', [500, 599])
+                ->orderBy('http_checked_at', 'DESC')->paginate(10),
+        ]);
+    }
+
+    public function viewDisabled()
+    {
+        return view('manage.links_disabled')->with([
+            'page_title' => __('Disabled Links'),
+            'stats' => new HealthCheckStats(),
+            'disabled_links' => Link::where('is_health_check_enabled', 0)->paginate(10),
+        ]);
+    }
+}

app/Http/Requests/StoreLinkRequest.php

@@ -27,6 +27,9 @@ public function rules()
                 'required',
                 'url',
             ],
+            'is_health_check_enabled' => [
+                'nullable',
+            ],
             'is_private' => [
                 'nullable',
             ],

app/Http/Resources/LinkResource.php

@@ -13,6 +13,10 @@ public function toArray($request)
             'title' => $this->title,
             'content' => $this->content,
             'url' => $this->url,
+            'is_health_check_enabled' => $this->is_health_check_enabled,
+            'http_status' => $this->getStatusText($this->http_status),
+            'http_status_color' => $this->getStatusColor($this->http_status),
+            'http_checked_at' => $this->http_checked_at,
             'permalink' => $this->permalink,
             'is_private' => $this->post->is_private,
             'is_pinned' => $this->post->is_pinned,
@@ -33,4 +37,34 @@ public function toArray($request)
             ])
         ];
     }
+
+    public function getStatusText($status)
+    {
+        if (is_null($status)) {
+            return null;
+        }
+
+        if ($status == 200) {
+            return 'Healthy (200)';
+        }
+
+        if (400 <= $status and $status <= 499) {
+            return 'Dead (4xx)';
+        }
+
+        return 'Other (3xx, 5xx)';
+    }
+
+    public function getStatusColor($status)
+    {
+        if ($status == 200) {
+            return 'success';
+        }
+
+        if (400 <= $status and $status <= 499) {
+            return 'danger';
+        }
+
+        return 'warning';
+    }
 }

app/Link.php

@@ -18,6 +18,7 @@ class Link extends Model
         'preview',
         'archive',
         'url',
+        'is_health_check_enabled',
     ];
     protected $appends = [
         'permalink',

app/Services/HealthCheckStats.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace App\Services;
+
+use App\Services\Shaark\Shaark;
+
+class HealthCheckStats
+{
+    /** @var \Illuminate\Support\Collection $stats */
+    public $stats;
+
+    public function __construct()
+    {
+        $this->stats = \DB::table('links')
+            ->select('http_status', \DB::raw('count(id) as num_count'))
+            ->groupBy('http_status')
+            ->get();
+    }
+
+    public function get()
+    {
+        return [
+            'num_healthy' => $this->countHealthy(),
+            'num_other' => $this->countOther(),
+            'num_dead' => $this->countDead(),
+            'num_pending' => $this->countPending(),
+        ];
+    }
+
+    public function isHealthCheckEnabled()
+    {
+        return app(Shaark::class)->getLinkHealthChecksEnabled();
+    }
+
+    public function countTotal()
+    {
+        return $this->stats->sum('num_count');
+    }
+
+    public function countHealthy()
+    {
+        return $this->stats->where('http_status', 200)->sum('num_count');
+    }
+
+    public function countOther()
+    {
+        $redirects = $this->stats->whereBetween('http_status', [300, 399])
+            ->sum('num_count');
+
+        $server_errors = $this->stats->whereBetween('http_status', [500, 599])
+            ->sum('num_count');
+
+        return $redirects + $server_errors;
+    }
+
+    public function countDead()
+    {
+        return $this->stats->whereBetween('http_status', [400, 499])
+            ->sum('num_count');
+    }
+
+    public function countPending()
+    {
+        return \DB::table('links')
+            ->where('is_health_check_enabled', 1)
+            ->where(function ($query) {
+                return $query->where('http_checked_at', '<', now()->subDays(app(Shaark::class)->getLinkHealthChecksAge()))
+                    ->orWhereNull('http_checked_at');
+            })
+            ->count();
+    }
+
+    public function countDisabled()
+    {
+        return \DB::table('links')
+            ->where('is_health_check_enabled', 0)
+            ->count();
+    }
+}

composer.json

@@ -27,6 +27,7 @@
         "php": "^7.2",
         "doctrine/dbal": "^2.9",
         "fideloper/proxy": "^4.0",
+        "guzzlehttp/guzzle": "^6.5",
         "hashids/hashids": "^2.0.4|~3.0",
         "lab404/laravel-auth-checker": "^1.4",
         "laravel/framework": "^6.18",