-
-
Notifications
You must be signed in to change notification settings - Fork 158
Expand file tree
/
Copy pathFrameworkKernel.php
More file actions
289 lines (228 loc) · 8.03 KB
/
FrameworkKernel.php
File metadata and controls
289 lines (228 loc) · 8.03 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<?php
declare(strict_types=1);
namespace Tempest\Core;
use Dotenv\Dotenv;
use ErrorException;
use RuntimeException;
use Tempest\Container\Container;
use Tempest\Container\GenericContainer;
use Tempest\Core\Kernel\FinishDeferredTasks;
use Tempest\Core\Kernel\LoadConfig;
use Tempest\Core\Kernel\RegisterEmergencyExceptionHandler;
use Tempest\Discovery\AutoloadDiscoveryLocations;
use Tempest\Discovery\BootDiscovery;
use Tempest\Discovery\Composer;
use Tempest\Discovery\DiscoveryCache;
use Tempest\Discovery\DiscoveryCacheInitializer;
use Tempest\Discovery\DiscoveryConfig;
use Tempest\Discovery\DiscoveryLocation;
use Tempest\EventBus\EventBus;
use Tempest\Process\GenericProcessExecutor;
use Tempest\Support\Filesystem;
final class FrameworkKernel implements Kernel
{
public readonly Container $container;
public string $internalStorage;
public DiscoveryConfig $discoveryConfig;
public function __construct(
public string $root,
/** @var DiscoveryLocation[] */
private array $discoveryLocations = [],
?Container $container = null,
?string $internalStorage = null,
) {
$this->container = $container ?? $this->createContainer();
if ($internalStorage !== null) {
$this->internalStorage = $internalStorage;
}
}
public static function boot(
string $root,
array $discoveryLocations = [],
?Container $container = null,
?string $internalStorage = null,
): self {
if (! defined('TEMPEST_START')) {
define('TEMPEST_START', value: hrtime(as_number: true));
}
return new self(
root: $root,
discoveryLocations: $discoveryLocations,
container: $container,
internalStorage: $internalStorage,
)
->registerKernel()
->validateRoot()
->loadEnv()
->registerEmergencyExceptionHandler()
->registerShutdownFunction()
->registerInternalStorage()
->loadComposer()
->loadDiscoveryConfig()
->loadConfig()
->bootDiscovery()
->registerExceptionHandler()
->event(KernelEvent::BOOTED);
}
public function createContainer(): GenericContainer
{
$container = new GenericContainer();
GenericContainer::setInstance($container);
return $container;
}
public function validateRoot(): self
{
$root = Filesystem\normalize_path($this->root);
if (! is_dir($root)) {
throw new RuntimeException('The specified root directory is not valid.');
}
$this->root = $root;
return $this;
}
public function shutdown(int|string $status = ''): never
{
$this->finishDeferredTasks()
->event(KernelEvent::SHUTDOWN);
exit($status);
}
public function loadComposer(): self
{
if (class_exists(GenericProcessExecutor::class)) {
$processExecutor = new GenericProcessExecutor();
} else {
$processExecutor = null;
}
$composer = new Composer(
root: $this->root,
executor: $processExecutor,
)->load();
$this->container->singleton(Composer::class, $composer);
return $this;
}
public function loadEnv(): self
{
$dotenv = Dotenv::createUnsafeImmutable($this->root);
$dotenv->safeLoad();
return $this;
}
public function registerKernel(): self
{
$this->container->singleton(Kernel::class, $this);
$this->container->singleton(self::class, $this);
return $this;
}
public function registerShutdownFunction(): self
{
// Fix for classes that don't have a proper PSR-4 namespace,
// they break discovery with an unrecoverable error,
// but you don't know why because PHP simply says "duplicate classname" instead of something reasonable.
register_shutdown_function(function (): void {
$error = error_get_last();
$message = $error['message'] ?? '';
if (str_contains($message, 'Cannot declare class')) {
echo 'Does this class have the right namespace?' . PHP_EOL;
}
});
return $this;
}
public function loadDiscoveryConfig(): self
{
/** @var DiscoveryConfig $discoveryConfig */
$discoveryConfig = $this->container->get(DiscoveryConfig::class);
$discoveryConfig->locations = [
...$this->discoveryLocations,
...(new AutoloadDiscoveryLocations(
rootPath: $this->root,
composer: $this->container->get(Composer::class),
))(),
];
$this->container->config($discoveryConfig);
$this->discoveryConfig = $discoveryConfig;
return $this;
}
public function loadConfig(): self
{
$this->container->addInitializer(ConfigCacheInitializer::class);
$loadConfig = new LoadConfig(
discoveryConfig: $this->container->get(DiscoveryConfig::class),
container: $this->container,
cache: $this->container->get(ConfigCache::class),
environment: Environment::guessFromEnvironment(),
);
$loadConfig();
return $this;
}
public function bootDiscovery(): self
{
$this->container->addInitializer(DiscoveryCacheInitializer::class);
$bootDiscovery = new BootDiscovery(
container: $this->container,
config: $this->container->get(DiscoveryConfig::class),
cache: $this->container->get(DiscoveryCache::class),
);
$bootDiscovery();
return $this;
}
public function registerInternalStorage(): self
{
$path = $this->internalStorage ?? $this->root . '/.tempest';
if (! is_dir($path)) {
if (file_exists($path)) {
throw CouldNotRegisterInternalStorage::fileExists($path);
}
if (! mkdir($path, recursive: true)) {
throw CouldNotRegisterInternalStorage::directoryNotWritable($path);
}
} elseif (! is_writable($path)) {
throw CouldNotRegisterInternalStorage::noPermission($path);
}
$this->internalStorage = Filesystem\normalize_path($path);
return $this;
}
public function finishDeferredTasks(): self
{
$this->container->invoke(FinishDeferredTasks::class);
return $this;
}
public function event(object $event): self
{
if (interface_exists(EventBus::class)) {
$this->container->get(EventBus::class)->dispatch($event);
}
return $this;
}
public function registerEmergencyExceptionHandler(): self
{
$environment = Environment::guessFromEnvironment();
// During tests, PHPUnit registers its own error handling.
if ($environment->isTesting()) {
return $this;
}
// In development, we want to register a developer-friendly error
// handler as soon as possible to catch any kind of exception.
if (PHP_SAPI !== 'cli' && $environment->isLocal()) {
new RegisterEmergencyExceptionHandler()->register();
}
return $this;
}
public function registerExceptionHandler(): self
{
// During tests, PHPUnit registers its own error handling.
if (Environment::guessFromEnvironment()->isTesting()) {
return $this;
}
$handler = $this->container->get(ExceptionHandler::class);
ini_set('display_errors', 'Off'); // @mago-expect lint:no-ini-set
set_exception_handler($handler->handle(...));
set_error_handler(function (int $code, string $message, string $filename, int $line) use ($handler): bool {
$handler->handle(new ErrorException(
message: $message,
code: $code,
filename: $filename,
line: $line,
));
return true;
});
return $this;
}
}