Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 0 additions & 1 deletion src/TwigComponent/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
"symfony/framework-bundle": "^5.4|^6.0|^7.0",
"symfony/phpunit-bridge": "^6.0|^7.0",
"symfony/stimulus-bundle": "^2.9.1",
"symfony/stopwatch": "^5.4|^6.0|^7.0",
"symfony/twig-bundle": "^5.4|^6.0|^7.0",
"symfony/webpack-encore-bundle": "^1.15"
},
Expand Down
3 changes: 0 additions & 3 deletions src/TwigComponent/config/debug.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@
$container->services()

->set('ux.twig_component.component_logger_listener', TwigComponentLoggerListener::class)
->args([
service('debug.stopwatch')->ignoreOnInvalid(),
])
->tag('kernel.event_subscriber')

->set('ux.twig_component.data_collector', TwigComponentDataCollector::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@

/**
* @author Simon André <smn.andre@gmail.com>
*
* @internal
*/
class TwigComponentDataCollector extends AbstractDataCollector implements LateDataCollectorInterface
final class TwigComponentDataCollector extends AbstractDataCollector implements LateDataCollectorInterface
{
private bool $hasStub;

Expand Down Expand Up @@ -99,6 +101,9 @@ private function collectDataFromLogger(): void
$renders = [];
$ongoingRenders = [];

$classStubs = [];
$templatePaths = [];

foreach ($this->logger->getEvents() as [$event, $profile]) {
if ($event instanceof PreRenderEvent) {
$mountedComponent = $event->getMountedComponent();
Expand All @@ -110,9 +115,9 @@ private function collectDataFromLogger(): void
$components[$componentName] ??= [
'name' => $componentName,
'class' => $componentClass,
'class_stub' => $this->hasStub ? new ClassStub($componentClass) : $componentClass,
'template' => $metadata->getTemplate(),
'template_path' => $this->resolveTemplatePath($metadata->getTemplate()), // defer ? lazy ?
'class_stub' => $classStubs[$componentClass] ??= ($this->hasStub ? new ClassStub($componentClass) : $componentClass),
'template' => $template = $metadata->getTemplate(),
'template_path' => $templatePaths[$template] ??= $this->resolveTemplatePath($template),
'render_count' => 0,
'render_time' => 0,
];
Expand Down
63 changes: 14 additions & 49 deletions src/TwigComponent/src/EventListener/TwigComponentLoggerListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,90 +12,55 @@
namespace Symfony\UX\TwigComponent\EventListener;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Stopwatch\Stopwatch;
use Symfony\Contracts\Service\ResetInterface;
use Symfony\UX\TwigComponent\Event\PostMountEvent;
use Symfony\UX\TwigComponent\Event\PostRenderEvent;
use Symfony\UX\TwigComponent\Event\PreCreateForRenderEvent;
use Symfony\UX\TwigComponent\Event\PreMountEvent;
use Symfony\UX\TwigComponent\Event\PreRenderEvent;

/**
* @author Simon André <smn.andre@gmail.com>
*
* @internal
*/
class TwigComponentLoggerListener implements EventSubscriberInterface, ResetInterface
final class TwigComponentLoggerListener implements EventSubscriberInterface, ResetInterface
{
private array $events = [];

public function __construct(private ?Stopwatch $stopwatch = null)
{
}

public static function getSubscribedEvents(): array
{
return [
PreCreateForRenderEvent::class => [
// High priority: start the stopwatch as soon as possible
['onPreCreateForRender', 255],
// Low priority: check `event::getRenderedString()` as late as possible
['onPostCreateForRender', -255],
],
PreMountEvent::class => ['onPreMount', 255],
PostMountEvent::class => ['onPostMount', -255],
PreRenderEvent::class => ['onPreRender', 255],
PostRenderEvent::class => ['onPostRender', -255],
];
}

/**
* @return list<array{
* PreRenderEvent|PostRenderEvent,
* array{float, int},
* }>
*/
public function getEvents(): array
{
return $this->events;
}

public function onPreCreateForRender(PreCreateForRenderEvent $event): void
{
$this->stopwatch?->start($event->getName(), 'twig_component');
$this->logEvent($event);
}

private function logEvent(object $event): void
{
$this->events[] = [$event, [microtime(true), memory_get_usage(true)]];
}

public function onPostCreateForRender(PreCreateForRenderEvent $event): void
{
if (\is_string($event->getRenderedString())) {
$this->stopwatch?->stop($event->getName());
$this->logEvent($event);
}
}

public function onPreMount(PreMountEvent $event): void
{
$this->logEvent($event);
}

public function onPostMount(PostMountEvent $event): void
{
$this->logEvent($event);
}

public function onPreRender(PreRenderEvent $event): void
{
$this->logEvent($event);
}

public function onPostRender(PostRenderEvent $event): void
{
if ($this->stopwatch?->isStarted($name = $event->getMountedComponent()->getName())) {
$this->stopwatch->stop($name);
}
$this->logEvent($event);
}

public function reset(): void
{
$this->events = [];
}

private function logEvent(object $event): void
{
$this->events[] = [$event, [microtime(true), memory_get_usage(true)]];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@
use PHPUnit\Framework\TestCase;
use Symfony\UX\TwigComponent\ComponentAttributes;
use Symfony\UX\TwigComponent\ComponentMetadata;
use Symfony\UX\TwigComponent\Event\PostMountEvent;
use Symfony\UX\TwigComponent\Event\PostRenderEvent;
use Symfony\UX\TwigComponent\Event\PreCreateForRenderEvent;
use Symfony\UX\TwigComponent\Event\PreMountEvent;
use Symfony\UX\TwigComponent\Event\PreRenderEvent;
use Symfony\UX\TwigComponent\EventListener\TwigComponentLoggerListener;
use Symfony\UX\TwigComponent\MountedComponent;
Expand All @@ -32,31 +29,20 @@ public function testLoggerStoreEvents(): void
$logger = new TwigComponentLoggerListener();
$this->assertSame([], $logger->getEvents());

$eventA = new PreCreateForRenderEvent('a');
$logger->onPreCreateForRender($eventA);

$eventB = new PreCreateForRenderEvent('b');
$logger->onPreCreateForRender($eventB);

$eventC = new PreMountEvent(new \stdClass(), [], new ComponentMetadata([]));
$logger->onPreMount($eventC);
$eventD = new PostMountEvent(new \stdClass(), [], new ComponentMetadata([]));
$logger->onPostMount($eventD);

$mounted = new MountedComponent('foo', new \stdClass(), new ComponentAttributes([]));
$eventE = new PreRenderEvent($mounted, new ComponentMetadata(['template' => 'bar']), []);
$logger->onPreRender($eventE);
$eventF = new PostRenderEvent($mounted);
$logger->onPostRender($eventF);
$eventA = new PreRenderEvent($mounted, new ComponentMetadata(['template' => 'bar']), []);
$logger->onPreRender($eventA);
$eventB = new PostRenderEvent($mounted);
$logger->onPostRender($eventB);

$this->assertSame([$eventA, $eventB, $eventC, $eventD, $eventE, $eventF], array_column($logger->getEvents(), 0));
$this->assertSame([$eventA, $eventB], array_column($logger->getEvents(), 0));
}

public function testLoggerReset(): void
{
$logger = new TwigComponentLoggerListener();

$logger->onPreCreateForRender(new PreCreateForRenderEvent('foo'));
$logger->onPreRender(new PreRenderEvent(new MountedComponent('foo', new \stdClass(), new ComponentAttributes([])), new ComponentMetadata(['template' => 'bar']), []));
$this->assertNotSame([], $logger->getEvents());

$logger->reset();
Expand Down