Merge pull request #232 from rbibby/main

Allow status code of Json results controller to be changed on failure

config/health.php

@@ -118,4 +118,10 @@
      * in Horizon's silenced jobs screen.
      */
     'silence_health_queue_job' => true,
+
+    /*
+     * The response code to use for HealthCheckJsonResultsController when a health
+     * check has failed
+     */
+    'json_results_failure_status' => 200,
 ];

docs/viewing-results/as-json.md

@@ -24,3 +24,8 @@ https://example.com/health?fresh
 ```
 
 This way you'll see the latest results in the JSON.
+
+## Status codes
+
+By default, a 200 response will be returned regardless of the results. You can change the status code that
+will be returned if a check fails using the `health.json_results_failure_status` config value.

src/Http/Controllers/HealthCheckJsonResultsController.php

@@ -18,7 +18,7 @@ public function __invoke(Request $request, ResultStore $resultStore): Response
 
         $checkResults = $resultStore->latestResults();
 
-        return response($checkResults?->toJson() ?? '')
+        return response($checkResults?->toJson() ?? '', config('health.json_results_failure_status', 200))
             ->header('Content-Type', 'application/json')
             ->header('Cache-Control', 'no-store, no-cache, must-revalidate, post-check=0, pre-check=0');
     }

tests/Http/Controllers/HealthCheckJsonResultsControllerTest.php

@@ -6,6 +6,7 @@
 use Spatie\Health\Http\Controllers\HealthCheckJsonResultsController;
 use Spatie\Health\ResultStores\StoredCheckResults\StoredCheckResults;
 use Spatie\Health\Tests\TestClasses\FakeUsedDiskSpaceCheck;
+use Symfony\Component\HttpFoundation\Response;
 
 use function Pest\Laravel\artisan;
 use function Pest\Laravel\getJson;
@@ -56,3 +57,18 @@
     expect($storedCheckResults)->toBeInstanceOf(StoredCheckResults::class)
         ->and($storedCheckResults->storedCheckResults)->toHaveCount(1);
 });
+
+it('will return the configured status for a unhealthy check', function () {
+    $this->check->replyWith(fn () => false);
+
+    config()->set('health.json_results_failure_status', Response::HTTP_SERVICE_UNAVAILABLE);
+
+    artisan(RunHealthChecksCommand::class);
+
+    $json = getJson('/')
+        ->assertStatus(Response::HTTP_SERVICE_UNAVAILABLE)
+        ->json();
+
+    assertMatchesSnapshot($json);
+});
+

tests/TestClasses/FakeUsedDiskSpaceCheck.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\Health\Tests\TestClasses;
 
+use Closure;
 use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck;
 
 class FakeUsedDiskSpaceCheck extends UsedDiskSpaceCheck
@@ -24,4 +25,11 @@ public function getFilesystemName(): ?string
     {
         return $this->filesystemName;
     }
+
+    public function replyWith(Closure $closure): self
+    {
+        $this->closure = $closure;
+
+        return $this;
+    }
 }

tests/__snapshots__/HealthCheckJsonResultsControllerTest__it_will_return_the_configured_status_for_a_unhealthy_check__1.yml

@@ -0,0 +1,3 @@
+finishedAt: 1609459200
+checkResults:
+    - { name: FakeUsedDiskSpace, label: 'Fake Used Disk Space', notificationMessage: 'The disk is almost full (100% used).', shortSummary: 100%, status: failed, meta: { disk_space_used_percentage: 100 } }