Merge pull request #40 from vormkracht10/feature/notification-timeout

add timeout for notifications on a per check basis.

config/ok.php

@@ -5,12 +5,16 @@
 
 return [
     'notifications' => [
-        'enabled' => env('LARAVEL_OK_NOTIFICATIONS_ENABLED', true),
+        'enabled' => env('OK_NOTIFICATIONS_ENABLED', true),
 
         'failed_notification' => CheckFailedNotification::class,
 
         'notifiable' => Notifiable::class,
 
+        'interval_in_minutes' => env('OK_NOTIFICATION_INTERVAL', 60 * 60 * 24),
+
+        'cache_driver' => env('OK_CACHE_DRIVER', 'file'),
+
         'via' => [
             // 'discord' => [
             //     'channel' => 123456790,

src/Checks/Base/Check.php

@@ -24,6 +24,10 @@ abstract class Check
 
     protected string $expression = '* * * * *';
 
+    protected int $repeatSeconds;
+
+    protected int $notificationIntervalInMinutes;
+
     protected ?string $name = null;
 
     protected ?string $message = null;
@@ -34,10 +38,6 @@ abstract class Check
 
     protected int $timesToFailWithoutNotification = 1;
 
-    public function __construct()
-    {
-    }
-
     public static function config(): static
     {
         $instance = app(static::class);
@@ -47,6 +47,16 @@ public static function config(): static
         return $instance;
     }
 
+    public function getExpression(): string
+    {
+        return $this->expression;
+    }
+
+    public function getRepeatSeconds(): int
+    {
+        return $this->repeatSeconds;
+    }
+
     public function name(string $name): self
     {
         $this->name = $name;
@@ -108,4 +118,16 @@ public function markAsCrashed(): Result
     {
         return new Result(Status::CRASHED);
     }
+
+    public function getNotificationInterval(): int
+    {
+        return $this->notificationIntervalInMinutes ?? config('ok.notifications.interval_in_minutes');
+    }
+
+    public function setNotificationInterval(int $intervalInMinutes): static
+    {
+        $this->notificationIntervalInMinutes = $intervalInMinutes;
+
+        return $this;
+    }
 }

src/Checks/PermissionCheck.php

@@ -12,8 +12,6 @@ class PermissionCheck extends Check
 
     public function __construct(array $configured = [])
     {
-        parent::__construct();
-
         $this->configured = $configured;
     }
 

src/Commands/RunChecksCommand.php

@@ -36,9 +36,7 @@ public function runChecks()
     {
         return app(OK::class)
             ->configuredChecks()
-            ->map(function (mixed $check) {
-                return is_string($check) ? app($check) : $check;
-            })
+            ->map(fn ($check) => is_string($check) ? app($check) : $check)
             ->map(function (Check $check): Result {
                 return $check->shouldRun()
                     ? $this->runCheck($check)

src/Listeners/SendCheckFailedNotification.php

@@ -2,18 +2,60 @@
 
 namespace Vormkracht10\LaravelOK\Listeners;
 
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Cache;
+use Vormkracht10\LaravelOK\Checks\Base\Check;
+use Vormkracht10\LaravelOK\Events\CheckFailed;
+
 class SendCheckFailedNotification
 {
-    public function handle($event)
+    public function handle(CheckFailed $event)
     {
+        if (! $this->shouldSendNotification($event->check)) {
+            return;
+        }
+
         $notifiableClass = config('ok.notifications.notifiable');
 
         $notifiable = app($notifiableClass);
 
         $failedNotificationClass = config('ok.notifications.failed_notification');
 
-        $notification = (new $failedNotificationClass($event->check, $event->result));
+        $notification = new $failedNotificationClass($event->check, $event->result);
 
         $notifiable->notify($notification);
+
+        $this->setNotificationTimestamp($check);
+    }
+
+    protected function setNotificationTime(Check $check): int
+    {
+        return Cache::driver('file')->forever(
+            'laravel-ok::notifications::'.$check::class,
+            now()->getTimestamp(),
+        );
+    }
+
+    protected function getLastNotifiedTime(Check $check): ?Carbon
+    {
+        $timestamp = Cache::driver('file')
+            ->get('laravel-ok::notifications::'.$check::class);
+
+        if (! $timestamp) {
+            return null;
+        }
+
+        return Carbon::createFromTimestamp($timestamp);
+    }
+
+    protected function shouldSendNotification(Check $check): bool
+    {
+        $lastNotified = $this->getLastNotifiedTime($check);
+
+        if (! $lastNotified) {
+            return true;
+        }
+
+        return now() >= $lastNotified->addMinutes($check->getNotificationInterval());
     }
 }