From d7d49d9a5d81a150df64eeaeb01be7fee1c95a99 Mon Sep 17 00:00:00 2001
From: "Abdulmhsen B. A. A" <admin@arabcoders.org>
Date: Sat, 27 Apr 2024 11:50:41 +0300
Subject: [PATCH] Added an open healthcheck API endpoint.

---
 src/API/System/HealthCheck.php                | 24 +++++++++++++++++++
 .../Middlewares/APIKeyRequiredMiddleware.php  |  4 ++--
 2 files changed, 26 insertions(+), 2 deletions(-)
 create mode 100644 src/API/System/HealthCheck.php

diff --git a/src/API/System/HealthCheck.php b/src/API/System/HealthCheck.php
new file mode 100644
index 00000000..86968bf8
--- /dev/null
+++ b/src/API/System/HealthCheck.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\API\System;
+
+use App\Libs\Attributes\Route\Get;
+use App\Libs\HTTP_STATUS;
+use Psr\Http\Message\ResponseInterface as iResponse;
+use Psr\Http\Message\ServerRequestInterface as iRequest;
+
+final class HealthCheck
+{
+    public const string URL = '%{api.prefix}/system/healthcheck';
+
+    #[Get(self::URL . '[/]', name: 'system.healthcheck')]
+    public function __invoke(iRequest $request): iResponse
+    {
+        return api_response(HTTP_STATUS::HTTP_OK, [
+            'status' => 'ok',
+            'message' => 'System is healthy',
+        ]);
+    }
+}
diff --git a/src/Libs/Middlewares/APIKeyRequiredMiddleware.php b/src/Libs/Middlewares/APIKeyRequiredMiddleware.php
index 6d08cb45..8017d4cb 100644
--- a/src/Libs/Middlewares/APIKeyRequiredMiddleware.php
+++ b/src/Libs/Middlewares/APIKeyRequiredMiddleware.php
@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace App\Libs\Middlewares;
 
+use App\API\System\HealthCheck;
 use App\Libs\Config;
 use App\Libs\HTTP_STATUS;
 use Psr\Http\Message\ResponseInterface;
@@ -17,8 +18,7 @@ final class APIKeyRequiredMiddleware implements MiddlewareInterface
     public const string KEY_NAME = 'apikey';
 
     private const array OPEN_ROUTES = [
-        \App\API\Webhooks\Index::URL,
-        \App\API\System\HealthCheck::URL,
+        HealthCheck::URL,
     ];
 
     /**