Skip to content

[WebProfilerBundle] Show APP_RUNTIME #61508

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

Closed
mudassaralichouhan wants to merge 3 commits into from
Closed

[WebProfilerBundle] Show APP_RUNTIME #61508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd9a1d2
feature: Add APP_RUNTIME display in Symfony Profiler configuration da…
mudassaralichouhan Aug 23, 2025
567a4ed
profiler: display resolved application runtime class in Config panel
mudassaralichouhan Aug 25, 2025
2dfd6ee
profiler: fix runtime resolution caching in collector tests
mudassaralichouhan Aug 25, 2025
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
1 change: 1 addition & 0 deletions src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ CHANGELOG
---

* Add support for the `QUERY` HTTP method in the profiler
* Add `APP_RUNTIME` display in the configuration dashboard

7.3
---
Expand Down
10 changes: 10 additions & 0 deletions src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/config.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,16 @@
<a href="{{ path('_profiler_phpinfo') }}">View full PHP configuration</a>
</p>

{% if collector.appRuntime %}
<h2>Application Runtime</h2>
<div class="metrics">
<div class="metric">
<span class="value">{{ collector.appRuntime }}</span>
<span class="label">Runtime</span>
</div>
</div>
{% endif %}

{% if collector.bundles %}
<h2>Enabled Bundles <small>({{ collector.bundles|length }})</small></h2>
<table>
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/HttpKernel/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ CHANGELOG
* Deprecate implementing `__sleep/wakeup()` on kernels; use `__(un)serialize()` instead
* Deprecate implementing `__sleep/wakeup()` on data collectors; use `__(un)serialize()` instead
* Make `Profile` final and `Profiler::__sleep()` internal
* Add `APP_RUNTIME` display in the Symfony Profiler configuration dashboard

7.3
---
Expand Down
36 changes: 36 additions & 0 deletions src/Symfony/Component/HttpKernel/DataCollector/ConfigDataCollector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ public function collect(Request $request, Response $response, ?\Throwable $excep
'zend_opcache_status' => \extension_loaded('Zend OPcache') ? (filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOLEAN) ? 'Enabled' : 'Not enabled') : 'Not installed',
'bundles' => [],
'sapi_name' => \PHP_SAPI,
'app_runtime_resolved' => $this->resolveAppRuntime(),
];

if (isset($this->kernel)) {
Expand Down Expand Up @@ -249,6 +250,11 @@ public function getSapiName(): string
return $this->data['sapi_name'];
}

public function getAppRuntime(): ?string
{
return $this->data['app_runtime_resolved'] ?? null;
}

public function getName(): string
{
return 'config';
Expand All @@ -272,4 +278,34 @@ private function determineSymfonyState(): string

return $versionState;
}

private function resolveAppRuntime(): ?string
{
$envRuntime = $_SERVER['APP_RUNTIME'] ?? null;
if (\is_string($envRuntime) && '' !== $envRuntime) {
return $envRuntime;
}

if (isset($this->kernel)) {
$composerJsonPath = $this->kernel->getProjectDir().'/composer.json';
if (is_file($composerJsonPath) && is_readable($composerJsonPath)) {
$json = @file_get_contents($composerJsonPath);
if (false !== $json) {
$decoded = json_decode($json, true);
if (\is_array($decoded)) {
$runtimeClass = $decoded['extra']['runtime']['class'] ?? null;
if (\is_string($runtimeClass) && '' !== $runtimeClass) {
return $runtimeClass;
}
}
}
}
}

if (class_exists('Symfony\\Runtime\\SymfonyRuntime')) {
return 'Symfony\\Runtime\\SymfonyRuntime';
}

return null;
}
}
79 changes: 79 additions & 0 deletions src/Symfony/Component/HttpKernel/Tests/DataCollector/ConfigDataCollectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,85 @@ public function testCollectWithoutKernel()
$this->assertSame($eom, $c->getSymfonyEom());
$this->assertSame($eol, $c->getSymfonyEol());
}

public function testGetAppRuntime()
{
$c = new ConfigDataCollector();

$c->collect(new Request(), new Response());
$this->assertNull($c->getAppRuntime());

$_SERVER['APP_RUNTIME'] = 'Symfony\\Runtime\\SymfonyRuntime';
$c->collect(new Request(), new Response());
$this->assertSame('Symfony\\Runtime\\SymfonyRuntime', $c->getAppRuntime());

unset($_SERVER['APP_RUNTIME']);
}

public function testGetAppRuntimeFromComposerJson()
{
$tempDir = sys_get_temp_dir().'/sf_runtime_'.uniqid();
@mkdir($tempDir);

$composerJson = [
'name' => 'example/app',
'type' => 'project',
'extra' => [
'runtime' => [
'class' => 'App\\CustomRuntime',
],
],
];
file_put_contents($tempDir.'/composer.json', json_encode($composerJson));

$kernel = new class('test', true, $tempDir) extends KernelForTest {
public function __construct(string $environment, bool $debug, private string $pdir)
{
parent::__construct($environment, $debug);
}
public function getProjectDir(): string
{
return $this->pdir;
}
};

$c = new ConfigDataCollector();
$c->setKernel($kernel);
$c->collect(new Request(), new Response());
$this->assertSame('App\\CustomRuntime', $c->getAppRuntime());

@unlink($tempDir.'/composer.json');
@rmdir($tempDir);
}

public function testGetAppRuntimeFallback()
{
$tempDir = sys_get_temp_dir().'/sf_runtime_'.uniqid();
@mkdir($tempDir);

$kernel = new class('test', true, $tempDir) extends KernelForTest {
public function __construct(string $environment, bool $debug, private string $pdir)
{
parent::__construct($environment, $debug);
}
public function getProjectDir(): string
{
return $this->pdir;
}
};

$c = new ConfigDataCollector();
$c->setKernel($kernel);
$c->collect(new Request(), new Response());

if (class_exists('Symfony\\Runtime\\SymfonyRuntime')) {
$this->assertSame('Symfony\\Runtime\\SymfonyRuntime', $c->getAppRuntime());
} else {
$this->assertNull($c->getAppRuntime());
}

@rmdir($tempDir);
}
}

class KernelForTest extends Kernel
Expand Down
Loading