Skip to content
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.

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

Add loaded entities profiler section #1872

Merged
merged 7 commits into from
Mar 9, 2025
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
48 changes: 41 additions & 7 deletions src/DataCollector/DoctrineDataCollector.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

use function array_map;
use function array_sum;
use function arsort;
use function assert;
use function count;
use function usort;
Expand All @@ -42,13 +43,16 @@
* errors: array<string, array<class-string, list<string>>>,
* managers: list<string>,
* queries: array<string, list<QueryType>>,
* entityCounts: array<string, array<class-string, int>>
* }
* @psalm-property DataType $data
*/
class DoctrineDataCollector extends BaseCollector
{
private int|null $invalidEntityCount = null;

private int|null $managedEntityCount = null;

/**
* @var mixed[][]|null
* @phpstan-var ?array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
Expand All @@ -68,9 +72,10 @@ public function collect(Request $request, Response $response, Throwable|null $ex
{
parent::collect($request, $response, $exception);

$errors = [];
$entities = [];
$caches = [
$errors = [];
$entities = [];
$entityCounts = [];
$caches = [
'enabled' => false,
'log_enabled' => false,
'counts' => [
Expand Down Expand Up @@ -114,6 +119,14 @@ public function collect(Request $request, Response $response, Throwable|null $ex
}
}

$entityCounts[$name] = [];
foreach ($em->getUnitOfWork()->getIdentityMap() as $className => $entityList) {
$entityCounts[$name][$className] = count($entityList);
}

// Sort entities by count (in descending order)
arsort($entityCounts[$name]);

$emConfig = $em->getConfiguration();
$slcEnabled = $emConfig->isSecondLevelCacheEnabled();

Expand Down Expand Up @@ -165,10 +178,11 @@ public function collect(Request $request, Response $response, Throwable|null $ex
}
}

$this->data['entities'] = $entities;
$this->data['errors'] = $errors;
$this->data['caches'] = $caches;
$this->groupedQueries = null;
$this->data['entities'] = $entities;
$this->data['errors'] = $errors;
$this->data['caches'] = $caches;
$this->data['entityCounts'] = $entityCounts;
$this->groupedQueries = null;
}

/** @return array<string, array<class-string, array{class: class-string, file: false|string, line: false|int}>> */
Expand Down Expand Up @@ -228,6 +242,26 @@ public function getInvalidEntityCount()
return $this->invalidEntityCount ??= array_sum(array_map('count', $this->data['errors']));
}

public function getManagedEntityCount(): int
{
if ($this->managedEntityCount === null) {
$total = 0;
foreach ($this->data['entityCounts'] as $entities) {
$total += array_sum($entities);
}

$this->managedEntityCount = $total;
}

return $this->managedEntityCount;
}

/** @return array<string, array<class-string, int>> */
public function getManagedEntityCountByClass(): array
{
return $this->data['entityCounts'];
}

