portiny / doctrine

src/Adapter/Nette/Tracy/DoctrineSQLPanel.php

<?php declare(strict_types = 1);

namespace Portiny\Doctrine\Adapter\Nette\Tracy;

use Doctrine\DBAL\Logging\SQLLogger;
use Doctrine\ORM\Cache\Logging\CacheLoggerChain;
use Doctrine\ORM\Cache\Logging\StatisticsCacheLogger;
use Doctrine\ORM\EntityManager;
use Tracy\Debugger;
use Tracy\Dumper;
use Tracy\IBarPanel;

/**
 * Debug panel for Doctrine
 *
 * @author David Grudl
 * @author Patrik Votoček
 * @author Jan Mareš
 * @author Tomáš Pilař
 */
final class DoctrineSQLPanel implements IBarPanel, SQLLogger

The interface Doctrine\DBAL\Logging\SQLLogger has been deprecated: Use {@see \Doctrine\DBAL\Logging\Middleware} or implement {@see \Doctrine\DBAL\Driver\Middleware} instead.

{
	public const DATA_INDEX_SQL = 0;

	public const DATA_INDEX_PARAMS = 1;

	public const DATA_INDEX_TYPES = 2;

	public const DATA_INDEX_TIME = 3;

	public const DATA_INDEX_TRACE = 4;

	public const DATA_INDEX_COUNT = 5;

	/**
	 * @var int
	 */
	private $totalTime = 0;

	/**
	 * @var bool
	 */
	private $sortQueries = false;

	/**
	 * @var array
	 */
	private $queries = [];

	/**
	 * @var EntityManager
	 */
	private $entityManager;


	public function __construct(EntityManager $entityManager)
	{
		$this->entityManager = $entityManager;
	}


	/**
	 * {@inheritdoc}
	 */
	public function startQuery($sql, ?array $params = null, ?array $types = null): void
	{
		Debugger::timer('doctrine');

		$this->queries[] = [
			self::DATA_INDEX_SQL => $sql,
			self::DATA_INDEX_PARAMS => $params,
			self::DATA_INDEX_TYPES => $types,
			self::DATA_INDEX_TIME => 0,
			self::DATA_INDEX_TRACE => debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS),
		];
	}


	/**
	 * {@inheritdoc}
	 */
	public function stopQuery(): void
	{
		$keys = array_keys($this->queries);
		$key = end($keys);
		$this->queries[$key][self::DATA_INDEX_TIME] = Debugger::timer('doctrine');
		$this->totalTime += $this->queries[$key][self::DATA_INDEX_TIME];
	}


	/**
	 * {@inheritdoc}
	 */
	public function getTab(): string
	{
		return '<span title="Doctrine 2">'
			. '<img  src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAKT2lDQ1BQaG90b3Nob3A'
			. 'gSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIo'
			. 'K2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDw'
			. 'rIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl'
			. '7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABR'
			. 'G8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8'
			. 't6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcp'
			. 'Xff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcU'
			. 'l0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAA'
			. 'ARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLy'
			. 'BCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLV'
			. 'Duag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQ'
			. 'SgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkm'
			. 'xpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2'
			. 'ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl'
			. '3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61M'
			. 'bU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvO'
			. 'UZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9l'
			. 'T3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcN'
			. 'AQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2B'
			. 'aeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8W'
			. 'uw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc'
			. '+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrde'
			. 'wt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1'
			. 'BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU8'
			. '5ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJT'
			. 'wQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZB'
			. 'xQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsI'
			. 'S4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+'
			. '1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7Z'
			. 'DuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXH'
			. 'txwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRpt'
			. 'TmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK'
			. '4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu'
			. '72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6'
			. 'i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8'
			. 'EA5jz/GMzLdsAAAAJcEhZcwAALiMAAC4jAXilP3YAAAAHdElNRQffCxUPDinoxmA5AAABO1BMVEUAAADjcTnqakDwgzrxgz7ziDv'
			. '1gz72iUD5hz35iD75iT7/gAD/gED/gEf/gID/iz25VS33hDv3iUjngzf/hT7xgTz3hj31gTz8iTv4hj7tfTr5hj77ij78iT73hj3'
			. '6iD37hkD8iT35hz77hz77iT73hj36hz76hz/6hz76iD79iD/2hTz7iD75hz37iD76iD77iT75hz77iT75iD78ij/6iT/6iT74hz7'
			. '3hj37hz33hj30hD31gDb1gjj1gjn1hDr1hDv1hTz1hT31iEP1iUP2hT32hT72hj32i0b2lVX3hTr3hj33hz73k1L3mFz3mV33ml7'
			. '3m1/3nGP4hjz4hz74n2X4oGf4qXf4sYL5hz76iD781bz83cr849H96dz969/+7uT+8+v+8+3+9O7+9/H++PT//Pv//v7///+xeeL'
			. 'XAAAAO3RSTlMAAAAAAAAAAAAAAAAAAAAAAgUGBw0QEBERFBUZHR4fKSotP0RKW15lc32GlaWsydvo6err6+z2+vv8/YuXaogAAAA'
			. 'BYktHRGjLbPQiAAAAuklEQVQYGQXBhyIVABQA0FNkr6zsGTKzZT83e5Vsks39/y/oHFD7ZbC+HADMLU82qgRQaSpivsUHAGVtCxE'
			. '37aoBRRrGI+K6B1BhZGntVyHisB8wtBOX+bq7EWfdxfjUfBPx8yHf9wrxHfTF6vHvk5fMP4UfdTAafzMzM3NzqwsG4ur56fEt837'
			. 'loAk6D6Kwfp75by1moMpExEXmXcTOMPB5No7yNmJ7TA3g2+Lp/vX0VyWAUjp6W/mI/zsxJP3EcQMdAAAAAElFTkSuQmCC" />'
			. count($this->queries) . ' queries'
			. ($this->totalTime ? ' / ' . sprintf('%0.1f', $this->totalTime * 1000) . 'ms' : '')
			. '</span>';
	}


	/**
	 * {@inheritdoc}
	 */
	public function getPanel(): string
	{
		$s = '';

		if ($this->sortQueries) {
			$this->queries = $this->sortQueries($this->queries, self::DATA_INDEX_TIME);
		}

		foreach ($this->queries as $query) {
			$s .= $this->processQuery($query);
		}

		return $this->renderStyles() .
			'<h1>Queries: ' . count($this->queries) .
			($this->totalTime ? ', time: ' . sprintf('%0.3f', $this->totalTime * 1000) . ' ms' : '') .
			'</h1>
			<div class="tracy-inner nette-Doctrine2Panel">
			' . $this->renderPanelCacheStatistics() . '
			<h2>Queries</h2>
			<table>
			<tr><th>Time&nbsp;ms</th><th>SQL</th><th>Params</th><th>Trace</th></tr>' . $s .
			'</table>
			</div>';
	}


	/**
	 * Binds panel to debug bar.
	 */
	public function bindToBar(): void
	{
		if (! $this->isTracyEnabled()) {
			return;
		}

		$this->entityManager->getConfiguration()->setSQLLogger($this);

The function Doctrine\DBAL\Configuration::setSQLLogger() has been deprecated: Use {@see setMiddlewares()} and {@see \Doctrine\DBAL\Logging\Middleware} instead.

		Debugger::getBar()->addPanel($this);
	}


	/**
	 * @param bool $sortQueries
	 */
	public function setSortQueries($sortQueries): void
	{
		$this->sortQueries = $sortQueries;
	}


	public function getQueries(): array
	{
		return $this->queries;
	}


	private function sortQueries(array $queries, int $key): array
	{
		uasort(
			$queries,
			function ($a, $b) use ($key) {
				if ($a[$key] === $b[$key]) {
					return 0;
				}

				return $a[$key] > $b[$key] ? -1 : 1;
			}
		);

		return $queries;
	}


	private function processQuery(array $query): string
	{
		$s = '<tr>';
		$s .= '<td>' . sprintf('%0.3f', $query[self::DATA_INDEX_TIME] * 1000);

		if (isset($query[self::DATA_INDEX_COUNT])) {
			$s .= '/' . sprintf('%d', $query[self::DATA_INDEX_COUNT]);
		}

		$s .= '</td>';

		$s .= '<td class="nette-Doctrine2Panel-sql" style="min-width: 400px">' .
			Helper::dumpSql($query[self::DATA_INDEX_SQL]);

		$s .= '</td>';
		$s .= '<td>' . Dumper::toHtml($query[self::DATA_INDEX_PARAMS]) . '</td>';
		$s .= '<td>' . Dumper::toHtml($query[self::DATA_INDEX_TRACE]) . '</td>';
		$s .= '</tr>';

		return $s;
	}


	private function renderStyles(): string
	{
		return '<style>
			#tracy-debug td.nette-Doctrine2Panel-sql { background: white !important }
			#tracy-debug .nette-Doctrine2Panel-source { color: #BBB !important }
			#tracy-debug div.tracy-inner.nette-Doctrine2Panel { max-width: 1000px }
			#tracy-debug .nette-Doctrine2Panel tr table { margin: 8px 0; max-height: 150px; overflow:auto }
			#tracy-debug .nette-Doctrine2Panel-cache-green { color: green !important; font-weight: bold }
			#tracy-debug .nette-Doctrine2Panel-cache-red { color: red !important; font-weight: bold }
			#tracy-debug .nette-Doctrine2Panel h2 { font-size: 23px; }
			</style>';
	}


	private function renderPanelCacheStatistics(): string
	{
		if (empty($this->entityManager)) {
			return '';
		}

		$config = $this->entityManager->getConfiguration();
		if (! $config->isSecondLevelCacheEnabled()) {
			return '';
		}

		$cacheConfiguration = $config->getSecondLevelCacheConfiguration();
		if (! $cacheConfiguration) {
			return '';
		}

		$cacheLogger = $cacheConfiguration->getCacheLogger();
		if (! $cacheLogger instanceof CacheLoggerChain) {
			return '';
		}

		/** @var StatisticsCacheLogger|null $statistics */
		$statistics = $cacheLogger->getLogger('statistics');
		if (! $statistics) {

$statistics is of type Doctrine\ORM\Cache\Logging\StatisticsCacheLogger, thus it always evaluated to true.

			return '';
		}

		$cacheDriver = $this->entityManager->getConfiguration()->getMetadataCacheImpl();

The function Doctrine\ORM\Configuration::getMetadataCacheImpl() has been deprecated: Deprecated in favor of getMetadataCache

		$driverInformation = '';
		if ($cacheDriver) {
			$driverInformation = get_class($cacheDriver);
		}

		return '<h2>Second Level Cache</h2>
			<table>
				<tr>
					<td>Driver</td>
					<td><strong>' . $driverInformation . '</strong></td>
				</tr>
				<tr>
					<td>Cache hits</td>
					<td>
						<strong class="nette-Doctrine2Panel-cache-green">' . $statistics->getHitCount() . '</strong>
					</td>
				</tr>
				<tr>
					<td>Cache misses</td>
					<td>
						<strong class="nette-Doctrine2Panel-cache-red">' . $statistics->getMissCount() . '</strong>
					</td>
				</tr>
				<tr>
					<td>Cache puts</td>
					<td>
						<strong class="nette-Doctrine2Panel-cache-red">' . $statistics->getPutCount() . '</strong>
					</td>
				</tr>
			</table>';
	}


	private function isTracyEnabled(): bool
	{
		return PHP_SAPI !== 'cli' && Debugger::isEnabled() && ! Debugger::$productionMode;

The expression Tracy\Debugger::productionMode of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

	}

}