Skip to content

[WebProfilerBundle] display profiler url in logs #60505

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
wants to merge 4 commits into
base: 7.4
Choose a base branch
from
+214 −0
Open

[WebProfilerBundle] display profiler url in logs #60505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e0b5ef
[WebProfilerBundle] display profiler url in logs
jeremyFreeAgent May 21, 2025
22559d0
add changelog entry
jeremyFreeAgent May 21, 2025
bd46580
use final and private attributes
jeremyFreeAgent May 21, 2025
6143514
Update src/Symfony/Bundle/WebProfilerBundle/EventListener/ProfilerLin…
jeremyFreeAgent May 21, 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
2 changes: 2 additions & 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 @@ -4,6 +4,8 @@ CHANGELOG
7.3
---

* Display profiler URL in logs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are feature freeze for 7.3, hopefully this feature will be for 7.4. You can add the 7.4 title.


* Add `profiler.php` and `wdt.php` routing configuration files (use them instead of their XML equivalent)

Before:
Expand Down
60 changes: 60 additions & 0 deletions src/Symfony/Bundle/WebProfilerBundle/EventListener/ProfilerLinkLogListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Bundle\WebProfilerBundle\EventListener;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Psr\Log\LoggerInterface;

/**
* @author Jérémy Romey jeremyFreeAgent <jeremy@free-agent.fr>
*/
final class ProfilerLinkLogListener implements EventSubscriberInterface
{
public function __construct(
private ?LoggerInterface $logger = null,
private ?UrlGeneratorInterface $urlGenerator = null,
) {
}

public function onKernelResponse(ResponseEvent $event): void
{
if (null === $this->logger) {
return;
}
if (null === $this->urlGenerator) {
return;
}

$response = $event->getResponse();
$request = $event->getRequest();

if (!$event->isMainRequest()) {
return;
}

if (!$response->headers->has('X-Debug-Token')) {
return;
}

$this->logger->debug(\sprintf('See profiler at %s', $this->urlGenerator->generate('_profiler', ['token' => $response->headers->get('X-Debug-Token')], UrlGeneratorInterface::ABSOLUTE_URL)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The logger should do the interpolation. Does it work like this?

Suggested change
$this->logger->debug(\sprintf('See profiler at %s', $this->urlGenerator->generate('_profiler', ['token' => $response->headers->get('X-Debug-Token')], UrlGeneratorInterface::ABSOLUTE_URL)));
$this->logger->debug('See profiler at {profiler_url}', ['profiler_url' => $this->urlGenerator->generate('_profiler', ['token' => $response->headers->get('X-Debug-Token')], UrlGeneratorInterface::ABSOLUTE_URL)]);

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not use directly X-Debug-Token-Link header?

}

public static function getSubscribedEvents(): array
{
return [
KernelEvents::RESPONSE => ['onKernelResponse', -2048],
];
}
}
10 changes: 10 additions & 0 deletions src/Symfony/Bundle/WebProfilerBundle/Resources/config/profiler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Symfony\Bundle\WebProfilerBundle\Controller\RouterController;
use Symfony\Bundle\WebProfilerBundle\Csp\ContentSecurityPolicyHandler;
use Symfony\Bundle\WebProfilerBundle\Csp\NonceGenerator;
use Symfony\Bundle\WebProfilerBundle\EventListener\ProfilerLinkLogListener;
use Symfony\Bundle\WebProfilerBundle\Profiler\CodeExtension;
use Symfony\Bundle\WebProfilerBundle\Twig\WebProfilerExtension;
use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter;
Expand Down Expand Up @@ -84,5 +85,14 @@
->set('twig.extension.code', CodeExtension::class)
->args([service('debug.file_link_formatter'), param('kernel.project_dir'), param('kernel.charset')])
->tag('twig.extension')

->set('web_profiler.profiler_link_log_listener', ProfilerLinkLogListener::class)
->args([
service('logger')->nullOnInvalid(),
service('router')->ignoreOnInvalid(),
])

->tag('monolog.logger', ['channel' => 'profiler'])
->tag('kernel.event_subscriber')
;
};
142 changes: 142 additions & 0 deletions src/Symfony/Bundle/WebProfilerBundle/Tests/EventListener/ProfilerLinkLogListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Bundle\WebProfilerBundle\Tests\EventListener;

use PHPUnit\Framework\TestCase;
use Symfony\Bundle\WebProfilerBundle\EventListener\ProfilerLinkLogListener;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Psr\Log\LoggerInterface;

/**
* @author Jérémy Romey jeremyFreeAgent <jeremy@free-agent.fr>
*/
final class ProfilerLinkLogListenerTest extends TestCase
{
public function testProfilerLinkLog()
{
$response = new Response('I love Symfony', 200);
$response->headers->set('Location', 'https://example.com/');
$response->headers->set('X-Debug-Token', '04bb3f');

$event = new ResponseEvent($this->createMock(Kernel::class), new Request(), HttpKernelInterface::MAIN_REQUEST, $response);

$logger = $this->createMock(LoggerInterface::class);
$logger
->expects($this->once())
->method('debug')
->with('See profiler at http://mydomain.com/_profiler/04bb3f')
;

$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
$urlGenerator
->expects($this->once())
->method('generate')
->with('_profiler', ['token' => '04bb3f'], UrlGeneratorInterface::ABSOLUTE_URL)
->willReturn('http://mydomain.com/_profiler/04bb3f')
;

$listener = new ProfilerLinkLogListener($logger, $urlGenerator);
$listener->onKernelResponse($event);
}

public function testProfilerLinkLogShouldNotLogWhenNoLogger()
{
$response = new Response('I love Symfony', 200);
$response->headers->set('Location', 'https://example.com/');
$response->headers->set('X-Debug-Token', '04bb3f');

$event = new ResponseEvent($this->createMock(Kernel::class), new Request(), HttpKernelInterface::MAIN_REQUEST, $response);

$logger = null;

$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
$urlGenerator
->expects($this->never())
->method('generate')
;

$listener = new ProfilerLinkLogListener($logger, $urlGenerator);
$listener->onKernelResponse($event);
}

public function testProfilerLinkLogShouldNotLogWhenNoUrlGenerator()
{
$response = new Response('I love Symfony', 200);
$response->headers->set('Location', 'https://example.com/');
$response->headers->set('X-Debug-Token', '04bb3f');

$event = new ResponseEvent($this->createMock(Kernel::class), new Request(), HttpKernelInterface::MAIN_REQUEST, $response);

$logger = $this->createMock(LoggerInterface::class);
$logger
->expects($this->never())
->method('debug')
;

$urlGenerator = null;

$listener = new ProfilerLinkLogListener($logger, $urlGenerator);
$listener->onKernelResponse($event);
}

public function testProfilerLinkLogShouldNotLogWhenNotMainRequest()
{
$response = new Response('I love Symfony', 200);
$response->headers->set('Location', 'https://example.com/');
$response->headers->set('X-Debug-Token', '04bb3f');

$event = new ResponseEvent($this->createMock(Kernel::class), new Request(), HttpKernelInterface::SUB_REQUEST, $response);

$logger = $this->createMock(LoggerInterface::class);
$logger
->expects($this->never())
->method('debug')
;

$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
$urlGenerator
->expects($this->never())
->method('generate')
;

$listener = new ProfilerLinkLogListener($logger, $urlGenerator);
$listener->onKernelResponse($event);
}

public function testProfilerLinkLogShouldNotLogWhenNoToken()
{
$response = new Response('I love Symfony', 200);
$response->headers->set('Location', 'https://example.com/');

$event = new ResponseEvent($this->createMock(Kernel::class), new Request(), HttpKernelInterface::MAIN_REQUEST, $response);

$logger = $this->createMock(LoggerInterface::class);
$logger
->expects($this->never())
->method('debug')
;

$urlGenerator = $this->createMock(UrlGeneratorInterface::class);
$urlGenerator
->expects($this->never())
->method('generate')
;

$listener = new ProfilerLinkLogListener($logger, $urlGenerator);
$listener->onKernelResponse($event);
}
}