Skip to content

fix: return HTTP 503 on bootstrap error for /health endpoint #1961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kayjoosten wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: return HTTP 503 on bootstrap error for /health endpoint #1961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions public/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,29 @@

require dirname(__DIR__).'/vendor/autoload.php';

// Validate required envs
if (!isset($_ENV['APP_ENV'])) {
throw new RuntimeException('APP_ENV environment variable is not defined.');
}
if (!isset($_ENV['APP_SECRET']) || trim($_ENV['APP_SECRET']) === '') {
throw new \RuntimeException('APP_SECRET is missing or empty. Set it in your environment configuration.');
}
if ($_ENV['APP_ENV'] === 'prod' && strlen($_ENV['APP_SECRET']) < 32) {
throw new \RuntimeException('APP_SECRET must be at least 32 characters long in production.');
try {
// Validate required envs
if (!isset($_ENV['APP_ENV'])) {
throw new RuntimeException('APP_ENV environment variable is not defined.');
}
if (!isset($_ENV['APP_SECRET']) || trim($_ENV['APP_SECRET']) === '') {
throw new \RuntimeException('APP_SECRET is missing or empty. Set it in your environment configuration.');
}
if ($_ENV['APP_ENV'] === 'prod' && strlen($_ENV['APP_SECRET']) < 32) {
throw new \RuntimeException('APP_SECRET must be at least 32 characters long in production.');
}
} catch (\Throwable $e) {
http_response_code(503);
header('Content-Type: application/json');
$body = ['status' => 'DOWN'];
if (trim($e->getMessage()) !== '') {
$body['message'] = $e->getMessage();
}
error_log($e->getMessage());
echo json_encode($body) ?: '{"status":"DOWN"}';
exit;
}

$debug = filter_var($_ENV['APP_DEBUG'], FILTER_VALIDATE_BOOLEAN);

if ($debug) {
Expand Down
15 changes: 15 additions & 0 deletions tests/functional/OpenConext/EngineBlockBundle/Controller/MonitorControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,19 @@ public function internal_health_returns_json()
$json = json_decode($response->getContent(), true, 512, JSON_THROW_ON_ERROR);
$this->assertSame(['status' => 'UP'], $json);
}

#[Test]
#[Group('Monitor')]
public function health_returns_json(): void
{
$client = self::createClient();
$client->request('GET', 'https://engine.dev.openconext.local/health');

$response = $client->getResponse();
$this->assertEquals(Response::HTTP_OK, $response->getStatusCode());
$this->assertJson($response->getContent());

$json = json_decode($response->getContent(), true, 512, JSON_THROW_ON_ERROR);
$this->assertSame(['status' => 'UP'], $json);
}
}