Merge pull request #55 from awarrenlove/degraded-status

Support DEGRADED status in HealthChecks
ans-group · May 17, 2021 · b6d5f26 · b6d5f26
2 parents 35fe6de + 56af564
commit b6d5f26
Show file tree

Hide file tree

Showing 4 changed files with 111 additions and 6 deletions.
diff --git a/src/Controllers/HealthCheckController.php b/src/Controllers/HealthCheckController.php
@@ -5,6 +5,7 @@
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Http\Response;
 use Illuminate\Support\Collection;
+use UKFast\HealthCheck\Status;
 
 class HealthCheckController
 {
@@ -19,16 +20,20 @@ public function __invoke(Container $container)
             return $check->status();
         });
 
-        $isOkay = $statuses->filter(function ($status) {
+        $isProblem = $statuses->contains(function ($status) {
             return $status->isProblem();
-        })->isEmpty();
+        });
+
+        $isDegraded = $statuses->contains(function ($status) {
+            return $status->isDegraded();
+        });
 
-        $body = ['status' => $isOkay ? 'OK' : 'PROBLEM'];
+        $body = ['status' => ($isProblem ? Status::PROBLEM : ($isDegraded ? Status::DEGRADED : Status::OKAY))];
         foreach ($statuses as $status) {
             $body[$status->name()] = [];
-            $body[$status->name()]['status'] = $status->isOkay() ? 'OK' : 'PROBLEM';
+            $body[$status->name()]['status'] = $status->getStatus();
 
-            if ($status->isProblem()) {
+            if (!$status->isOkay()) {
                 $body[$status->name()]['message'] = $status->message();
             }
 
@@ -37,6 +42,6 @@ public function __invoke(Container $container)
             }
         }
 
-        return new Response($body, $isOkay ? 200 : 500);
+        return new Response($body, $isProblem ? 500 : 200);
     }
 }
diff --git a/src/HealthCheck.php b/src/HealthCheck.php
@@ -23,6 +23,14 @@ public function problem($message = '', $context = [])
             ->withName($this->name());
     }
 
+    public function degraded($message = '', $context = [])
+    {
+        return (new Status)
+            ->degraded($message)
+            ->withContext($context)
+            ->withName($this->name());
+    }
+
     public function okay($context = [])
     {
         return (new Status)

diff --git a/src/Status.php b/src/Status.php
@@ -6,6 +6,8 @@ class Status
 {
     const PROBLEM = 'PROBLEM';
 
+    const DEGRADED = 'DEGRADED';
+
     const OKAY = 'OK';
 
     /** @var string */
@@ -30,6 +32,19 @@ public function problem($message = '')
         return $this;
     }
 
+    /**
+     * Marks the status as degraded
+     * 
+     * @param string? $message Degraded message
+     * @return self
+     */
+    public function degraded($message = '')
+    {
+        $this->status = Status::DEGRADED;
+        $this->message = $message;
+        return $this;
+    }
+
     /**
      * Marks status as okay
      * 
@@ -41,6 +56,16 @@ public function okay()
         return $this;
     }
 
+    /**
+     * Returns the status string
+     * 
+     * @return string|null
+     */
+    public function getStatus()
+    {
+        return $this->status;
+    }
+
     /**
      * Returns if the status is a problem
      * 
@@ -51,6 +76,16 @@ public function isProblem()
         return $this->status == Status::PROBLEM;
     }
 
+    /**
+     * Returns if the status is degraded
+     * 
+     * @return bool
+     */
+    public function isDegraded()
+    {
+        return $this->status == Status::DEGRADED;
+    }
+
     /**
      * Returns if the status is okay
      * 

diff --git a/tests/Controllers/HealthCheckControllerTest.php b/tests/Controllers/HealthCheckControllerTest.php
@@ -2,6 +2,7 @@
 
 namespace Tests\Controllers;
 
+use Illuminate\Http\Response;
 use Tests\TestCase;
 use UKFast\HealthCheck\Controllers\HealthCheckController;
 use UKFast\HealthCheck\HealthCheck;
@@ -27,6 +28,26 @@ public function returns_overall_status_of_okay_when_everything_is_up()
         ], json_decode($response->getContent(), true));
     }
 
+    /**
+     * @test
+     */
+    public function returns_degraded_status_with_response_code_200_when_service_is_degraded()
+    {
+        $this->setChecks([AlwaysUpCheck::class, AlwaysDegradedCheck::class]);
+        $response = (new HealthCheckController())->__invoke($this->app);
+
+        $this->assertSame(Response::HTTP_OK, $response->getStatusCode());
+        $this->assertSame([
+            'status' => 'DEGRADED',
+            'always-up' => ['status' => 'OK'],
+            'always-degraded' => [
+                'status' => 'DEGRADED',
+                'message' => 'Something went wrong',
+                'context' => ['debug' => 'info'],
+            ],
+        ], json_decode($response->getContent(), true));
+    }
+
     /**
      * @test
      */
@@ -46,6 +67,30 @@ public function returns_status_of_problem_when_a_problem_occurs()
         ], json_decode($response->getContent(), true));
     }
 
+    /**
+     * @test
+     */
+    public function returns_status_of_problem_when_both_degraded_and_problem_statuses_occur()
+    {
+        $this->setChecks([AlwaysUpCheck::class, AlwaysDegradedCheck::class, AlwaysDownCheck::class]);
+        $response = (new HealthCheckController)->__invoke($this->app);
+
+        $this->assertSame([
+            'status' => 'PROBLEM',
+            'always-up' => ['status' => 'OK'],
+            'always-degraded' => [
+                'status' => 'DEGRADED',
+                'message' => 'Something went wrong',
+                'context' => ['debug' => 'info'],
+            ],
+            'always-down' => [
+                'status' => 'PROBLEM',
+                'message' => 'Something went wrong',
+                'context' => ['debug' => 'info'],
+            ],
+        ], json_decode($response->getContent(), true));
+    }
+
     protected function setChecks($checks)
     {
         config(['healthcheck.checks' => $checks]);
@@ -62,6 +107,18 @@ public function status()
     }
 }
 
+class AlwaysDegradedCheck extends HealthCheck
+{
+    protected $name = 'always-degraded';
+
+    public function status()
+    {
+        return $this->degraded('Something went wrong', [
+            'debug' => 'info',
+        ]);
+    }
+}
+
 class AlwaysDownCheck extends HealthCheck
 {
     protected $name = 'always-down';