Repository navigation
Expand file tree
/
Copy pathPlatformHealthChecks.php
More file actions
147 lines (123 loc) · 4.14 KB
/
Copy pathPlatformHealthChecks.php
File metadata and controls
147 lines (123 loc) · 4.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?php
declare(strict_types=1);
namespace ProcessMaker\Health;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Redis;
use Throwable;
final class PlatformHealthChecks
{
/**
* @return array{
* checks: list<array{name: string, status: string, detail: ?string}>|null,
* failure: ?string
* }
*/
public static function evaluate(bool $ready): array
{
if (!$ready) {
return ['checks' => null, 'failure' => null];
}
$checks = self::run();
return [
'checks' => $checks,
'failure' => self::firstFailure($checks),
];
}
/**
* @return list<array{name: string, status: string, detail: ?string}>
*/
public static function run(): array
{
$database = self::tryCheck('Database', static fn () => DB::connection()->getPdo(), (string) config('database.default'));
if ($database['status'] === 'failed') {
return [$database];
}
$checks = [$database];
if (!self::redisRequired()) {
$checks[] = [
'name' => 'Redis',
'status' => 'skipped',
'detail' => 'Not required by cache, queue, session, or broadcasting',
];
return $checks;
}
$checks[] = self::tryCheck(
'Redis',
static fn () => Redis::connection()->ping(),
(string) config('database.redis.default.host', '127.0.0.1'),
);
return $checks;
}
/**
* @param array{name: string, status: string, detail: ?string} $check
*/
public static function consoleLine(array $check): string
{
$name = $check['name'];
$detail = $check['detail'] ?? '';
return match ($check['status']) {
'ok' => $detail !== '' ? "{$name}: <info>OK</info> ({$detail})" : "{$name}: <info>OK</info>",
'skipped' => $detail !== '' ? "{$name}: <comment>skipped</comment> — {$detail}" : "{$name}: <comment>skipped</comment>",
default => $detail !== '' ? "{$name}: <error>FAILED</error> — {$detail}" : "{$name}: <error>FAILED</error>",
};
}
/**
* @return array{
* dead: ?OctaneHeartbeatResult,
* checks: list<array{name: string, status: string, detail: ?string}>|null
* }
*/
public static function guard(
ProbeContext $context,
bool $ready,
string $hint,
?int $httpStatus = null,
): array {
$platform = self::evaluate($ready);
if ($platform['failure'] === null) {
return ['dead' => null, 'checks' => $platform['checks']];
}
return [
'dead' => OctaneHeartbeatResult::deadFromContext(
$context,
$platform['failure'],
hint: $hint,
httpStatus: $httpStatus,
platformChecks: $platform['checks'],
),
'checks' => $platform['checks'],
];
}
/**
* @return array{name: string, status: string, detail: ?string}
*/
private static function tryCheck(string $name, callable $callback, string $okDetail): array
{
try {
$callback();
return ['name' => $name, 'status' => 'ok', 'detail' => $okDetail];
} catch (Throwable $exception) {
return ['name' => $name, 'status' => 'failed', 'detail' => $exception->getMessage()];
}
}
/**
* @param list<array{name: string, status: string, detail: ?string}> $checks
*/
private static function firstFailure(array $checks): ?string
{
$failed = array_find($checks, static fn (array $check): bool => $check['status'] === 'failed');
if ($failed === null) {
return null;
}
return strtolower($failed['name']) . ' unavailable: ' . ($failed['detail'] ?? 'check failed');
}
private static function redisRequired(): bool
{
return in_array('redis', [
config('cache.default'),
config('queue.default'),
config('broadcasting.default'),
config('session.driver'),
], true);
}
}