/**
* @return string[][]
* @phpstan-return array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
Expand Down
27 changes: 26 additions & 1 deletion templates/Collector/db.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@
<b>Invalid entities</b>
<span class="sf-toolbar-status {{ collector.invalidEntityCount > 0 ? 'sf-toolbar-status-red' : '' }}">{{ collector.invalidEntityCount }}</span>
</div>
<div class="sf-toolbar-info-piece">
<b>Managed entities</b>
<span class="sf-toolbar-status">{{ collector.managedEntityCount }}</span>
</div>
{% if collector.cacheEnabled %}
<div class="sf-toolbar-info-piece">
<b>Cache hits</b>
Expand Down Expand Up @@ -137,6 +141,11 @@
<span class="value">{{ collector.invalidEntityCount }}</span>
<span class="label">Invalid entities</span>
</div>

<div class="metric">
<span class="value">{{ collector.managedEntityCount }}</span>
<span class="label">Managed entities</span>
</div>
</div>

{% if collector.cacheEnabled %}
Expand Down Expand Up @@ -384,6 +393,22 @@
</div>
</div>

<div class="tab">
<h3 class="tab-title">Managed Entities</h3>
<div class="tab-content">
{% if not collector.managedEntityCountByClass %}
<div class="empty">
<p>No managed entities.</p>
</div>
{% else %}
{% for manager, entityCounts in collector.managedEntityCountByClass %}
<h4>{{ manager }} <small>entity manager</small></h4>
{{ helper.render_simple_table('Class', 'Amount of managed objects', entityCounts) }}
{% endfor %}
{% endif %}
</div>
</div>

<div class="tab {{ not collector.entities ? 'disabled' }}">
<h3 class="tab-title">Entities Mapping</h3>
<div class="tab-content">
Expand All @@ -395,7 +420,7 @@
{% else %}
{% for manager, classes in collector.entities %}
{% if collector.managers|length > 1 %}
<h3>{{ manager }} <small>entity manager</small></h3>
<h4>{{ manager }} <small>entity manager</small></h4>
{% endif %}

{% if classes is empty %}
Expand Down
34 changes: 27 additions & 7 deletions tests/DataCollector/DoctrineDataCollectorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Mapping\ClassMetadataFactory;
use Doctrine\ORM\UnitOfWork;
use Doctrine\Persistence\ManagerRegistry;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use stdClass;
use Symfony\Bridge\Doctrine\Middleware\Debug\DebugDataHolder;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
Expand All @@ -28,17 +30,27 @@ public function testCollectEntities(): void
self::markTestSkipped('This test requires ORM');
}

$manager = $this->createMock(EntityManagerInterface::class);
$config = $this->createMock(Configuration::class);
$factory = $this->createMock(ClassMetadataFactory::class);
$collector = $this->createCollector(['default' => $manager], true, $this->createMock(DebugDataHolder::class));
$manager = $this->createMock(EntityManagerInterface::class);
$config = $this->createMock(Configuration::class);
$factory = $this->createMock(ClassMetadataFactory::class);
$collector = $this->createCollector(['default' => $manager], true, $this->createMock(DebugDataHolder::class));
$unitOfWork = $this->createMock(UnitOfWork::class);

$manager->expects($this->any())
->method('getMetadataFactory')
->will($this->returnValue($factory));
$manager->expects($this->any())
->method('getConfiguration')
->will($this->returnValue($config));
$manager->expects($this->any())
->method('getUnitOfWork')
->will($this->returnValue($unitOfWork));
$unitOfWork->expects($this->any())
->method('getIdentityMap')
->will($this->returnValue([
self::FIRST_ENTITY => [new stdClass()],
self::SECOND_ENTITY => [new stdClass(), new stdClass()],
]));

$config->expects($this->once())
->method('isSecondLevelCacheEnabled')
Expand All @@ -58,6 +70,7 @@ public function testCollectEntities(): void
$entities = $collector->getEntities();
$this->assertArrayHasKey('default', $entities);
$this->assertCount(2, $entities['default']);
$this->assertSame(3, $collector->getManagedEntityCount());
}

public function testDoesNotCollectEntities(): void
Expand All @@ -66,14 +79,21 @@ public function testDoesNotCollectEntities(): void
self::markTestSkipped('This test requires ORM');
}

$manager = $this->createMock(EntityManager::class);
$config = $this->createMock(Configuration::class);
$collector = $this->createCollector(['default' => $manager], false, $this->createMock(DebugDataHolder::class));
$manager = $this->createMock(EntityManager::class);
$config = $this->createMock(Configuration::class);
$collector = $this->createCollector(['default' => $manager], false, $this->createMock(DebugDataHolder::class));
$unitOfWork = $this->createMock(UnitOfWork::class);

$manager->expects($this->never())
->method('getMetadataFactory');
$manager->method('getConfiguration')
->will($this->returnValue($config));
$manager->expects($this->any())
->method('getUnitOfWork')
->will($this->returnValue($unitOfWork));
$unitOfWork->expects($this->any())
->method('getIdentityMap')
->will($this->returnValue([]));

$collector->collect(new Request(), new Response());

Expand Down
3 changes: 3 additions & 0 deletions tests/ProfilerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -120,5 +120,8 @@ public function testRender(): void
'.*',
preg_quote('SELECT * FROM foo WHERE bar IN ( ? , ? )'),
) . '/', $output));

$this->assertStringContainsString('Managed entities', $output);
$this->assertStringContainsString('No managed entities.', $output);
}
}