[1.x] Ignore offline servers (continued) (#355)

* Add the option to ignore offline servers

* Fix: make default value false if the config option is not set.

* Specify Ignore After time

* Fix inconsistent default values for ignore after

* Combine config options into one simple 'ignore_after'

* Get the $ignoreAfter config only once.

* Configure ignore in seconds to match thresholds

* Add tests

* Add 'ignoreAfter' as a property on the Servers card

* Fix getIgnoreAfterSeconds return

* Formatting

---------

Co-authored-by: Leventdev <[email protected]>
Co-authored-by: Jess Archer <[email protected]>
Co-authored-by: Tim MacDonald <[email protected]>

src/Livewire/Servers.php

@@ -3,8 +3,10 @@
 namespace Laravel\Pulse\Livewire;
 
 use Carbon\CarbonImmutable;
+use Carbon\CarbonInterval;
 use Illuminate\Contracts\Support\Renderable;
 use Illuminate\Support\Facades\View;
+use Illuminate\Support\InteractsWithTime;
 use Livewire\Attributes\Lazy;
 use Livewire\Livewire;
 
@@ -14,6 +16,10 @@
 #[Lazy]
 class Servers extends Card
 {
+    use InteractsWithTime;
+
+    public int|string|null $ignoreAfter = null;
+
     /**
      * Render the component.
      */
@@ -24,6 +30,10 @@ public function render(): Renderable
 
             return $this->values('system')
                 ->map(function ($system, $slug) use ($graphs) {
+                    if ($this->ignoreSystem($system)) {
+                        return null;
+                    }
+
                     $values = json_decode($system->value, flags: JSON_THROW_ON_ERROR);
 
                     return (object) [
@@ -38,6 +48,7 @@ public function render(): Renderable
                         'recently_reported' => $updatedAt->isAfter(now()->subSeconds(30)),
                     ];
                 })
+                ->filter()
                 ->sortBy('name');
         });
 
@@ -59,4 +70,22 @@ public function placeholder(): Renderable
     {
         return View::make('pulse::components.servers-placeholder', ['cols' => $this->cols, 'rows' => $this->rows, 'class' => $this->class]);
     }
+
+    /**
+     * Determine if the system should be ignored.
+     *
+     * @param  object{ timestamp: int, key: string, value: string }  $system
+     */
+    protected function ignoreSystem(object $system): bool
+    {
+        if ($this->ignoreAfter === null) {
+            return false;
+        }
+
+        $ignoreAfter = is_numeric($this->ignoreAfter)
+            ? (int) $this->ignoreAfter
+            : CarbonInterval::createFromDateString($this->ignoreAfter)->totalSeconds;
+
+        return CarbonImmutable::createFromTimestamp($system->timestamp)->addSeconds($ignoreAfter)->isPast();
+    }
 }

tests/Feature/Livewire/ServersTest.php

@@ -87,3 +87,51 @@
     Livewire::test(Servers::class, ['lazy' => false])
         ->assertSeeInOrder(['A Web', 'B Web', 'C Web']);
 });
+
+it('can ignore servers that have stopped reporting', function ($ignoreAfter, $see, $dontSee) {
+    Carbon::setTestNow(now()->startOfSecond());
+
+    $data = [
+        'memory_used' => 1234,
+        'memory_total' => 2468,
+        'cpu' => 99,
+        'storage' => [
+            ['directory' => '/', 'used' => 123, 'total' => 456],
+        ],
+    ];
+
+    Pulse::set('system', 'server-1', json_encode([
+        'name' => 'Server 1',
+        ...$data,
+    ]), now()->subSeconds(599));
+
+    Pulse::set('system', 'server-2', json_encode([
+        'name' => 'Server 2',
+        ...$data,
+    ]), now()->subSeconds(600));
+
+    Pulse::set('system', 'server-3', json_encode([
+        'name' => 'Server 3',
+        ...$data,
+    ]), now()->subSeconds(601));
+
+    Pulse::ingest();
+
+    Livewire::test(Servers::class, ['lazy' => false, 'ignoreAfter' => value($ignoreAfter)])
+        ->assertSeeInOrder($see)
+        ->assertDontSeeText($dontSee);
+})->with([
+    [null, ['Server 1', 'Server 2', 'Server 3'], []],
+    [588, [], ['Server 1', 'Server 2', 'Server 3']],
+    [599, ['Server 1'], ['Server 2', 'Server 3']],
+    [600, ['Server 1', 'Server 2'], ['Server 3']],
+    [601, ['Server 1', 'Server 2', 'Server 3'], []],
+    ['588', [], ['Server 1', 'Server 2', 'Server 3']],
+    ['599', ['Server 1'], ['Server 2', 'Server 3']],
+    ['600', ['Server 1', 'Server 2'], ['Server 3']],
+    ['601', ['Server 1', 'Server 2', 'Server 3'], []],
+    ['588 seconds', [], ['Server 1', 'Server 2', 'Server 3']],
+    ['599 seconds', ['Server 1'], ['Server 2', 'Server 3']],
+    ['600 seconds', ['Server 1', 'Server 2'], ['Server 3']],
+    ['601 seconds', ['Server 1', 'Server 2', 'Server 3'], []],
+]);