From 478b2859e62a6ac9b74f3bf7981a2eb64bad09d8 Mon Sep 17 00:00:00 2001
From: Robin Appelman <robin@icewind.nl>
Date: Wed, 17 Apr 2024 14:26:43 +0200
Subject: [PATCH] feat: add request id as comment to all queries

Signed-off-by: Robin Appelman <robin@icewind.nl>
---
 config/config.sample.php      |  7 +++++++
 lib/private/DB/Connection.php | 29 +++++++++++++++++++++--------
 2 files changed, 28 insertions(+), 8 deletions(-)

diff --git a/config/config.sample.php b/config/config.sample.php
index 9818921f9229d..30bc5ef4f188b 100644
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -151,6 +151,13 @@
  */
 'dbpersistent' => '',
 
+/**
+ * Add request id to the database query in a comment.
+ *
+ * This can be enabled to assist in mapping database logs to Nextcloud logs.
+ */
+'db.log_request_id' => false,
+
 /**
  * Indicates whether the Nextcloud instance was installed successfully; ``true``
  * indicates a successful installation, and ``false`` indicates an unsuccessful
diff --git a/lib/private/DB/Connection.php b/lib/private/DB/Connection.php
index 6e2724ca5abc1..ab0b35c11b006 100644
--- a/lib/private/DB/Connection.php
+++ b/lib/private/DB/Connection.php
@@ -53,6 +53,7 @@
 use OCP\IRequestId;
 use OCP\PreConditionNotMetException;
 use OCP\Profiler\IProfiler;
+use OCP\Server;
 use Psr\Log\LoggerInterface;
 
 class Connection extends \Doctrine\DBAL\Connection {
@@ -78,6 +79,9 @@ class Connection extends \Doctrine\DBAL\Connection {
 	/** @var DbDataCollector|null */
 	protected $dbDataCollector = null;
 
+	protected bool $logRequestId;
+	protected string $requestId;
+
 	/**
 	 * Initializes a new instance of the Connection class.
 	 *
@@ -105,6 +109,9 @@ public function __construct(
 		$this->systemConfig = \OC::$server->getSystemConfig();
 		$this->logger = \OC::$server->get(LoggerInterface::class);
 
+		$this->logRequestId = $this->systemConfig->getValue('db.log_request_id', false);
+		$this->requestId = Server::get(IRequestId::class)->getId();
+
 		/** @var \OCP\Profiler\IProfiler */
 		$profiler = \OC::$server->get(IProfiler::class);
 		if ($profiler->isEnabled()) {
@@ -232,8 +239,7 @@ public function prepare($sql, $limit = null, $offset = null): Statement {
 			$platform = $this->getDatabasePlatform();
 			$sql = $platform->modifyLimitQuery($sql, $limit, $offset);
 		}
-		$statement = $this->replaceTablePrefix($sql);
-		$statement = $this->adapter->fixupStatement($statement);
+		$statement = $this->finishQuery($sql);
 
 		return parent::prepare($statement);
 	}
@@ -254,8 +260,7 @@ public function prepare($sql, $limit = null, $offset = null): Statement {
 	 * @throws \Doctrine\DBAL\Exception
 	 */
 	public function executeQuery(string $sql, array $params = [], $types = [], QueryCacheProfile $qcp = null): Result {
-		$sql = $this->replaceTablePrefix($sql);
-		$sql = $this->adapter->fixupStatement($sql);
+		$sql = $this->finishQuery($sql);
 		$this->queriesExecuted++;
 		$this->logQueryToFile($sql);
 		return parent::executeQuery($sql, $params, $types, $qcp);
@@ -265,8 +270,7 @@ public function executeQuery(string $sql, array $params = [], $types = [], Query
 	 * @throws Exception
 	 */
 	public function executeUpdate(string $sql, array $params = [], array $types = []): int {
-		$sql = $this->replaceTablePrefix($sql);
-		$sql = $this->adapter->fixupStatement($sql);
+		$sql = $this->finishQuery($sql);
 		$this->queriesExecuted++;
 		$this->logQueryToFile($sql);
 		return parent::executeUpdate($sql, $params, $types);
@@ -287,8 +291,7 @@ public function executeUpdate(string $sql, array $params = [], array $types = []
 	 * @throws \Doctrine\DBAL\Exception
 	 */
 	public function executeStatement($sql, array $params = [], array $types = []): int {
-		$sql = $this->replaceTablePrefix($sql);
-		$sql = $this->adapter->fixupStatement($sql);
+		$sql = $this->finishQuery($sql);
 		$this->queriesExecuted++;
 		$this->logQueryToFile($sql);
 		return (int)parent::executeStatement($sql, $params, $types);
@@ -515,6 +518,16 @@ public function tableExists($table) {
 		return $schema->tablesExist([$table]);
 	}
 
+	protected function finishQuery(string $statement): string {
+		$statement = $this->replaceTablePrefix($statement);
+		$statement = $this->adapter->fixupStatement($statement);
+		if ($this->logRequestId) {
+			return $statement . " /* reqid: " . $this->requestId . " */";
+		} else {
+			return $statement;
+		}
+	}
+
 	// internal use
 	/**
 	 * @param string $statement