Improve look Tracy bar

src/DI/Pass/ConnectionPass.php

@@ -82,8 +82,9 @@ public function loadConnectionConfiguration(string $connectionName, mixed $conne
 
 		// Middlewares: debug
 		if ($config->debug->panel) {
+			$sourcePaths = $config->debug->sourcePaths;
 			$builder->addDefinition($this->prefix(sprintf('connections.%s.middleware.internal.debug.stack', $connectionName)))
-				->setFactory(DebugStack::class)
+				->setFactory(DebugStack::class, ['sourcePaths' => $sourcePaths])
 				->setAutowired(false);
 			$builder->addDefinition($this->prefix(sprintf('connections.%s.middleware.internal.debug', $connectionName)))
 				->setFactory(DebugMiddleware::class, [$this->prefix(sprintf('@connections.%s.middleware.internal.debug.stack', $connectionName)), $connectionName])

src/Middleware/Debug/DebugStack.php

@@ -2,6 +2,8 @@
 
 namespace Nettrine\DBAL\Middleware\Debug;
 
+use Nettrine\DBAL\Utils\QueryUtils;
+
 /**
  * @see https://github.com/symfony/doctrine-bridge
  * @internal
@@ -12,13 +14,23 @@ class DebugStack
 	/** @var array<string, array<int, array{sql: string, params: mixed[], types: mixed[], duration: callable|float }>> */
 	private array $data = [];
 
+	public function __construct(
+		/** @var array<string> */
+		private array $sourcePaths
+	)
+	{
+	}
+
 	public function addQuery(string $connectionName, DebugQuery $query): void
 	{
+		$backtrace = debug_backtrace();
+		$backtrace = QueryUtils::getSource($this->sourcePaths, $backtrace);
 		$this->data[$connectionName][] = [
 			'sql' => $query->getSql(),
 			'params' => $query->getParams(),
 			'types' => $query->getTypes(),
 			'duration' => $query->getDuration(...), // stop() may not be called at this point
+			'source' => $backtrace,
 		];
 	}
 

src/Tracy/ConnectionPanel.php

@@ -6,6 +6,7 @@
 use Doctrine\DBAL\Driver\Exception;
 use Doctrine\DBAL\Query\QueryException;
 use Nettrine\DBAL\Middleware\Debug\DebugStack;
+use Nettrine\DBAL\Utils\Formatter;
 use PDO;
 use PDOException;
 use Throwable;
@@ -22,23 +23,27 @@ class ConnectionPanel implements IBarPanel
 
 	protected string $connectionName;
 
-	private function __construct(DebugStack $stack, string $connectionName)
+	protected Connection $connection;
+
+	private function __construct(DebugStack $stack, string $connectionName, Connection $connection)
 	{
 		$this->stack = $stack;
 		$this->connectionName = $connectionName;
+		$this->connection = $connection;
 	}
 
 	public static function initialize(
 		DebugStack $stack,
 		string $connectionName,
+		Connection $connection,
 		?Bar $bar = null,
 		?BlueScreen $blueScreen = null,
 	): self
 	{
 		$blueScreen ??= Debugger::getBlueScreen();
 		$blueScreen->addPanel(self::renderException(...));
 
-		$panel = new self($stack, $connectionName);
+		$panel = new self($stack, $connectionName, $connection);
 		$bar ??= Debugger::getBar();
 		$bar->addPanel($panel);
 
@@ -107,6 +112,7 @@ public function getPanel(): string
 	{
 		// phpcs:disable
 		return Helpers::capture(function (): void {
+			$connection = $this->connection;
 			$queries = $this->stack->getDataBy($this->connectionName);
 			$queriesNum = count($queries);
 			$totalTime = 0;
@@ -115,6 +121,23 @@ public function getPanel(): string
 				$totalTime += $query['duration'];
 			}
 
+			$formatter = new Formatter();
+
+			/**
+			 * @var string[] $params
+			 */
+			$params = $this->connection->getParams();
+
+			$dbParams = [
+				'driver' => $params['driver'],
+				'host' => $params['host'],
+				'user' => $params['user'],
+				'password' => '*****',
+				'dbname' => $params['dbname'],
+				'port' => $params['port'],
+				'charset' => $params['charset'],
+			];
+
 			require __DIR__ . '/templates/panel.phtml';
 		});
 		// phpcs:enable

src/Tracy/templates/panel.phtml

@@ -2,10 +2,17 @@
 
 namespace Nettrine\DBAL\Tracy;
 
+use Doctrine\DBAL\Connection;
+use Nettrine\DBAL\Utils\Formatter;
+use Nettrine\DBAL\Utils\QueryUtils;
 use Tracy\Dumper;
+use Tracy\Helpers;
 
+/** @var Connection $connection */
+/** @var Formatter $formatter  */
 /** @var int $queriesNum */
 /** @var int $totalTime */
+/** @var array $dbParams */
 /** @var array<array{sql: string, params: mixed[], types: mixed[], duration: float }> $queries */
 ?>
 <style>
@@ -38,29 +45,77 @@ use Tracy\Dumper;
 	</h1>
 	<div class="tracy-inner nettrine-dbal">
 		<?php if ($queries !== []): ?>
+			<h2>Queries with params</h2>
 			<table class="tracy-sortable">
 				<tr>
 					<th>Time&nbsp;ms</th>
 					<th>SQL</th>
 					<th>Params</th>
+					<th>Types</th>
 				</tr>
 
 				<?php foreach ($queries as $q): ?>
 					<tr>
 						<td>
 							<?= sprintf('%0.2f', $q['duration'] * 1000); ?>
+							<?php if (count($q['source']) !== 0): ?>
+								<br><a class="tracy-toggle tracy-collapsed" data-tracy-ref="^tr .nettrine-dbal-backtrace"></a>
+							<?php endif; ?>
 						</td>
 						<td class="tracy-dbal-sql">
-							<?= $q['sql']; ?>
+							<?= QueryUtils::highlight($q['sql']); ?>
+							<?php if (count($q['source']) !== 0): ?>
+								<table class="nettrine-dbal-backtrace tracy-collapsed">
+									<?php foreach ($q['source'] as $s): ?>
+										<tr><td><?= Helpers::editorLink($s['file'], $s['line']); ?></td></tr>
+									<?php endforeach; ?>
+								</table>
+							<?php endif; ?>
 						</td>
 						<td class="tracy-dbal-sql">
 							<?= Dumper::toHtml($q['params']); ?>
+						</td>
+						<td class="tracy-dbal-sql">
 							<?= Dumper::toHtml($q['types'], [Dumper::COLLAPSE => true]); ?>
 						</td>
 					</tr>
 				<?php endforeach; ?>
+			</table>
+		<?php endif; ?>
+		<?php if ($queries !== []): ?>
+			<h2>Plain queries</h2>
+			<table class="tracy-sortable">
+				<tr>
+					<th>Time&nbsp;ms</th>
+					<th>SQL</th>
+				</tr>
 
+				<?php foreach ($queries as $q): ?>
+					<tr>
+						<td>
+							<?= sprintf('%0.2f', $q['duration'] * 1000); ?>
+							<?php if (count($q['source']) !== 0): ?>
+								<br><a class="tracy-toggle tracy-collapsed" data-tracy-ref="^tr .nettrine-dbal-backtrace"></a>
+							<?php endif; ?>
+						</td>
+						<td class="tracy-dbal-sql">
+							<?php $sql = $formatter->formatSql($connection, $q['sql'], $q['params']); ?>
+							<?= QueryUtils::highlight($sql); ?>
+							<?php if (count($q['source']) !== 0): ?>
+								<table class="nettrine-dbal-backtrace tracy-collapsed">
+									<?php foreach ($q['source'] as $s): ?>
+										<tr><td><?= Helpers::editorLink($s['file'], $s['line']); ?></td></tr>
+									<?php endforeach; ?>
+								</table>
+							<?php endif; ?>
+						</td>
+					</tr>
+				<?php endforeach; ?>
 			</table>
 		<?php endif; ?>
+
+		<div style="margin-top: 25px;">
+			<?= Dumper::toHtml($dbParams, [Dumper::COLLAPSE => true]); ?>
+		</div>
 	</div>
 <?php } ?>

src/Utils/Formatter.php

@@ -0,0 +1,87 @@
+<?php declare(strict_types = 1);
+
+namespace Nettrine\DBAL\Utils;
+
+use Doctrine\DBAL\ArrayParameterType;
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\ExpandArrayParameters;
+use Doctrine\DBAL\Types\Type;
+
+class Formatter
+{
+
+	/**
+	 * @param ?array<mixed> $params
+	 */
+	public function formatSql(Connection $connection, string $sql, ?array $params = null): string
+	{
+		if ($params) {
+			[$sql, $params] = self::expandListParameters($connection, $sql, $params, []);
+
+			// Escape % before vsprintf (example: LIKE '%ant%')
+			$sql = str_replace(['%', '?'], ['%%', '%s'], $sql);
+
+			$query = vsprintf(
+				$sql,
+				call_user_func(function () use ($connection, $params) {
+					$quotedParams = [];
+					foreach ($params as $value) {
+						$quotedParams[] = $connection->quote((string) $value);
+					}
+
+					return $quotedParams;
+				})
+			);
+		} else {
+			$query = $sql;
+		}
+
+		return $query;
+	}
+
+	/**
+	 * @param array<int, mixed>|array<string, mixed>                               $params
+	 * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types
+	 */
+	private static function needsArrayParameterConversion(array $params, array $types): bool
+	{
+		if (is_string(key($params))) {
+			return true;
+		}
+
+		foreach ($types as $type) {
+			if (
+				$type === ArrayParameterType::INTEGER
+				|| $type === ArrayParameterType::STRING
+				|| $type === ArrayParameterType::ASCII
+			) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @param array<int, mixed>|array<string, mixed> $params
+	 * @param array<int,Type|int|string|null>|array<string,Type|int|string|null> $types
+	 * @return array{string, array<int|string, mixed>, array<int|string,Type|int|string|null>}
+	 */
+	private function expandListParameters(Connection $connection, string $query, array $params, array $types): array
+	{
+		if (!self::needsArrayParameterConversion($params, $types)) {
+			return [$query, $params, $types];
+		}
+
+		$parser = $connection->getDatabasePlatform()->createSQLParser();
+		$visitor = new ExpandArrayParameters($params, $types);
+		$parser->parse($query, $visitor);
+
+		return [
+			$visitor->getSQL(),
+			$visitor->getParameters(),
+			$visitor->getTypes(),
+		];
+	}
+
+}

src/Utils/QueryUtils.php

@@ -0,0 +1,63 @@
+<?php declare(strict_types = 1);
+
+namespace Nettrine\DBAL\Utils;
+
+final class QueryUtils
+{
+
+	/**
+	 * Highlight given SQL parts
+	 */
+	public static function highlight(string $sql): string
+	{
+		static $keywords1 = 'SELECT|(?:ON\s+DUPLICATE\s+KEY)?UPDATE|INSERT(?:\s+INTO)?|REPLACE(?:\s+INTO)?|SHOW|DELETE|CALL|UNION|FROM|WHERE|HAVING|GROUP\s+BY|ORDER\s+BY|LIMIT|OFFSET|SET|VALUES|LEFT\s+JOIN|INNER\s+JOIN|TRUNCATE|START\s+TRANSACTION|COMMIT|ROLLBACK|(?:RELEASE\s+|ROLLBACK\s+TO\s+)?SAVEPOINT';
+		static $keywords2 = 'ALL|DISTINCT|DISTINCTROW|IGNORE|AS|USING|ON|AND|OR|IN|IS|NOT|NULL|[RI]?LIKE|REGEXP|TRUE|FALSE';
+		$sql = ' ' . $sql . ' ';
+		$sql = htmlspecialchars($sql, ENT_IGNORE, 'UTF-8');
+		$sql = preg_replace_callback(sprintf('#(/\\*.+?\\*/)|(?<=[\\s,(])(%s)(?=[\\s,)])|(?<=[\\s,(=])(%s)(?=[\\s,)=])#is', $keywords1, $keywords2), function ($matches) {
+			if (!empty($matches[1])) { // comment
+				return '<em style="color:gray">' . $matches[1] . '</em>';
+			}
+
+			if (!empty($matches[2])) { // most important keywords
+				return '<strong style="color:#2D44AD">' . $matches[2] . '</strong>';
+			}
+
+			if (!empty($matches[3])) { // other keywords
+				return '<strong>' . $matches[3] . '</strong>';
+			}
+		}, $sql);
+
+		return trim((string) $sql);
+	}
+
+	/**
+	 * @param string[] $sourcePaths
+	 * @param mixed[] $backtrace
+	 * @return mixed[]
+	 */
+	public static function getSource(array $sourcePaths, array $backtrace): array
+	{
+		$result = [];
+		if (count($sourcePaths) === 0) {
+			return $result;
+		}
+
+		foreach ($backtrace as $i) {
+			if (!isset($i['file'], $i['line'])) {
+				continue;
+			}
+
+			foreach ($sourcePaths as $path) {
+				$path = realpath($path);
+
+				if (str_contains($i['file'], $path)) {
+					$result[] = $i;
+				}
+			}
+		}
+
+		return $result;
+	}
+
+}