Php-Template/src/Controllers/HealthcheckController.php

<?php

declare(strict_types=1);

namespace Siteworxpro\App\Controllers;

use Illuminate\Database\PostgresConnection;
use Nyholm\Psr7\ServerRequest;
use Psr\Http\Message\ResponseInterface;
use Siteworxpro\App\Http\JsonResponseFactory;
use Siteworxpro\App\Http\Responses\GenericResponse;
use Siteworxpro\App\Models\Model;
use Siteworxpro\App\Services\Facades\Redis;
use Siteworxpro\HttpStatus\CodesEnum;
use OpenApi\Attributes as OA;

/**
 * Class HealthcheckController
 *
 * Handles health check requests to verify database and cache connectivity.
 *
 * @package Siteworxpro\App\Controllers
 */
class HealthcheckController extends Controller
{
    /**
     * Handles the GET request for health check.
     *
     * @throws \JsonException
     */
    #[OA\Get(path: '/healthz', tags: ['Healthcheck'])]
    #[OA\Response(response: '200', description: 'Healthcheck OK')]
    #[OA\Response(response: '503', description: 'Healthcheck Failed')]
    public function get(ServerRequest $request): ResponseInterface
    {
        try {
            /** @var PostgresConnection $conn */
            $conn = Model::getConnectionResolver()->connection();
            $conn->getPdo()->exec('SELECT 1');

            $response = Redis::ping();
            if ($response->getPayload() !== 'PONG') {
                throw new \Exception('Redis ping failed');
            }
        } catch (\Exception $e) {
            return JsonResponseFactory::createJsonResponse(
                [
                    'status_code' => CodesEnum::SERVICE_UNAVAILABLE->value,
                    'message' => 'Healthcheck Failed',
                    'error' => $e->getMessage(),
                ],
                CodesEnum::SERVICE_UNAVAILABLE
            );
        }

        return JsonResponseFactory::createJsonResponse(
            new GenericResponse('Healthcheck OK', CodesEnum::OK->value)
        );
    }
}