Allow custom success status codes (#362)

* Allow custom success status codes * Add tests * Update README.md
spatie · Oct 20, 2024 · fa0b682 · fa0b682
1 parent 8a320f9
commit fa0b682
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -127,6 +127,11 @@ return [
          * When reaching out to the sites these headers will be added.
          */
         'additional_headers' => [],
+
+        /*
+         * Allow status codes other than 200 to be considered as successful uptime checks.
+         */
+        'additional_status_codes' => [],
     ],
 
     'certificate_check' => [

diff --git a/config/uptime-monitor.php b/config/uptime-monitor.php
@@ -113,6 +113,11 @@
          * When reaching out to the sites these headers will be added.
          */
         'additional_headers' => [],
+
+        /*
+         * All status codes in this array will be interpreted as successful requests.
+         */
+        'additional_status_codes' => [],
     ],
 
     'certificate_check' => [

diff --git a/src/MonitorCollection.php b/src/MonitorCollection.php
@@ -55,6 +55,17 @@ protected function getPromises(): Generator
                     'headers' => $this->promiseHeaders($monitor),
                     'body' => $monitor->uptime_check_payload,
                 ])
+            )->then(
+                function (ResponseInterface $response) {
+                    return $response;
+                },
+                function (TransferException $exception) {
+                    if (in_array($exception->getCode(), config('uptime-monitor.uptime_check.additional_status_codes', []))) {
+                        return $exception->getResponse();
+                    }
+
+                    throw $exception;
+                }
             );
 
             yield $promise;

diff --git a/tests/Integration/Commands/CheckUptimeCommandTest.php b/tests/Integration/Commands/CheckUptimeCommandTest.php
@@ -100,4 +100,40 @@ public function it_can_use_a_custom_response_checker()
         $this->assertEquals(UptimeStatus::DOWN, $monitor->uptime_status);
         $this->assertEquals(ResponseCheckerFailureFake::FAILURE_REASON, $monitor->uptime_check_failure_reason);
     }
+
+    /** @test */
+    public function it_handles_additional_status_codes_as_valid_responses()
+    {
+        config()->set('uptime-monitor.uptime_check.additional_status_codes', [401]);
+
+        $monitor = Monitor::factory()->create([
+            'uptime_status' => UptimeStatus::NOT_YET_CHECKED,
+        ]);
+
+        $this->server->setResponseBody('', 401);
+
+        Artisan::call('monitor:check-uptime');
+
+        $monitor = $monitor->fresh();
+
+        $this->assertEquals(UptimeStatus::UP, $monitor->uptime_status);
+    }
+
+    /** @test */
+    public function it_handles_additional_status_codes_as_valid_responses_and_still_fails_on_others()
+    {
+        config()->set('uptime-monitor.uptime_check.additional_status_codes', [401]);
+
+        $monitor = Monitor::factory()->create([
+            'uptime_status' => UptimeStatus::NOT_YET_CHECKED,
+        ]);
+
+        $this->server->setResponseBody('', 418);
+
+        Artisan::call('monitor:check-uptime');
+
+        $monitor = $monitor->fresh();
+
+        $this->assertEquals(UptimeStatus::DOWN, $monitor->uptime_status);
+    }
 }